@adminforth/two-factors-auth 3.3.8 → 3.3.10

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import { AdminForthPlugin, HttpExtra } from "adminforth";
+import type { AdminForthResource, AdminUser, IAdminForth, IHttpServer, IAdminForthAuth, IAdminForthHttpResponse } from "adminforth";
+import { PluginOptions } from "./types.js";
+export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
+    options: PluginOptions;
+    adminforth: IAdminForth;
+    authResource: AdminForthResource;
+    connectors: any;
+    adminForthAuth: IAdminForthAuth;
+    constructor(options: PluginOptions);
+    instanceUniqueRepresentation(pluginOptions: any): string;
+    private parseIfNeeded;
+    private useChellenge;
+    private checkIfChellengeNotUsed;
+    private validateCookiesForPasskeyLogin;
+    checkIfSkipSetupAllowSkipVerify(adminUser: AdminUser): Promise<{
+        skipAllowed: boolean;
+    }>;
+    private generateHashForStepUpMfaGraceCookie;
+    private issueTempSkip2FAGraceJWT;
+    private isTempSkip2FAGraceValid;
+    private pending;
+    private waitForResponse;
+    private resolveResponse;
+    verifyAuto(adminUser: AdminUser): Promise<any>;
+    verify(confirmationResult: Record<string, any>, opts?: {
+        adminUser?: AdminUser;
+        userPk?: string;
+        cookies?: any;
+        response?: IAdminForthHttpResponse;
+        extra?: HttpExtra;
+    }): Promise<{
+        ok: true;
+    } | {
+        error: string;
+    }>;
+    parsePeriod(period?: string): number;
+    verifyPasskeyResponse(body: any, user_id: string, cookies: any): Promise<{
+        ok: boolean;
+        error: string;
+        passkeyConfirmed?: undefined;
+    } | {
+        ok: boolean;
+        passkeyConfirmed: boolean;
+        error?: undefined;
+    }>;
+    modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource): void;
+    validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource): void;
+    activate(resourceConfig: AdminForthResource, adminforth: IAdminForth): void;
+    setupEndpoints(server: IHttpServer): void;
+}

package/dist/types.d.ts

@@ -0,0 +1,116 @@
+import { AdminUser, KeyValueAdapter } from "adminforth";
+import { type PluginsCommonOptions } from "adminforth";
+export interface PluginOptions extends PluginsCommonOptions {
+    /**
+     * Name of the field in the auth resource which will store 2FA secret.
+     *
+     * Resource mandatory should have one columns which defined {@link AdminForthResourceColumn} which
+     * name should be equal to the value .
+     */
+    twoFaSecretFieldName: string;
+    /**
+     * Not-negative optional time step window for 2FA. This value means that the user will be able to enter the old code
+     * for the next 30 seconds after the new code was generated.
+     */
+    timeStepWindow?: number;
+    /**
+     * Number of seconds for step-up MFA grace period.
+     * During this period, user will not be challenged with 2FA on sensitive actions.
+     */
+    stepUpMfaGracePeriodSeconds?: number;
+    customBrandPrefix?: string;
+    /**
+     * Passkeys (WebAuthn) configuration.
+     */
+    passkeys?: {
+        credentialResourceID: string;
+        credentialIdFieldName: string;
+        credentialMetaFieldName: string;
+        credentialUserIdFieldName: string;
+        /**
+         * KeyValueAdapter is required to make sure that generated challenge can't be reused more than once
+         */
+        keyValueAdapter: KeyValueAdapter;
+        /**
+         * Allow login with Passkeys even if 2FA is not set up. Default is true.
+         */
+        allowLoginWithPasskeys?: boolean;
+        /**
+         * Remember user for number of days after login with Passkey, so that user won't be challenged with 2FA on every login.
+         */
+        rememberDaysAfterPasskeyLogin?: number;
+        /**
+         * Order of "Continue with passkey" button in under login button injection
+         */
+        continueWithButtonsOrder?: number;
+        /**
+         *  Period between showing alert suggesting to set up Passkeys if not set up yet.
+         */
+        suggestionPeriod?: string;
+        /**
+         * Challenge period for Passkeys authentication.
+         */
+        challengeValidityPeriod?: string;
+        /**
+         *  Passkeys settings for WebAuthn API.
+         */
+        settings: {
+            /**
+             * The origin that you expect the authentication to come from. (e.g. https://example.com or http://localhost:3000)
+             */
+            expectedOrigin: string;
+            rp?: {
+                /**
+                 * The Relying Party name.
+                 */
+                name?: string;
+                /**
+                 * The Relying Party ID. A domain or subdomain (e.g. example.com or login.example.com).
+                 */
+                id?: string;
+            };
+            user: {
+                /**
+                 * Field in users resource, that user will recognize as unique user ID.(e.g. email or username)
+                 */
+                nameField: string;
+                /**
+                 * Field in users resource, that user will recognize as display name.(e.g. full name)
+                 */
+                displayNameField?: string;
+            };
+            authenticatorSelection?: {
+                /**
+                 * The preferred authenticator attachment. It can be either "platform", "cross-platform" or "both".
+                 * Default to "platform".
+                 */
+                authenticatorAttachment?: 'platform' | 'cross-platform' | 'both';
+                /**
+                 * Set it to a boolean true. A discoverable credential (resident key)
+                 * stores user information to the passkey and lets users select the account upon authentication.
+                 * Default to "True".
+                 */
+                requireResidentKey?: boolean;
+                /**
+                 * Indicates whether a user verification using the device screen lock is "required" or "discouraged".
+                 * The default is "required".
+                 */
+                userVerification?: 'required' | 'discouraged';
+            };
+        };
+    };
+    /**
+     * Optional function to filter users to apply 2FA.
+     * Should return true if 2FA should be applied to the user and false if AdminForth should not challenge the user with 2FA.
+     * @param adminUser
+     * @returns true if 2FA should be applied to the user and false if AdminForth should not challenge the user with 2FA.
+     */
+    usersFilterToApply?: (adminUser: AdminUser) => boolean;
+    /**
+     * Optional function to allow users to skip 2FA setup.
+     * Should return true if the user should be allowed to skip the 2FA setup and false if AdminForth should require the user to set up 2FA.
+     * @param adminUser
+     * @returns true if the user should be allowed to skip the 2FA setup and false if AdminForth should require the user to set up 2FA.
+     */
+    usersFilterToAllowSkipSetup?: (adminUser: AdminUser) => boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/two-factors-auth",
-  "version": "3.3.8",
+  "version": "3.3.10",
   "description": "AdminForth plugin for two factors authentication",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -28,11 +28,11 @@
     "node-2fa": "^2.0.3"
   },
   "peerDependencies": {
-    "adminforth": "^2.70.0"
+    "adminforth": "2.71.1"
   },
   "devDependencies": {
     "@types/node": "^22.10.7",
-    "adminforth": "2.70.0",
+    "adminforth": "2.71.1",
     "semantic-release": "^24.2.1",
     "semantic-release-slack-bot": "^4.0.2",
     "typescript": "^5.7.3"

package/tsconfig.json

@@ -50,7 +50,7 @@
     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
 
     /* Emit */
-    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
     // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
     // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */