@1auth/authn-recovery-codes 0.0.0-alpha.9 → 0.0.0-beta.1

package/index.js

@@ -1,64 +1,125 @@
-import { recoveryCode } from '@1auth/crypto'
+// Copyright 2003 - 2026 will Farrell, and 1Auth contributors.
+// SPDX-License-Identifier: MIT
 import {
-  options as authnOptions,
-  create as authnCreate,
-  authenticate as authnVerifyAuthentication
-} from '@1auth/authn'
+	authenticate as authnAuthenticate,
+	count as authnCount,
+	// create as authnCreate,
+	createList as authnCreateList,
+	getOptions as authnGetOptions,
+	//select as authnSelect,
+	list as authnList,
+	remove as authnRemove,
+	removeList as authnRemoveList,
+} from "@1auth/authn";
+import {
+	createSecretHash,
+	makeRandomConfigObject,
+	verifySecretHash,
+} from "@1auth/crypto";
+
+// aka lookup secret
+const id = "recoveryCodes";
 
-const options = {
-  id: 'recovery',
-  count: 5
-}
-export default (params) => {
-  Object.assign(options, authnOptions, { secret: recoveryCode }, params)
-}
+export const secret = ({
+	type = "secret",
+	entropy = 112,
+	otp = true,
+	encode = (value) => createSecretHash(value),
+	decode = (value) => value,
+	verify = (value, hash) => verifySecretHash(hash, value),
+	...params
+} = {}) =>
+	makeRandomConfigObject({
+		id,
+		type,
+		entropy,
+		otp,
+		encode,
+		decode,
+		verify,
+		...params,
+	});
+
+const defaults = {
+	id,
+	secret: secret(),
+	count: 5,
+};
+const options = {};
+export default (opt = {}) => {
+	Object.assign(options, authnGetOptions(), defaults, opt);
+};
 
 export const authenticate = async (username, secret) => {
-  const { sub } = await authnVerifyAuthentication(username, secret, options)
-  return sub
-}
+	return await authnAuthenticate(options.secret, username, secret);
+};
+
+export const count = async (sub) => {
+	return await authnCount(options.secret, sub);
+};
+
+// export const select = async (sub, id) => {
+//   return await authnSelect(options.secret, sub, id);
+// };
+
+export const list = async (sub) => {
+	return await authnList(options.secret, sub);
+};
 
 export const create = async (sub) => {
-  const secrets = await createSecrets(sub)
-  return secrets
-}
+	const secrets = await createSecrets(sub, options.count);
+	await options.notify.trigger("authn-recovery-codes-create", sub);
+	return secrets;
+};
 
 export const update = async (sub) => {
-  const secrets = await createSecrets(sub)
-  await options.notify.trigger('authn-recovery-codes-update', sub)
-  return secrets
-}
+	if (!sub || typeof sub !== "string") {
+		throw new Error("401 Unauthorized", { cause: { sub } });
+	}
+	const existingSecrets = await options.store.selectList(options.table, {
+		sub,
+		type: `${options.secret.id}-${options.secret.type}`,
+	});
+	const secrets = await createSecrets(sub, options.count);
+
+	const id = existingSecrets.map((item) => item.id);
+	await authnRemoveList(options.secret, sub, id);
 
-/* export const verifySecret = async (sub, ids) => {
-  if (!Array.isArray(ids)) ids = [ids]
-  for (const id of ids) {
-    await authnVerifySecret(sub, id, options)
-  }
-} */
+	await options.notify.trigger("authn-recovery-codes-update", sub);
+	return secrets;
+};
 
