JwsConfig

Defined in: packages/gateway/src/policies/auth/jws.ts:23

Configuration for the jws policy.

Extends

• PolicyConfig

Properties

forwardHeaderName?

optional forwardHeaderName?: string

Defined in: packages/gateway/src/policies/auth/jws.ts:35

Header name for forwarded payload. Default: “X-JWS-Payload”

---

forwardPayload?

optional forwardPayload?: boolean

Defined in: packages/gateway/src/policies/auth/jws.ts:33

Whether to forward the verified payload as a header. Default: false

---

headerName?

optional headerName?: string

Defined in: packages/gateway/src/policies/auth/jws.ts:29

Header containing the JWS. Default: “X-JWS-Signature”

---

jwksCacheTtlMs?

optional jwksCacheTtlMs?: number

Defined in: packages/gateway/src/policies/auth/jws.ts:37

JWKS cache TTL in ms. Default: 300000

---

jwksTimeoutMs?

optional jwksTimeoutMs?: number

Defined in: packages/gateway/src/policies/auth/jws.ts:39

JWKS fetch timeout in milliseconds. Default: 10000 (10 seconds).

---

jwksUrl?

optional jwksUrl?: string

Defined in: packages/gateway/src/policies/auth/jws.ts:27

JWKS endpoint for RSA verification

---

payloadSource?

optional payloadSource?: "body" | "embedded"

Defined in: packages/gateway/src/policies/auth/jws.ts:31

Where the payload comes from for detached JWS. Default: “embedded”

---

secret?

optional secret?: string

Defined in: packages/gateway/src/policies/auth/jws.ts:25

HMAC secret for verification

---

skip?

optional skip?: (c) => boolean | Promise<boolean>

Defined in: packages/gateway/src/policies/types.ts:90

Skip this policy when condition returns true

Parameters

c

unknown

Returns

boolean | Promise<boolean>

Inherited from

PolicyConfig.skip