Files
jose/docs/interfaces/types.FlattenedJWSInput.md
2023-04-12 18:54:17 +02:00

1.8 KiB

Interface: FlattenedJWSInput

💗 Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.


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

Table of contents

Properties

Properties

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.


signature

• signature: string

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


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.


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.