jose

"JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes.

Implemented specs & features

The following specifications are implemented by jose

• JSON Web Signature (JWS) - RFC7515
• JSON Web Encryption (JWE) - RFC7516
• JSON Web Key (JWK) - RFC7517
• JSON Web Algorithms (JWA) - RFC7518
• JSON Web Token (JWT) - RFC7519
• JSON Web Key Thumbprint - RFC7638
• JSON Web Key Thumbprint URI - RFC9278
• JWS Unencoded Payload Option - RFC7797
• CFRG Elliptic Curve ECDH and Signatures - RFC8037
• secp256k1 EC Key curve support - JOSE Registrations for WebAuthn Algorithms

The test suite utilizes examples defined in RFC7520 to confirm its JOSE implementation is correct.

💗 Help the project

Dependencies: 0

Documentation

example ESM import

import * as jose from 'jose'

example CJS require

const jose = require('jose')

example Deno import

import * as jose from 'https://deno.land/x/[email protected]/index.ts'

• JSON Web Tokens (JWT)
  • Signing
  • Verification & JWT Claims Set Validation
  • Encrypted JSON Web Tokens
    • Encryption
    • Decryption & JWT Claims Set Validation
• Key Import
  • JWK Import
  • Public Key Import (SPKI)
  • Public Key Import (X.509 Certificate)
  • Private Key Import (PKCS #8)
• JSON Web Encryption (JWE)
  • Encryption - Compact, Flattened, General
  • Decryption - Compact, Flattened, General
• JSON Web Signature (JWS)
  • Signing - Compact, Flattened, General
  • Verification - Compact, Flattened, General
• JSON Web Key (JWK)
  • Calculating JWK Thumbprint
  • Calculating JWK Thumbprint URI
  • Verification using a JWK Embedded in a JWS Header
• JSON Web Key Set (JWKS)
  • Verify using a local JWKSet
  • Verify using a remote JWKSet
• Key Pair or Secret Generation
  • Asymmetric Key Pair Generation
  • Symmetric Secret Generation
• Key Export
  • JWK Export
  • Private Key Export
  • Public Key Export
• Utilities
  • Decoding Token's Protected Header
  • Decoding JWT Claims Set
• Unsecured JWT
• JOSE Errors

Supported Runtimes

The supported JavaScript runtimes include ones that support the utilized Web API globals and standard built-in objects or are Node.js

These are (this is not an exhaustive list):

• Bun
• Browsers
• Cloudflare Workers
• Deno
• Electron
• Node.js
• Vercel's Edge Runtime

FAQ

Supported Versions

| Version | Security Fixes 🔑 | Other Bug Fixes 🐞 | New Features ⭐ | | ------- | --------- | -------- | -------- | | v4.x | ✅ | ✅ | ✅ | | v3.x, v2.x, v1.x | ✅ | ❌ | ❌ |

Uint8Array?!

• Whenever Uint8Array is a valid input, so is Buffer since buffers are instances of Uint8Array.
• Whenever Uint8Array is returned and you want a Buffer instead, use Buffer.from(uint8array).

Bundle Size, Package Size, Tree Shaking

Yes the bundle size is on the larger side, that is because each module is actually published multiple times so that it can remain truly without dependencies and be universal / isomorphic.

Nevertheless, since each module can be required independently and is fully tree-shakeable, the install size should not be a cause for concern.