VerifyHttpSignatureConfig
Defined in: src/policies/auth/verify-http-signature.ts:29
Configuration for the verifyHttpSignature policy.
Extends
Section titled “Extends”Properties
Section titled “Properties”keys:
Record<string,HttpSignatureKey>
Defined in: src/policies/auth/verify-http-signature.ts:31
Map of keyId to key material.
label?
Section titled “label?”
optionallabel:string
Defined in: src/policies/auth/verify-http-signature.ts:41
Expected signature label. Default: “sig1”.
maxAge?
Section titled “maxAge?”
optionalmaxAge:number
Defined in: src/policies/auth/verify-http-signature.ts:35
Max signature age in seconds. Default: 300 (5 min).
requiredComponents?
Section titled “requiredComponents?”
optionalrequiredComponents:string[]
Defined in: src/policies/auth/verify-http-signature.ts:33
Components that MUST be in the signature. Default: [“@method”].
signatureHeaderName?
Section titled “signatureHeaderName?”
optionalsignatureHeaderName:string
Defined in: src/policies/auth/verify-http-signature.ts:37
Signature header name. Default: “Signature”.
signatureInputHeaderName?
Section titled “signatureInputHeaderName?”
optionalsignatureInputHeaderName:string
Defined in: src/policies/auth/verify-http-signature.ts:39
Signature-Input header name. Default: “Signature-Input”.
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>