jose/docs/interfaces/types.GeneralJWE.md
2021-08-20 22:40:04 +02:00

3.1 KiB

Interface: GeneralJWE

types.GeneralJWE

Hierarchy

  • Omit<FlattenedJWE, "encrypted_key" | "header">

    GeneralJWE

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.

Inherited from

Omit.aad

Defined in

types.d.ts:324


ciphertext

ciphertext: string

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

Inherited from

Omit.ciphertext

Defined in

types.d.ts:330


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.

Inherited from

Omit.iv

Defined in

types.d.ts:354


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.

Inherited from

Omit.protected

Defined in

types.d.ts:362


recipients

recipients: Pick<FlattenedJWE, "header" | "encrypted_key">[]

Defined in

types.d.ts:382


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.

Inherited from

Omit.tag

Defined in

types.d.ts:369


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.

Inherited from

Omit.unprotected

Defined in

types.d.ts:378