@sequencemedia/pbkdf2 1.0.1

package/babel.config.cjs

@@ -0,0 +1,34 @@
+const {
+  env: {
+    NODE_ENV = 'development'
+  }
+} = process
+
+function env () {
+  return (
+    NODE_ENV === 'production'
+  )
+}
+
+const presets = [
+  [
+    '@babel/env', {
+      targets: {
+        node: 'current'
+      },
+      useBuiltIns: 'usage',
+      corejs: 3
+    }
+  ]
+]
+
+const plugins = []
+
+module.exports = (api) => {
+  if (api) api.cache.using(env)
+
+  return {
+    presets,
+    plugins
+  }
+}

package/config/compare.mjs

@@ -0,0 +1,19 @@
+import argsMap from '#utils/args-map'
+
+export const ITERATIONS = (
+  argsMap.has('ITERATIONS')
+    ? argsMap.get('ITERATIONS')
+    : 10
+)
+
+export const KEYLEN = (
+  argsMap.has('KEYLEN')
+    ? argsMap.get('KEYLEN')
+    : 64
+)
+
+export const DIGEST = (
+  argsMap.has('DIGEST')
+    ? argsMap.get('DIGEST')
+    : 'sha512'
+)

package/index.d.ts

@@ -0,0 +1,5 @@
+declare module '@sequencemedia/pbkdf2' {
+  export function compare(password: string, params: { salt: string, hash: Buffer, iteration?: number, keylen?: number, digest?: string }): Promise<boolean>
+  export function hash (password: string, params: { salt: string, iteration?: number, keylen?: number, digest?: string }): Promise<Buffer>
+  export function salt (size: number): Promise<Buffer>
+}

package/index.mjs

@@ -0,0 +1,9 @@
+import compare from '#utils/compare'
+import hash from '#utils/hash'
+import salt from '#utils/salt'
+
+export {
+  compare,
+  hash,
+  salt
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@sequencemedia/pbkdf2",
+  "version": "1.0.1",
+  "main": "./index.mjs",
+  "type": "module",
+  "author": {
+    "name": "Jonathan Perry for Sequence Media Limited",
+    "email": "sequencemedia@sequencemedia.net",
+    "url": "http://sequencemedia.net"
+  },
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:sequencemedia/pbkdf2.git"
+  },
+  "scripts": {
+    "lint": "cross-env NODE_ENV=production eslint . --ext .mjs --ext .cjs",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "cross-env NODE_ENV=test mocha tests --recursive --verbose --color",
+    "compare": "cross-env NODE_ENV=production node scripts/compare.mjs",
+    "hash": "cross-env NODE_ENV=production node scripts/hash.mjs",
+    "salt": "cross-env NODE_ENV=production node scripts/salt.mjs",
+    "prepare": "husky install"
+  },
+  "dependencies": {
+    "debug": "^4.3.4",
+    "yargs-parser": "^21.1.1"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.20.7",
+    "@babel/core": "^7.20.12",
+    "@babel/eslint-parser": "^7.19.1",
+    "@babel/preset-env": "^7.20.2",
+    "@sequencemedia/hooks": "^1.0.314",
+    "@types/node": "^18.11.18",
+    "chai": "^4.3.7",
+    "core-js": "^3.27.2",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.32.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "husky": "^8.0.3",
+    "mocha": "^10.2.0"
+  },
+  "imports": {
+    "#config/*": "./config/*.mjs",
+    "#utils/*": "./utils/*.mjs"
+  }
+}

package/scripts/compare.mjs

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+
+import argsMap from '#utils/args-map'
+import compare from '#utils/compare'
+import {
+  fromBase64ToBuffer,
+  fromBase64
+} from '#utils/common'
+import {
+  ITERATIONS,
+  KEYLEN,
+  DIGEST
+} from '#config/compare'
+
+if (!argsMap.has('password')) throw new Error('Parameter `password` is required')
+const password = argsMap.get('password')
+
+if (!argsMap.has('hash')) throw new Error('Parameter `hash` is required')
+const hash = fromBase64ToBuffer(argsMap.get('hash'))
+
+if (!argsMap.has('salt')) throw new Error('Parameter `salt` is required')
+const salt = fromBase64(argsMap.get('salt'))
+
+const iterations = (
+  argsMap.has('iterations')
+    ? argsMap.get('iterations')
+    : ITERATIONS
+)
+
+const keylen = (
+  argsMap.has('keylen')
+    ? argsMap.get('keylen')
+    : KEYLEN
+)
+
+const digest = (
+  argsMap.has('digest')
+    ? argsMap.get('digest')
+    : DIGEST
+)
+
+compare(password, { hash, salt, iterations, keylen, digest })
+  .then((isValid) => {
+    console.log(isValid ? '👍' : '👎')
+  })
+  .catch(() => {
+    console.error('💩')
+  })

