@clemax/nest-keycloak-connect 2.0.0

package/dist/interface/keycloak-connect-options.interface.d.ts

@@ -0,0 +1,166 @@
+import { PolicyEnforcementMode, RoleMerge, TokenValidation } from '../constants';
+export type KeycloakConnectOptions = string | KeycloakConnectConfig;
+/**
+ * Multi tenant configuration.
+ */
+export interface MultiTenantOptions {
+    /**
+     * Option to always resolve the realm and secret. Disabled by default.
+     */
+    resolveAlways?: boolean;
+    /**
+     * The realm resolver function.
+     */
+    realmResolver: (request: any) => Promise<string> | string;
+    /**
+     * The realm secret resolver function.
+     */
+    realmSecretResolver?: (realm: string, request?: any) => Promise<string> | string;
+    /**
+     * The realm auth server url resolver function.
+     */
+    realmAuthServerUrlResolver?: (realm: string, request?: any) => Promise<string> | string;
+    /**
+     * The realm client id resolver function.
+     */
+    realmClientIdResolver: (realm: string, request?: any) => Promise<string> | string;
+}
+/**
+ * Library only configuration.
+ */
+export interface NestKeycloakConfig {
+    /**
+     * Cookie key.
+     */
+    cookieKey?: string;
+    /**
+     * Sets the policy enforcement mode for this adapter, defaults to {@link PolicyEnforcementMode.PERMISSIVE}.
+     */
+    policyEnforcement?: PolicyEnforcementMode;
+    /**
+     * Sets the token validation method, defaults to {@link TokenValidation.ONLINE}.
+     */
+    tokenValidation?: TokenValidation;
+    /**
+     * Multi tenant options.
+     */
+    multiTenant?: MultiTenantOptions;
+    /**
+     * Role merging options.
+     */
+    roleMerge?: RoleMerge;
+}
+/**
+ * Keycloak Connect options.
+ * @see {@link https://github.com/keycloak/keycloak-nodejs-connect/blob/f8e011aea5/middleware/auth-utils/config.js}
+ */
+export interface KeycloakConnectConfig extends NestKeycloakConfig {
+    /**
+     * Realm ID.
+     */
+    realm?: string;
+    /**
+     * Client/Application ID.
+     */
+    resource?: string;
+    /**
+     * Client/Application ID.
+     * @see {KeycloakConnectOptions#resource}
+     */
+    'client-id'?: string;
+    /**
+     * Client/Application ID.
+     * @see {KeycloakConnectOptions#resource}
+     */
+    clientId?: string;
+    /**
+     * Client/Application secret.
+     */
+    credentials?: KeycloakCredentials;
+    /**
+     * Client/Application secret.
+     * @see {KeycloakCredentials#secret}
+     */
+    secret: string;
+    /**
+     * If this is a public application or confidential.
+     * @see {KeycloakConnectOptions#public}
+     */
+    'public-client'?: boolean;
+    /**
+     * If this is a public application or confidential.
+     */
+    public?: boolean;
+    /**
+     * Authentication server URL.
+     * @see {KeycloakConnectOptions#authServerUrl}
+     */
+    'auth-server-url'?: string;
+    /**
+     * Authentication server URL.
+     * @see {KeycloakConnectOptions#authServerUrl}
+     */
+    'server-url'?: string;
+    /**
+     * Authentication server URL.
+     * @see {KeycloakConnectOptions#authServerUrl}
+     */
+    serverUrl?: string;
+    /**
+     * Authentication server URL.
+     */
+    authServerUrl?: string;
+    /**
+     * How many minutes before retrying getting the keys.
+     * @see {KeycloakConnectOptions#minTimeBetweenJwksRequests}
+     */
+    'min-time-between-jwks-requests'?: number;
+    /**
+     * How many minutes before retrying getting the keys.
+     */
+    minTimeBetweenJwksRequests?: number;
+    /**
+     * If this is a Bearer Only application.
+     * @see {KeycloakConnectOptions#bearerOnly}
+     */
+    'bearer-only'?: boolean;
+    /**
+     * If this is a Bearer Only application.
+     */
+    bearerOnly?: boolean;
+    /**
+     * Formatted public-key.
+     * @see {KeycloakConnectOptions#realmPublicKey}
+     */
+    'realm-public-key'?: string;
+    /**
+     * Formatted public-key.
+     */
+    realmPublicKey?: string;
+    /**
+     * Verify token audience.
+     * @see {KeycloakConnectOptions#verifyTokenAudience}
+     */
+    'verify-token-audience'?: boolean;
+    /**
+     * Verify token audience.
+     */
+    verifyTokenAudience?: boolean;
+    /**
+     * Confidential port.
+     */
+    'confidential-port'?: string | number;
+    /**
+     * Require SSL.
+     */
+    'ssl-required'?: string;
+}
+/**
+ * Represents Keycloak credentials.
+ */
+export interface KeycloakCredentials {
+    /**
+     * Client/Application secret.
+     */
+    secret: string;
+}

