Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cerbos/express-prisma-cerbos
An example application of integrating Cerbos with an Express server using Prisma as the ORM.
https://github.com/cerbos/express-prisma-cerbos
cerbos express node prisma
Last synced: about 18 hours ago
JSON representation
An example application of integrating Cerbos with an Express server using Prisma as the ORM.
- Host: GitHub
- URL: https://github.com/cerbos/express-prisma-cerbos
- Owner: cerbos
- License: apache-2.0
- Created: 2021-08-30T10:02:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T04:46:21.000Z (7 months ago)
- Last Synced: 2024-04-08T05:38:07.466Z (7 months ago)
- Topics: cerbos, express, node, prisma
- Language: TypeScript
- Homepage:
- Size: 265 KB
- Stars: 10
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# express-prisma-cerbos
An example application of integrating [Cerbos](https://cerbos.dev) with an [Express](https://expressjs.com/) server using [Prisma](https://prisma.io/) as the ORM. Cerbos helps you super-charge your authorization implementation by writing context-aware access control policies for your application resources. Author access rules using an intuitive YAML configuration language, use your Git-ops infrastructure to test and deploy them and, make simple API requests to the Cerbos PDP to evaluate the policies and make dynamic access decisions.
This is based on the [REST API Express](https://github.com/prisma/prisma-examples/tree/latest/typescript/rest-express) example from Prisma.
## Dependencies
- Node.js
- Docker for running the [Cerbos Policy Decision Point (PDP)](https://docs.cerbos.dev/cerbos/installation/container.html)
## Getting Started
1. Start up the Cerbos PDP instance docker container. This will be called by the express app to check authorization.
```bash
cd cerbos
./start.sh
```
2. Install node dependencies
```bash
npm install
```
3. Setup Prisma and seed the database
```
npx prisma migrate dev --name init
```
4. Start the express server
```bash
npm run dev
```
## Seed Users
The Prisma seed command will create the following users in the database. Authentication is done via Basic authentication using the following credentials. The Role and Department is loaded from the database after successful authentication.
| ID | Username | Password | Role | Department |
| --- | -------- | ------------ | ----- | ---------- |
| 1 | alice | supersecret | Admin | IT |
| 2 | john | password1234 | User | Sales |
| 3 | sarah | asdfghjkl | User | Sales |
| 4 | geri | pwd123 | User | Marketing |
## Policies
This example has a simple CRUD policy in place for a resource kind of `contact` - like a CRM system would have. The policy file can be found in the `cerbos/policies` folder [here](https://github.com/cerbos/express-prisma-cerbos/blob/main/cerbos/policies/contact.yaml).
Should you wish to experiment with this policy, you can try it in the Cerbos Playground.
The [policy](./cerbos/policies/contact.yaml) expects one of two roles to be set on the principal - `admin` and `user` and an attribute which defines their department as either `IT`, `Sales` or `Marketing`.
These roles are authorized as follows:
| Action | Role: User | Role: Admin |
| -------- | ------------------------------------------- | ----------- |
| `read` | Only if department is `Sales` | Y |
| `create` | Only if department is `Sales` | Y |
| `update` | Only if they own the contact being accessed | Y |
| `delete` | Only if they own the contact being accessed | Y |
## Example Requests
### Get all contact
As a Sales user => `200 OK`
```
curl -i http://john:password1234@localhost:3000/contacts
```
As a Marketing user => `403 Unauthorized`
```
curl -i http://geri:pwd123@localhost:3000/contacts
```
### Get a contact
As a Sales user => `200 OK`
```
curl -i http://john:password1234@localhost:3000/contacts/1
```
As a Marketing user => `403 Unauthorized`
```
curl -i http://geri:pwd123@localhost:3000/contacts/1
```