package/scripts/hash.mjs

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+
+import argsMap from '#utils/args-map'
+import {
+  fromBase64,
+  fromBufferToBase64
+} from '#utils/common'
+import hash from '#utils/hash'
+import {
+  ITERATIONS,
+  KEYLEN,
+  DIGEST
+} from '#config/compare'
+
+if (!argsMap.has('password')) throw new Error('Parameter `password` is required')
+const password = argsMap.get('password')
+
+if (!argsMap.has('salt')) throw new Error('Parameter `salt` is required')
+const salt = fromBase64(argsMap.get('salt'))
+
+const iterations = (
+  argsMap.has('iterations')
+    ? argsMap.get('iterations')
+    : ITERATIONS
+)
+
+const keylen = (
+  argsMap.has('keylen')
+    ? argsMap.get('keylen')
+    : KEYLEN
+)
+
+const digest = (
+  argsMap.has('digest')
+    ? argsMap.get('digest')
+    : DIGEST
+)
+
+hash(password, { salt, iterations, keylen, digest })
+  .then((buffer) => {
+    console.log(fromBufferToBase64(buffer))
+  })
+  .catch(() => {
+    console.error('💩')
+  })

package/scripts/salt.mjs

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+import argsMap from '#utils/args-map'
+import {
+  fromBufferToBase64
+} from '#utils/common'
+import salt from '#utils/salt'
+
+if (!argsMap.has('size')) throw new Error('Parameter `size` is required')
+const size = argsMap.get('size')
+
+salt(size)
+  .then((buffer) => {
+    console.log(fromBufferToBase64(buffer))
+  })
+  .catch(() => {
+    console.error('💩')
+  })

package/tests/utils/common.spec.mjs

