Class NdnsecKeyChain

Access ndn-cxx KeyChain.

Hierarchy (View Summary)

KeyChainSerialized
- NdnsecKeyChain

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`mutex

mutex: Mutex

`Readonly`needJwk

needJwk: true

Return whether .insertKey() method expects JsonWebKey instead of CryptoKey.

Accessors

`Static`supported

get supported(): boolean
Whether current environment supports ndn-cxx KeyChain.

Returns boolean
Remarks
It checks whether ndnsec program is installed.
- Defined in ndnsec/src/keychain_node.ts:23

Methods

copyTo

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

deleteCert

deleteCert(name: Name): Promise<void>
Delete certificate.
Parameters
- name: Name
Returns Promise<void>
Inherited from KeyChainSerialized.deleteCert
- Defined in keychain/lib/store/keychain.d.ts:134

deleteKey

deleteKey(name: Name): Promise<void>
Delete key pair and associated certificates.
Parameters
- name: Name
Returns Promise<void>
Inherited from KeyChainSerialized.deleteKey
- Defined in keychain/lib/store/keychain.d.ts:126

getCert

getCert(name: Name): Promise<Certificate>
Retrieve certificate by cert name.
Parameters
- name: Name
Returns Promise<Certificate>
Inherited from KeyChainSerialized.getCert
- Defined in keychain/lib/store/keychain.d.ts:130

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]>
Inherited from KeyChainSerialized.getKey
- Defined in keychain/lib/store/keychain.d.ts:20

getKeyPair

getKeyPair(name: Name): Promise<KeyChain.KeyPair<any>>
Retrieve key pair by key name.
Parameters
- name: Name
Returns Promise<KeyChain.KeyPair<any>>
Inherited from KeyChainSerialized.getKeyPair
- Defined in keychain/lib/store/keychain.d.ts:122

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.
- Optional__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.
Inherited from KeyChainSerialized.getSigner
- Defined in keychain/lib/store/keychain.d.ts:56

insertCert

insertCert(cert: Certificate): Promise<void>
Insert certificate.
Parameters
- cert: Certificate
Returns Promise<void>
Remarks
Corresponding key must exist.
Inherited from KeyChainSerialized.insertCert
- Defined in keychain/lib/store/keychain.d.ts:132

insertKey

insertKey(name: Name, stored: StoredKey): Promise<void>
Insert key pair.
Parameters
- name: Name
- stored: StoredKey
Returns Promise<void>
Inherited from KeyChainSerialized.insertKey
- Defined in keychain/lib/store/keychain.d.ts:124

listCerts

listCerts(prefix?: Name): Promise<Name[]>
List certificates, filtered by name prefix.
Parameters
- Optionalprefix: Name
Returns Promise<Name[]>
Inherited from KeyChainSerialized.listCerts
- Defined in keychain/lib/store/keychain.d.ts:128

listKeys

listKeys(prefix?: Name): Promise<Name[]>
List keys, filtered by name prefix.
Parameters
- Optionalprefix: Name
Returns Promise<Name[]>
Inherited from KeyChainSerialized.listKeys
- Defined in keychain/lib/store/keychain.d.ts:120

`Protected`sDeleteCert

sDeleteCert(name: Name): Promise<void>
Parameters
- name: Name
Returns Promise<void>
Overrides KeyChainSerialized.sDeleteCert
- Defined in ndnsec/src/keychain_node.ts:152

`Protected`sDeleteKey

sDeleteKey(name: Name): Promise<void>
Parameters
- name: Name
Returns Promise<void>
Overrides KeyChainSerialized.sDeleteKey
- Defined in ndnsec/src/keychain_node.ts:132

`Protected`sGetCert

sGetCert(name: Name): Promise<Certificate>
Parameters
- name: Name
Returns Promise<Certificate>
Overrides KeyChainSerialized.sGetCert
- Defined in ndnsec/src/keychain_node.ts:142

`Protected`sGetKeyPair

sGetKeyPair(name: Name): Promise<KeyChain.KeyPair<any>>
Parameters
- name: Name
Returns Promise<KeyChain.KeyPair<any>>
Overrides KeyChainSerialized.sGetKeyPair
- Defined in ndnsec/src/keychain_node.ts:110

`Protected`sInsertCert

sInsertCert(cert: Certificate): Promise<void>
Parameters
- cert: Certificate
Returns Promise<void>
Overrides KeyChainSerialized.sInsertCert
- Defined in ndnsec/src/keychain_node.ts:147

`Protected`sInsertKey

sInsertKey(name: Name, stored: StoredKey): Promise<void>
Parameters
- name: Name
- stored: StoredKey
Returns Promise<void>
Overrides KeyChainSerialized.sInsertKey
- Defined in ndnsec/src/keychain_node.ts:115

`Protected`sListCerts

sListCerts(prefix: Name): Promise<Name[]>
Parameters
- prefix: Name
Returns Promise<Name[]>
Overrides KeyChainSerialized.sListCerts
- Defined in ndnsec/src/keychain_node.ts:137

`Protected`sListKeys

sListKeys(prefix: Name): Promise<Name[]>
Parameters
- prefix: Name
Returns Promise<Name[]>
Overrides KeyChainSerialized.sListKeys
- Defined in ndnsec/src/keychain_node.ts:105

Class NdnsecKeyChain

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NdnsecKeyChain

Properties

Protected Readonlymutex

ReadonlyneedJwk

Accessors

Staticsupported

Returns boolean

Remarks

Methods

copyTo

Parameters

Returns Promise<KeyChain>

deleteCert

Parameters

Returns Promise<void>

deleteKey

Parameters

Returns Promise<void>

getCert

Parameters

Returns Promise<Certificate>

getKey

Type Parameters

Parameters

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

getKeyPair

Parameters

Returns Promise<KeyChain.KeyPair<any>>

getSigner

Parameters

Returns Promise<Signer>

Remarks

insertCert

Parameters

Returns Promise<void>

Remarks

insertKey

Parameters

Returns Promise<void>

listCerts

Parameters

Returns Promise<Name[]>

listKeys

Parameters

Returns Promise<Name[]>

ProtectedsDeleteCert

Parameters

Returns Promise<void>

ProtectedsDeleteKey

Parameters

Returns Promise<void>

ProtectedsGetCert

Parameters

Returns Promise<Certificate>

ProtectedsGetKeyPair

Parameters

Returns Promise<KeyChain.KeyPair<any>>

ProtectedsInsertCert

Parameters

Returns Promise<void>

ProtectedsInsertKey

Parameters

Returns Promise<void>

ProtectedsListCerts

Parameters

Returns Promise<Name[]>

ProtectedsListKeys

Parameters

Returns Promise<Name[]>

Settings

`Protected` `Readonly`mutex

`Readonly`needJwk

`Static`supported

`Protected`sDeleteCert

`Protected`sDeleteKey

`Protected`sGetCert

`Protected`sGetKeyPair

`Protected`sInsertCert

`Protected`sInsertKey

`Protected`sListCerts

`Protected`sListKeys