package/dist/interface/keycloak-connect-options.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+// The typings are a bit of a mess, I'm sure there's a better way to do this.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/internal.util.d.ts

@@ -0,0 +1,8 @@
+import { ExecutionContext } from '@nestjs/common';
+import KeycloakConnect from 'keycloak-connect';
+import { KeycloakConnectConfig } from './interface/keycloak-connect-options.interface';
+import { KeycloakMultiTenantService } from './services/keycloak-multitenant.service';
+export declare const useKeycloak: (request: any, jwt: string, singleTenant: KeycloakConnect.Keycloak, multiTenant: KeycloakMultiTenantService, opts: KeycloakConnectConfig) => Promise<KeycloakConnect.Keycloak>;
+export declare const attachCookieToHeader: (request: any, cookieKey: string) => any;
+export declare const extractRequest: (context: ExecutionContext) => [any, any];
+export declare const extractRequestAndAttachCookie: (context: ExecutionContext, cookieKey: string) => any[];

package/dist/internal.util.js

@@ -0,0 +1,69 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractRequestAndAttachCookie = exports.extractRequest = exports.attachCookieToHeader = exports.useKeycloak = void 0;
+const util_1 = require("./util");
+// Confusing and all, but I needed to extract this fn to avoid more repeating code
+// TODO: Rework in 2.0
+const useKeycloak = (request, jwt, singleTenant, multiTenant, opts) => __awaiter(void 0, void 0, void 0, function* () {
+    if (opts.multiTenant && opts.multiTenant.realmResolver) {
+        const resolvedRealm = opts.multiTenant.realmResolver(request);
+        const realm = resolvedRealm instanceof Promise ? yield resolvedRealm : resolvedRealm;
+        return yield multiTenant.get(realm, request);
+    }
+    else if (!opts.realm) {
+        const payload = (0, util_1.parseToken)(jwt);
+        const issuerRealm = payload.iss.split('/').pop();
+        return yield multiTenant.get(issuerRealm, request);
+    }
+    return singleTenant;
+});
+exports.useKeycloak = useKeycloak;
+const attachCookieToHeader = (request, cookieKey) => {
+    // Attach cookie as authorization header
+    if (request && request.cookies && request.cookies[cookieKey]) {
+        request.headers.authorization = `Bearer ${request.cookies[cookieKey]}`;
+    }
+    return request;
+};
+exports.attachCookieToHeader = attachCookieToHeader;
+const extractRequest = (context) => {
+    let request, response;
+    // Check if request is coming from graphql or http
+    if (context.getType() === 'http') {
+        // http request
+        const httpContext = context.switchToHttp();
+        request = httpContext.getRequest();
+        response = httpContext.getResponse();
+    }
+    else if (context.getType() === 'graphql') {
+        let gql;
+        // Check if graphql is installed
+        try {
+            gql = require('@nestjs/graphql');
+        }
+        catch (er) {
+            throw new Error('@nestjs/graphql is not installed, cannot proceed');
+        }
+        // graphql request
+        const gqlContext = gql.GqlExecutionContext.create(context).getContext();
+        request = gqlContext.req;
+        response = gqlContext.res;
+    }
+    return [request, response];
+};
+exports.extractRequest = extractRequest;
+const extractRequestAndAttachCookie = (context, cookieKey) => {
+    const [tmpRequest, response] = (0, exports.extractRequest)(context);
+    const request = (0, exports.attachCookieToHeader)(tmpRequest, cookieKey);
+    return [request, response];
+};
+exports.extractRequestAndAttachCookie = extractRequestAndAttachCookie;

package/dist/keycloak-connect.module.d.ts

