JwsConfig
Defined in: src/policies/auth/jws.ts:14
Configuration for the jws policy.
Extends
Section titled “Extends”Properties
Section titled “Properties”forwardHeaderName?
Section titled “forwardHeaderName?”
optionalforwardHeaderName:string
Defined in: src/policies/auth/jws.ts:26
Header name for forwarded payload. Default: “X-JWS-Payload”
forwardPayload?
Section titled “forwardPayload?”
optionalforwardPayload:boolean
Defined in: src/policies/auth/jws.ts:24
Whether to forward the verified payload as a header. Default: false
headerName?
Section titled “headerName?”
optionalheaderName:string
Defined in: src/policies/auth/jws.ts:20
Header containing the JWS. Default: “X-JWS-Signature”
jwksCacheTtlMs?
Section titled “jwksCacheTtlMs?”
optionaljwksCacheTtlMs:number
Defined in: src/policies/auth/jws.ts:28
JWKS cache TTL in ms. Default: 300000
jwksTimeoutMs?
Section titled “jwksTimeoutMs?”
optionaljwksTimeoutMs:number
Defined in: src/policies/auth/jws.ts:30
JWKS fetch timeout in milliseconds. Default: 10000 (10 seconds).
jwksUrl?
Section titled “jwksUrl?”
optionaljwksUrl:string
Defined in: src/policies/auth/jws.ts:18
JWKS endpoint for RSA verification
payloadSource?
Section titled “payloadSource?”
optionalpayloadSource:"body"|"embedded"
Defined in: src/policies/auth/jws.ts:22
Where the payload comes from for detached JWS. Default: “embedded”
secret?
Section titled “secret?”
optionalsecret:string
Defined in: src/policies/auth/jws.ts:16
HMAC secret for verification
skip()?
Section titled “skip()?”
optionalskip: (c) =>boolean|Promise<boolean>
Defined in: src/policies/types.ts:33
Skip this policy when condition returns true
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”boolean | Promise<boolean>