@ndn/ndncert

This package is part of NDNts, Named Data Networking libraries for the modern web.

This package partially implements NDN Certificate Management protocol v0.3 and challenges. This implementation is validated against the reference implementation using ndncert-interop.

Features:

CA profile (segmentation not supported)
PROBE command
PROBE extension for redirection
PROBE extension for privacy
certificate issuance: NEW and CHALLENGE commands
certificate renewal
certificate revocation
CA publishes issued certificates to @ndn/repo

Challenges:

PIN
email, with name assignment policy
proof of possession, with name assignment policy
"nop" (not in NDNCERT spec)

@ndn/keychain-cli package offers ndnts-keychain ndncert03-make-profile, ndnts-keychain ndncert03-show-profile, ndnts-keychain ndncert03-ca, and ndnts-keychain ndncert03-client commands that use this implementation.

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

ParameterKV

Variables

Functions

Type aliases

ParameterKV

ParameterKV: Record<string, Uint8Array>

Parameter key-value pair.

Variables

Const C

C: { CA: Component; CHALLENGE: Component; INFO: Component; NEW: Component; PROBE: Component } = ...

Type declaration

CA: Component
CHALLENGE: Component
INFO: Component
NEW: Component
PROBE: Component

Const TT

TT: { AuthenticationTag: number; CaCertificate: number; CaInfo: number; CaPrefix: number; CertRequest: number; CertToRevoke: number; Challenge: number; ChallengeStatus: number; EcdhPub: number; EncryptedPayload: number; ErrorCode: number; ErrorInfo: number; InitializationVector: number; IssuedCertName: number; MaxSuffixLength: number; MaxValidityPeriod: number; ParameterKey: number; ParameterValue: number; ProbeRedirect: number; ProbeResponse: number; RemainingTime: number; RemainingTries: number; RequestId: number; Salt: number; SelectedChallenge: number; Status: number } = ...

Type declaration

AuthenticationTag: number
CaCertificate: number
CaInfo: number
CaPrefix: number
CertRequest: number
CertToRevoke: number
Challenge: number
ChallengeStatus: number
EcdhPub: number
EncryptedPayload: number
ErrorCode: number
ErrorInfo: number
InitializationVector: number
IssuedCertName: number
MaxSuffixLength: number
MaxValidityPeriod: number
ParameterKey: number
ParameterValue: number
ProbeRedirect: number
ProbeResponse: number
RemainingTime: number
RemainingTries: number
RequestId: number
Salt: number
SelectedChallenge: number
Status: number

Functions

exportClientConf

exportClientConf(profile: CaProfile): ClientConf

- Defined in packages/ndncert/src/client/clientconf.ts:50
Export CA profile as client.conf of NDNCERT C++ implementation.

Parameters
- profile: CaProfile
Returns ClientConf

importClientConf

importClientConf(conf: ClientConf, opts?: Omit<RetrieveCaProfileOptions, "caPrefix" | "caCertFullName">): Promise<CaProfile>

- Defined in packages/ndncert/src/client/clientconf.ts:60
Retrieve CA profile according to client.conf of NDNCERT C++ implementation.

Parameters
- conf: ClientConf
- opts: Omit<RetrieveCaProfileOptions, "caPrefix" | "caCertFullName"> = {}
Returns Promise<CaProfile>

matchProbe

matchProbe(probeResponse: ProbeResponse.Fields, name: Name): boolean

- Defined in packages/ndncert/src/client/probe.ts:46
Determine if a subject name is acceptable according to probe response.

Parameters
- probeResponse: ProbeResponse.Fields
  
  probe response from CA.
- name: Name
  
  subject name, key name, or certificate name. Only the subject name portion is considered.
Returns boolean

requestCertificate

requestCertificate(__namedParameters: ClientOptions): Promise<Certificate>

- Defined in packages/ndncert/src/client/request.ts:32
Request a certificate for the given key.

Parameters
- __namedParameters: ClientOptions
Returns Promise<Certificate>

requestProbe

requestProbe(__namedParameters: ClientProbeOptions): Promise<ProbeResponse.Fields>

- Defined in packages/ndncert/src/client/probe.ts:21
Run PROBE command to determine available names.

Parameters
- __namedParameters: ClientProbeOptions
Returns Promise<ProbeResponse.Fields>

retrieveCaProfile

retrieveCaProfile(__namedParameters: RetrieveCaProfileOptions): Promise<CaProfile>

- Defined in packages/ndncert/src/client/retrieve-profile.ts:27
Retrieve and verify CA profile.

Parameters
- __namedParameters: RetrieveCaProfileOptions
Returns Promise<CaProfile>

@ndn/ndncert

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ParameterKV

Variables

Const C

Type declaration

CA: Component

CHALLENGE: Component

INFO: Component

NEW: Component

PROBE: Component

Const TT

Type declaration

AuthenticationTag: number

CaCertificate: number

CaInfo: number

CaPrefix: number

CertRequest: number

CertToRevoke: number

Challenge: number

ChallengeStatus: number

EcdhPub: number

EncryptedPayload: number

ErrorCode: number

ErrorInfo: number

InitializationVector: number

IssuedCertName: number

MaxSuffixLength: number

MaxValidityPeriod: number

ParameterKey: number

ParameterValue: number

ProbeRedirect: number

ProbeResponse: number

RemainingTime: number

RemainingTries: number

RequestId: number

Salt: number

SelectedChallenge: number

Status: number

Functions

exportClientConf

Parameters

profile: CaProfile

Returns ClientConf

importClientConf

Parameters

conf: ClientConf

opts: Omit<RetrieveCaProfileOptions, "caPrefix" | "caCertFullName"> = {}

Returns Promise<CaProfile>

matchProbe

Parameters

probeResponse: ProbeResponse.Fields

name: Name

Returns boolean

requestCertificate

Parameters

__namedParameters: ClientOptions

Returns Promise<Certificate>

requestProbe

Parameters

__namedParameters: ClientProbeOptions

Returns Promise<ProbeResponse.Fields>

retrieveCaProfile

Parameters

__namedParameters: RetrieveCaProfileOptions

Returns Promise<CaProfile>