Skip to content

client-certificate-auth API Reference


client-certificate-auth API Reference / extractor / ExtractionFailure

Interface: ExtractionFailure ​

Defined in: extractor.js:135

Properties ​

certificate ​

certificate: null

Defined in: extractor.js:137

Always null on this arm of the union


reason ​

reason: ExtractionFailureReason

Defined in: extractor.js:138

Rejection reason code

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, or unreadable
  • 'certificate_not_retrievable' - Socket authorized but getPeerCertificate() is missing, returned empty, or threw

success ​

success: false

Defined in: extractor.js:136

Always false on this arm of the union

Released under the MIT License.