@kaapi/oauth2-auth-design 0.0.13 → 0.0.14

package/lib/cli.d.ts

@@ -0,0 +1,13 @@
+import { FileGenerator, FileGeneratorType, Question } from '@kaapi/cli/definitions';
+export declare class OAuth2FileGenerator implements FileGenerator {
+    #private;
+    get type(): FileGeneratorType;
+    get name(): 'oauth2-generator';
+    get description(): string;
+    get options(): Record<string, string>;
+    init(options: Record<string, unknown>): void;
+    isValid(): boolean;
+    getFileContent(): string;
+    getQuestions(): Question[];
+    getFilename(): string;
+}

package/lib/cli.js

@@ -0,0 +1,181 @@
+"use strict";
+var _OAuth2FileGenerator_values;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAuth2FileGenerator = void 0;
+const tslib_1 = require("tslib");
+const definitions_1 = require("@kaapi/cli/definitions");
+const utils_1 = require("@kaapi/cli/utils");
+class OAuth2FileGenerator {
+    constructor() {
+        _OAuth2FileGenerator_values.set(this, {
+            name: ''
+        });
+    }
+    get type() {
+        return 'auth-design';
+    }
+    get name() {
+        return 'oauth2-generator';
+    }
+    get description() {
+        return 'Creates an auth design based on OAuth2 specifications.';
+    }
+    get options() {
+        return {
+            name: 'The name of the design'
+        };
+    }
+    init(options) {
+        if (typeof options['name'] == 'string') {
+            tslib_1.__classPrivateFieldGet(this, _OAuth2FileGenerator_values, "f").name = (0, utils_1.camelCase)(options['name']);
+        }
+    }
+    isValid() {
+        return !!tslib_1.__classPrivateFieldGet(this, _OAuth2FileGenerator_values, "f").name;
+    }
+    getFileContent() {
+        return `import Boom from '@hapi/boom'
+import {
+    OAuth2ACAuthorizationRoute,
+    OAuth2RefreshTokenHandler,
+    OAuth2RefreshTokenRoute,
+    OAuth2ACTokenRoute,
+    OpenIDAuthDesign,
+    OpenIDJWKSRoute,
+    OAuth2TokenResponse,
+    BearerToken
+} from '@kaapi/oauth2-auth-design';
+
+const tokenType = new BearerToken()
+
+export const ${tslib_1.__classPrivateFieldGet(this, _OAuth2FileGenerator_values, "f").name} = new OpenIDAuthDesign(
+    {
+        strategyName: '${(0, utils_1.kebabCase)(tslib_1.__classPrivateFieldGet(this, _OAuth2FileGenerator_values, "f").name)}',
+        openidConfiguration: {
+            ...tokenType.configuration
+        },
+        jwksStore: undefined,
+        jwksRoute: new OpenIDJWKSRoute('/openid/jwks'),
+        authorizationRoute: OAuth2ACAuthorizationRoute.buildDefault<object, { Payload: { user: string, pass: string } }>()
+            .setPath('/oauth2/authorize')
+            .setEmailField('email')
+            .setPasswordField('password')
+            .generateCode(async ({ clientId, codeChallenge, scope, nonce }, { payload: { user, pass } }) => {
+                // validate and generate code
+                if (user == 'janed@example.com' && pass == '1234') {
+                    return JSON.stringify({ clientId, codeChallenge, scope, nonce, user: '248289761001' })
+                }
+
+                return null
+            }),
+        tokenRoute: OAuth2ACTokenRoute.buildDefault()
+            .setPath('/oauth2/token')
+            .generateToken(async ({ clientId, clientSecret, code, codeVerifier, redirectUri, ttl, createIDToken }, _req) => {
+
+                if (!clientSecret && !codeVerifier) {
+                    return { error: 'invalid_request', error_description: 'Token Request was missing the \\'client_secret\\' parameter.' }
+                }
+                try {
+                    //#region @TODO: validation + token
+                    const accessToken = 'generated_access_token'
+                    const refreshToken = 'generated_refresh_token'
+                    const scope: string[] = ['openid']
+                    return new OAuth2TokenResponse({ access_token: accessToken })
+                        .setExpiresIn(ttl)
+                        .setRefreshToken(refreshToken)
+                        .setScope(scope)
+                        .setIDToken(
+                            await createIDToken?.({
+                                sub: '248289761001',
+                                name: 'Jane Doe',
+                                given_name: 'Jane',
+                                family_name: 'Doe',
+                                preferred_username: 'janed',
+                                email: 'janed@example.com',
+                                email_verified: true,
+                                picture: 'https://example.com/janed.jpg'
+                            })
+                        )
+                        .setTokenType(tokenType)
+                    //#endregion @TODO: validation + token
+                } catch (err) {
+                    console.error(err)
+                }
+
+                return null
+            }),
+        refreshTokenRoute: new OAuth2RefreshTokenRoute(
+            '/oauth2/token',
+            (async ({ clientId, clientSecret, refreshToken, scope, ttl }, _req, h) => {
+
+                //#region @TODO: validation + refresh token
+
+                //#endregion @TODO: validation + refresh token
+
+                return h.response({ error: 'invalid_token' }).code(400)
+            }) as OAuth2RefreshTokenHandler,
+        ),
+        options: {
+            async validate(req, token, h) {
+                if (token) {
+                    //#region @TODO: validation
+                    if (token != 'generated_access_token') {
+                        return {}
+                    }
+                    //#endregion @TODO: validation
+
+                    // authorized to go further
+                    return {
+                        isValid: !!token,
+                        credentials: {
+                            user: {
+                                sub: '248289761001',
+                                name: 'Jane Doe',
+                                given_name: 'Jane',
+                            }
+                        }
+                    }
+                }
+
+                return h.unauthenticated(Boom.unauthorized('unauthorized', 'Bearer'))
+            },
+        }
+    }
+)
+    .setDescription('This API uses OAuth 2 with the authentication code grant flow. [More info](https://oauth.net/2/grant-types/authorization-code/)')
+    .setScopes({
+        profile: 'Access to your profile information',
+        email: 'Access to your email address',
+        offline_access: 'Access to your data when you are not connected'
+    })
+    .setTokenType(tokenType)
+    .setTokenTTL(36000)
+    .clientSecretBasicAuthenticationMethod()
+    .clientSecretPostAuthenticationMethod() // to debug (used in SwaggerUI)
+    //.withoutPkce() // to remove 'none'
+`;
+    }
+    getQuestions() {
+        const r = [];
+        if (!tslib_1.__classPrivateFieldGet(this, _OAuth2FileGenerator_values, "f").name) {
+            r.push({
+                type: definitions_1.QuestionType.text,
+                options: {
+                    message: 'The name of the auth design?',
+                    defaultValue: 'oauth2AuthDesign',
+                    placeholder: 'oauth2AuthDesign'
+                },
+                setValue: (pluginName) => {
+                    tslib_1.__classPrivateFieldGet(this, _OAuth2FileGenerator_values, "f").name = (0, utils_1.camelCase)(pluginName);
+                }
+            });
+        }
+        return r;
+    }
+    getFilename() {
+        return (0, utils_1.kebabCase)(`${tslib_1.__classPrivateFieldGet(this, _OAuth2FileGenerator_values, "f").name}`) + '.ts';
+    }
+}
+exports.OAuth2FileGenerator = OAuth2FileGenerator;
+_OAuth2FileGenerator_values = new WeakMap();
+//# sourceMappingURL=cli.js.map

