"JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK, JWKS with no dependencies using runtime's native crypto in Node.js, Browser, Cloudflare Workers, Electron, and Deno.
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
- 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.
If you or your business use jose
, please consider becoming a sponsor so I can continue maintaining it and adding new features carefree.
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/jose/index.ts'
- JSON Web Tokens (JWT)
- Signing
- Verification & Claims Set Validation
- Encrypted JSON Web Tokens
- Key Import
- JSON Web Encryption (JWE)
- JSON Web Signature (JWS)
- JSON Web Key (JWK)
- JSON Web Key Set (JWKS)
- Key Pair or Secret Generation
- Key Export
- Utilities
- Unsecured JWT
- JOSE Errors
- Browser Support
- Cloudflare Workers Support
- Deno Support
- Electron Support
- Next.js Middleware / Vercel Edge Functions Support
- Node.js Support
Version | Security Fixes π | Other Bug Fixes π | New Features β |
---|---|---|---|
4.x.x | β | β | β |
3.x.x | β | β until 2022-04-30 | β |
2.x.x | β | β until 2022-04-30 | β |
1.x.x | β | β | β |
Yes. All module's public API is subject to Semantic Versioning 2.0.0.
How is it different from jws
, jwa
or jsonwebtoken
?
- it supports Browser, Cloudflare Workers, and Deno runtimes
- it supports encrypted JWTs (i.e. in JWE format)
- supports secp256k1, Ed25519, Ed448, X25519, and X448
- it supports JWK Key Format for all four key types (oct, RSA, EC and OKP)
- it is exclusively using native platform Key object representations (CryptoKey and KeyObject)
- there is JSON Web Encryption support
- it supports the flattened JWS / JWE Serialization Syntaxes
- it supports the "crit" member validations to make sure extensions are handled correctly
How is it different from node-jose
?
node-jose
is built to work in any javascript runtime, to be able to do that it packs a lot of
polyfills and javascript implementation code in the form of
node-forge
, this significantly increases the footprint
of the modules with dependencies that either aren't ever used or have native implementation available
in the runtime already, those are often times faster and more reliable.
- supports secp256k1, Ed25519, Ed448, X25519, and X448
- Whenever
Uint8Array
is a valid input, so isBuffer
since buffers are instances of Uint8Array. - Whenever
Uint8Array
is returned and you want aBuffer
instead, useBuffer.from(uint8array)
.
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.