Skip to content

client-certificate-auth API Reference


client-certificate-auth API Reference / extractor / ExtractionResult

Type Alias: ExtractionResult

ExtractionResult = object

Defined in: extractor.d.ts:61

Properties

certificate

certificate: PeerCertificate | null

Defined in: extractor.d.ts:69

  • Extracted certificate (null on failure)

reason

reason: string | null

Defined in: extractor.d.ts:79

  • Rejection reason code (null on success)

Rejection reasons:

  • 'verification_header_mismatch' - Proxy verify header didn't match expected value
  • 'header_missing_or_malformed' - Header extraction failed and no fallback configured
  • 'socket_not_authorized' - Socket not authorized for TLS client cert
  • 'certificate_not_retrievable' - Socket authorized but getPeerCertificate() returned empty

success

success: boolean

Defined in: extractor.d.ts:65

  • Whether extraction succeeded

Released under the MIT License.