DOCS.md

MFDPG

An instance of a Multi-Factor Deterministic Password Generator (MFDPG).

Kind: global class

• MFDPG
  • new MFDPG(factors)
  • instance
    • .export() ⇒ Object
    • .revokeKey(hash)
    • .check(hash) ⇒ Boolean
    • .revoke(domain)
    • .generate(domain, regex) ⇒ string
  • static
    • .import(object, factors) ⇒ MFDPG

new MFDPG(factors)

Create a brand new MFDPG instance from a series of authentication factors.

Returns: MFDPG - The newly created MFDPG instance.

Param	Type	Description
factors	Array.<MFKDFFactor>	Set of factors for this key.

mfdpg.export() ⇒ Object

Export this MFDPG instance for future use.

Kind: instance method of MFDPG
Returns: Object - The exported public parameters from this MFDPG instance.

mfdpg.revokeKey(hash)

Directly add a hashable object to the Cuckoo filter. Removes a fictitious entry to keep the number of entries constant.

Kind: instance method of MFDPG

Param	Type	Description
hash	HashableInput	The object to hash and add to the filter.

mfdpg.check(hash) ⇒ Boolean

Check whether a hashable object is in the Cuckoo filter.

Kind: instance method of MFDPG
Returns: Boolean - Whether the hash might be in the filter.

Param	Type	Description
hash	HashableInput	The object to hash and check.

mfdpg.revoke(domain)

Add a service to the revocation list using its domain name.

Kind: instance method of MFDPG

Param	Type	Description
domain	string	The domain name of the service to revoke.

mfdpg.generate(domain, regex) ⇒ string

Generate a password for a given service.

Kind: instance method of MFDPG
Returns: string - The generated password for the target service.

Param	Type	Description
domain	string	The domain name of the service.
regex	RegExp	The password policy of the service.

MFDPG.import(object, factors) ⇒ MFDPG

Create an MFDPG instance from a previously exported instance.

Kind: static method of MFDPG
Returns: MFDPG - The imported MFDPG instance.

Param	Type	Description
object	Object	The previously exported public parameters.
factors	Object	The MFKDF factors for recovering the key.