@kaapi/oauth2-auth-design 0.0.14 → 0.0.16

package/lib/flows/device-auth/token-route.js

@@ -0,0 +1,49 @@
+"use strict";
+var _DefaultOAuth2DeviceAuthTokenRoute_generateToken;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultOAuth2DeviceAuthTokenRoute = exports.OAuth2DeviceAuthTokenRoute = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("../common");
+class OAuth2DeviceAuthTokenRoute extends common_1.OAuth2TokenRoute {
+    static buildDefault() {
+        return new DefaultOAuth2DeviceAuthTokenRoute();
+    }
+}
+exports.OAuth2DeviceAuthTokenRoute = OAuth2DeviceAuthTokenRoute;
+class DefaultOAuth2DeviceAuthTokenRoute extends OAuth2DeviceAuthTokenRoute {
+    constructor() {
+        super('/oauth2/token', (props, req, h) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            let r = null;
+            try {
+                r = yield tslib_1.__classPrivateFieldGet(this, _DefaultOAuth2DeviceAuthTokenRoute_generateToken, "f").call(this, props, req);
+            }
+            catch (err) {
+                return h.response({ error: common_1.DeviceFlowOAuth2ErrorCode.ACCESS_DENIED, error_description: `${err}` }).code(400);
+            }
+            if (!r)
+                return h.response({ error: common_1.DeviceFlowOAuth2ErrorCode.ACCESS_DENIED }).code(400);
+            if ('error' in r)
+                return h.response(r).code(400);
+            return h.response(r).code(200);
+        }));
+        _DefaultOAuth2DeviceAuthTokenRoute_generateToken.set(this, void 0);
+        tslib_1.__classPrivateFieldSet(this, _DefaultOAuth2DeviceAuthTokenRoute_generateToken, () => tslib_1.__awaiter(this, void 0, void 0, function* () { return ({ error: common_1.DeviceFlowOAuth2ErrorCode.ACCESS_DENIED }); }), "f");
+    }
+    setPath(path) {
+        if (path)
+            this._path = path;
+        return this;
+    }
+    validate(handler) {
+        this._handler = handler;
+        return this;
+    }
+    generateToken(handler) {
+        tslib_1.__classPrivateFieldSet(this, _DefaultOAuth2DeviceAuthTokenRoute_generateToken, handler, "f");
+        return this;
+    }
+}
+exports.DefaultOAuth2DeviceAuthTokenRoute = DefaultOAuth2DeviceAuthTokenRoute;
+_DefaultOAuth2DeviceAuthTokenRoute_generateToken = new WeakMap();
+//#endregion Defaults
+//# sourceMappingURL=token-route.js.map

package/lib/flows/device-auth/token-route.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-route.js","sourceRoot":"","sources":["../../../src/flows/device-auth/token-route.ts"],"names":[],"mappings":";;;;;AAKA,sCAYkB;AA+BlB,MAAa,0BAEX,SAAQ,yBAGT;IAEG,MAAM,CAAC,YAAY;QAGf,OAAO,IAAI,iCAAiC,EAAQ,CAAA;IACxD,CAAC;CACJ;AAZD,gEAYC;AAWD,MAAa,iCAEX,SAAQ,0BAAgC;IAOtC;QACI,KAAK,CAAC,eAAe,EAAE,CAAO,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;YAC3C,IAAI,CAAC,GAA2F,IAAI,CAAA;YAEpG,IAAI,CAAC;gBACD,CAAC,GAAG,MAAM,+BAAA,IAAI,wDAAe,MAAnB,IAAI,EAAgB,KAAK,EAAE,GAAG,CAAC,CAAA;YAC7C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,kCAAyB,CAAC,aAAa,EAAE,iBAAiB,EAAE,GAAG,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAChH,CAAC;YAED,IAAI,CAAC,CAAC;gBAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,kCAAyB,CAAC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAEvF,IAAI,OAAO,IAAI,CAAC;gBAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAEhD,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAClC,CAAC,CAAA,CAAC,CAAA;QAjBN,mEAA8C;QAmB1C,+BAAA,IAAI,oDAAkB,GAAS,EAAE,wDAAC,OAAA,CAAC,EAAE,KAAK,EAAE,kCAAyB,CAAC,aAAa,EAAE,CAAC,CAAA,GAAA,MAAA,CAAA;IAC1F,CAAC;IAED,OAAO,CAAC,IAAe;QACnB,IAAI,IAAI;YACJ,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACrB,OAAO,IAAI,CAAA;IACf,CAAC;IAED,QAAQ,CAAC,OAA2C;QAChD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,OAAO,IAAI,CAAA;IACf,CAAC;IAED,aAAa,CAAC,OAAuC;QACjD,+BAAA,IAAI,oDAAkB,OAAO,MAAA,CAAA;QAC7B,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AA5CD,8EA4CC;;AAED,qBAAqB"}

