client-certificate-auth API Reference

---

client-certificate-auth API Reference / extractor / ExtractorOptions

Type Alias: ExtractorOptions

ExtractorOptions = object

Defined in: extractor.d.ts:81

Properties

certificateHeader?

optional certificateHeader?: string

Defined in: extractor.d.ts:89

• Custom header name

---

certificateSource?

optional certificateSource?: "aws-alb" | "envoy" | "cloudflare" | "traefik"

Defined in: extractor.d.ts:85

• Preset configuration

---

fallbackToSocket?

optional fallbackToSocket?: boolean

Defined in: extractor.d.ts:97

• Try socket if header extraction fails

---

headerEncoding?

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

Defined in: extractor.d.ts:93

• Header encoding

---

includeChain?

optional includeChain?: boolean

Defined in: extractor.d.ts:101

• Include issuerCertificate chain

---

verifyHeader?

optional verifyHeader?: string

Defined in: extractor.d.ts:105

• Header name for upstream verification status

---

verifyValue?

optional verifyValue?: string

Defined in: extractor.d.ts:109

• Expected value for successful verification