@adminforth/two-factors-auth 3.0.4 → 3.1.0

package/README.md

@@ -1,7 +1,31 @@
 # AdminForth TwoFactorsAuth Plugin
 
-<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" /> <img src="https://woodpecker.devforth.io/api/badges/3848/status.svg" alt="Build Status" /> <a href="https://www.npmjs.com/package/@adminforth/two-factors-auth"> <img src="https://img.shields.io/npm/dt/@adminforth/two-factors-auth" alt="npm downloads" /></a> <a href="https://www.npmjs.com/package/@adminforth/two-factors-auth"><img src="https://img.shields.io/npm/v/@adminforth/two-factors-auth" alt="npm version" /></a> <a href="https://www.npmjs.com/package/@adminforth/two-factors-auth">
+<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" /> <img src="https://woodpecker.devforth.io/api/badges/3848/status.svg" alt="Build Status" /> <a href="https://www.npmjs.com/package/@adminforth/two-factors-auth"><img src="https://img.shields.io/npm/dm/@adminforth/two-factors-auth" alt="npm downloads" /></a> <a href="https://www.npmjs.com/package/@adminforth/two-factors-auth"><img src="https://img.shields.io/npm/v/@adminforth/two-factors-auth" alt="npm version" /></a>
+
+[![Ask AI](https://tluma.ai/badge)](https://tluma.ai/ask-ai/devforth/adminforth)
 
 Allows to enable Two-Factor Authentication to an adminforth application.
 
-## For usage, see [AdminForth TwoFactorsAuth Documentation](https://adminforth.dev/docs/tutorial/Plugins/TwoFactorsAuth/)
+## Features
+
+- Add two-factor authentication to AdminForth login.
+- Improve account security for admin users.
+- Introduce a stronger verification step at sign-in.
+- Integrate 2FA into existing authentication workflows.
+
+## Documentation
+
+Full setup and configuration guide:
+
+[AdminForth TwoFactorsAuth Documentation](https://adminforth.dev/docs/tutorial/Plugins/two-factors-auth/)
+
+## About AdminForth
+
+AdminForth is an open-source, agent-first admin framework for building robust admin panels and back-office applications faster.
+
+## Related links
+
+- [AdminForth website](https://adminforth.dev)
+- [npm package](https://www.npmjs.com/package/@adminforth/two-factors-auth)
+- [More AdminForth plugins](https://adminforth.dev/docs/tutorial/ListOfPlugins/)
+- [Built by DevForth](https://devforth.io)

package/build.log

@@ -16,5 +16,5 @@ custom/pnpm-lock.yaml
 custom/tsconfig.json
 custom/utils.js
 
-sent 280,841 bytes  received 229 bytes  562,140.00 bytes/sec
-total size is 279,947  speedup is 1.00
+sent 282,665 bytes  received 229 bytes  565,788.00 bytes/sec
+total size is 281,759  speedup is 1.00

package/custom/TwoFAModal.vue

@@ -79,8 +79,9 @@
   import { Link, Button } from '@/afcl';
   import { IconShieldOutline } from '@iconify-prerendered/vue-flowbite';
   import { getPasskey } from './utils.js' 
-  import adminforth from '@/adminforth';
-
+  import { useAdminforth } from '@/adminforth';
+  import websocket from '@/websocket';
+  import type { AdminUser } from '@/types/Common';
 
   declare global {
     interface Window {
@@ -94,7 +95,51 @@
   }
   const props = defineProps<{
     autoFinishLogin?: boolean
+    adminUser?: AdminUser
   }>();
+
+  const { alert } = useAdminforth();
+
+  let currentSessionId: string | null = null;
+  watch( props, () => {
+    if (props.adminUser) {
+      websocket.unsubscribeByPrefix(`/user2fa/`);
+      websocket.subscribe(`/user2fa/${props.adminUser.pk}`, async (data: {sessionId: string}) => {
+        currentSessionId = data.sessionId;
+        let confirmationResult;
+        try {
+          confirmationResult = await window.adminforthTwoFaModal.get2FaConfirmationResult();
+        } catch (error) {
+          console.error('Error during 2FA confirmation:', error);
+        }
+        try {
+          const response = await callAdminForthApi({
+            method: "POST",
+            path: "/plugin/passkeys/resolveVerifyAuto",
+            body: { confirmationResult, sessionId: data.sessionId }
+          });
+          if (!response.ok && response.error === 'No session ID or confirmation result'){
+            alert({message: 'Verification session finished or cancelled.', variant: 'warning'});
+          } else if (!response.ok) {
+            alert({message: 'Verification failed', variant: 'danger'});
+          } else if (response.ok) {
+            alert({message: 'Verification successful', variant: 'success'});
+          }
+        } catch (error) {
+          console.error('Error resolving automatic 2FA verification:', error);
+        }
+        currentSessionId = null;
+      });
+      websocket.subscribe(`/user2fa/${props.adminUser.pk}-resolve`, async (data: {sessionId: string}) => {
+        if (currentSessionId === data.sessionId && rejectFn && modelShow.value) {
+          onCancel();
+          currentSessionId = null;
+        }
+      });
+    }
+  })
+
+
   const emit = defineEmits<{
     (e: 'resolved', payload: any): void
     (e: 'rejected', err?: any): void

package/custom/package.json

@@ -6,7 +6,7 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],
-  "author": "",
+  "author": "DevForth (https://devforth.io)",
   "license": "ISC",
   "description": "",
   "dependencies": {

package/dist/custom/TwoFAModal.vue

@@ -79,8 +79,9 @@
   import { Link, Button } from '@/afcl';
   import { IconShieldOutline } from '@iconify-prerendered/vue-flowbite';
   import { getPasskey } from './utils.js' 
-  import adminforth from '@/adminforth';
-
+  import { useAdminforth } from '@/adminforth';
+  import websocket from '@/websocket';
+  import type { AdminUser } from '@/types/Common';
 
   declare global {
     interface Window {
@@ -94,7 +95,51 @@
   }
   const props = defineProps<{
     autoFinishLogin?: boolean
+    adminUser?: AdminUser
   }>();
+
+  const { alert } = useAdminforth();
+
+  let currentSessionId: string | null = null;
+  watch( props, () => {
+    if (props.adminUser) {
+      websocket.unsubscribeByPrefix(`/user2fa/`);
+      websocket.subscribe(`/user2fa/${props.adminUser.pk}`, async (data: {sessionId: string}) => {
+        currentSessionId = data.sessionId;
+        let confirmationResult;
+        try {
+          confirmationResult = await window.adminforthTwoFaModal.get2FaConfirmationResult();
+        } catch (error) {
+          console.error('Error during 2FA confirmation:', error);
+        }
+        try {
+          const response = await callAdminForthApi({
+            method: "POST",
+            path: "/plugin/passkeys/resolveVerifyAuto",
+            body: { confirmationResult, sessionId: data.sessionId }
+          });
+          if (!response.ok && response.error === 'No session ID or confirmation result'){
+            alert({message: 'Verification session finished or cancelled.', variant: 'warning'});
+          } else if (!response.ok) {
+            alert({message: 'Verification failed', variant: 'danger'});
+          } else if (response.ok) {
+            alert({message: 'Verification successful', variant: 'success'});
+          }
+        } catch (error) {
+          console.error('Error resolving automatic 2FA verification:', error);
+        }
+        currentSessionId = null;
+      });
+      websocket.subscribe(`/user2fa/${props.adminUser.pk}-resolve`, async (data: {sessionId: string}) => {
+        if (currentSessionId === data.sessionId && rejectFn && modelShow.value) {
+          onCancel();
+          currentSessionId = null;
+        }
+      });
+    }
+  })
+
+
   const emit = defineEmits<{
     (e: 'resolved', payload: any): void
     (e: 'rejected', err?: any): void

package/dist/custom/package.json

@@ -6,7 +6,7 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],
-  "author": "",
+  "author": "DevForth (https://devforth.io)",
   "license": "ISC",
   "description": "",
   "dependencies": {

package/dist/index.js

@@ -16,6 +16,7 @@ import crypto from 'crypto';
 export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
     constructor(options) {
         super(options, import.meta.url);
+        this.pending = new Map();
         this.options = options;
         this.shouldHaveSingleInstancePerWholeApp = () => true;
     }
@@ -133,6 +134,27 @@ export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
             return false;
         });
     }
+    waitForResponse(id) {
+        return new Promise((resolve) => {
+            this.pending.set(id, resolve);
+        });
+    }
+    resolveResponse(id, data) {
+        const resolve = this.pending.get(id);
+        if (resolve) {
+            resolve(data);
+            this.pending.delete(id);
+        }
+    }
+    verifyAuto(adminUser) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sessionId = crypto.randomUUID();
+            this.adminforth.websocket.publish(`/user2fa/${adminUser.pk}`, { sessionId });
+            const result = yield this.waitForResponse(sessionId);
+            this.adminforth.websocket.publish(`/user2fa/${adminUser.pk}-resolve`, { sessionId });
+            return result;
+        });
+    }
     verify(confirmationResult, opts) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e;
@@ -695,7 +717,7 @@ export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
             method: 'POST',
             path: `/plugin/passkeys/registerPasskeyRequest`,
             noAuth: false,
-            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, response, cookies, extra }) {
+            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, response, cookies }) {
                 var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
                 const mode = body === null || body === void 0 ? void 0 : body.mode;
                 const confirmationResult = body === null || body === void 0 ? void 0 : body.confirmationResult;
@@ -703,8 +725,7 @@ export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
                     adminUser: adminUser,
                     userPk: adminUser.pk,
                     cookies: cookies,
-                    response: response,
-                    extra: Object.assign({}, extra)
+                    response: response
                 });
                 if (!verificationResult || !('ok' in verificationResult)) {
                     return { ok: false, error: 'Verification failed' };
@@ -990,5 +1011,30 @@ export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
                 }
             })
         });
