Cloudflare Worker JWT

> This package is modified from Cloudflare Worker JWT.

A lightweight JWT implementation with ZERO dependencies for Cloudflare Workers.

Contents

- Install
- Examples
- Usage
- Sign
- Verify
- Decode

Install

``
npm i @tsndr/cloudflare-worker-jwt
`




Examples

$3

`typescript
async () => {
import jwt from '@tsndr/cloudflare-worker-jwt'

// Creating a token
const token = await jwt.sign({ name: 'John Doe', email: 'john.doe@gmail.com' }, 'secret')

// Verifing token
const isValid = await jwt.verify(token, 'secret')

// Check for validity
if (!isValid)
return

// Decoding token
const { payload } = jwt.decode(token)
}
`

$3

`typescript
async () => {
import jwt from '@tsndr/cloudflare-worker-jwt'

// Creating a token
const token = await jwt.sign({
name: 'John Doe',
email: 'john.doe@gmail.com',
nbf: Math.floor(Date.now() / 1000) + (60 * 60), // Not before: Now + 1h
exp: Math.floor(Date.now() / 1000) + (2 (60 60)) // Expires: Now + 2h
}, 'secret')

// Verifing token
const isValid = await jwt.verify(token, 'secret') // false

// Check for validity
if (!isValid)
return

// Decoding token
const { payload } = jwt.decode(token) // { name: 'John Doe', email: 'john.doe@gmail.com', ... }
}
`

Usage

- Sign
- Verify
- Decode

---

$3


#### jwt.sign(payload, secret, [options])

Signs a payload and returns the token.

#### Arguments

Argument | Type | Status | Default | Description
----------- | -------- | -------- | ------- | -----------
payload | object | required | - | The payload object. To use nbf (Not Before) and/or exp (Expiration Time) add nbf and/or exp to the payload.
secret | string | required | - | A string which is used to sign the payload.
options | object | optional | { algorithm: 'HS256' } | The options object supporting algorithm and keyid. (See Available Algorithms)

#### return
Returns token as a string.

---

$3


#### jwt.verify(token, secret, [options])

Verifies the integrity of the token and returns a boolean value.

Argument | Type | Status | Default | Description
----------- | -------- | -------- | ------- | -----------
token | string | required | - | The token string generated by jwt.sign().
secret | string | required | - | The string which was used to sign the payload.
options | object | optional | { algorithm: 'HS256', throwError: false } | The options object supporting algorithm and throwError. (See Available Algorithms)

#### throws
If options.throwError is true and the token is invalid, an error will be thrown.

#### return
Returns true if signature, nbf (if set) and exp (if set) are valid, otherwise returns false.

---

$3


#### jwt.decode(token)

Returns the payload without verifying the integrity of the token. Please use jwt.verify() first to keep your application secure!

Argument | Type | Status | Default | Description
----------- | -------- | -------- | ------- | -----------
token | string | required | - | The token string generated by jwt.sign().

#### return
Returns an object containing header and payload:
`javascript
{
header: {
alg: 'HS256',
typ: 'JWT'
},
payload: {
name: 'John Doe',
email: 'john.doe@gmail.com'
}
}
``

$3

- ES256
- ES384
- ES512
- HS256
- HS384
- HS512
- RS256
- RS384
- RS512