Bearer 身份验证中间件

Bearer 身份验证中间件通过验证请求头中的 API 令牌来提供身份验证。访问端点的 HTTP 客户端将在请求头中添加 Authorization 头，其头值为 Bearer {token}。

使用终端中的 curl，它将如下所示

curl -H 'Authorization: Bearer honoiscool' https://127.0.0.1:8787/auth/page

导入

import { Hono } from 'hono'
import { bearerAuth } from 'hono/bearer-auth'

用法

const app = new Hono()

const token = 'honoiscool'

app.use('/api/*', bearerAuth({ token }))

app.get('/api/page', (c) => {
  return c.json({ message: 'You are authorized' })
})

要限制为特定路由 + 方法

const app = new Hono()

const token = 'honoiscool'

app.get('/api/page', (c) => {
  return c.json({ message: 'Read posts' })
})

app.post('/api/page', bearerAuth({ token }), (c) => {
  return c.json({ message: 'Created post!' }, 201)
})

要实现多个令牌（例如，任何有效令牌都可以读取，但创建/更新/删除仅限于特权令牌）

const app = new Hono()

const readToken = 'read'
const privilegedToken = 'read+write'
const privilegedMethods = ['POST', 'PUT', 'PATCH', 'DELETE']

app.on('GET', '/api/page/*', async (c, next) => {
  // List of valid tokens
  const bearer = bearerAuth({ token: [readToken, privilegedToken] })
  return bearer(c, next)
})
app.on(privilegedMethods, '/api/page/*', async (c, next) => {
  // Single valid privileged token
  const bearer = bearerAuth({ token: privilegedToken })
  return bearer(c, next)
})

// Define handlers for GET, POST, etc.

如果要自己验证令牌的值，请指定 verifyToken 选项；返回 true 表示它被接受。

const app = new Hono()

app.use(
  '/auth-verify-token/*',
  bearerAuth({
    verifyToken: async (token, c) => {
      return token === 'dynamic-token'
    },
  })
)

选项

必需 token: string | string[]

用于验证传入的承载令牌的字符串。

可选 realm: string

域的域名，作为返回的 WWW-Authenticate 质询头的一部分。默认值为 ""。了解更多： https://mdn.org.cn/en-US/docs/Web/HTTP/Headers/WWW-Authenticate#directives

可选 prefix: string

授权头值的 prefix（或称为 schema）。默认值为 "Bearer"。

可选 headerName: string

头名称。默认值为 Authorization。

可选 hashFunction: Function

用于处理安全比较身份验证令牌的哈希的函数。

可选 verifyToken: (token: string, c: Context) => boolean | Promise<boolean>

用于验证令牌的函数。

可选 noAuthenticationHeaderMessage: string | object | MessageFunction

MessageFunction 是 (c: Context) => string | object | Promise<string | object>。如果没有身份验证头，则自定义消息。

可选 invalidAuthenticationHeaderMessage: string | object | MessageFunction

如果身份验证头无效，则自定义消息。

可选 invalidTokenMessage: string | object | MessageFunction

如果令牌无效，则自定义消息。