@elysiajs/static

This package is a fork of @elysiajs/jwt and is not maintained by Elysia.JS team. This fork is created to fix iat validation issue

Plugin for Elysia for using JWT Authentication.

Installation

1bun add @elysiajs/jwt

Example

1import { Elysia, t } from 'elysia'
2import { jwt } from '@elysiajs/jwt'
3import { cookie } from '@elysiajs/cookie'
4
5const app = new Elysia()
6	.use(
7		jwt({
8			name: 'jwt',
9			// This should be Environment Variable
10			secret: 'MY_SECRETS'
11		})
12	)
13	.use(cookie())
14	.get('/sign/:name', async ({ jwt, cookie, setCookie, params }) => {
15		setCookie('auth', await jwt.sign(params), {
16			httpOnly: true
17		})
18
19		return `Sign in as ${params.name}`
20	})
21	.get('/profile', async ({ jwt, set, cookie: { auth } }) => {
22		const profile = await jwt.verify(auth)
23
24		if (!profile) {
25			set.status = 401
26			return 'Unauthorized'
27		}
28
29		return `Hello ${profile.name}`
30	})
31	.listen(8080)

Config

This package extends jose, most config is inherited from Jose.

Below are configurable properties for using JWT plugin

name

Name to decorate method as:

For example, jwt will decorate Context with Context.jwt

secret

JWT secret key

schema

Type strict validation for JWT payload

Jose's config

Below is the config inherits from jose

alg

@default 'HS256'

Algorithm to sign JWT with

crit

Critical Header Parameter.

iss

JWT Issuer

@see RFC7519#section-4.1.1

sub

JWT Subject

@see RFC7519#section-4.1.2

aud

JWT Audience

@see RFC7519#section-4.1.3

jti

JWT ID

@see RFC7519#section-4.1.7

nbf

JWT Not Before

@see RFC7519#section-4.1.5

exp

JWT Expiration Time

@see RFC7519#section-4.1.4

iat

JWT Issued At

@see RFC7519#section-4.1.6