Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Dgraph adapter (issues and updated default jwt encoding) #11338

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

fix: Dgraph adapter (issues and updated default jwt encoding) #11338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2023c8d
feat: adapter-dgraph updated client, notably: HS512, better error han…
adriangalilea Jul 5, 2024
c8b8aef
feat: adapter-dgraph improved adapter: native id's and general rework.
adriangalilea Jul 5, 2024
5e86d5b
chore: dgraph-adapter docs
adriangalilea Jul 5, 2024
dc4b32d
feat: adapter-dgraph remove non needed promises
adriangalilea Jul 5, 2024
9f7674e
chore: adapter-dgraph prettier format
adriangalilea Jul 5, 2024
444d1d5
feat: adapter-dgraph new tests
adriangalilea Jul 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 12 additions & 30 deletions docs/pages/getting-started/adapters/dgraph.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,15 @@ app.use(
</Code.Express>
</Code>

### Schema

<Callout type="warning">
Note that this adapter is designed so that it uses Dgraph internal ID's, if
you are interested in using external id's you should modify your schema `id:
ID` to `id: String @id` for instance and modify the adapter
methods(createUser, linkAccount...).
</Callout>

### Unsecure Schema

The quickest way to use Dgraph is by applying the unsecure schema to your [local](https://dgraph.io/docs/graphql/admin/#modifying-a-schema) Dgraph instance or if using Dgraph [cloud](https://dgraph.io/docs/cloud/cloud-quick-start/#the-schema) you can paste the schema in the codebox to update.
Expand Down Expand Up @@ -235,7 +244,7 @@ type VerificationToken
expires: DateTime
}

# Dgraph.Authorization {"VerificationKey":"<YOUR JWT SECRET HERE>","Header":"<YOUR AUTH HEADER HERE>","Namespace":"<YOUR CUSTOM NAMESPACE HERE>","Algo":"HS256"}
# Dgraph.Authorization {"VerificationKey":"<YOUR JWT SECRET HERE>","Header":"<YOUR AUTH HEADER HERE>","Namespace":"<YOUR CUSTOM NAMESPACE HERE>","Algo":"HS512"}
```

### Dgraph.Authorization
Expand All @@ -244,7 +253,7 @@ In order to secure your graphql backend define the `Dgraph.Authorization` object
bottom of your schema and provide `authHeader` and `jwtSecret` values to the DgraphClient.

```js
# Dgraph.Authorization {"VerificationKey":"<YOUR JWT SECRET HERE>","Header":"<YOUR AUTH HEADER HERE>","Namespace":"YOUR CUSTOM NAMESPACE HERE","Algo":"HS256"}
# Dgraph.Authorization {"VerificationKey":"<YOUR JWT SECRET HERE>","Header":"<YOUR AUTH HEADER HERE>","Namespace":"YOUR CUSTOM NAMESPACE HERE","Algo":"HS512"}
```

### VerificationKey and jwtSecret
Expand Down Expand Up @@ -276,31 +285,4 @@ type VerificationRequest

### JWT session and `@auth` directive

Dgraph only works with HS256 or RS256 algorithms. If you want to use session jwt to securely interact with your dgraph
database you must customize next-auth `encode` and `decode` functions, as the default algorithm is HS512. You can
further customize the jwt with roles if you want to implement [`RBAC logic`](https://dgraph.io/docs/graphql/authorization/directive/#role-based-access-control).

```js filename="./auth.js"
import NextAuth from "next-auth"
import * as jwt from "jsonwebtoken"

export const { handlers, auth, signIn, signOut } = NextAuth({
session: {
strategy: "jwt",
},
jwt: {
secret: process.env.SECRET,
encode: async ({ secret, token }) => {
return jwt.sign({ ...token, userId: token.id }, secret, {
algorithm: "HS256",
expiresIn: 30 * 24 * 60 * 60, // 30 days
})
},
decode: async ({ secret, token }) => {
return jwt.verify(token, secret, { algorithms: ["HS256"] })
},
},
})
```

Once your `Dgraph.Authorization` is defined in your schema and the JWT settings are set, this will allow you to define [`@auth rules`](https://dgraph.io/docs/graphql/authorization/authorization-overview/) for every part of your schema.
Once your `Dgraph.Authorization` is defined in your schema and the JWT settings are set, this will allow you to define [`@auth rules`](https://dgraph.io/docs/graphql/schema/directives/auth/) for every part of your schema.