@sequencemedia/pbkdf2 1.0.5 → 1.0.7

package/README.md

@@ -0,0 +1,21 @@
+# @sequencemedia/pbkdf2
+
+ES functions are exported from package root alongside a TS definition
+
+## Password validation
+
+A password can be validated against a `hash` and `salt` (and the number of `iterations` that were used to compute it)
+
+Both the `hash` and `salt` are expected from the command line to be strings in _Base64_ format
+
+- The `hash` is decoded to a `Buffer`
+- The `salt` is transformed from _Base64_ into _ASCII_
+
+You can use these utilities from the shell or as part of a Node application
+
+## Tests
+
+```bash
+npm test
+bash ./compare.sh
+```

package/compare.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# the-user-1
+npm run compare -- \
+  --password "^49pPaRdVSNC" \
+  --hash "kOhpM7//M4I9+WcWLH7vbb/yN2+8qKyxQ0xAfI4JzamcRMdwwl7vAh0ch7UJ0JoBe9AqaAGuUJZF/mVA9EqaLQ==" \
+  --salt "YzFjMTY4MmMyMWE4MjFkYjRhNWE5YjJmNDY0OTUzM2Q=" \
+  --iterations 32768 \
+  --digest sha512
+
+# the-user-2
+npm run compare -- \
+  --password "S0uSaC&FzDOO" \
+  --hash "BrtOel2qy5HrYWn45jBKf5b3HUKdVeQfIj1ljhGxQ/SiWsmMMuOl756H4MXkMOnVJKrgFfHFy7cgFXUaSFA2ow==" \
+  --salt "MDI2OGM0MDU4NWJiOTgxNWEyYzQwN2RkYjM1YTY5YWU=" \
+  --iterations 32768 \
+  --digest sha512
+
+# the-user-3
+npm run compare -- \
+  --password "@^EJmdlkt5A#" \
+  --hash "bV76sVqsM0doKBFnaHsZQC9OgcVnF/+gzkG7HFXdD7jyQdN1PqCVijyXKMijmYQPWJohi5f7sVxhoLJ5kf8aQA==" \
+  --salt "ZDI3OTZmZWU3M2I3M2Y3MTgxMmYyNGM3MjU4NDE2NDM=" \
+  --iterations 32768 \
+  --digest sha512

package/package.json

@@ -1,6 +1,15 @@
 {
   "name": "@sequencemedia/pbkdf2",
-  "version": "1.0.5",
+  "version": "1.0.7",
+  "keywords": [
+    "pbkdf2",
+    "crypto",
+    "compare",
+    "hash",
+    "salt",
+    "ecmascript",
+    "typescript"
+  ],
   "main": "./index.mjs",
   "type": "module",
   "author": {
@@ -14,12 +23,12 @@
     "url": "git@github.com:sequencemedia/pbkdf2.git"
   },
   "scripts": {
-    "lint": "cross-env NODE_ENV=production eslint . --ext .mjs --ext .cjs",
+    "lint": "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",
+    "compare": "node scripts/compare.mjs",
+    "hash": "node scripts/hash.mjs",
+    "salt": "node scripts/salt.mjs",
     "prepare": "husky install"
   },
   "dependencies": {

package/scripts/compare.mjs

@@ -43,6 +43,6 @@ compare(password, { hash, salt, iterations, keylen, digest })
   .then((isValid) => {
     console.log(isValid ? '👍' : '👎')
   })
-  .catch(() => {
-    console.error('💩')
+  .catch(({ message }) => {
+    console.error(`💩 - ${message}`)
   })

package/scripts/hash.mjs

@@ -40,6 +40,6 @@ hash(password, { salt, iterations, keylen, digest })
   .then((buffer) => {
     console.log(fromBufferToBase64(buffer))
   })
-  .catch(() => {
-    console.error('💩')
+  .catch(({ message }) => {
+    console.error(`💩 - ${message}`)
   })

package/scripts/salt.mjs

@@ -13,6 +13,6 @@ salt(size)
   .then((buffer) => {
     console.log(fromBufferToBase64(buffer))
   })
-  .catch(() => {
-    console.error('💩')
+  .catch(({ message }) => {
+    console.error(`💩 - ${message}`)
   })

package/utils/common.mjs

@@ -7,7 +7,7 @@ export function fromBufferToBase64 (buffer) {
 }
 
 export function fromBase64 (string) {
-  return Buffer.from(string, 'base64').toString()
+  return Buffer.from(string, 'base64').toString('ascii')
 }
 
 export function toBase64 (string) {