Module: keyring/keyring

keyring/keyring

The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage.
Source:

Requires

Classes

Keyring

Methods

<inner> checkForIdentityAndKeyTypeMatch(keys, identityFunction, identityInput, keyType) → {Array.<module:key~Key>}

searches all public keys in the keyring matching the address or address part of the user ids
Parameters:
Name Type Description
keys Array.<module:key~Key> array of keys to search
identityFunction module:keyring/keyring.checkCallback callback function which checks for a match
identityInput String input to check against
keyType module:enums.packet packet types of keys to check
Source:
Returns:
array of keys which match
Type
Array.<module:key~Key>

<inner> emailCheck(email, key) → {Boolean}

Checks a key to see if it matches the specified email address
Parameters:
Name Type Description
email String email address to search for
key module:key~Key The key to be checked.
Source:
Returns:
True if the email address is defined in the specified key
Type
Boolean

<inner> idCheck(id, key) → {Boolean}

Checks a key to see if it matches the specified keyid
Parameters:
Name Type Description
id String hex string keyid to search for
key module:key~Key the key to be checked.
Source:
Returns:
true if the email address is defined in the specified key
Type
Boolean

Type Definitions

checkCallback(input, key) → {Boolean}

Callback to check if a key matches the input
Parameters:
Name Type Description
input String input to search for
key module:key~Key The key to be checked.
Source:
Returns:
True if the input matches the specified key
Type
Boolean