Skip to content

ValidateCandidatePathInput ​

ValidateCandidatePathInput ​

Input for validateCandidatePath.

ts
interface ValidateCandidatePathInput extends PolicyValidationInput, InitialNameConstraintsInput {
	readonly distrustedSpkiSha256?: readonly string[];
	readonly policy?: PolicyValidationInput;
	readonly nameConstraints?: InitialNameConstraintsInput;
	readonly chain: readonly ParsedCertificate[];
	readonly anchorCertificateInChain?: boolean;
	readonly at?: Date;
	readonly purpose?: VerifyPurpose;
	readonly allowSelfSignedLeaf?: boolean;
	readonly rejectOversizedDisplayText?: boolean;
	readonly trustAnchor?: TrustAnchor;
}

Properties

  • readonly distrustedSpkiSha256?: readonly string``[] — SHA-256 hashes of complete DER SubjectPublicKeyInfo values to distrust. Supply 64 hexadecimal characters per hash (case-insensitive, no separators). Defaults to an empty list. Malformed entries throw RangeError. Applies to every path certificate and bare trust anchor, before revocation. A match returns public_key_distrusted, with the hash in details.actual.
  • readonly policy?: PolicyValidationInput — Nested policy validation overrides (takes precedence over flat fields).
  • readonly nameConstraints?: InitialNameConstraintsInput — Nested name constraint overrides (takes precedence over flat fields).
  • readonly chain: readonly ParsedCertificate[] — Pre-built certificate chain in leaf-to-root order.
  • readonly anchorCertificateInChain?: boolean — Whether the terminal certificate in chain is the trust anchor (and so is excluded from policy processing). Defaults to true, matching a chain that ends at a root certificate. Set false when a bare trust anchor verified the terminal certificate, which then must be processed as a path certificate.
  • readonly at?: Date — Validation time. Defaults to new Date().
  • readonly purpose?: VerifyPurpose — Leaf purpose constraint to enforce.
  • readonly allowSelfSignedLeaf?: boolean — When true, allows a self-signed leaf that is also the root. Defaults to false.
  • readonly rejectOversizedDisplayText?: boolean — When true, rejects a certificate whose user notice explicitText or noticeRef organization exceeds 200 characters with display_text_oversized. Defaults to false, and the parsed certificate reports such a value as oversizedExplicitText or oversizedOrganization.
  • readonly trustAnchor?: TrustAnchor — Bare anchor returned by buildCandidatePath. Required for distrust checks when anchorCertificateInChain is false.

Released under the MIT License.