Class KeyChainAbstract

constructor

• new KeyChain(): KeyChain

• Returns KeyChain

Abstract Readonly needJwk

Abstract deleteCert

• deleteCert(name): Promise<void>

• Delete certificate.

  Parameters

  • name: Name

  Returns Promise<void>

Abstract deleteKey

• deleteKey(name): Promise<void>

• Delete key pair and associated certificates.

  Parameters

  • name: Name

  Returns Promise<void>

Abstract getCert

• getCert(name): Promise<Certificate>

• Retrieve certificate by cert name.

  Parameters

  • name: Name

  Returns Promise<Certificate>

getKey

• getKey<K>(name, typ): Promise<KeyChain.KeyPair<any>[K]>

• Retrieve key by key name.

  Type Parameters

  • K extends keyof KeyChain.KeyPair<any>

  Parameters

  • name: Name

  • typ: K

    "signer", "verifier", etc.

  Returns Promise<KeyChain.KeyPair<any>[K]>

Abstract getKeyPair

• getKeyPair(name): Promise<KeyChain.KeyPair<any>>

• Retrieve key pair by key name.

  Parameters

  • name: Name

  Returns Promise<KeyChain.KeyPair<any>>

getSigner

• getSigner(name, __namedParameters?): Promise<Signer>

• Create a signer from keys and certificates in the KeyChain.

  Parameters

  • name: Name

    subject name, key name, or certificate name.

  • __namedParameters: GetSignerOptions = {}

  Returns Promise<Signer>

  Li

  If name is a certificate name, sign with the corresponding private key, and use the specified certificate name as KeyLocator.

  Li

  If name is a key name, sign with the specified private key. If a non-self-signed certificate exists for this key, use the certificate name as KeyLocator. Otherwise, use the key name as KeyLocator.

  Li

  If name is neither certificate name nor key name, it is interpreted as a subject name. A non-self-signed certificate of this subject name is preferred. If such a certificate does not exist, use any key of this subject name.

  Li

  If prefixMatch is true, name can also be interpreted as a prefix of the subject name.

Abstract insertCert

• insertCert(cert): Promise<void>

• Insert certificate; key must exist.

  Parameters

  • cert: Certificate

  Returns Promise<void>

Abstract insertKey

• insertKey(name, stored): Promise<void>

• Insert key pair.

  Parameters

  • name: Name

  • stored: StoredKey

  Returns Promise<void>

Abstract listCerts

• listCerts(prefix?): Promise<Name[]>

• List certificates, filtered by name prefix.

  Parameters

  • Optional prefix: Name

  Returns Promise<Name[]>

Abstract listKeys

• listKeys(prefix?): Promise<Name[]>

• List keys, filtered by name prefix.

  Parameters

  • Optional prefix: Name

  Returns Promise<Name[]>