npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tsndr/cloudflare-worker-jwt

v3.1.3

Published

A lightweight JWT implementation with ZERO dependencies for Cloudflare Worker

Downloads

161,782

Readme

Cloudflare Worker JWT

A lightweight JWT implementation with ZERO dependencies for Cloudflare Workers.

Contents

Install

npm i @tsndr/cloudflare-worker-jwt

Examples

Basic Example

async () => {
    import jwt from "@tsndr/cloudflare-worker-jwt"

    // Create a token
    const token = await jwt.sign({
        sub: "1234",
        name: "John Doe",
        email: "[email protected]"
    }, "secret")

    // Verify token
    const verifiedToken = await jwt.verify(token, "secret")

    // Abort if token isn't valid
    if (!verifiedToken)
        return

    // Access token payload
    const { payload } = verifiedToken

    // { sub: "1234", name: "John Doe", email: "[email protected]" }
}

Restrict Timeframe

async () => {
    import jwt from "@tsndr/cloudflare-worker-jwt"

    // Create a token
    const token = await jwt.sign({
        sub: "1234",
        name: "John Doe",
        email: "[email protected]",
        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")

    // Verify token
    const verifiedToken = await jwt.verify(token, "secret")

    // Abort if token isn't valid
    if (!verifiedToken)
        return

    // Access token payload
    const { payload } = verifiedToken

    // { sub: "1234", name: "John Doe", email: "[email protected]", ... }
}

Usage

Sign

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, JsonWebKey, CryptoKey | required | - | A string which is used to sign the payload. options | string, object | optional | HS256 | Either the algorithm string or an object. options.algorithm | string | optional | HS256 | See Available Algorithms options.header | object | optional | undefined | Extend the header of the resulting JWT.

return

Returns token as a string.

Verify

verify(token, secret, [options])

Verifies the integrity of the token.

Argument | Type | Status | Default | Description ------------------------ | ----------------------------------- | -------- | ------- | ----------- token | string | required | - | The token string generated by sign(). secret | string, JsonWebKey, CryptoKey | required | - | The string which was used to sign the payload. options | string, object | optional | HS256 | Either the algorithm string or an object. options.algorithm | string | optional | HS256 | See Available Algorithms options.clockTolerance | number | optional | 0 | Clock tolerance in seconds, to help with slighly out of sync systems. options.throwError | boolean | optional | false | By default this we will only throw integration errors, only set this to true if you want verification errors to be thrown as well.

throws

Throws integration errors and if options.throwError is set to true also throws ALG_MISMATCH, NOT_YET_VALID, EXPIRED or INVALID_SIGNATURE.

return

Returns the decoded token or undefined.

{
    header: {
        alg: "HS256",
        typ: "JWT"
    },
    payload: {
        sub: "1234",
        name: "John Doe",
        email: "[email protected]"
    }
}

Decode

decode(token)

Just returns the decoded token without verifying verifying it. Please use verify() if you intend to verify it as well.

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

return

Returns an object containing header and payload:

{
    header: {
        alg: "HS256",
        typ: "JWT"
    },
    payload: {
        sub: "1234",
        name: "John Doe",
        email: "[email protected]"
    }
}

Available Algorithms

  • ES256, ES384, ES512
  • HS256, HS384, HS512
  • RS256, RS384, RS512