- v5.9.6Latest
- v5.9.5
- v5.9.4
- v5.9.3
- v5.9.2
- v5.9.1
- v5.9.0
- v5.8.0
- v5.7.0
- v5.6.3
- v5.6.2
- v5.6.1
- v5.6.0
- v5.5.0
- v5.4.1
- v5.4.0
- v5.3.0
- v5.2.4
- v5.2.3
- v4.15.5
- v5.2.2
- v5.2.1
- v5.2.0
- v5.1.3
- v5.1.2
- v5.1.1
- v5.1.0
- v5.0.2
- v5.0.1
- v5.0.0
- v4.15.4
- v4.15.3
- v4.15.2
- v4.15.1
- v4.15.0
- v4.14.6
- v4.14.5
- v4.14.4
- v4.14.3
- v4.14.2
- v4.14.1
- v4.14.0
- v4.13.2
- v4.13.1
- v4.13.0
- v4.12.2
- v4.12.1
- v4.12.0
- v4.11.4
- v4.11.3
- v4.11.2
- v4.11.1
- v4.11.0
- v4.10.4
- v4.10.3
- v4.10.2
- v4.10.1
- v4.10.0
- v4.9.3
- v4.9.2
- v3.20.4
- v4.9.1
- v4.9.0
- v4.8.3
- v4.8.2
- v4.8.1
- v4.8.0
- v4.7.0
- v4.6.2
- v4.6.1
- v4.6.0
- v4.5.3
- v4.5.2
- v4.5.1
- v4.5.0
- v4.4.0
- v4.3.9
- v4.3.8
- v4.3.7
- v4.3.6
- v4.3.5
- v4.3.4
- v4.3.3
- v4.3.2
- v4.3.1
- v4.3.0
- v4.2.1
- v4.2.0
- v4.1.5
- v4.1.4
- v4.1.3
- v4.1.2
- v4.1.1
- v4.1.0
- v4.0.4
- v4.0.3
- v4.0.2
- v4.0.1
- v4.0.0
- v3.20.3
- v3.20.2
- v3.20.1
- v3.20.0
- v3.19.0
- v3.18.0
- v3.17.0
- v3.16.1
- v3.16.0
- v3.15.5
- v3.15.4
- v3.15.3
- v3.15.2
- v3.15.1
- v3.15.0
- v3.15.0-pre.0
jose
API Documentation
jose
is JavaScript module for JSON Object Signing and Encryption, providing support for JSON Web Tokens (JWT), JSON Web Signature (JWS), JSON Web Encryption (JWE), JSON Web Key (JWK), JSON Web Key Set (JWKS), and more. The module is designed to work across various Web-interoperable runtimes including Node.js, browsers, Cloudflare Workers, Deno, Bun, and others.
š 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.
Available modules
example
Deno import
import * as jose from 'https://deno.land/x/jose@v5.6.3/index.ts'
JSON Web Tokens (JWT)
The jose
module supports JSON Web Tokens (JWT) and provides functionality for signing and verifying tokens, as well as their JWT Claims Set validation.
- JWT Claims Set Validation & Signature Verification using the
jwtVerify
function - Signing using the
SignJWT
class - Utility functions
- Decoding Tokenās Protected Header
- Decoding JWT Claims Set prior to its validation
Encrypted JSON Web Tokens
The jose
module supports encrypted JSON Web Tokens and provides functionality for encrypting and decrypting tokens, as well as their JWT Claims Set validation.
- Decryption & JWT Claims Set Validation using the
jwtDecrypt
function - Encryption using the
EncryptJWT
class - Utility functions
Key Utilities
The jose
module supports importing, exporting, and generating keys and secrets in various formats, including PEM formats like SPKI, X.509 certificate, and PKCS #8, as well as JSON Web Key (JWK).
- Key Import Functions
- Key and Secret Generation Functions
- Key Export Functions
JSON Web Signature (JWS)
The jose
module supports signing and verification of JWS messages with arbitrary payloads in Compact, Flattened JSON, and General JSON serialization syntaxes.
- Signing - Compact, Flattened JSON, General JSON
- Verification - Compact, Flattened JSON, General JSON
- Utility functions
JSON Web Encryption (JWE)
The jose
module supports encryption and decryption of JWE messages with arbitrary plaintext in Compact, Flattened JSON, and General JSON serialization syntaxes.
- Encryption - Compact, Flattened JSON, General JSON
- Decryption - Compact, Flattened JSON, General JSON
- Utility functions
Other
The following are additional features and utilities provided by the jose
module: