jose/docs/interfaces/types.FlattenedJWSInput.md
2021-10-14 12:06:19 +02:00

1.4 KiB

Interface: FlattenedJWSInput

Flattened JWS definition for verify function inputs, allows payload as Uint8Array for detached signature validation.

Table of contents

Properties

Properties

header

Optional header: JWSHeaderParameters

The "header" member MUST be present and contain the value JWS Unprotected Header when the JWS Unprotected Header value is non- empty; otherwise, it MUST be absent. This value is represented as an unencoded JSON object, rather than as a string. These Header Parameter values are not integrity protected.


payload

payload: string | Uint8Array

The "payload" member MUST be present and contain the value BASE64URL(JWS Payload). When RFC7797 "b64": false is used the value passed may also be a Uint8Array.


protected

Optional protected: string

The "protected" member MUST be present and contain the value BASE64URL(UTF8(JWS Protected Header)) when the JWS Protected Header value is non-empty; otherwise, it MUST be absent. These Header Parameter values are integrity protected.


signature

signature: string

The "signature" member MUST be present and contain the value BASE64URL(JWS Signature).