Class Key

The public keys.

The private keys when held in the clear.

Whether the private keys are held in the clear.

Whether the private keys are held locked (parsed without the password).

The salt the 'privateKey' assertion carries.

The reference of the public keys.

The signing public key.

The endpoints (a copy).

The nickname; empty when there is none.

The permissions (live).

The allowed privileges (a copy).

The denied privileges (a copy).

A key from its public keys; no permissions unless private keys or permissions are given. A null privateKeys is a TypeError: absent private keys are undefined.

A public key allowed All.

The Schnorr and X25519 keys of a base, private keys included, allowed All.

The encapsulation public key.

Whether signature is the public keys' signature of message.

Adds an endpoint, as a URI or its text (a components error for text that is not a URI).

Removes an endpoint; whether it was there.

Sets (or clears, with "") the nickname.

Sets the nickname once: Duplicate when set, EmptyValue when empty.

Allows privilege.

Denies privilege.

Stops allowing privilege.

Stops denying privilege.

Empties both sets.

addAllow under the reference's Key::add_permission name.

The public keys as the subject, the private keys per privateKeys (a locked key stays locked), then 'nickname', 'endpoint's and the permissions. An unknown option is a TypeError.

A key from its envelope. A locked 'privateKey' is unlocked with the password when one is given and it fits; otherwise it is kept locked. Every failure is an XIDError: a subject or leaf of the wrong type is Cbor; a missing or repeated 'salt', a second 'nickname' or one that is not text are EnvelopeParsing; a permission that is not a known value is EnvelopeParsing, one that names no privilege is UnknownPrivilege.

The private keys as an envelope: in the clear when held so, unlocked with the password when locked (an InvalidPassword error when it does not fit), or the locked envelope itself without a password.

Same public keys, private material (in the clear or locked, with its salt), nickname, endpoints and permissions — as the reference's equality; a key parsed from an envelope that omitted its private keys is not equal to the original.

A copy: the private material shared, the endpoints and permissions copied.