-const createSecrets = async (sub) => {
-  const existingSecrets = await options.store.selectList(options.table, {
-    sub,
-    type: options.id + '-' + options.secret.type
-  })
-  const secrets = []
-  for (let i = options.count; i--;) {
-    const secret = await options.secret.create()
-    const id = await authnCreate(
-      options.secret.type,
-      { sub, value: secret },
-      options
-    )
-    secrets.push({ id, secret })
-  }
+export const remove = async (sub, id) => {
+	if (id) {
+		await authnRemove(options.secret, sub, id);
+	} else {
+		if (!sub || typeof sub !== "string") {
+			throw new Error("401 Unauthorized", { cause: { sub } });
+		}
+		const ids = await options.store
+			.selectList(options.table, {
+				sub,
+				type: `${options.id}-${options.secret.type}`,
+			})
+			.then((res) => res.map((item) => item.id));
+		await authnRemoveList(options.secret, sub, ids);
+	}
 
-  for (const item of existingSecrets) {
-    options.store.remove(options.table, { id: item.id, sub })
-  }
+	await options.notify.trigger("authn-recovery-codes-remove", sub);
+};
 
-  return secrets
-}
+const createSecrets = async (sub, count = options.count) => {
+	const secrets = [];
+	const now = nowInSeconds();
+	for (let i = count; i--; ) {
+		const secret = await options.secret.create();
+		secrets.push({
+			value: secret,
+			verify: now,
+		});
+	}
+	await authnCreateList(options.secret, sub, secrets);
+	return secrets;
+};
 
-export const list = async (sub, type = options.id + '-secret') => {
-  return options.store.selectList(options.table, { sub, type })
-}
+const nowInSeconds = () => Math.floor(Date.now() / 1000);

package/package.json

@@ -1,56 +1,56 @@
 {
-  "name": "@1auth/authn-recovery-codes",
-  "version": "0.0.0-alpha.9",
-  "description": "",
-  "type": "module",
-  "engines": {
-    "node": ">=16"
-  },
-  "engineStrict": true,
-  "publishConfig": {
-    "access": "public"
-  },
-  "main": "./index.js",
-  "module": "./index.js",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./index.d.ts",
-        "default": "./index.js"
-      }
-    }
-  },
-  "types": "index.d.ts",
-  "files": [
-    "index.js",
-    "index.d.ts"
-  ],
-  "scripts": {
-    "test": "npm run test:unit",
-    "test:unit": "ava"
-  },
-  "license": "MIT",
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/willfarrell"
-  },
-  "keywords": [],
-  "author": {
-    "name": "1auth contributors",
-    "url": "https://github.com/willfarrell/1auth/graphs/contributors"
-  },
-  "repository": {
-    "type": "git",
-    "url": "github:willfarrell/1auth",
-    "directory": "packages/authn-recovery-codes"
-  },
-  "bugs": {
-    "url": "https://github.com/willfarrell/1auth/issues"
-  },
-  "homepage": "https://github.com/willfarrell/1auth",
-  "gitHead": "d21e1013f55ed05af4daf980bc4dfdfd52538792",
-  "dependencies": {
-    "@1auth/authn": "0.0.0-alpha.9",
-    "@1auth/crypto": "0.0.0-alpha.9"
-  }
+	"name": "@1auth/authn-recovery-codes",
+	"version": "0.0.0-beta.1",
+	"description": "",
+	"type": "module",
+	"engines": {
+		"node": ">=24"
+	},
+	"engineStrict": true,
+	"publishConfig": {
+		"access": "public"
+	},
+	"main": "./index.js",
+	"module": "./index.js",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./index.d.ts",
+				"default": "./index.js"
+			}
+		}
+	},
+	"types": "index.d.ts",
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"scripts": {
+		"test": "npm run test:unit",
+		"test:unit": "node --test"
+	},
+	"license": "MIT",
+	"funding": {
+		"type": "github",
+		"url": "https://github.com/sponsors/willfarrell"
+	},
+	"keywords": [],
+	"author": {
+		"name": "1auth contributors",
+		"url": "https://github.com/willfarrell/1auth/graphs/contributors"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/willfarrell/1auth.git",
+		"directory": "packages/authn-recovery-codes"
+	},
+	"bugs": {
+		"url": "https://github.com/willfarrell/1auth/issues"
+	},
+	"homepage": "https://github.com/willfarrell/1auth",
+	"gitHead": "7a6c0fbb8ab71d6a2171e678697de9f237568431",
+	"dependencies": {
+		"@1auth/authn": "0.0.0-beta.1",
+		"@1auth/crypto": "0.0.0-beta.1"
+	}
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 will Farrell
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.