@@ -0,0 +1,32 @@
+import { DynamicModule, Logger } from '@nestjs/common';
+import { KeycloakConnectModuleAsyncOptions } from './interface/keycloak-connect-module-async-options.interface';
+import { KeycloakConnectOptions, NestKeycloakConfig } from './interface/keycloak-connect-options.interface';
+export * from './constants';
+export * from './decorators/access-token.decorator';
+export * from './decorators/enforcer-options.decorator';
+export * from './decorators/keycloak-user.decorator';
+export * from './decorators/public.decorator';
+export * from './decorators/resource.decorator';
+export * from './decorators/roles.decorator';
+export * from './decorators/scopes.decorator';
+export * from './guards/auth.guard';
+export * from './guards/resource.guard';
+export * from './guards/role.guard';
+export * from './interface/keycloak-connect-module-async-options.interface';
+export * from './interface/keycloak-connect-options-factory.interface';
+export * from './interface/keycloak-connect-options.interface';
+export * from './services/keycloak-multitenant.service';
+export * from './util';
+export declare class KeycloakConnectModule {
+    static logger: Logger;
+    /**
+     * Register the `KeycloakConnect` module.
+     * @param opts `keycloak.json` path in string or {@link NestKeycloakConfig} object.
+     * @param config {@link NestKeycloakConfig} when using `keycloak.json` path, optional
+     * @returns
+     */
+    static register(opts: KeycloakConnectOptions, config?: NestKeycloakConfig): DynamicModule;
+    static registerAsync(opts: KeycloakConnectModuleAsyncOptions): DynamicModule;
+    private static createAsyncProviders;
+    private static createAsyncOptionsProvider;
+}

package/dist/keycloak-connect.module.js

@@ -0,0 +1,126 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var KeycloakConnectModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeycloakConnectModule = void 0;
+const common_1 = require("@nestjs/common");
+const constants_1 = require("./constants");
+const keycloak_connect_providers_1 = require("./keycloak-connect.providers");
+const keycloak_multitenant_service_1 = require("./services/keycloak-multitenant.service");
+__exportStar(require("./constants"), exports);
+__exportStar(require("./decorators/access-token.decorator"), exports);
+__exportStar(require("./decorators/enforcer-options.decorator"), exports);
+__exportStar(require("./decorators/keycloak-user.decorator"), exports);
+__exportStar(require("./decorators/public.decorator"), exports);
+__exportStar(require("./decorators/resource.decorator"), exports);
+__exportStar(require("./decorators/roles.decorator"), exports);
+__exportStar(require("./decorators/scopes.decorator"), exports);
+__exportStar(require("./guards/auth.guard"), exports);
+__exportStar(require("./guards/resource.guard"), exports);
+__exportStar(require("./guards/role.guard"), exports);
+__exportStar(require("./interface/keycloak-connect-module-async-options.interface"), exports);
+__exportStar(require("./interface/keycloak-connect-options-factory.interface"), exports);
+__exportStar(require("./interface/keycloak-connect-options.interface"), exports);
+__exportStar(require("./services/keycloak-multitenant.service"), exports);
+__exportStar(require("./util"), exports);
+let KeycloakConnectModule = KeycloakConnectModule_1 = class KeycloakConnectModule {
+    /**
+     * Register the `KeycloakConnect` module.
+     * @param opts `keycloak.json` path in string or {@link NestKeycloakConfig} object.
+     * @param config {@link NestKeycloakConfig} when using `keycloak.json` path, optional
+     * @returns
+     */
+    static register(opts, config) {
+        const keycloakConnectProviders = [
+            (0, keycloak_connect_providers_1.createKeycloakConnectOptionProvider)(opts, config),
+            keycloak_connect_providers_1.keycloakProvider,
+            keycloak_multitenant_service_1.KeycloakMultiTenantService,
+            {
+                provide: constants_1.KEYCLOAK_MULTITENANT_SERVICE,
+                useClass: keycloak_multitenant_service_1.KeycloakMultiTenantService,
+            },
+        ];
+        return {
+            module: KeycloakConnectModule_1,
+            providers: keycloakConnectProviders,
+            exports: keycloakConnectProviders,
+        };
+    }
+    static registerAsync(opts) {
+        const optsProvider = this.createAsyncProviders(opts);
+        return {
+            module: KeycloakConnectModule_1,
+            imports: opts.imports || [],
+            providers: optsProvider,
+            exports: optsProvider,
+        };
+    }
+    static createAsyncProviders(options) {
+        const reqProviders = [
+            this.createAsyncOptionsProvider(options),
+            keycloak_connect_providers_1.keycloakProvider,
+            keycloak_multitenant_service_1.KeycloakMultiTenantService,
+            {
+                provide: constants_1.KEYCLOAK_MULTITENANT_SERVICE,
+                useClass: keycloak_multitenant_service_1.KeycloakMultiTenantService,
+            },
+        ];
+        if (options.useExisting || options.useFactory) {
+            return reqProviders;
+        }
+        return [
+            ...reqProviders,
+            {
+                provide: options.useClass,
+                useClass: options.useClass,
+            },
+        ];
+    }
+    static createAsyncOptionsProvider(options) {
+        if (options.useFactory) {
+            return {
+                provide: constants_1.KEYCLOAK_CONNECT_OPTIONS,
+                useFactory: options.useFactory,
+                inject: options.inject || [],
+            };
+        }
+        return {
+            provide: constants_1.KEYCLOAK_CONNECT_OPTIONS,
+            useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return yield optionsFactory.createKeycloakConnectOptions(); }),
+            inject: [options.useExisting || options.useClass],
+        };
+    }
+};
+exports.KeycloakConnectModule = KeycloakConnectModule;
+KeycloakConnectModule.logger = new common_1.Logger(KeycloakConnectModule_1.name);
+exports.KeycloakConnectModule = KeycloakConnectModule = KeycloakConnectModule_1 = __decorate([
+    (0, common_1.Module)({})
+], KeycloakConnectModule);

