MFKDF

derive/factors/uuid.js

  1. /**
  2.  * @file MFKDF UUID Factor Derivation
  3.  * @copyright Multifactor 2022 All Rights Reserved
  4.  *
  5.  * @description
  6.  * Derive UUID factor for multi-factor key derivation
  7.  *
  8.  * @author Vivek Nair (https://nair.me) <vivek@nair.me>
  9.  */
  10. const { validate: uuidValidate, parse: uuidParse } = require('uuid')
  12. /**
  13.  * Derive an MFKDF UUID factor
  14.  *
  15.  * @example
  16.  * // setup key with uuid factor
  17.  * const setup = await mfkdf.setup.key([
  18.  *   await mfkdf.setup.factors.uuid({ uuid: '9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d' })
  19.  * ], {size: 8})
  20.  *
  21.  * // derive key with uuid factor
  22.  * const derive = await mfkdf.derive.key(setup.policy, {
  23.  *   uuid: mfkdf.derive.factors.uuid('9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d')
  24.  * })
  25.  *
  26.  * setup.key.toString('hex') // -> 01d0c7236adf2516
  27.  * derive.key.toString('hex') // -> 01d0c7236adf2516
  28.  *
  29.  * @param {string} uuid - The uuid from which to derive an MFKDF factor
  30.  * @returns {function(config:Object): Promise<MFKDFFactor>} Async function to generate MFKDF factor information
  31.  * @author Vivek Nair (https://nair.me) <vivek@nair.me>
  32.  * @since 0.9.0
  33.  * @memberof derive.factors
  34.  */
  35. function uuid (uuid) {
  36.   if (typeof uuid !== 'string') throw new TypeError('uuid must be a string')
  37.   if (!uuidValidate(uuid)) throw new TypeError('uuid is not a valid uuid')
  39.   return async () => {
  40.     return {
  41.       type: 'uuid',
  42.       data: Buffer.from(uuidParse(uuid)),
  43.       params: async () => {
  44.         return {}
  45.       },
  46.       output: async () => {
  47.         return { uuid }
  48.       }
  49.     }
  50.   }
  51. }
  52. module.exports.uuid = uuid