Class NdnsecKeyChain

Access ndn-cxx KeyChain.

Hierarchy

KeyChain
- NdnsecKeyChain

Index

Constructors

constructor

new NdnsecKeyChain(__namedParameters?): NdnsecKeyChain
Parameters
- __namedParameters: NdnsecKeyChain.Options = {}
Returns NdnsecKeyChain
Overrides KeyChain.constructor
- Defined in packages/ndnsec/src/keychain_node.ts:16

Properties

`Readonly` needJwk

needJwk: true = true

Methods

copyTo

copyTo(dest): Promise<KeyChain>
Copy keys and certificates to another keychain.
Parameters
- dest: KeyChain
Returns Promise<KeyChain>
- Defined in packages/ndnsec/src/keychain_node.ts:58

deleteCert

deleteCert(name): Promise<void>
Parameters
- name: Name
Returns Promise<void>
Overrides KeyChain.deleteCert
- Defined in packages/ndnsec/src/keychain_node.ts:157

deleteKey

deleteKey(name): Promise<void>
Parameters
- name: Name
Returns Promise<void>
Overrides KeyChain.deleteKey
- Defined in packages/ndnsec/src/keychain_node.ts:129

getCert

getCert(name): Promise<Certificate>
Parameters
- name: Name
Returns Promise<Certificate>
Overrides KeyChain.getCert
- Defined in packages/ndnsec/src/keychain_node.ts:143

getKey

getKey<K>(name, typ): Promise<KeyPair<any>[K]>
Retrieve key by key name.
Type Parameters
- K extends keyof KeyPair<any>
Parameters
- name: Name
- typ: K
  
  "signer", "verifier", etc.
Returns Promise<KeyPair<any>[K]>
Inherited from KeyChain.getKey
- Defined in packages/keychain/lib/store/keychain.d.ts:18

getKeyPair

getKeyPair(name): Promise<KeyPair<any>>
Parameters
- name: Name
Returns Promise<KeyPair<any>>
Overrides KeyChain.getKeyPair
- Defined in packages/ndnsec/src/keychain_node.ts:103

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.
- Optional __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.
Inherited from KeyChain.getSigner
- Defined in packages/keychain/lib/store/keychain.d.ts:45

insertCert

insertCert(cert): Promise<void>
Parameters
- cert: Certificate
Returns Promise<void>
Overrides KeyChain.insertCert
- Defined in packages/ndnsec/src/keychain_node.ts:150

insertKey

insertKey(name, stored): Promise<void>
Parameters
- name: Name
- stored: StoredKey
Returns Promise<void>
Overrides KeyChain.insertKey
- Defined in packages/ndnsec/src/keychain_node.ts:110

listCerts

listCerts(prefix?): Promise<Name[]>
Parameters
- prefix: Name = ...
Returns Promise<Name[]>
Overrides KeyChain.listCerts
- Defined in packages/ndnsec/src/keychain_node.ts:136

listKeys

listKeys(prefix?): Promise<Name[]>
Parameters
- prefix: Name = ...
Returns Promise<Name[]>
Overrides KeyChain.listKeys
- Defined in packages/ndnsec/src/keychain_node.ts:96

Class NdnsecKeyChain

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: NdnsecKeyChain.Options = {}

Returns NdnsecKeyChain

Properties

Readonly needJwk

Methods

copyTo

Parameters

dest: KeyChain

Returns Promise<KeyChain>

deleteCert

Parameters

name: Name

Returns Promise<void>

deleteKey

Parameters

name: Name

Returns Promise<void>

getCert

Parameters

name: Name

Returns Promise<Certificate>

getKey

Type Parameters

K extends keyof KeyPair<any>

Parameters

name: Name

typ: K

Returns Promise<KeyPair<any>[K]>

getKeyPair

Parameters

name: Name

Returns Promise<KeyPair<any>>

getSigner

Parameters

name: Name

Optional __namedParameters: GetSignerOptions

Returns Promise<Signer>

Li

Li

Li

Li

insertCert

Parameters

cert: Certificate

Returns Promise<void>

insertKey

Parameters

name: Name

stored: StoredKey

Returns Promise<void>

listCerts

Parameters

prefix: Name = ...

Returns Promise<Name[]>

listKeys

Parameters

prefix: Name = ...

Returns Promise<Name[]>

Settings

Member Visibility

Theme

On This Page

`Readonly` needJwk

`Optional` __namedParameters: GetSignerOptions