Fix Docs

Author: VCNinc

README.md

@@ -5,7 +5,7 @@ Next-Generation Multi-Factor Key Derivation Function (MFKDF2)
 [![GitHub issues](https://img.shields.io/github/issues/multifactor/MFKDF)](https://github.com/multifactor/MFKDF/issues)
 [![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)](https://www.mfkdf.com/coverage)
 [![Tests](https://img.shields.io/badge/tests-100%25-brightgreen)](https://www.mfkdf.com/tests)
-[![BSD](https://img.shields.io/badge/license-BSD%25-brightgreen.svg)](https://github.com/multifactor/MFKDF/blob/main/LICENSE)
+[![BSD](https://img.shields.io/badge/license-BSD-brightgreen.svg)](https://github.com/multifactor/MFKDF/blob/main/LICENSE)
 [![GitHub tag](https://img.shields.io/github/tag/multifactor/MFKDF.svg)](https://github.com/multifactor/MFKDF/tags)
 [![GitHub release](https://img.shields.io/github/release/multifactor/MFKDF.svg)](https://github.com/multifactor/MFKDF/releases)
 [![NPM release](https://img.shields.io/npm/v/mfkdf.svg)](https://www.npmjs.com/package/mfkdf)

mfkdf.js

@@ -4463,7 +4463,7 @@ exports.callbackify = callbackify;
 const sss = __webpack_require__(9381)
 
 /**
- * K-of-N secret recovery. Uses bitwise XOR for k=n, Shamir's Secret Sharing for 1 < K < N, and direct secret sharing for K = 1.
+ * K-of-N secret recovery. Uses direct secret sharing for K = 1, and Shamir's Secret Sharing for K > 1.
  *
  * @example
  * // share secret using 2-of-3 shares
@@ -30085,7 +30085,7 @@ MFKDFDerivedKey.prototype.persistFactor = persistence.persistFactor
 
 // Strengthening Functions
 const strengthening = __webpack_require__(7280)
-MFKDFDerivedKey.prototype.strenthen = strengthening.strenthen
+MFKDFDerivedKey.prototype.strengthen = strengthening.strengthen
 
 // MFDPG Functions
 const mfdpg = __webpack_require__(7214)
@@ -34911,19 +34911,8 @@ const validate = (__webpack_require__(4685).validate)
  * @param {MFKDFFactor} factor - Base factor used to derive this key
  * @param {Object} [options] - Configuration options
  * @param {string} [options.id] - Unique identifier for this key; random UUIDv4 generated by default
- * @param {number} [options.size=32] - Size of derived key, in bytes
  * @param {number} [options.threshold] - Number of factors required to derive key; factors.length by default (all required)
  * @param {Buffer} [options.salt] - Cryptographic salt; generated via secure PRG by default (recommended)
- * @param {string} [options.kdf='argon2id'] - KDF algorithm to use; pbkdf2, bcrypt, scrypt, argon2i, argon2d, or argon2id
- * @param {number} [options.pbkdf2rounds=310000] - Number of rounds to use if using pbkdf2
- * @param {string} [options.pbkdf2digest='sha256'] - Hash function to use if using pbkdf2; sha1, sha256, sha384, or sha512
- * @param {number} [options.bcryptrounds=10] - Number of rounds to use if using bcrypt
- * @param {number} [options.scryptcost=16384] - Iterations count (N) to use if using scrypt
- * @param {number} [options.scryptblocksize=8] - Block size (r) to use if using scrypt
- * @param {number} [options.scryptparallelism=1] - Parallelism factor (p) to use if using scrypt
- * @param {number} [options.argon2time=2] - Iterations to use if using argon2
- * @param {number} [options.argon2mem=24576] - Memory to use if using argon2
- * @param {number} [options.argon2parallelism=1] - Parallelism to use if using argon2
  * @returns {MFKDFDerivedKey} A multi-factor derived key object
  * @author Vivek Nair (https://nair.me) <vivek@nair.me>
  * @since 0.16.0
@@ -35460,19 +35449,8 @@ const setupKey = (__webpack_require__(7073).key)
  * @param {Array.<MFKDFFactor>} factors - Array of factors used to derive this key
  * @param {Object} [options] - Configuration options
  * @param {string} [options.id='stack'] - Unique identifier for this factor
- * @param {number} [options.size=32] - Size of derived key, in bytes
  * @param {number} [options.threshold] - Number of factors required to derive key; factors.length by default (all required)
  * @param {Buffer} [options.salt] - Cryptographic salt; generated via secure PRG by default (recommended)
- * @param {string} [options.kdf='pbkdf2'] - KDF algorithm to use; pbkdf2, bcrypt, scrypt, argon2i, argon2d, or argon2id
- * @param {number} [options.pbkdf2rounds=1] - Number of rounds to use if using pbkdf2
- * @param {string} [options.pbkdf2digest='sha256'] - Hash function to use if using pbkdf2; sha1, sha256, sha384, or sha512
- * @param {number} [options.bcryptrounds=10] - Number of rounds to use if using bcrypt
- * @param {number} [options.scryptcost=16384] - Iterations count (N) to use if using scrypt
- * @param {number} [options.scryptblocksize=8] - Block size (r) to use if using scrypt
- * @param {number} [options.scryptparallelism=1] - Parallelism factor (p) to use if using scrypt
- * @param {number} [options.argon2time=2] - Iterations to use if using argon2
- * @param {number} [options.argon2mem=24576] -Mmemory to use if using argon2
- * @param {number} [options.argon2parallelism=1] - Parallelism to use if using argon2
  * @returns {MFKDFFactor} MFKDF factor information
  * @author Vivek Nair (https://nair.me) <vivek@nair.me>
  * @since 0.15.0
@@ -51271,8 +51249,8 @@ module.exports = supportsStandardArguments ? isStandardArguments : isLegacyArgum
  * @author Vivek Nair (https://nair.me) <vivek@nair.me>
  */
 
-const { encrypt } = __webpack_require__(9208)
-const { argon2id } = __webpack_require__(964)
+const { encrypt } = __webpack_require__(9208);
+const { argon2id } = __webpack_require__(964);
 
 /**
  * Update the time and/or memory cost of an existing multi-factor derived key.
@@ -51307,32 +51285,32 @@ const { argon2id } = __webpack_require__(964)
  * @memberOf MFKDFDerivedKey
  * @async
  */
-async function strenthen (time = 0, memory = 0) {
-  if (typeof time !== 'number' || time < 0 || !Number.isInteger(time)) {
-    throw new TypeError('time must be a non-negative integer')
+async function strengthen(time = 0, memory = 0) {
+  if (typeof time !== "number" || time < 0 || !Number.isInteger(time)) {
+    throw new TypeError("time must be a non-negative integer");
   }
-  if (typeof memory !== 'number' || memory < 0 || !Number.isInteger(memory)) {
-    throw new TypeError('memory must be a non-negative integer')
+  if (typeof memory !== "number" || memory < 0 || !Number.isInteger(memory)) {
+    throw new TypeError("memory must be a non-negative integer");
   }
 
-  this.policy.time = time
-  this.policy.memory = memory
+  this.policy.time = time;
+  this.policy.memory = memory;
 
   const kek = Buffer.from(
     await argon2id({
       password: this.secret,
-      salt: Buffer.from(this.policy.salt, 'base64'),
+      salt: Buffer.from(this.policy.salt, "base64"),
       hashLength: 32,
       parallelism: 1,
       iterations: 2 + Math.max(0, time),
       memorySize: 19456 + Math.max(0, memory),
-      outputType: 'binary'
+      outputType: "binary",
     })
-  )
+  );
 
-  this.policy.key = encrypt(this.key, kek).toString('base64')
+  this.policy.key = encrypt(this.key, kek).toString("base64");
 }
-module.exports.strenthen = strenthen
+module.exports.strengthen = strengthen;
 
 
 /***/ }),
@@ -52955,7 +52933,7 @@ module.exports = function xor (a, b) {
 const sss = __webpack_require__(9381)
 
 /**
- * K-of-N secret combining. Uses bitwise XOR for k=n, Shamir's Secret Sharing for 1 < K < N, and direct secret sharing for K = 1.
+ * K-of-N secret combining. Uses direct secret sharing for K = 1, and Shamir's Secret Sharing for K > 1.
  *
  * @example
  * // share secret using 2-of-3 shares
@@ -67319,7 +67297,7 @@ module.exports = RangeError;
 const sss = __webpack_require__(9381)
 
 /**
- * K-of-N secret sharing. Uses bitwise XOR for k=n, Shamir's Secret Sharing for 1 < K < N, and direct secret sharing for K = 1.
+ * K-of-N secret sharing. Uses direct secret sharing for K = 1, and Shamir's Secret Sharing for K > 1.
  *
  * @example
  * // share secret using 2-of-3 shares

mfkdf.min.js

@@ -53,7 +53,7 @@ MFKDFDerivedKey.prototype.persistFactor = persistence.persistFactor
 
 // Strengthening Functions
 const strengthening = require('./strengthening')
-MFKDFDerivedKey.prototype.strenthen = strengthening.strenthen
+MFKDFDerivedKey.prototype.strengthen = strengthening.strengthen
 
 // MFDPG Functions
 const mfdpg = require('./mfdpg')

src/classes/MFKDFDerivedKey/index.js

@@ -8,8 +8,8 @@
  * @author Vivek Nair (https://nair.me) <vivek@nair.me>
  */
 
-const { encrypt } = require('../../crypt')
-const { argon2id } = require('hash-wasm')
+const { encrypt } = require("../../crypt");
+const { argon2id } = require("hash-wasm");
 
 /**
  * Update the time and/or memory cost of an existing multi-factor derived key.
@@ -44,29 +44,29 @@ const { argon2id } = require('hash-wasm')
  * @memberOf MFKDFDerivedKey
  * @async
  */
-async function strenthen (time = 0, memory = 0) {
-  if (typeof time !== 'number' || time < 0 || !Number.isInteger(time)) {
-    throw new TypeError('time must be a non-negative integer')
+async function strengthen(time = 0, memory = 0) {
+  if (typeof time !== "number" || time < 0 || !Number.isInteger(time)) {
+    throw new TypeError("time must be a non-negative integer");
   }
-  if (typeof memory !== 'number' || memory < 0 || !Number.isInteger(memory)) {
-    throw new TypeError('memory must be a non-negative integer')
+  if (typeof memory !== "number" || memory < 0 || !Number.isInteger(memory)) {
+    throw new TypeError("memory must be a non-negative integer");
   }
 
-  this.policy.time = time
-  this.policy.memory = memory
+  this.policy.time = time;
+  this.policy.memory = memory;
 
   const kek = Buffer.from(
     await argon2id({
       password: this.secret,
-      salt: Buffer.from(this.policy.salt, 'base64'),
+      salt: Buffer.from(this.policy.salt, "base64"),
       hashLength: 32,
       parallelism: 1,
       iterations: 2 + Math.max(0, time),
       memorySize: 19456 + Math.max(0, memory),
-      outputType: 'binary'
+      outputType: "binary",
     })
-  )
+  );
 
-  this.policy.key = encrypt(this.key, kek).toString('base64')
+  this.policy.key = encrypt(this.key, kek).toString("base64");
 }
-module.exports.strenthen = strenthen
+module.exports.strengthen = strengthen;

src/classes/MFKDFDerivedKey/strengthening.js

@@ -38,19 +38,8 @@ const validate = require('./validate').validate
  * @param {MFKDFFactor} factor - Base factor used to derive this key
  * @param {Object} [options] - Configuration options
  * @param {string} [options.id] - Unique identifier for this key; random UUIDv4 generated by default
- * @param {number} [options.size=32] - Size of derived key, in bytes
  * @param {number} [options.threshold] - Number of factors required to derive key; factors.length by default (all required)
  * @param {Buffer} [options.salt] - Cryptographic salt; generated via secure PRG by default (recommended)
- * @param {string} [options.kdf='argon2id'] - KDF algorithm to use; pbkdf2, bcrypt, scrypt, argon2i, argon2d, or argon2id
- * @param {number} [options.pbkdf2rounds=310000] - Number of rounds to use if using pbkdf2
- * @param {string} [options.pbkdf2digest='sha256'] - Hash function to use if using pbkdf2; sha1, sha256, sha384, or sha512
- * @param {number} [options.bcryptrounds=10] - Number of rounds to use if using bcrypt
- * @param {number} [options.scryptcost=16384] - Iterations count (N) to use if using scrypt
- * @param {number} [options.scryptblocksize=8] - Block size (r) to use if using scrypt
- * @param {number} [options.scryptparallelism=1] - Parallelism factor (p) to use if using scrypt
- * @param {number} [options.argon2time=2] - Iterations to use if using argon2
- * @param {number} [options.argon2mem=24576] - Memory to use if using argon2
- * @param {number} [options.argon2parallelism=1] - Parallelism to use if using argon2
  * @returns {MFKDFDerivedKey} A multi-factor derived key object
  * @author Vivek Nair (https://nair.me) <vivek@nair.me>
  * @since 0.16.0

src/policy/setup.js

@@ -10,7 +10,7 @@
 const sss = require('./library')
 
 /**
- * K-of-N secret combining. Uses bitwise XOR for k=n, Shamir's Secret Sharing for 1 < K < N, and direct secret sharing for K = 1.
+ * K-of-N secret combining. Uses direct secret sharing for K = 1, and Shamir's Secret Sharing for K > 1.
  *
  * @example
  * // share secret using 2-of-3 shares

src/secrets/combine.js

@@ -10,7 +10,7 @@
 const sss = require('./library')
 
 /**
- * K-of-N secret recovery. Uses bitwise XOR for k=n, Shamir's Secret Sharing for 1 < K < N, and direct secret sharing for K = 1.
+ * K-of-N secret recovery. Uses direct secret sharing for K = 1, and Shamir's Secret Sharing for K > 1.
  *
  * @example
  * // share secret using 2-of-3 shares

src/secrets/recover.js

@@ -10,7 +10,7 @@
 const sss = require('./library')
 
 /**
- * K-of-N secret sharing. Uses bitwise XOR for k=n, Shamir's Secret Sharing for 1 < K < N, and direct secret sharing for K = 1.
+ * K-of-N secret sharing. Uses direct secret sharing for K = 1, and Shamir's Secret Sharing for K > 1.
  *
  * @example
  * // share secret using 2-of-3 shares

src/secrets/share.js

@@ -42,19 +42,8 @@ const setupKey = require('../key').key
  * @param {Array.<MFKDFFactor>} factors - Array of factors used to derive this key
  * @param {Object} [options] - Configuration options
  * @param {string} [options.id='stack'] - Unique identifier for this factor
- * @param {number} [options.size=32] - Size of derived key, in bytes
  * @param {number} [options.threshold] - Number of factors required to derive key; factors.length by default (all required)
  * @param {Buffer} [options.salt] - Cryptographic salt; generated via secure PRG by default (recommended)
- * @param {string} [options.kdf='pbkdf2'] - KDF algorithm to use; pbkdf2, bcrypt, scrypt, argon2i, argon2d, or argon2id
- * @param {number} [options.pbkdf2rounds=1] - Number of rounds to use if using pbkdf2
- * @param {string} [options.pbkdf2digest='sha256'] - Hash function to use if using pbkdf2; sha1, sha256, sha384, or sha512
- * @param {number} [options.bcryptrounds=10] - Number of rounds to use if using bcrypt
- * @param {number} [options.scryptcost=16384] - Iterations count (N) to use if using scrypt
- * @param {number} [options.scryptblocksize=8] - Block size (r) to use if using scrypt
- * @param {number} [options.scryptparallelism=1] - Parallelism factor (p) to use if using scrypt
- * @param {number} [options.argon2time=2] - Iterations to use if using argon2
- * @param {number} [options.argon2mem=24576] -Mmemory to use if using argon2
- * @param {number} [options.argon2parallelism=1] - Parallelism to use if using argon2
  * @returns {MFKDFFactor} MFKDF factor information
  * @author Vivek Nair (https://nair.me) <vivek@nair.me>
  * @since 0.15.0