All files / src/derive/factors password.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
 
 
 
 
 
 
 
 
1x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
239x
1x
 
238x
 
237x
 
237x
220x
 
 
 
216x
 
 
217x
 
 
 
 
1x
 
/**
 * @file MFKDF Password Factor Derivation
 * @copyright Multifactor, Inc. 2022–2025
 *
 * @description
 * Derive password factor for multi-factor key derivation
 *
 * @author Vivek Nair (https://nair.me) <[email protected]>
 */
const zxcvbn = require('zxcvbn')
 
/**
 * Derive an MFKDF password factor
 *
 * @example
 * // setup key with password factor
 * const setup = await mfkdf.setup.key([
 *   await mfkdf.setup.factors.password('password')
 * ])
 *
 * // derive key with password factor
 * const derive = await mfkdf.derive.key(setup.policy, {
 *   password: mfkdf.derive.factors.password('password')
 * })
 *
 * setup.key.toString('hex') // -> 01d0…2516
 * derive.key.toString('hex') // -> 01d0…2516
 *
 * @param {string} password - The password from which to derive an MFKDF factor
 * @returns {function(config:Object): Promise<MFKDFFactor>} Async function to generate MFKDF factor information
 * @author Vivek Nair (https://nair.me) <[email protected]>
 * @since 0.9.0
 * @memberof derive.factors
 */
function password (password) {
  if (typeof password !== 'string') {
    throw new TypeError('password must be a string')
  }
  if (password.length === 0) throw new RangeError('password cannot be empty')
 
  const strength = zxcvbn(password)
 
  return async () => {
    return {
      type: 'password',
      data: Buffer.from(password, 'utf-8'),
      params: async () => {
        return {}
      },
      output: async () => {
        return { strength }
      }
    }
  }
}
module.exports.password = password