@graphql-yoga/plugin-jwt 1.0.0-alpha-20221021134149-437795dc

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2018-2020 Graphcool
+Copyright (c) 2020-2021 Prisma
+Copyright (c) 2021- The Guild
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/cjs/index.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useJwt = void 0;
+const jwks_rsa_1 = require("jwks-rsa");
+const jsonwebtoken_1 = require("jsonwebtoken");
+const graphql_1 = require("graphql");
+function useJwt(options) {
+    let jwksClient;
+    if (options.jwksUri) {
+        jwksClient = new jwks_rsa_1.JwksClient({
+            cache: true,
+            rateLimit: true,
+            jwksRequestsPerMinute: 5,
+            jwksUri: options.jwksUri,
+        });
+    }
+    const headerName = options.headerName || 'authorization';
+    const headerType = options.headerType || 'Bearer ';
+    const contextFieldName = options.extendContextField || '_jwt';
+    const payloadByRequest = new WeakMap();
+    return {
+        async onRequest({ request }) {
+            const header = request.headers.get(headerName);
+            if (header != null) {
+                const [type, token] = header.split(' ');
+                if (type !== headerType) {
+                    throw new graphql_1.GraphQLError(`Unsupported token type provided: "${type}"!`, {
+                        extensions: {
+                            http: {
+                                status: 401,
+                            },
+                        },
+                    });
+                }
+                const decodedToken = (0, jsonwebtoken_1.decode)(token, { complete: true });
+                if (decodedToken?.header?.kid == null) {
+                    throw new graphql_1.GraphQLError(`Failed to decode authentication token!`, {
+                        extensions: {
+                            http: {
+                                status: 401,
+                            },
+                        },
+                    });
+                }
+                let signingKey;
+                if (options.signingKey) {
+                    signingKey = options.signingKey;
+                }
+                else if (options.jwksUri) {
+                    const secret = await jwksClient.getSigningKey(decodedToken.header.kid);
+                    signingKey = secret.getPublicKey();
+                }
+                if (signingKey) {
+                    const verified = await new Promise((resolve, reject) => {
+                        (0, jsonwebtoken_1.verify)(token, signingKey, {
+                            algorithms: options.algorithms || ['RS256'],
+                            audience: options.audience,
+                            issuer: options.issuer,
+                        }, (err, result) => {
+                            if (err) {
+                                reject(err);
+                            }
+                            else {
+                                resolve(result);
+                            }
+                        });
+                    });
+                    if (!verified) {
+                        throw new graphql_1.GraphQLError(`Unauthenticated!`, {
+                            extensions: {
+                                http: {
+                                    status: 401,
+                                },
+                            },
+                        });
+                    }
+                    payloadByRequest.set(request, verified);
+                }
+                else {
+                    payloadByRequest.set(request, decodedToken.payload);
+                }
+            }
+        },
+        onContextBuilding({ context, extendContext }) {
+            if (context.request == null) {
+                throw new Error('Request is not available on context! Make sure you use this plugin with GraphQL Yoga.');
+            }
+            const payload = payloadByRequest.get(context.request);
+            if (payload != null) {
+                extendContext({
+                    [contextFieldName]: payload,
+                });
+            }
+        },
+    };
+}
+exports.useJwt = useJwt;

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/esm/index.js