@@ -0,0 +1,135 @@
+import {
+  expect
+} from 'chai'
+import {
+  fromBase64,
+  toBase64,
+  fromBase64ToBuffer,
+  fromBufferToBase64
+} from '#utils/common'
+
+describe('`#utils/common`', () => {
+  describe('fromBase64', () => it('is a function', () => expect(fromBase64).to.be.a('function')))
+
+  describe('toBase64', () => it('is a function', () => expect(toBase64).to.be.a('function')))
+
+  describe('fromBase64ToBuffer', () => it('is a function', () => expect(fromBase64ToBuffer).to.be.a('function')))
+
+  describe('fromBufferToBase64', () => it('is a function', () => expect(fromBufferToBase64).to.be.a('function')))
+
+  describe('fromBase64()', () => {
+    describe('User 1', () => {
+      it('returns a string', () => {
+        const BASE64 = 'YzFjMTY4MmMyMWE4MjFkYjRhNWE5YjJmNDY0OTUzM2Q='
+        const UTF8 = 'c1c1682c21a821db4a5a9b2f4649533d'
+
+        return expect(fromBase64(BASE64)).to.equal(UTF8)
+      })
+    })
+
+    describe('User 2', () => {
+      it('returns a string', () => {
+        const BASE64 = 'MDI2OGM0MDU4NWJiOTgxNWEyYzQwN2RkYjM1YTY5YWU='
+        const UTF8 = '0268c40585bb9815a2c407ddb35a69ae'
+
+        return expect(fromBase64(BASE64)).to.equal(UTF8)
+      })
+    })
+
+    describe('User 3', () => {
+      it('returns a string', () => {
+        const BASE64 = 'ZDI3OTZmZWU3M2I3M2Y3MTgxMmYyNGM3MjU4NDE2NDM='
+        const UTF8 = 'd2796fee73b73f71812f24c725841643'
+
+        return expect(fromBase64(BASE64)).to.equal(UTF8)
+      })
+    })
+  })
+
+  describe('toBase64()', () => {
+    describe('User 1', () => {
+      it('returns a string', () => {
+        const UTF8 = 'c1c1682c21a821db4a5a9b2f4649533d'
+        const BASE64 = 'YzFjMTY4MmMyMWE4MjFkYjRhNWE5YjJmNDY0OTUzM2Q='
+
+        return expect(toBase64(UTF8)).to.equal(BASE64)
+      })
+    })
+
+    describe('User 2', () => {
+      it('returns a string', () => {
+        const UTF8 = '0268c40585bb9815a2c407ddb35a69ae'
+        const BASE64 = 'MDI2OGM0MDU4NWJiOTgxNWEyYzQwN2RkYjM1YTY5YWU='
+
+        return expect(toBase64(UTF8)).to.equal(BASE64)
+      })
+    })
+
+    describe('User 3', () => {
+      it('returns a string', () => {
+        const UTF8 = 'd2796fee73b73f71812f24c725841643'
+        const BASE64 = 'ZDI3OTZmZWU3M2I3M2Y3MTgxMmYyNGM3MjU4NDE2NDM='
+
+        return expect(toBase64(UTF8)).to.equal(BASE64)
+      })
+    })
+  })
+
+  describe('fromBase64ToBuffer()', () => {
+    describe('User 1', () => {
+      it('returns a buffer', () => {
+        const BASE64 = 'YzFjMTY4MmMyMWE4MjFkYjRhNWE5YjJmNDY0OTUzM2Q='
+        const BUFFER = Buffer.from('c1c1682c21a821db4a5a9b2f4649533d')
+
+        return expect(Buffer.compare(fromBase64ToBuffer(BASE64), BUFFER)).to.equal(0)
+      })
+    })
+
+    describe('User 2', () => {
+      it('returns a buffer', () => {
+        const BASE64 = 'MDI2OGM0MDU4NWJiOTgxNWEyYzQwN2RkYjM1YTY5YWU='
+        const BUFFER = Buffer.from('0268c40585bb9815a2c407ddb35a69ae')
+
+        return expect(Buffer.compare(fromBase64ToBuffer(BASE64), BUFFER)).to.equal(0)
+      })
+    })
+
+    describe('User 3', () => {
+      it('returns a buffer', () => {
+        const BASE64 = 'ZDI3OTZmZWU3M2I3M2Y3MTgxMmYyNGM3MjU4NDE2NDM='
+        const BUFFER = Buffer.from('d2796fee73b73f71812f24c725841643')
+
+        return expect(Buffer.compare(fromBase64ToBuffer(BASE64), BUFFER)).to.equal(0)
+      })
+    })
+  })
+
+  describe('fromBufferToBase64()', () => {
+    describe('User 1', () => {
+      it('returns a string', () => {
+        const BUFFER = Buffer.from('c1c1682c21a821db4a5a9b2f4649533d')
+        const BASE64 = 'YzFjMTY4MmMyMWE4MjFkYjRhNWE5YjJmNDY0OTUzM2Q='
+
+        return expect(fromBufferToBase64(BUFFER)).to.equal(BASE64)
+      })
+    })
+
+    describe('User 2', () => {
+      it('returns a string', () => {
+        const BUFFER = Buffer.from('0268c40585bb9815a2c407ddb35a69ae')
+        const BASE64 = 'MDI2OGM0MDU4NWJiOTgxNWEyYzQwN2RkYjM1YTY5YWU='
+
+        return expect(fromBufferToBase64(BUFFER)).to.equal(BASE64)
+      })
+    })
+
+    describe('User 3', () => {
+      it('returns a string', () => {
+        const BUFFER = Buffer.from('d2796fee73b73f71812f24c725841643')
+        const BASE64 = 'ZDI3OTZmZWU3M2I3M2Y3MTgxMmYyNGM3MjU4NDE2NDM='
+
+        return expect(fromBufferToBase64(BUFFER)).to.equal(BASE64)
+      })
+    })
+  })
+})

package/tests/utils/compare.spec.mjs

