Class ServerPinLikeChallenge<State>`Abstract`

Base of a challenge where client submits a server-generated pin code.

Type Parameters

State extends ServerPinLikeChallenge.State = ServerPinLikeChallenge.State

Hierarchy

ServerPinLikeChallenge
- ServerEmailChallenge
- ServerPinChallenge

Implements

ServerChallenge<State>

Index

Constructors

Properties

challengeId retryLimit timeLimit

Methods

Constructors

constructor

new ServerPinLikeChallenge<State>(): ServerPinLikeChallenge<State>
Type Parameters
- State extends ServerPinLikeChallenge.State<State> = ServerPinLikeChallenge.State
Returns ServerPinLikeChallenge<State>

Properties

`Readonly` `Abstract` challengeId

challengeId: string

Challenge module identifier.

`Readonly` `Abstract` retryLimit

retryLimit: number

Retry limit, including the initial attempt.

`Readonly` `Abstract` timeLimit

timeLimit: number

Time limit (millis).

Methods

process

process(request: ChallengeRequest, context: ServerChallengeContext<State>): Promise<ServerChallengeResponse>
Process selection or continuation of the challenge.
Parameters
- request: ChallengeRequest
- context: ServerChallengeContext<State>
Returns Promise<ServerChallengeResponse>
Implementation of ServerChallenge.process
- Defined in packages/ndncert/src/server/pin-like-challenge.ts:25

`Protected` `Abstract` start

start(request: ChallengeRequest, context: ServerChallengeContext<State>): Promise<ServerChallengeResponse | State>
Validate a new request, create State object, and deliver PIN to client if applicable.

Returns
a State to continue the challenge, or a ServerChallengeResponse to fail the challenge.
Parameters
- request: ChallengeRequest
  
  the CHALLENGE request packet.
- context: ServerChallengeContext<State>
  
  the challenge context, which contains the certificate request.
Returns Promise<ServerChallengeResponse | State>
- Defined in packages/ndncert/src/server/pin-like-challenge.ts:23

Generated using TypeDoc