jose-browser-runtime

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.1.1/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.

• Signing using the SignJWT class
• Verification & JWT Claims Set Validation using the jwtVerify function
  • Using a remote JWKS
  • Using a local JWKS
• 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.

• Encryption using the EncryptJWT class
• Decryption & JWT Claims Set Validation using the jwtDecrypt function
• Utility functions
  • Decoding Token's Protected Header

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
  • JWK Import
  • Public Key Import (SPKI)
  • Public Key Import (X.509 Certificate)
  • Private Key Import (PKCS #8)
• Key and Secret Generation Functions
  • Asymmetric Key Pair Generation
  • Symmetric Secret Generation
• Key Export Functions
  • JWK Export
  • Private Key Export
  • Public Key Export

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
  • Verify using a remote JWKS
  • Verify using a local JWKS
• Utility functions
  • Decoding Token's Protected Header

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
  • Decoding Token's Protected Header

Other

The following are additional features and utilities provided by the jose module:

• Calculating JWK Thumbprint
• Calculating JWK Thumbprint URI
• Verification using a JWK Embedded in a JWS Header
• Unsecured JWT
• JOSE Errors

Changelog

5.1.1 (2023-11-14)

Refactor

• deprecate the RSA1_5 JWE Algorithm (f746da1)