Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AttestationTokenValidationOptions

Package version

Options used to validate attestation tokens.

typeparam

if provided, specifies the expected issuer of the attestation token.

typeparam

if true, validate the expiration time in the token.

typeparam

if true, validate the "not before" time in the token.

typeparam

if true, validate the token.

typeparam

the validation time slack in the time based validations.

remarks

If validateToken, validateNotBeforeTime, or validateExpirationTime are not provided, they are all assumed to be 'true'.

Hierarchy

  • AttestationTokenValidationOptions

Index

Properties

Optional expectedIssuer

expectedIssuer: undefined | string

The expected issuer for the AttestationToken. Only checked if validateIssuer is set.

Optional timeValidationSlack

timeValidationSlack: undefined | number

Tolerance time (in seconds) used to accound for clock drift between the local machine and the server creating the token.

Optional validateAttestationToken

validateAttestationToken: undefined | ((token: AttestationToken, signer?: AttestationSigner) => string[] | undefined)

Validation function which allows developers to provide their own validation functionality for the attestation token. This can be used to perform additional validations for signing certificate in AttestationSigner.

param

Attestation Token to validate.

param

Signing Certificate which validated the token.

remarks

If there is a problem with token validation, the validateAttestationCallback function will return an array of strings indicating the set of problems found in the token.

returns

an array of problems in the token, or undefined if there are no problems.

Optional validateExpirationTime

validateExpirationTime: undefined | false | true

If true, validate the expiration time for the token.

Optional validateIssuer

validateIssuer: undefined | false | true

If true, validate the issuer of the token.

Optional validateNotBeforeTime

validateNotBeforeTime: undefined | false | true

If true, validate the "not before" time for the token.

Optional validateToken

validateToken: undefined | false | true

If true, validate the attestation token, if false, skip validation.

Generated using TypeDoc