@@ -0,0 +1,93 @@
+import { JwksClient } from 'jwks-rsa';
+import { decode, verify } from 'jsonwebtoken';
+import { GraphQLError } from 'graphql';
+export function useJwt(options) {
+    let jwksClient;
+    if (options.jwksUri) {
+        jwksClient = new JwksClient({
+            cache: true,
+            rateLimit: true,
+            jwksRequestsPerMinute: 5,
+            jwksUri: options.jwksUri,
+        });
+    }
+    const headerName = options.headerName || 'authorization';
+    const headerType = options.headerType || 'Bearer ';
+    const contextFieldName = options.extendContextField || '_jwt';
+    const payloadByRequest = new WeakMap();
+    return {
+        async onRequest({ request }) {
+            const header = request.headers.get(headerName);
+            if (header != null) {
+                const [type, token] = header.split(' ');
+                if (type !== headerType) {
+                    throw new GraphQLError(`Unsupported token type provided: "${type}"!`, {
+                        extensions: {
+                            http: {
+                                status: 401,
+                            },
+                        },
+                    });
+                }
+                const decodedToken = decode(token, { complete: true });
+                if (decodedToken?.header?.kid == null) {
+                    throw new GraphQLError(`Failed to decode authentication token!`, {
+                        extensions: {
+                            http: {
+                                status: 401,
+                            },
+                        },
+                    });
+                }
+                let signingKey;
+                if (options.signingKey) {
+                    signingKey = options.signingKey;
+                }
+                else if (options.jwksUri) {
+                    const secret = await jwksClient.getSigningKey(decodedToken.header.kid);
+                    signingKey = secret.getPublicKey();
+                }
+                if (signingKey) {
+                    const verified = await new Promise((resolve, reject) => {
+                        verify(token, signingKey, {
+                            algorithms: options.algorithms || ['RS256'],
+                            audience: options.audience,
+                            issuer: options.issuer,
+                        }, (err, result) => {
+                            if (err) {
+                                reject(err);
+                            }
+                            else {
+                                resolve(result);
+                            }
+                        });
+                    });
+                    if (!verified) {
+                        throw new GraphQLError(`Unauthenticated!`, {
+                            extensions: {
+                                http: {
+                                    status: 401,
+                                },
+                            },
+                        });
+                    }
+                    payloadByRequest.set(request, verified);
+                }
+                else {
+                    payloadByRequest.set(request, decodedToken.payload);
+                }
+            }
+        },
+        onContextBuilding({ context, extendContext }) {
+            if (context.request == null) {
+                throw new Error('Request is not available on context! Make sure you use this plugin with GraphQL Yoga.');
+            }
+            const payload = payloadByRequest.get(context.request);
+            if (payload != null) {
+                extendContext({
+                    [contextFieldName]: payload,
+                });
+            }
+        },
+    };
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@graphql-yoga/plugin-jwt",
+  "version": "1.0.0-alpha-20221021134149-437795dc",
+  "description": "jwt plugin for GraphQL Yoga.",
+  "dependencies": {
+    "@graphql-tools/utils": "8.12.0",
+    "jsonwebtoken": "8.5.1",
+    "jwks-rsa": "2.1.5",
+    "tslib": "^2.4.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dotansimha/graphql-yoga.git",
+    "directory": "packages/plugins/jwt"
+  },
+  "author": "Arda TANRIKULU <ardatanrikulu@gmail.com>",
+  "license": "MIT",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
+  "typescript": {
+    "definition": "typings/index.d.ts"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./typings/index.d.cts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  }
+}

package/typings/index.d.cts

@@ -0,0 +1,46 @@
+import { Algorithm } from 'jsonwebtoken';
+import { Plugin } from 'graphql-yoga';
+export interface JwtPluginOptions {
+    /**
+     * The endpoint to fetch keys from.
+     *
+     * For example: https://example.com/.well-known/jwks.json
+     */
+    jwksUri?: string;
+    /**
+     * Signing key to be used to verify the token
+     * You can also use the jwks option to fetch the key from a JWKS endpoint
+     */
+    signingKey?: string;
+    /**
+     * List of the algorithms used to verify the token
+     *
+     * Default: ["RS256"] (Allowed values: HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512, none)
+     */
+    algorithms?: Algorithm[];
+    /**
+     * The audience is the identifier of the API and is forwarded to your Auth API in order to specify for which API we are trying to authenticate our user for. E.g. if our API is hosted on `http://localhost:3000/graphql`, we would pass that value.
+     */
+    audience?: string;
+    /**
+     * For example: `https://myapp.auth0.com/`
+     */
+    issuer: string;
+    /**
+     * Once a user got successfully authenticated the authentication information is added on the context object under this field. In our resolvers we can then access the authentication information via `context._jwt.sub`.
+     */
+    extendContextField?: string;
+    /**
+     * The name of the header to be used to extract the token from.
+     *
+     * Default: "Authorization"
+     */
+    headerName?: string;
+    /**
+     * The type of the header
+     *
+     * Default: Bearer
+     */
+    headerType?: string;
+}
+export declare function useJwt(options: JwtPluginOptions): Plugin;

package/typings/index.d.ts

@@ -0,0 +1,46 @@
+import { Algorithm } from 'jsonwebtoken';
+import { Plugin } from 'graphql-yoga';
+export interface JwtPluginOptions {
+    /**
+     * The endpoint to fetch keys from.
+     *
+     * For example: https://example.com/.well-known/jwks.json
+     */
+    jwksUri?: string;
+    /**
+     * Signing key to be used to verify the token
+     * You can also use the jwks option to fetch the key from a JWKS endpoint
+     */
+    signingKey?: string;
+    /**
+     * List of the algorithms used to verify the token
+     *
+     * Default: ["RS256"] (Allowed values: HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512, none)
+     */
+    algorithms?: Algorithm[];
+    /**
+     * The audience is the identifier of the API and is forwarded to your Auth API in order to specify for which API we are trying to authenticate our user for. E.g. if our API is hosted on `http://localhost:3000/graphql`, we would pass that value.
+     */
+    audience?: string;
+    /**
+     * For example: `https://myapp.auth0.com/`
+     */
+    issuer: string;
+    /**
+     * Once a user got successfully authenticated the authentication information is added on the context object under this field. In our resolvers we can then access the authentication information via `context._jwt.sub`.
+     */
+    extendContextField?: string;
+    /**
+     * The name of the header to be used to extract the token from.
+     *
+     * Default: "Authorization"
+     */
+    headerName?: string;
+    /**
+     * The type of the header
+     *
+     * Default: Bearer
+     */
+    headerType?: string;
+}
+export declare function useJwt(options: JwtPluginOptions): Plugin;