@sequencemedia/pbkdf2 1.0.6 → 1.0.8

package/README.md

@@ -1,13 +1,91 @@
 # @sequencemedia/pbkdf2
 
-A password can be validated against a `hash` and `salt` (and the number of `iterations` that were used to compute it)
+## Compare a given password to a `hash` and `salt`
 
-Both the `hash` and `salt` are expected from the command line to be strings in _Base64_ format
+Exposes the crypto `pbkdf2` utilities as `async` functions for Node and the shell
+
+ES functions are exported from the package root alongside a TS definition
+
+## Password validation by `hash` and `salt` comparison
+
+A password can be compared with a `hash` and `salt` (and the number of `iterations` that were used to compute it) to determine whether it is valid
+
+The ES functions expect the same argument types as the underlying Node utilities
+
+- The `hash` is a `Buffer`
+- The `salt` is a `String`
+- `iterations` is a `Number`
+
+Etc.
+
+### `compare`
+
+The password is expected as the first argument, while the others are fields on a params object
+
+```javascript
+const isValid = await compare(password, { hash, salt, iterations, keylen, digest })
+```
+
+### `hash`
+
+As with `compare`, the password is expected as the first argument, while the others are fields on a params object (except for `hash` which can of course be omitted)
+
+```javascript
+const value = await hash(password, { salt, iterations, keylen, digest })
+```
+
+### `salt`
+
+An `async` wrapper around `crypto.randomBytes` to _generate_ a salt from the salt size
+
+```javascript
+const value = await salt(size)
+```
+## In the shell
+
+Scripts are exposed to `npm` in the package and each script can of course be invoked from the command line directly in the shell
+
+```json
+{
+  "compare": "node scripts/compare.mjs",
+  "hash": "node scripts/hash.mjs",
+  "salt": "node scripts/salt.mjs"
+}
+```
+
+Where required, both the `hash` and `salt` arguments are expected from the command line to be strings in _Base64_ format. Both `iterations` and `keylen` are coerced from strings to numbers
+
+```bash
+npm run compare -- \
+  --password <PASSWORD> \
+  --hash <HASH> \
+  --salt <SALT> \
+  --keylen <KEY LENGTH> \
+  --iterations <ITERATIONS> \
+  --digest <DIGEST>
+```
+
+```bash
+./scripts/compare.mjs \
+  --password <PASSWORD> \
+  --hash <HASH> \
+  --salt <SALT> \
+  --keylen <KEY LENGTH> \
+  --iterations <ITERATIONS> \
+  --digest <DIGEST>
+```
+
+Etc.
 
 - The `hash` is decoded to a `Buffer`
-- The `salt` is transformed from _Base64_ into _ASCII_
+- The `salt` is transformed from a _Base64_ into an _ASCII_ `String`
+
+## Tests
 
 ```bash
 npm test
-bash ./compare.sh
+```
+
+```bash
+./compare.sh
 ```

package/package.json

@@ -1,6 +1,15 @@
 {
   "name": "@sequencemedia/pbkdf2",
-  "version": "1.0.6",
+  "version": "1.0.8",
+  "keywords": [
+    "pbkdf2",
+    "crypto",
+    "compare",
+    "hash",
+    "salt",
+    "ecmascript",
+    "typescript"
+  ],
   "main": "./index.mjs",
   "type": "module",
   "author": {