keychain | NDNts

Index

Namespaces

KeyLength

Interfaces

Variables

Functions

Variables

Const CBC

CBC: Encryption<{}, GenParams> = ...

AES-CBC encryption algorithm.

Initialization Vectors must be 16 octets. During encryption, if IV is unspecified, it is randomly generated. During decryption, quality of IV is not checked.

Const CTR

CTR: Encryption<Info, GenParams> = ...

AES-CTR encryption algorithm.

Initialization Vectors must be 16 octets. During encryption, if IV is unspecified, it is constructed with two parts:

li

a 64-bit random number, generated each time a private key instance is constructed;

li

a 64-bit counter starting from zero.

During decryption, quality of IV is not automatically checked. Since the security of AES-CTR depends on having unique IVs, the application is recommended to check IVs using CounterIvChecker type.

Const GCM

GCM: Encryption<{}, GenParams> = ...

AES-GCM encryption algorithm.

Initialization Vectors must be 12 octets. During encryption, if IV is unspecified, it is constructed with two parts:

li

a 64-bit random number, generated each time a private key instance is constructed;

li

a 32-bit counter starting from zero.

During decryption, quality of IV is not automatically checked. Since the security of AES-CTR depends on having unique IVs, the application is recommended to check IVs using CounterIvChecker type.

Const ISSUER_DEFAULT

ISSUER_DEFAULT: Component = ...

Default issuerId.

Const ISSUER_SELF

ISSUER_SELF: Component = ...

Self-signed issuerId.

Const KEY

KEY: Component = ...

'KEY' component.

Const blockSize

blockSize: 16 = 16

AES block size in octets.

Functions

isCertName

isCertName(name: Name): boolean

- Defined in packages/keychain/src/naming.ts:85
Determine whether the name is a certificate name.

Parameters
- name: Name
Returns boolean

isKeyName

isKeyName(name: Name): boolean

- Defined in packages/keychain/src/naming.ts:33
Determine whether the name is a key name.

Parameters
- name: Name
Returns boolean

makeCertName

makeCertName(name: Name, opts?: Partial<Omit<CertNameFields, "subjectName">>): Name

- Defined in packages/keychain/src/naming.ts:108
Create certificate name from subject name, key name, or certificate name.

Parameters
- name: Name
  
  subject name, key name, or certificate name.
- opts: Partial<Omit<CertNameFields, "subjectName">> = {}
Returns Name

makeKeyName

makeKeyName(name: Name, opts?: Partial<Omit<KeyNameFields, "subjectName">>): Name

- Defined in packages/keychain/src/naming.ts:73
Create key name from subject name, key name, or certificate name.

Parameters
- name: Name
  
  subject name, key name, or certificate name.
- opts: Partial<Omit<KeyNameFields, "subjectName">> = {}
Returns Name

parseCertName

parseCertName(name: Name): CertNameFields

- Defined in packages/keychain/src/naming.ts:90
Parse a certificate name into fields.

Parameters
- name: Name
Returns CertNameFields

parseKeyName

parseKeyName(name: Name): KeyNameFields

- Defined in packages/keychain/src/naming.ts:38
Parse a key name into fields.

Parameters
- name: Name
Returns KeyNameFields

toKeyName

toKeyName(name: Name): Name

- Defined in packages/keychain/src/naming.ts:60
Get key name from key name or certificate name.

throws

input name is neither key name nor certificate name.

Parameters
- name: Name
Returns Name

toSubjectName

toSubjectName(name: Name): Name

- Defined in packages/keychain/src/naming.ts:26
Get subject name from subject name, key name, or certificate name.

Parameters
- name: Name
Returns Name

Index

Namespaces

Interfaces

Variables

Functions

Variables

Const CBC

Const CTR

Const GCM

Const ISSUER_DEFAULT

Const ISSUER_SELF

Const KEY

Const blockSize

Functions

isCertName

Parameters

name: Name

Returns boolean

isKeyName

Parameters

name: Name

Returns boolean

makeCertName

Parameters

name: Name

opts: Partial<Omit<CertNameFields, "subjectName">> = {}

Returns Name

makeKeyName

Parameters

name: Name

opts: Partial<Omit<KeyNameFields, "subjectName">> = {}

Returns Name

parseCertName

Parameters

name: Name

Returns CertNameFields

parseKeyName

Parameters

name: Name

Returns KeyNameFields

toKeyName

Parameters

name: Name

Returns Name

toSubjectName

Parameters

name: Name

Returns Name