jose/docs/README.md

jose Modules API Documentation

"JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK, JWKS with no dependencies using runtime's native crypto.

Support

If you or your business use jose, please consider becoming a sponsor so I can continue maintaining it and adding new features carefree.

Available modules

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 & 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)
  • Thumbprints
  • EmbeddedJWK
• 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