Class Key

Create a new Key with only public keys.

Create a new Key with public keys and allow-all permissions.

Create a new Key with private keys.

Create a new Key with private key base (derives keys from it).

Get the public keys.

Get the private keys, if available and decrypted.

Check if this key has decrypted private keys.

Check if this key has encrypted private keys.

Get the salt used for private key decorrelation.

Get the reference for this key (based on public keys tagged CBOR).

Get the signing public key.

Get the encapsulation public key.

Verify a signature against a message.

Get the endpoints set.

Get the endpoints set for mutation.

Add an endpoint.

Add a permission.

Get the nickname for this object.

Set the nickname for this object.

Get the permissions for this object.

Get a mutable reference to the permissions.

Convert to envelope with specified options.

Try to extract a Key from an envelope, optionally with password for decryption.

Get the private key envelope, optionally decrypting it.

Returns:

• undefined if no private keys
• The decrypted private key envelope if unencrypted
• The decrypted envelope if encrypted + correct password
• The encrypted envelope as-is if encrypted + no password
• Throws on wrong password

Check equality with another Key.

Get a hash key for use in Sets/Maps.

Clone this Key.