@@ -0,0 +1,81 @@
+import {
+  expect
+} from 'chai'
+import compare from '#utils/compare'
+
+describe('`#utils/compare`', () => {
+  describe('compare', () => it('is a function', () => expect(compare).to.be.a('function')))
+
+  describe('compare()', () => {
+    const ITERATIONS = 32768
+
+    describe('User 1', () => {
+      const HASH = Buffer.from('kOhpM7//M4I9+WcWLH7vbb/yN2+8qKyxQ0xAfI4JzamcRMdwwl7vAh0ch7UJ0JoBe9AqaAGuUJZF/mVA9EqaLQ==', 'base64')
+      const SALT = 'c1c1682c21a821db4a5a9b2f4649533d'
+
+      describe('`password` is valid', () => {
+        it('returns true', async () => {
+          const password = '^49pPaRdVSNC'
+          const isValid = await compare(password, { hash: HASH, salt: SALT, iterations: ITERATIONS })
+
+          return expect(isValid).to.be.true
+        })
+      })
+
+      describe('`password` is not valid', () => {
+        it('returns false', async () => {
+          const password = 'not password'
+          const isValid = await compare(password, { hash: HASH, salt: SALT, iterations: ITERATIONS })
+
+          return expect(isValid).to.be.false
+        })
+      })
+    })
+
+    describe('User 2', () => {
+      const HASH = Buffer.from('BrtOel2qy5HrYWn45jBKf5b3HUKdVeQfIj1ljhGxQ/SiWsmMMuOl756H4MXkMOnVJKrgFfHFy7cgFXUaSFA2ow==', 'base64')
+      const SALT = '0268c40585bb9815a2c407ddb35a69ae'
+
+      describe('`password` is valid', () => {
+        it('returns true', async () => {
+          const password = 'S0uSaC&FzDOO'
+          const isValid = await compare(password, { hash: HASH, salt: SALT, iterations: ITERATIONS })
+
+          return expect(isValid).to.be.true
+        })
+      })
+
+      describe('`password` is not valid', () => {
+        it('returns false', async () => {
+          const password = 'not password'
+          const isValid = await compare(password, { hash: HASH, salt: SALT, iterations: ITERATIONS })
+
+          return expect(isValid).to.be.false
+        })
+      })
+    })
+
+    describe('User 3', () => {
+      const HASH = Buffer.from('bV76sVqsM0doKBFnaHsZQC9OgcVnF/+gzkG7HFXdD7jyQdN1PqCVijyXKMijmYQPWJohi5f7sVxhoLJ5kf8aQA==', 'base64')
+      const SALT = 'd2796fee73b73f71812f24c725841643'
+
+      describe('`password` is valid', () => {
+        it('returns true', async () => {
+          const password = '@^EJmdlkt5A#'
+          const isValid = await compare(password, { hash: HASH, salt: SALT, iterations: ITERATIONS })
+
+          return expect(isValid).to.be.true
+        })
+      })
+
+      describe('`password` is not valid', () => {
+        it('returns false', async () => {
+          const password = 'not password'
+          const isValid = await compare(password, { hash: HASH, salt: SALT, iterations: ITERATIONS })
+
+          return expect(isValid).to.be.false
+        })
+      })
+    })
+  })
+})

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "types": ["node"]
+  }
+}

package/utils/args-map.mjs

@@ -0,0 +1,9 @@
+import yargsParser from 'yargs-parser'
+
+const {
+  argv = []
+} = process
+
+export const args = argv.slice(2)
+
+export default new Map(Object.entries(yargsParser(args)))

package/utils/common.mjs

@@ -0,0 +1,15 @@
+export function fromBase64ToBuffer (string) {
+  return Buffer.from(string, 'base64')
+}
+
+export function fromBufferToBase64 (buffer) {
+  return buffer.toString('base64')
+}
+
+export function fromBase64 (string) {
+  return Buffer.from(string, 'base64').toString()
+}
+
+export function toBase64 (string) {
+  return Buffer.from(string).toString('base64')
+}

package/utils/compare.mjs

@@ -0,0 +1,23 @@
+import {
+  timingSafeEqual
+} from 'node:crypto'
+import hash from './hash.mjs'
+
+/**
+ * function compare (password, salt, h, complete = () => {}) {
+ *   hash(password, salt, (e, v) => {
+ *     if (e) return complete(e)
+ *
+ *     complete(null, timingSafeEqual(h, v))
+ *   })
+ * }
+ */
+
+export default async function compare (password, {
+  hash: alpha,
+  ...params
+} = {}) {
+  const omega = await hash(password, params)
+
+  return timingSafeEqual(alpha, omega)
+}

package/utils/hash.mjs

@@ -0,0 +1,31 @@
+import {
+  pbkdf2
+} from 'node:crypto'
+import {
+  ITERATIONS,
+  KEYLEN,
+  DIGEST
+} from '#config/compare'
+
+/**
+ * function hash (password, salt, complete = () => {}) {
+ *   pbkdf2(password, salt, ITERATIONS, KEYLEN, DIGEST, complete)
+ * }
+ */
+
+export default function hash (password, {
+  salt,
+  iterations = ITERATIONS,
+  keylen = KEYLEN,
+  digest = DIGEST
+} = {}) {
+  return (
+    new Promise((resolve, reject) => {
+      pbkdf2(password, salt, iterations, keylen, digest, (e, buffer) => {
+        (!e)
+          ? resolve(buffer)
+          : reject(e)
+      })
+    })
+  )
+}

package/utils/salt.mjs

@@ -0,0 +1,21 @@
+import {
+  randomBytes
+} from 'node:crypto'
+
+/**
+ * function salt (size, complete = () => {}) {
+ *   randomBytes(size, complete)
+ * }
+ */
+
+export default function salt (size) {
+  return (
+    new Promise((resolve, reject) => {
+      randomBytes(size, (e, buffer) => {
+        (!e)
+          ? resolve(buffer)
+          : reject(e)
+      })
+    })
+  )
+}