package/dist/keycloak-connect.providers.d.ts

@@ -0,0 +1,7 @@
+import { Provider } from '@nestjs/common';
+import { KeycloakConnectConfig, KeycloakConnectOptions, NestKeycloakConfig } from './interface/keycloak-connect-options.interface';
+export declare const keycloakProvider: Provider;
+export declare const createKeycloakConnectOptionProvider: (opts: KeycloakConnectOptions, config?: NestKeycloakConfig) => {
+    provide: string;
+    useValue: KeycloakConnectConfig;
+};

package/dist/keycloak-connect.providers.js

@@ -0,0 +1,81 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createKeycloakConnectOptionProvider = exports.keycloakProvider = void 0;
+const fs = __importStar(require("fs"));
+const keycloak_connect_1 = __importDefault(require("keycloak-connect"));
+const path = __importStar(require("path"));
+const constants_1 = require("./constants");
+const keycloak_connect_module_1 = require("./keycloak-connect.module");
+exports.keycloakProvider = {
+    provide: constants_1.KEYCLOAK_INSTANCE,
+    useFactory: (opts) => {
+        const keycloakOpts = opts;
+        const keycloak = new keycloak_connect_1.default({}, keycloakOpts);
+        // Warn if using token validation none
+        if (typeof opts !== 'string' &&
+            opts.tokenValidation &&
+            opts.tokenValidation === constants_1.TokenValidation.NONE) {
+            keycloak_connect_module_1.KeycloakConnectModule.logger.warn(`Token validation is disabled, please only do this on development/special use-cases.`);
+        }
+        // Access denied is called, add a flag to request so our resource guard knows
+        keycloak.accessDenied = (req, res, next) => {
+            req.resourceDenied = true;
+            next();
+        };
+        return keycloak;
+    },
+    inject: [constants_1.KEYCLOAK_CONNECT_OPTIONS],
+};
+const parseConfig = (opts, config) => {
+    if (typeof opts === 'string') {
+        const configPathRelative = path.join(__dirname, opts);
+        const configPathRoot = path.join(process.cwd(), opts);
+        let configPath;
+        if (fs.existsSync(configPathRelative)) {
+            configPath = configPathRelative;
+        }
+        else if (fs.existsSync(configPathRoot)) {
+            configPath = configPathRoot;
+        }
+        else {
+            throw new Error(`Cannot find files, looked in [ ${configPathRelative}, ${configPathRoot} ]`);
+        }
+        const json = fs.readFileSync(configPath);
+        const keycloakConfig = JSON.parse(json.toString());
+        return Object.assign(keycloakConfig, config);
+    }
+    return opts;
+};
+const createKeycloakConnectOptionProvider = (opts, config) => {
+    return {
+        provide: constants_1.KEYCLOAK_CONNECT_OPTIONS,
+        useValue: parseConfig(opts, config),
+    };
+};
+exports.createKeycloakConnectOptionProvider = createKeycloakConnectOptionProvider;

package/dist/services/keycloak-multitenant.service.d.ts

@@ -0,0 +1,24 @@
+import KeycloakConnect from 'keycloak-connect';
+import { KeycloakConnectOptions } from '../interface/keycloak-connect-options.interface';
+/**
+ * Stores all keycloak instances when multi tenant option is defined.
+ */
+export declare class KeycloakMultiTenantService {
+    private keycloakOpts;
+    private instances;
+    constructor(keycloakOpts: KeycloakConnectOptions);
+    /**
+     * Clears the cached Keycloak instances.
+     */
+    clear(): void;
+    /**
+     * Retrieves a keycloak instance based on the realm provided.
+     * @param realm the realm to retrieve from
+     * @param request the request instance, defaults to undefined
+     * @returns the multi tenant keycloak instance
+     */
+    get(realm: string, request?: any): Promise<KeycloakConnect.Keycloak>;
+    resolveAuthServerUrl(realm: string, request?: any): Promise<string>;
+    resolveClientId(realm: string, request?: any): Promise<string>;
+    resolveSecret(realm: string, request?: any): Promise<string>;
+}