Class KeyChain Abstract

Storage of own private keys and certificates.

Hierarchy

KeyChain

Index

Constructors

constructor

Properties

needJwk

Methods

Constructors

constructor

new KeyChain(): KeyChain

Returns KeyChain

Properties

Readonly Abstract needJwk

needJwk: boolean

Return whether insertKey function expects JsonWebKey instead of CryptoKey.

Methods

Abstract deleteCert

deleteCert(name: Name): Promise<void>

- Defined in packages/keychain/src/store/keychain.ts:48
Delete certificate.

Parameters
- name: Name
Returns Promise<void>

Abstract deleteKey

deleteKey(name: Name): Promise<void>

- Defined in packages/keychain/src/store/keychain.ts:36
Delete key pair and associated certificates.

Parameters
- name: Name
Returns Promise<void>

Abstract getCert

getCert(name: Name): Promise<Certificate>

- Defined in packages/keychain/src/store/keychain.ts:42
Retrieve certificate by cert name.

Parameters
- name: Name
Returns Promise<Certificate>

getKey

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

- Defined in packages/keychain/src/store/keychain.ts:27
Retrieve key by key name.

Type parameters
- K: keyof KeyChain.KeyPair<any>
Parameters
- name: Name
- typ: K
  
  "signer", "verifier", etc.
Returns Promise<KeyChain.KeyPair<any>[K]>

Abstract getKeyPair

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

- Defined in packages/keychain/src/store/keychain.ts:21
Retrieve key pair by key name.

Parameters
- name: Name
Returns Promise<KeyChain.KeyPair<any>>

getSigner

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

- Defined in packages/keychain/src/store/keychain.ts:64
Create a signer from keys and certificates in the KeyChain.

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.

Parameters
- name: Name
  
  subject name, key name, or certificate name.
- __namedParameters: GetSignerOptions = {}
Returns Promise<Signer>

Abstract insertCert

insertCert(cert: Certificate): Promise<void>

- Defined in packages/keychain/src/store/keychain.ts:45
Insert certificate; key must exist.

Parameters
- cert: Certificate
Returns Promise<void>

Abstract insertKey

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

- Defined in packages/keychain/src/store/keychain.ts:33
Insert key pair.

Parameters
- name: Name
- stored: StoredKey
Returns Promise<void>

Abstract listCerts

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

- Defined in packages/keychain/src/store/keychain.ts:39
List certificates, filtered by name prefix.

Parameters
- Optional prefix: Name
Returns Promise<Name[]>

Abstract listKeys

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

- Defined in packages/keychain/src/store/keychain.ts:18
List keys, filtered by name prefix.

Parameters
- Optional prefix: Name
Returns Promise<Name[]>

Generated using TypeDoc