package/lib/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,wDAAiG;AACjG,4CAAuD;AAEvD,MAAa,mBAAmB;IAAhC;QAoBI,sCAAU;YACN,IAAI,EAAE,EAAE;SACX,EAAA;IA8JL,CAAC;IAlLG,IAAI,IAAI;QACJ,OAAO,aAAa,CAAA;IACxB,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,kBAAkB,CAAA;IAC7B,CAAC;IAED,IAAI,WAAW;QACX,OAAO,wDAAwD,CAAA;IACnE,CAAC;IAED,IAAI,OAAO;QACP,OAAO;YACH,IAAI,EAAE,wBAAwB;SACjC,CAAA;IACL,CAAC;IAMD,IAAI,CAAC,OAAgC;QACjC,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACrC,+BAAA,IAAI,mCAAQ,CAAC,IAAI,GAAG,IAAA,iBAAS,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;QAClD,CAAC;IACL,CAAC;IAED,OAAO;QACH,OAAO,CAAC,CAAC,+BAAA,IAAI,mCAAQ,CAAC,IAAI,CAAA;IAC9B,CAAC;IAED,cAAc;QACV,OAAO;;;;;;;;;;;;;;eAcA,+BAAA,IAAI,mCAAQ,CAAC,IAAI;;yBAEP,IAAA,iBAAS,EAAC,+BAAA,IAAI,mCAAQ,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuGpD,CAAA;IACG,CAAC;IAED,YAAY;QACR,MAAM,CAAC,GAAe,EAAE,CAAA;QAExB,IAAI,CAAC,+BAAA,IAAI,mCAAQ,CAAC,IAAI,EAAE,CAAC;YACrB,CAAC,CAAC,IAAI,CAAC;gBACH,IAAI,EAAE,0BAAY,CAAC,IAAI;gBACvB,OAAO,EAAE;oBACL,OAAO,EAAE,8BAA8B;oBACvC,YAAY,EAAE,kBAAkB;oBAChC,WAAW,EAAE,kBAAkB;iBAClC;gBACD,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE;oBACrB,+BAAA,IAAI,mCAAQ,CAAC,IAAI,GAAG,IAAA,iBAAS,EAAC,UAAU,CAAC,CAAA;gBAC7C,CAAC;aACJ,CAAC,CAAA;QACN,CAAC;QAED,OAAO,CAAC,CAAA;IACZ,CAAC;IAED,WAAW;QACP,OAAO,IAAA,iBAAS,EAAC,GAAG,+BAAA,IAAI,mCAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,KAAK,CAAA;IACpD,CAAC;CACJ;AApLD,kDAoLC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaapi/oauth2-auth-design",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "private": false,
   "description": "OAuth2 auth design for kaapi",
   "main": "lib/index.js",
@@ -8,6 +8,10 @@
     ".": {
       "types": "./lib/index.d.ts",
       "default": "./lib/index.js"
+    },
+    "./cli": {
+      "types": "./lib/cli.d.ts",
+      "default": "./lib/cli.js"
     }
   },
   "author": "demingongo",
@@ -22,12 +26,13 @@
     "@hapi/hoek": "^11.0.7",
     "@novice1/api-doc-generator": "^1.0.2",
     "html-entities": "^2.6.0",
-    "jose": "^6.0.12",
+    "jose": "^6.0.13",
     "jsonwebtoken": "^9.0.2",
     "jwk-to-pem": "^2.0.7",
     "node-jose": "^2.2.0",
     "tslib": "^2.8.1",
-    "@kaapi/kaapi": "^0.0.13"
+    "@kaapi/cli": "^0.0.14",
+    "@kaapi/kaapi": "^0.0.14"
   },
   "devDependencies": {
     "@types/jsonwebtoken": "^9.0.10",