@1auth/authn-recovery-codes 0.0.0-alpha.4 → 0.0.0-alpha.40

package/index.js

@@ -1,64 +1,115 @@
-import { recoveryCode } from '@1auth/crypto'
 import {
-  options as authnOptions,
+  charactersAlphaNumeric,
+  entropyToCharacterLength,
+  randomAlphaNumeric,
+  createSecretHash,
+  verifySecretHash
+} from '@1auth/crypto'
+import {
+  getOptions as authnGetOptions,
+  count as authnCount,
+  list as authnList,
   create as authnCreate,
-  authenticate as authnVerifyAuthentication
+  authenticate as authnAuthenticate,
+  remove as authnRemove
 } from '@1auth/authn'
 
-const options = {
-  id: 'recovery',
+// aka lookup secret
+const id = 'recoveryCodes'
+
+const secret = {
+  id,
+  type: 'secret',
+  minLength: entropyToCharacterLength(112, charactersAlphaNumeric.length),
+  otp: true,
+  create: async () => randomAlphaNumeric(secret.minLength),
+  encode: async (value) => createSecretHash(value),
+  decode: async (value) => value,
+  verify: async (value, hash) => verifySecretHash(hash, value)
+}
+
+const defaults = {
+  id,
+  secret,
   count: 5
 }
-export default (params) => {
-  Object.assign(options, authnOptions, { secret: recoveryCode }, params)
+const options = {}
+export default (opt = {}) => {
+  Object.assign(options, authnGetOptions(), defaults, opt)
+}
+
+export const count = async (sub) => {
+  if (options.log) {
+    options.log('@1auth/authn-recovery-codes count(', sub, ')')
+  }
+  return await authnCount(options.secret, sub)
+}
+
+export const list = async (sub) => {
+  if (options.log) {
+    options.log('@1auth/authn-recovery-codes list(', sub, ')')
+  }
+  return await authnList(options.secret, sub)
 }
 
 export const authenticate = async (username, secret) => {
-  const { sub } = await authnVerifyAuthentication(username, secret, options)
-  return sub
+  return await authnAuthenticate(options.secret, username, secret)
 }
 
 export const create = async (sub) => {
-  const secrets = await createSecrets(sub)
+  if (options.log) {
+    options.log('@1auth/authn-recovery-codes create(', sub, ')')
+  }
+  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
-}
-
-/* export const verifySecret = async (sub, ids) => {
-  if (!Array.isArray(ids)) ids = [ids]
-  for (const id of ids) {
-    await authnVerifySecret(sub, id, options)
+  if (options.log) {
+    options.log('@1auth/authn-recovery-codes update(', sub, ')')
   }
-} */
-
-const createSecrets = async (sub) => {
   const existingSecrets = await options.store.selectList(options.table, {
     sub,
-    type: options.id + '-' + options.secret.type
+    type: options.secret.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 })
+  const secrets = await createSecrets(sub, options.count)
+  for (const item of existingSecrets) {
+    await authnRemove(options.secret, sub, item.id)
   }
+  await options.notify.trigger('authn-recovery-codes-update', sub)
+  return secrets
+}
 
+export const remove = async (sub, id) => {
+  if (options.log) {
+    options.log('@1auth/authn-recovery-codes remove(', sub, id, ')')
+  }
+  const existingSecrets = id
+    ? await options.store.selectList(options.table, {
+      sub,
+      type: options.id + '-' + options.secret.type
+    })
+    : [{ id }]
+  // TODO update to remove in single request id: []
   for (const item of existingSecrets) {
     options.store.remove(options.table, { id: item.id, sub })
   }
+  await options.notify.trigger('authn-recovery-codes-remove', sub)
+}
 
+const createSecrets = async (sub, count = options.count) => {
+  const secrets = []
+  const now = nowInSeconds()
+  for (let i = count; i--;) {
+    const secret = await options.secret.create()
+    const id = await authnCreate(options.secret, sub, {
+      value: secret,
+      verify: now
+    })
+    secrets.push({ id, secret })
+  }
   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,10 +1,10 @@
 {
   "name": "@1auth/authn-recovery-codes",
-  "version": "0.0.0-alpha.4",
+  "version": "0.0.0-alpha.40",
   "description": "",
   "type": "module",
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "engineStrict": true,
   "publishConfig": {
@@ -27,7 +27,7 @@
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "node --test"
   },
   "license": "MIT",
   "funding": {
@@ -48,9 +48,9 @@
     "url": "https://github.com/willfarrell/1auth/issues"
   },
   "homepage": "https://github.com/willfarrell/1auth",
-  "gitHead": "47894073ee5f1b6754cef5e482f123dc81575b1c",
+  "gitHead": "7a6c0fbb8ab71d6a2171e678697de9f237568431",
   "dependencies": {
-    "@1auth/authn": "0.0.0-alpha.4",
-    "@1auth/crypto": "0.0.0-alpha.4"
+    "@1auth/authn": "0.0.0-alpha.40",
+    "@1auth/crypto": "0.0.0-alpha.40"
   }
 }

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.