client-certificate-auth API Reference

---

client-certificate-auth API Reference / fetch / ExtractorOptions

Type Alias: ExtractorOptions

ExtractorOptions = object

Defined in: extractor.d.ts:92

Properties

certificateHeader?

optional certificateHeader?: string

Defined in: extractor.d.ts:100

• Custom header name

---

certificateSource?

optional certificateSource?: "aws-alb" | "aws-alb-verify" | "azure-app-service" | "cloudflare" | "cloudflare-rfc9440" | "envoy" | "traefik"

Defined in: extractor.d.ts:96

• Preset configuration

---

chainHeader?

optional chainHeader?: string

Defined in: extractor.d.ts:104

• Optional second header carrying the certificate chain

---

fallbackToSocket?

optional fallbackToSocket?: boolean

Defined in: extractor.d.ts:112

• Try socket if header extraction fails

---

headerEncoding?

optional headerEncoding?: "url-pem" | "url-pem-aws" | "xfcc" | "base64-der" | "rfc9440"

Defined in: extractor.d.ts:108

• Header encoding

---

includeChain?

optional includeChain?: boolean

Defined in: extractor.d.ts:116

• Include issuerCertificate chain

---

verifyHeader?

optional verifyHeader?: string

Defined in: extractor.d.ts:122

• Header name for upstream verification status. Pairs with verifyValue, and requires certificateSource or certificateHeader: verification applies to header-based extraction only.

---

verifyValue?

optional verifyValue?: string

Defined in: extractor.d.ts:126

• Expected value for successful verification. Pairs with verifyHeader.