JWT Auth Middleware

JWT Auth Middleware 通过使用 JWT 验证 token 来提供身份验证。 如果 cookie 选项未设置，中间件将检查 Authorization 头部。

INFO

客户端发送的 Authorization 头部必须具有指定的 scheme。

例如：Bearer my.token.value 或 Basic my.token.value

Import

import { Hono } from 'hono'
import { jwt } from 'hono/jwt'
import type { JwtVariables } from 'hono/jwt'

Usage

// 指定变量类型以推断 `c.get('jwtPayload')` 的类型：
type Variables = JwtVariables

const app = new Hono<{ Variables: Variables }>()

app.use(
  '/auth/*',
  jwt({
    secret: 'it-is-very-secret',
  })
)

app.get('/auth/page', (c) => {
  return c.text('You are authorized')
})

获取 payload:

const app = new Hono()

app.use(
  '/auth/*',
  jwt({
    secret: 'it-is-very-secret',
  })
)

app.get('/auth/page', (c) => {
  const payload = c.get('jwtPayload')
  return c.json(payload) // eg: { "sub": "1234567890", "name": "John Doe", "iat": 1516239022 }
})

TIP

jwt() 只是一个中间件函数。如果你想使用环境变量 (例如: c.env.JWT_SECRET)，你可以像下面这样使用它：

app.use('/auth/*', (c, next) => {
  const jwtMiddleware = jwt({
    secret: c.env.JWT_SECRET,
  })
  return jwtMiddleware(c, next)
})

Options

required secret: string

你的密钥的值。

optional cookie: string

如果设置了这个值，那么将使用该值作为键从 cookie 头部检索值，然后将其作为 token 进行验证。

optional alg: string

用于验证的算法类型。 默认值为 HS256。

可用的类型有 HS256 | HS384 | HS512 | RS256 | RS384 | RS512 | PS256 | PS384 | PS512 | ES256 | ES384 | ES512 | EdDSA。