+        server.endpoint({
+            method: 'POST',
+            path: `/plugin/passkeys/resolveVerifyAuto`,
+            noAuth: false,
+            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, response, cookies }) {
+                const sessionId = body === null || body === void 0 ? void 0 : body.sessionId;
+                const confirmationResult = body === null || body === void 0 ? void 0 : body.confirmationResult;
+                if (!sessionId || !confirmationResult) {
+                    this.resolveResponse(sessionId, { ok: false, error: 'No session ID or confirmation result' });
+                    return { ok: false, error: 'No session ID or confirmation result' };
+                }
+                const verificationResult = yield this.verify(confirmationResult, {
+                    adminUser: adminUser,
+                    userPk: adminUser.pk,
+                    cookies: cookies,
+                    response: response
+                });
+                if (!verificationResult || !('ok' in verificationResult)) {
+                    this.resolveResponse(sessionId, { ok: false, error: 'Verification failed' });
+                    return { ok: false, error: 'Verification failed' };
+                }
+                this.resolveResponse(sessionId, { ok: true, passkeyConfirmed: verificationResult });
+                return { ok: true };
+            })
+        });
     }
 }

package/index.ts

@@ -141,6 +141,30 @@ export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
     return false;
   }
 
+  private pending = new Map<string, (value: any) => void>();
+
+  private waitForResponse(id: string): Promise<any> {
+    return new Promise((resolve) => {
+      this.pending.set(id, resolve);
+    });
+  }
+
+  private resolveResponse(id: string, data: any) {
+    const resolve = this.pending.get(id);
+    if (resolve) {
+      resolve(data);
+      this.pending.delete(id);
+    }
+  }
+
+  public async verifyAuto(adminUser: AdminUser) {
+    const sessionId = crypto.randomUUID();
+    this.adminforth.websocket.publish(`/user2fa/${adminUser.pk}`, { sessionId });
+    const result = await this.waitForResponse(sessionId);
+    this.adminforth.websocket.publish(`/user2fa/${adminUser.pk}-resolve`, { sessionId });
+    return result;
+  }
+
   public async verify(
     confirmationResult: Record<string, any>,
     opts?: { adminUser?: AdminUser; userPk?: string; cookies?: any, response?: IAdminForthHttpResponse, extra?: HttpExtra }
@@ -753,7 +777,7 @@ export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
       method: 'POST',
       path: `/plugin/passkeys/registerPasskeyRequest`,
       noAuth: false,
-      handler: async ({ body, adminUser, response, cookies, extra }) => {
+      handler: async ({ body, adminUser, response, cookies }) => {
         const mode = body?.mode;
 
         const confirmationResult = body?.confirmationResult;
@@ -761,8 +785,7 @@ export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
           adminUser: adminUser,
           userPk: adminUser.pk, 
           cookies: cookies,
-          response: response,
-          extra: { ...extra }
+          response: response
         });
         if ( !verificationResult || !('ok' in verificationResult) ) {
           return { ok: false, error: 'Verification failed' };
@@ -1049,5 +1072,30 @@ export default class TwoFactorsAuthPlugin extends AdminForthPlugin {
         }
       }
     });
