feat(QR Code Decoder): parse otpauth and otp-migration urls

Fix #307

Author: sharevb

locales/en.yml

@@ -4787,6 +4787,8 @@ tools:
         email-1: Email
         email-0: Email
         email: Email
+        otpauth: OTP Auth
+        otpmigration: OTP Migration
   SplashScreen:
     text:
       pomodoro-timer: Pomodoro Timer

package.json

@@ -269,6 +269,7 @@
     "node-forge": "^1.3.3",
     "openai-chat-tokens": "^0.2.8",
     "openpgp": "^6.3.0",
+    "otpauth-migration": "^1.0.0",
     "oui-data": "^1.1.476",
     "parse-duration": "^2.1.5",
     "parse-torrent": "^11.0.19",

pnpm-lock.yaml

@@ -6,7 +6,7 @@ export const tool = defineTool({
   name: t('tools.qr-code-decoder.title'),
   path: '/qr-code-decoder',
   description: t('tools.qr-code-decoder.description'),
-  keywords: ['qrcode', 'qr-code', 'decoder', 'reader'],
+  keywords: ['qrcode', 'qr-code', 'decoder', 'reader', 'wifi', 'otp', 'parser'],
   component: () => import('./qr-code-decoder.vue'),
   icon: Qrcode,
   createdAt: new Date('2024-09-01'),

src/tools/qr-code-decoder/index.ts

@@ -64,6 +64,63 @@ describe('qr-code-decoder', () => {
         password: 'password', // NOSONAR
       },
     });
+    expect(parseQRData('otpauth://totp/ACME%20Co:john.doe@email.com?secret=HXDMVJECJJWSRB3HWIZR4IFUGFTMXBOZ&issuer=ACME%20Co&algorithm=SHA1&digits=6&period=30')).toEqual({
+      type: 'OTP Auth',
+      value: {
+        label: {
+          account: 'john.doe@email.com',
+          issuer: 'ACME Co',
+          raw: 'ACME Co:john.doe@email.com',
+        },
+        params: {
+          algorithm: 'SHA1',
+          digits: '6',
+          issuer: 'ACME Co',
+          period: '30',
+          secret: 'HXDMVJECJJWSRB3HWIZR4IFUGFTMXBOZ',
+        },
+        type: 'totp',
+        uri: 'otpauth://totp/ACME%20Co:john.doe@email.com?secret=HXDMVJECJJWSRB3HWIZR4IFUGFTMXBOZ&issuer=ACME%20Co&algorithm=SHA1&digits=6&period=30',
+      },
+    });
+    expect(parseQRData('otpauth-migration://offline?data=CigKFFVUVURPbmFMMXd1cDlBSVZHOUVjEgRUZXN0GgRUZXN0IAEoAjACCi8KCkhlbGxvId6tvu8SEGFsaWNlQGdvb2dsZS5jb20aB0V4YW1wbGUgASgBMAE4BxABGAEgAA%3D%3D')).toEqual({
+      type: 'OTP Migration',
+      value: [
+        {
+          label: {
+            account: 'Test',
+            issuer: 'Test',
+            raw: 'Test:Test',
+          },
+          params: {
+            algorithm: 'SHA1',
+            digits: '8',
+            issuer: 'Test',
+            secret: 'KVKFKRCPNZQUYMLXOVYDSQKJKZDTSRLD',
+          },
+          type: 'totp',
+          uri: 'otpauth://totp/Test%3ATest?issuer=Test&algorithm=SHA1&digits=8&secret=KVKFKRCPNZQUYMLXOVYDSQKJKZDTSRLD',
+        },
+        {
+          label: {
+            account: 'alice@google.com',
+            issuer: 'Example',
+            raw: 'Example:alice@google.com',
+          },
+          params: {
+            algorithm: 'SHA1',
+            counter: '7',
+            digits: '6',
+            issuer: 'Example',
+            secret: 'JBSWY3DPEHPK3PXP',
+          },
+          type: 'hotp',
+          uri: 'otpauth://hotp/Example%3Aalice%40google.com?issuer=Example&algorithm=SHA1&digits=6&counter=7&secret=JBSWY3DPEHPK3PXP',
+        },
+      ],
+    },
+
+    );
     expect(parseQRData('BEGIN:VCALENDAR\nPRODID:-//xyz Corp//NONSGML PDA Calendar Version 1.0//EN\nVERSION:2.0\nBEGIN:VEVENT\nDTSTAMP:19960704T120000Z\nUID:uid1@example.com\nORGANIZER:mailto:jsmith@example.com\nDTSTART:19960918T143000Z\nDTEND:19960920T220000Z\nSTATUS:CONFIRMED\nCATEGORIES:CONFERENCE\nSUMMARY:Networld+Interop Conference\nDESCRIPTION:Networld+Interop Conference\n  and Exhibit\\nAtlanta World Congress Center\\n\n Atlanta\\, Georgia\nEND:VEVENT\nEND:VCALENDAR'))
       .toEqual({
         type: 'iCal',

src/tools/qr-code-decoder/qr-code-decoder.service.test.ts

@@ -1,7 +1,67 @@
 import ICAL from 'ical.js';
+import { URI as OTPURI } from 'otpauth-migration';
 
 import { translate as t } from '@/plugins/i18n.plugin';
 
+interface OTPAuthURI {
+  type: string
+  label: {
+    issuer?: string
+    account?: string
+    raw: string
+  }
+  params: Record<string, string>
+  uri: string
+}
+
+function parseOtpAuthUri(uri: string): OTPAuthURI | null {
+  const url = new URL(uri);
+
+  if (url.protocol !== 'otpauth:') {
+    return null;
+  }
+
+  // url.hostname contains the OTP type (totp, hotp, etc.)
+  const type = url.hostname;
+
+  // url.pathname starts with "/", so strip it
+  const rawLabel = decodeURIComponent(url.pathname.slice(1));
+
+  let issuer: string | undefined;
+  let account: string | undefined;
+
+  const labelParts = rawLabel.split(':');
+  if (labelParts.length > 1) {
+    issuer = labelParts[0];
+    account = labelParts.slice(1).join(':');
+  }
+  else {
+    account = rawLabel;
+  }
+
+  // Extract query parameters
+  const params: Record<string, string> = {};
+  url.searchParams.forEach((value, key) => {
+    params[key] = value;
+  });
+
+  // If issuer missing in label but present in params, use it
+  if (!issuer && params.issuer) {
+    issuer = params.issuer;
+  }
+
+  return {
+    type,
+    label: {
+      issuer,
+      account,
+      raw: rawLabel,
+    },
+    params,
+    uri,
+  };
+}
+
 export function parseQRData(qrContent: string | null) {
   if (!qrContent) {
     return { type: t('tools.qr-code-decoder.service.text.unknown'), value: '' };
@@ -72,6 +132,19 @@ export function parseQRData(qrContent: string | null) {
       },
     };
   }
+  if (qrContent.startsWith('otpauth:')) {
+    return {
+      type: t('tools.qr-code-decoder.service.text.otpauth'),
+      value: parseOtpAuthUri(qrContent),
+    };
+  }
+  if (qrContent.startsWith('otpauth-migration:')) {
+    const otpauthUris = OTPURI.toOTPAuthURIs(qrContent);
+    return {
+      type: t('tools.qr-code-decoder.service.text.otpmigration'),
+      value: otpauthUris.map(otpauthUri => parseOtpAuthUri(otpauthUri)),
+    };
+  }
   if (/^(?:https?|ftp):\/\//.test(qrContent)) {
     return {
       type: t('tools.websocket-tester.texts.label-url'),

src/tools/qr-code-decoder/qr-code-decoder.service.ts

@@ -135,6 +135,11 @@ export default defineConfig({
   },
   test: {
     exclude: [...configDefaults.exclude, '**/*.e2e.spec.ts'],
+    server: {
+      deps: {
+        inline: ['otpauth-migration', 'proto'],
+      },
+    },
   },
   build: {
     target: 'esnext',