Class KeyChainAbstract

constructor

• new KeyChain(): KeyChain

• Returns KeyChain

Abstract ReadonlyneedJwk

AbstractdeleteCert

• deleteCert(name: Name): Promise<void>

• Delete certificate.

  Parameters

  • name: Name

  Returns Promise<void>

AbstractdeleteKey

• deleteKey(name: Name): Promise<void>

• Delete key pair and associated certificates.

  Parameters

  • name: Name

  Returns Promise<void>

AbstractgetCert

• getCert(name: Name): Promise<Certificate>

• Retrieve certificate by cert name.

  Parameters

  • name: Name

  Returns Promise<Certificate>

getKey

• getKey<K extends keyof KeyChain.KeyPair<any>>(
      name: Name,
      typ: K,
  ): 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]>

AbstractgetKeyPair

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

• Retrieve key pair by key name.

  Parameters

  • name: Name

  Returns Promise<KeyChain.KeyPair<any>>

getSigner

• getSigner(name: Name, __namedParameters?: GetSignerOptions): 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>

  Remarks

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

  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.

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

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

AbstractinsertCert

• insertCert(cert: Certificate): Promise<void>

• Insert certificate.

  Parameters

  • cert: Certificate

  Returns Promise<void>

  Remarks

  Corresponding key must exist.

AbstractinsertKey

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

• Insert key pair.

  Parameters

  • name: Name
  • stored: StoredKey

  Returns Promise<void>

AbstractlistCerts

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

• List certificates, filtered by name prefix.

  Parameters

  • Optionalprefix: Name

  Returns Promise<Name[]>

AbstractlistKeys

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

• List keys, filtered by name prefix.

  Parameters

  • Optionalprefix: Name

  Returns Promise<Name[]>