types.JWEHeaderParameters.md

Interface: JWEHeaderParameters

💗 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.

---

Recognized JWE Header Parameters, any other Header members may also be present.

Table of contents

Properties

• alg
• crit
• cty
• enc
• jku
• jwk
• kid
• typ
• x5c
• x5t
• x5u
• zip

Properties

alg

• Optional alg: string

JWE "alg" (Algorithm) Header Parameter.

---

crit

• Optional crit: string[]

JWE "crit" (Critical) Header Parameter.

---

cty

• Optional cty: string

"cty" (Content Type) Header Parameter.

---

enc

• Optional enc: string

JWE "enc" (Encryption Algorithm) Header Parameter.

---

jku

• Optional jku: string

"jku" (JWK Set URL) Header Parameter.

---

jwk

• Optional jwk: Pick<JWK, "x" | "y" | "crv" | "e" | "kty" | "n">

"jwk" (JSON Web Key) Header Parameter.

---

kid

• Optional kid: string

"kid" (Key ID) Header Parameter.

---

typ

• Optional typ: string

"typ" (Type) Header Parameter.

---

x5c

• Optional x5c: string[]

"x5c" (X.509 Certificate Chain) Header Parameter.

---

x5t

• Optional x5t: string

"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter.

---

x5u

• Optional x5u: string

"x5u" (X.509 URL) Header Parameter.

---

zip

• Optional zip: string

JWE "zip" (Compression Algorithm) Header Parameter. This parameter is not supported anymore.

Deprecated

Compression of data SHOULD NOT be done before encryption, because such compressed data often reveals information about the plaintext.

See

Avoid Compression of Encryption Inputs