File: types.FlattenedJWSInput.md

package info (click to toggle)
node-jose 4.11.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, trixie
  • size: 4,264 kB
  • sloc: javascript: 16,258; sh: 111; makefile: 4
file content (53 lines) | stat: -rw-r--r-- 1,513 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Interface: FlattenedJWSInput

[💗 Help the project](https://github.com/sponsors/panva)

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

## Table of contents

### Properties

- [payload](types.FlattenedJWSInput.md#payload)
- [signature](types.FlattenedJWSInput.md#signature)
- [header](types.FlattenedJWSInput.md#header)
- [protected](types.FlattenedJWSInput.md#protected)

## 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`](types.JWSHeaderParameters.md)

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.