@1auth/account-username 0.0.0-alpha.6 → 0.0.0-alpha.60

package/README.md

@@ -0,0 +1,38 @@
+# @1auth/account-username
+Extends `@1auth/account`
+
+## Getting started
+
+**auth.js**
+```javascript
+import accountUsername from "@1auth/account";
+
+export {
+  create as accountUsernameCreate,
+  exists as accountUsernameExists,
+  lookup as accountUsernameLookup,
+  update as accountUsernameUpdate,
+  recover as accountUsernameRecover,
+} from "@1auth/account-username";
+
+account({ store, notify, encryptedFields: ["username",  "privateKey"] });
+accountUsername({
+  usernameBlacklist: ["admin"]
+})
+```
+
+```javascript
+import {accountUsernameCreate} from './auth.js'
+await accountUsernameCreate(sub, username)
+```
+
+## Options
+
+- `maxLength`: Max length of username. Defaults to `32`
+- `usernameBlacklist`: Array of blacklisted words.
+
+## Database table
+
+
+- `username`
+- `digest`: Digest of `username`

package/index.js

@@ -1,79 +1,122 @@
 import {
   getOptions as accountOptions,
-  update as accountUpdate
+  update as accountUpdate,
+  lookup as accountLookup
 } from '@1auth/account'
 
-import { createDigest } from '@1auth/crypto'
-
-export const regexp = /^[a-z0-9-]*$/
-export const jsonSchema = {
-  type: 'string',
-  pattern: '^[a-z0-9-]*$',
-  minLength: 1,
-  maxLength: 32
-}
+import { createSeasonedDigest, symmetricDecryptFields } from '@1auth/crypto'
 
+// Only allow characters that are safe to encode
+// . not allowed because it can be used to declare and extension
+let usernameBlacklistRegExp
 const options = {
   id: 'username',
-  blacklist: ['admin', 'security']
+  allowedCharRegExp: /^[a-z0-9_-]*$/,
+  usernameBlacklist: [],
+  maxLength: 32
 }
 export default (params) => {
   Object.assign(options, accountOptions(), params)
+  if (options.usernameBlacklist.length) {
+    usernameBlacklistRegExp = new RegExp(
+      `(${options.usernameBlacklist.map((value) => value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')).join('|')})`
+    )
+  }
 }
 
 export const exists = async (username) => {
-  const usernameSanitized = __sanitize(username)
+  const usernameSanitized = sanitize(username)
+  const usernameDigest = createSeasonedDigest(usernameSanitized)
   return options.store.exists(options.table, {
-    digest: await createDigest(usernameSanitized)
+    digest: usernameDigest
   })
 }
 
 export const lookup = async (username) => {
-  if (!username) return {}
-  const usernameSanitized = __sanitize(username)
-  return await options.store.select(options.table, {
-    digest: await createDigest(usernameSanitized)
+  const usernameSanitized = sanitize(username)
+  const usernameDigest = createSeasonedDigest(usernameSanitized)
+
+  let item = await options.store.select(options.table, {
+    digest: usernameDigest
   })
+  if (!item) return
+  // must match @1auth/account
+  item = symmetricDecryptFields(
+    item,
+    { encryptedKey: item.encryptionKey, sub: item.sub },
+    options.encryptedFields
+  )
+  delete item.encryptionKey
+  delete item.privateKey
+  return item
 }
 
 export const create = async (sub, username) => {
-  if (!__validate(username)) {
-    throw new Error('400 invalid characters')
+  const usernameSanitized = sanitize(username)
+  const usernameValidate = validate(usernameSanitized)
+  if (usernameValidate !== true) {
+    throw new Error(usernameValidate, {
+      cause: { username, usernameSanitized }
+    })
   }
-  if (!__blacklist(username) || (await exists(username))) {
-    throw new Error('409 Conflict')
+  const usernameDigest = createSeasonedDigest(usernameSanitized)
+  const usernameExists = await options.store.exists(options.table, {
+    digest: usernameDigest
+  })
+  if (usernameExists) {
+    throw new Error('409 Conflict', { cause: { username, usernameSanitized } })
   }
-  const usernameSanitized = __sanitize(username)
+
   await accountUpdate(sub, {
-    username: usernameSanitized,
-    digest: await createDigest(usernameSanitized)
+    username,
+    digest: usernameDigest
   })
 }
 
 export const update = async (sub, username) => {
   await create(sub, username)
-  await options.notify.trigger('account-username-change')
+  await options.notify.trigger('account-username-change', sub)
 }
 
 export const recover = async (sub) => {
-  const { username } = await options.store.select(options.table, { sub })
-  await options.notify.trigger('account-username-recover', { username })
+  const { username } = await accountLookup(sub)
+  await options.notify.trigger('account-username-recover', sub, { username })
+}
+
+export const sanitize = (value) => {
+  return value
+    .trim()
+    .toLocaleLowerCase()
+    .normalize('NFKD')
+    .replace(/\p{Diacritic}/gu, '')
 }
 
-export const __sanitize = (value) => {
-  return value.trim()
+export const validate = (value) => {
+  let valid = true
+  if (valid === true) valid = validateLength(value)
+  if (valid === true) valid = validateAllowedChar(value)
+  if (valid === true) valid = validateBlacklist(value)
+  return valid
+}
+
+export const validateLength = (value) => {
+  if (value.length < 1 && options.maxLength < value.length) {
+    return '400 Bad Request'
+  }
+  return true
 }
 
-export const __validate = (value) => {
-  if (!regexp.test(value)) {
-    return false
+export const validateAllowedChar = (value) => {
+  // TODO URL encode compare
+  if (!options.allowedCharRegExp.test(value)) {
+    return '400 Bad Request'
   }
   return true
 }
 
-export const __blacklist = (value) => {
-  if (options.blacklist.includes(value)) {
-    return false
+export const validateBlacklist = (value) => {
+  if (usernameBlacklistRegExp?.test(value)) {
+    return '409 Conflict'
   }
   return true
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@1auth/account-username",
-  "version": "0.0.0-alpha.6",
+  "version": "0.0.0-alpha.60",
   "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,8 +48,8 @@
     "url": "https://github.com/willfarrell/1auth/issues"
   },
   "homepage": "https://github.com/willfarrell/1auth",
-  "gitHead": "be4a52c6e52443e7b21d0f67cb6062ae9f6f069c",
+  "gitHead": "7a6c0fbb8ab71d6a2171e678697de9f237568431",
   "dependencies": {
-    "@1auth/account": "0.0.0-alpha.6"
+    "@1auth/account": "0.0.0-alpha.60"
   }
 }

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.