Cookie 助手

Cookie 助手提供了一个简易的接口来管理 cookie，使开发者能够无缝地设置、解析和删除 cookie。

导入

import { Hono } from 'hono'
import {
  getCookie,
  getSignedCookie,
  setCookie,
  setSignedCookie,
  deleteCookie,
} from 'hono/cookie'

用法

注意: 设置和检索签名 Cookie 会返回 Promise，这是因为 WebCrypto API 的异步特性，它被用于创建 HMAC SHA-256 签名。

const app = new Hono()

app.get('/cookie', (c) => {
  const allCookies = getCookie(c)
  const yummyCookie = getCookie(c, 'yummy_cookie')
  // ...
  setCookie(c, 'delicious_cookie', 'macha')
  deleteCookie(c, 'delicious_cookie')
  //
})

app.get('/signed-cookie', async (c) => {
  const secret = 'secret ingredient'
  // `getSignedCookie` 对于指定的 cookie，如果签名被篡改或无效，将返回 `false`
  const allSignedCookies = await getSignedCookie(c, secret)
  const fortuneCookie = await getSignedCookie(
    c,
    secret,
    'fortune_cookie'
  )
  // ...
  const anotherSecret = 'secret chocolate chips'
  await setSignedCookie(c, 'great_cookie', 'blueberry', anotherSecret)
  deleteCookie(c, 'great_cookie')
  //
})

选项

setCookie & setSignedCookie

• domain: string
• expires: Date
• httpOnly: boolean
• maxAge: number
• path: string
• secure: boolean
• sameSite: 'Strict' | 'Lax' | 'None'
• priority: 'Low' | 'Medium' | 'High'
• prefix: secure | 'host'
• partitioned: boolean

示例:

// 常规 cookies
setCookie(c, 'great_cookie', 'banana', {
  path: '/',
  secure: true,
  domain: 'example.com',
  httpOnly: true,
  maxAge: 1000,
  expires: new Date(Date.UTC(2000, 11, 24, 10, 30, 59, 900)),
  sameSite: 'Strict',
})

// 签名 cookies
await setSignedCookie(
  c,
  'fortune_cookie',
  'lots-of-money',
  'secret ingredient',
  {
    path: '/',
    secure: true,
    domain: 'example.com',
    httpOnly: true,
    maxAge: 1000,
    expires: new Date(Date.UTC(2000, 11, 24, 10, 30, 59, 900)),
    sameSite: 'Strict',
  }
)

deleteCookie

• path: string
• secure: boolean
• domain: string

示例:

deleteCookie(c, 'banana', {
  path: '/',
  secure: true,
  domain: 'example.com',
})

deleteCookie 返回被删除的值:

const deletedCookie = deleteCookie(c, 'delicious_cookie')

__Secure- 和 __Host- 前缀

Cookie 助手支持 cookie 名称的 __Secure- 和 __Host- 前缀。

如果你想验证 cookie 名称是否带有前缀，可以指定 prefix 选项。

const securePrefixCookie = getCookie(c, 'yummy_cookie', 'secure')
const hostPrefixCookie = getCookie(c, 'yummy_cookie', 'host')

const securePrefixSignedCookie = await getSignedCookie(
  c,
  secret,
  'fortune_cookie',
  'secure'
)
const hostPrefixSignedCookie = await getSignedCookie(
  c,
  secret,
  'fortune_cookie',
  'host'
)

此外，如果你希望在设置 cookie 时指定前缀，可以为 prefix 选项指定一个值。

setCookie(c, 'delicious_cookie', 'macha', {
  prefix: 'secure', // 或 `host`
})

await setSignedCookie(
  c,
  'delicious_cookie',
  'macha',
  'secret choco chips',
  {
    prefix: 'secure', // 或 `host`
  }
)

遵循最佳实践

新的 Cookie RFC (又名 cookie-bis) 和 CHIPS 包含了一些开发者应该遵循的 Cookie 设置最佳实践。

• RFC6265bis-13
  • Max-Age/Expires 限制
  • __Host-/__Secure- 前缀限制
• CHIPS-01
  • Partitioned 限制

Hono 正在遵循最佳实践。 当解析 cookie 时，如果出现以下情况，cookie 助手将抛出一个 Error:

• cookie 名称以 __Secure- 开头，但 secure 选项未设置。
• cookie 名称以 __Host- 开头，但 secure 选项未设置。
• cookie 名称以 __Host- 开头，但 path 不是 /。
• cookie 名称以 __Host- 开头，但设置了 domain。
• maxAge 选项值大于 400 天。
• expires 选项值比当前时间晚 400 天。