https://github.com/shgysk8zer0/jwk-utils

Use JWK and JWTs using the Crypto API
https://github.com/shgysk8zer0/jwk-utils

crypto jwk jwt

Last synced: 6 months ago
JSON representation

Use JWK and JWTs using the Crypto API

• Host: GitHub
• URL: https://github.com/shgysk8zer0/jwk-utils
• Owner: shgysk8zer0
• License: mit
• Created: 2024-08-30T21:53:42.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-04-10T15:26:08.000Z (7 months ago)
• Last Synced: 2025-04-15T05:46:57.878Z (6 months ago)
• Topics: crypto, jwk, jwt
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@shgysk8zer0/jwk-utils
• Size: 589 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# @shgysk8zer0/jwk-utils

Use JWK and JWTs using the Crypto API

[![JWT Compatible](https://jwt.io/img/badge-compatible.svg)](https://jwt.io/)

[![CodeQL](https://github.com/shgysk8zer0/jwk-utils/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shgysk8zer0/jwk-utils/actions/workflows/codeql-analysis.yml)

![Node CI](https://github.com/shgysk8zer0/jwk-utils/workflows/Node%20CI/badge.svg)

![Lint Code Base](https://github.com/shgysk8zer0/jwk-utils/workflows/Lint%20Code%20Base/badge.svg)

[![GitHub license](https://img.shields.io/github/license/shgysk8zer0/jwk-utils.svg)](https://github.com/shgysk8zer0/jwk-utils/blob/master/LICENSE)

[![GitHub last commit](https://img.shields.io/github/last-commit/shgysk8zer0/jwk-utils.svg)](https://github.com/shgysk8zer0/jwk-utils/commits/master)

[![GitHub release](https://img.shields.io/github/release/shgysk8zer0/jwk-utils?logo=github)](https://github.com/shgysk8zer0/jwk-utils/releases)

[![GitHub Sponsors](https://img.shields.io/github/sponsors/shgysk8zer0?logo=github)](https://github.com/sponsors/shgysk8zer0)

[![npm](https://img.shields.io/npm/v/@shgysk8zer0/jwk-utils)](https://www.npmjs.com/package/@shgysk8zer0/jwk-utils)

![node-current](https://img.shields.io/node/v/@shgysk8zer0/jwk-utils)

![npm bundle size gzipped](https://img.shields.io/bundlephobia/minzip/@shgysk8zer0/jwk-utils)

[![npm](https://img.shields.io/npm/dw/@shgysk8zer0/jwk-utils?logo=npm)](https://www.npmjs.com/package/@shgysk8zer0/jwk-utils)

[![GitHub followers](https://img.shields.io/github/followers/shgysk8zer0.svg?style=social)](https://github.com/shgysk8zer0)

![GitHub forks](https://img.shields.io/github/forks/shgysk8zer0/jwk-utils.svg?style=social)

![GitHub stars](https://img.shields.io/github/stars/shgysk8zer0/jwk-utils.svg?style=social)

[![Twitter Follow](https://img.shields.io/twitter/follow/shgysk8zer0.svg?style=social)](https://twitter.com/shgysk8zer0)

[![Donate using Liberapay](https://img.shields.io/liberapay/receives/shgysk8zer0.svg?logo=liberapay)](https://liberapay.com/shgysk8zer0/donate "Donate using Liberapay")

- - -

- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)

- [Contributing](./.github/CONTRIBUTING.md)

## Installation

```bash

npm i @shgysk8zer0/jwk-utils

```

## About

This library provides [JWK](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key)

and [JWT](https://jwt.io/) support via the [`crypto` API](https://developer.mozilla.org/en-US/docs/Web/API/Crypto).

### Supported Algorithms

- RS256

- RS384

- RS512

- ES256

- ES384

- ES512

- HS256

- HS384

- HS512

- PS256

- PS384

- PS512

- EdDSA

> [!Note]

> EdDSA is currently experimental in Node.js and is only suported in Safari. See [Browser Compatibility on MDN](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/sign#browser_compatibility).

## Not Supported

- ES256K

### Example

```js

import { generateJWK, createJWT, verifyJWT } from '@shgysk8zer0/jwt-jwk';

// Generate a JWK pair

const { publicKey, privateKey } = await generateJWK();

// JWTs use Unix timestamps - seconds, not ms.

const now = Math.floor(Date.now() / 1000);

// Create a JWT

const token = await createJWT({

  iss: 'Some issuer',

  sub: 'The Subject',

  iat: now,

  exp: now + 60,

  nbf: now,

  jti: crypto.randomUUID(),

  scope: 'api',

  entitlements: ['db:read'],

}, privateKey);

// Verify the JWT

const verifiedPayload = await verifyJWT(token, publicKey, { entitlements: ['db:read'] });

```

## Limitations

Due to using JWKs and public/private keys, this currently does not support algorithms

not suppported by `crypto.subtle`.

> [!Note]

> Polyfills, especially for `Unit8Array.fromBase64()` & `Uint8Array.prototype.toBase64()` are required. They are

> provided by `@shgysk8zer0/polyfills`, which is imported in the main package (`@shgysk8zer0/jwk-utils`). However,

for compatibility with client-side usage and to avoid conflicts, it is not imported by direct imports.