+    server.endpoint({
+      method: 'POST',
+      path: `/plugin/passkeys/resolveVerifyAuto`,
+      noAuth: false,
+      handler: async ({ body, adminUser, response, cookies }) => {
+        const sessionId = body?.sessionId;
+        const confirmationResult = body?.confirmationResult;
+        if (!sessionId || !confirmationResult) {
+          this.resolveResponse(sessionId, { ok: false, error: 'No session ID or confirmation result' });
+          return { ok: false, error: 'No session ID or confirmation result' };
+        }
+        const verificationResult = await this.verify(confirmationResult, {
+          adminUser: adminUser,
+          userPk: adminUser.pk, 
+          cookies: cookies,
+          response: response
+        });
+        if ( !verificationResult || !('ok' in verificationResult) ) {
+          this.resolveResponse(sessionId, { ok: false, error: 'Verification failed' });
+          return { ok: false, error: 'Verification failed' };
+        }
+        this.resolveResponse(sessionId, { ok: true, passkeyConfirmed: verificationResult });
+        return { ok: true };
+      }
+    });
   }
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@adminforth/two-factors-auth",
-  "version": "3.0.4",
+  "version": "3.1.0",
   "description": "AdminForth plugin for two factors authentication",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
-  "homepage": "https://adminforth.dev/docs/tutorial/Plugins/TwoFactorsAuth/",
+  "homepage": "https://adminforth.dev/docs/tutorial/Plugins/two-factors-auth/",
   "repository": {
     "type": "git",
     "url": "https://github.com/devforth/adminforth-two-factors-auth.git"
@@ -21,14 +21,14 @@
     "two-factors-auth",
     "2fa"
   ],
-  "author": "devforth",
+  "author": "DevForth (https://devforth.io)",
   "license": "MIT",
   "dependencies": {
     "@simplewebauthn/server": "^13.2.1",
     "node-2fa": "^2.0.3"
   },
   "peerDependencies": {
-    "adminforth": "^2.24.0"
+    "adminforth": "^2.42.0"
   },
   "devDependencies": {
     "@types/node": "^22.10.7",

package/types.ts

@@ -1,6 +1,7 @@
 import { AdminUser, KeyValueAdapter } from "adminforth";
+import  {type PluginsCommonOptions } from "adminforth";
 
-export type PluginOptions = {
+export interface PluginOptions extends PluginsCommonOptions {
 
     /**
      * Name of the field in the auth resource which will store 2FA secret.