package/lib/flows/device-authorization.d.ts

@@ -0,0 +1,112 @@
+import { KaapiTools, Lifecycle, ReqRef, ReqRefDefaults, Request, ResponseToolkit } from '@kaapi/kaapi';
+import { IOAuth2RefreshTokenRoute, OAuth2AuthOptions, OAuth2AuthDesign, OAuth2SingleAuthFlow, DefaultOAuth2RefreshTokenRoute, DefaultJWKSRoute, OAuth2AuthDesignBuilder, OAuth2AuthDesignOptions, OAuth2JwksOptions } from './common';
+import { DefaultOAuth2DeviceAuthorizationRoute, IOAuth2DeviceAuthorizationRoute } from './device-auth/authorization-route';
+import { DefaultOAuth2DeviceAuthTokenRoute, IOAuth2DeviceAuthTokenRoute, OAuth2DeviceCodeTokenErrorBody } from './device-auth/token-route';
+import { TokenType } from '../utils/token-types';
+import { BaseAuthUtil } from '@novice1/api-doc-generator/lib/utils/auth/baseAuthUtils';
+import { ClientAuthMethod, TokenEndpointAuthMethod } from '../utils/client-auth-methods';
+import { JwksKeyStore } from '../utils/jwt-authority';
+export type DefaultOAuth2DeviceAuthRefreshTokenRoute<Refs extends ReqRef = ReqRefDefaults> = DefaultOAuth2RefreshTokenRoute<Refs, OAuth2DeviceCodeTokenErrorBody>;
+export interface OAuth2DeviceAuthorizationArg extends OAuth2AuthDesignOptions {
+    authorizationRoute: IOAuth2DeviceAuthorizationRoute<any>;
+    tokenRoute: IOAuth2DeviceAuthTokenRoute<any>;
+    refreshTokenRoute?: IOAuth2RefreshTokenRoute<any>;
+}
+export declare class OAuth2DeviceAuthorization extends OAuth2AuthDesign implements OAuth2SingleAuthFlow {
+    get grantType(): 'urn:ietf:params:oauth:grant-type:device_code';
+    protected authorizationRoute: IOAuth2DeviceAuthorizationRoute<any>;
+    protected tokenRoute: IOAuth2DeviceAuthTokenRoute<any>;
+    protected refreshTokenRoute?: IOAuth2RefreshTokenRoute<any>;
+    constructor({ authorizationRoute, tokenRoute, refreshTokenRoute, ...props }: OAuth2DeviceAuthorizationArg);
+    protected handleAuthorization<Refs extends ReqRef = ReqRefDefaults>(_t: KaapiTools, request: Request<Refs>, h: ResponseToolkit<Refs>): Promise<Lifecycle.ReturnValueTypes<{
+        Payload: {
+            client_id?: unknown;
+            scope?: unknown;
+        };
+    }>>;
+    registerAuthorizationEndpoint(t: KaapiTools): void;
+    handleToken<Refs extends ReqRef = ReqRefDefaults>(t: KaapiTools, request: Request<Refs>, h: ResponseToolkit<Refs>): Promise<Lifecycle.ReturnValueTypes<{
+        Payload: {
+            device_code?: unknown;
+            grant_type?: unknown;
+            scope?: unknown;
+            refresh_token?: unknown;
+        };
+    }>>;
+    handleRefreshToken<Refs extends ReqRef = ReqRefDefaults>(t: KaapiTools, request: Request<Refs>, h: ResponseToolkit<Refs>): Promise<Lifecycle.ReturnValueTypes<{
+        Payload: {
+            grant_type?: unknown;
+            refresh_token?: unknown;
+            scope?: unknown;
+        };
+    }>>;
+    docs(): BaseAuthUtil | undefined;
+    integrateHook(t: KaapiTools): void;
+}
+export type OIDCDeviceAuthorizationArg = OAuth2DeviceAuthorizationArg & {
+    /**
+     * Override the configuration served at the discovery endpoint
+     */
+    openidConfiguration?: Record<string, unknown>;
+};
+export declare class OIDCDeviceAuthorization extends OAuth2DeviceAuthorization implements OAuth2SingleAuthFlow {
+    protected openidConfiguration: Record<string, unknown>;
+    constructor(params: OIDCDeviceAuthorizationArg);
+    getDiscoveryConfiguration(t: KaapiTools): {
+        [x: string]: unknown;
+    };
+    integrateHook(t: KaapiTools): void;
+}
+export interface OAuth2DeviceAuthorizationBuilderArg extends OAuth2DeviceAuthorizationArg {
+    authorizationRoute: DefaultOAuth2DeviceAuthorizationRoute<any>;
+    tokenRoute: DefaultOAuth2DeviceAuthTokenRoute<any>;
+    refreshTokenRoute?: DefaultOAuth2DeviceAuthRefreshTokenRoute<any>;
+    jwksRoute?: DefaultJWKSRoute<any>;
+    tokenType?: TokenType<any>;
+}
+export declare class OAuth2DeviceAuthorizationBuilder implements OAuth2AuthDesignBuilder {
+    protected params: OAuth2DeviceAuthorizationBuilderArg;
+    protected tokenType?: TokenType<any>;
+    protected tokenTTL?: number;
+    protected description?: string;
+    protected scopes?: Record<string, string>;
+    protected clientAuthMethods: Record<TokenEndpointAuthMethod, ClientAuthMethod | undefined>;
+    constructor(params: OAuth2DeviceAuthorizationBuilderArg);
+    static create(params?: Partial<OAuth2DeviceAuthorizationBuilderArg>): OAuth2DeviceAuthorizationBuilder;
+    build(): OAuth2DeviceAuthorization;
+    setTokenTTL(ttlSeconds?: number): this;
+    setDescription(description: string): this;
+    setScopes(scopes: Record<string, string>): this;
+    setTokenType<Refs extends ReqRef = ReqRefDefaults>(value: TokenType<Refs>): this;
+    addClientAuthenticationMethod(value: 'client_secret_basic' | 'client_secret_post' | 'none' | ClientAuthMethod): this;
+    strategyName(name: string): this;
+    setJwksKeyStore(keyStore: JwksKeyStore): this;
+    /**
+     *
+     * @param ttl seconds
+     */
+    setPublicKeyExpiry(ttl: number): this;
+    setJwksRotatorOptions(jwksRotatorOptions: OAuth2JwksOptions['rotation']): this;
+    validate<Refs extends ReqRef = ReqRefDefaults>(handler: OAuth2AuthOptions<Refs>['validate']): this;
+    /**
+     * Auto-verifies the access token JWT using the configured JWKS before running user validation.
+     */
+    useAccessTokenJwks(active: boolean): this;
+    jwksRoute<Refs extends ReqRef = ReqRefDefaults>(handler: (route: DefaultJWKSRoute<Refs>) => void): this;
+    authorizationRoute<PostRefs extends ReqRef = ReqRefDefaults>(handler: (route: DefaultOAuth2DeviceAuthorizationRoute<PostRefs>) => void): this;
+    tokenRoute<Refs extends ReqRef = ReqRefDefaults>(handler: (route: DefaultOAuth2DeviceAuthTokenRoute<Refs>) => void): this;
+    refreshTokenRoute<Refs extends ReqRef = ReqRefDefaults>(handler: (route: DefaultOAuth2DeviceAuthRefreshTokenRoute<Refs>) => void): this;
+}
+export type OIDCDeviceAuthorizationBuilderArg = OAuth2DeviceAuthorizationBuilderArg & {
+    /**
+     * Override the configuration served at the discovery endpoint
+     */
+    openidConfiguration?: Record<string, unknown>;
+};
+export declare class OIDCDeviceAuthorizationBuilder extends OAuth2DeviceAuthorizationBuilder {
+    protected openidConfiguration: Record<string, unknown>;
+    constructor(params: OIDCDeviceAuthorizationBuilderArg);
+    static create(params?: Partial<OIDCDeviceAuthorizationBuilderArg>): OIDCDeviceAuthorizationBuilder;
+    additionalConfiguration(openidConfiguration: Record<string, unknown>): this;
+    build(): OIDCDeviceAuthorization;
+}