Skip to content

Latest commit

 

History

History
121 lines (76 loc) · 3.43 KB

types.flattenedjwe.md

File metadata and controls

121 lines (76 loc) · 3.43 KB

Interface: FlattenedJWE

types.FlattenedJWE

Flattened JWE definition.

Table of contents

Properties

Properties

aad

• Optional aad: string

The "aad" member MUST be present and contain the value BASE64URL(JWE AAD)) when the JWE AAD value is non-empty; otherwise, it MUST be absent. A JWE AAD value can be included to supply a base64url-encoded value to be integrity protected but not encrypted.

Defined in: types.d.ts:315

ciphertext

• ciphertext: string

The "ciphertext" member MUST be present and contain the value BASE64URL(JWE Ciphertext).

Defined in: types.d.ts:321

encrypted_key

• Optional encrypted_key: string

The "encrypted_key" member MUST be present and contain the value BASE64URL(JWE Encrypted Key) when the JWE Encrypted Key value is non-empty; otherwise, it MUST be absent.

Defined in: types.d.ts:328

header

• Optional header: JWEHeaderParameters

The "header" member MUST be present and contain the value JWE Per- Recipient Unprotected Header when the JWE Per-Recipient 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.

Defined in: types.d.ts:338

iv

• iv: string

The "iv" member MUST be present and contain the value BASE64URL(JWE Initialization Vector) when the JWE Initialization Vector value is non-empty; otherwise, it MUST be absent.

Defined in: types.d.ts:345

protected

• Optional protected: string

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

Defined in: types.d.ts:353

tag

• tag: string

The "tag" member MUST be present and contain the value BASE64URL(JWE Authentication Tag) when the JWE Authentication Tag value is non-empty; otherwise, it MUST be absent.

Defined in: types.d.ts:360

unprotected

• Optional unprotected: JWEHeaderParameters

The "unprotected" member MUST be present and contain the value JWE Shared Unprotected Header when the JWE Shared 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.

Defined in: types.d.ts:369