Secure Headers 中间件

Secure Headers 中间件简化安全响应头的配置。它部分借鉴了 Helmet 的功能，允许控制特定安全响应头的启用与关闭。

导入

import { Hono } from 'hono'
import { secureHeaders } from 'hono/secure-headers'

用法

默认即可使用最佳配置。

const app = new Hono()
app.use(secureHeaders())

将不需要的头部设为 false，就能阻止其发送。

const app = new Hono()
app.use(
  '*',
  secureHeaders({
    xFrameOptions: false,
    xXssProtection: false,
  })
)

可以使用字符串覆盖默认头部值。

const app = new Hono()
app.use(
  '*',
  secureHeaders({
    strictTransportSecurity:
      'max-age=63072000; includeSubDomains; preload',
    xFrameOptions: 'DENY',
    xXssProtection: '1',
  })
)

支持的选项

各选项对应以下头部键值对。

选项	头部	值	默认值
-	X-Powered-By	（删除头部）	是
contentSecurityPolicy	Content-Security-Policy	用法：设置 Content-Security-Policy	未设置
contentSecurityPolicyReportOnly	Content-Security-Policy-Report-Only	用法：设置 Content-Security-Policy	未设置
trustedTypes	Trusted Types	用法：设置 Content-Security-Policy	未设置
requireTrustedTypesFor	Require Trusted Types For	用法：设置 Content-Security-Policy	未设置
crossOriginEmbedderPolicy	Cross-Origin-Embedder-Policy	require-corp	否
crossOriginResourcePolicy	Cross-Origin-Resource-Policy	same-origin	是
crossOriginOpenerPolicy	Cross-Origin-Opener-Policy	same-origin	是
originAgentCluster	Origin-Agent-Cluster	?1	是
referrerPolicy	Referrer-Policy	no-referrer	是
reportingEndpoints	Reporting-Endpoints	用法：设置 Content-Security-Policy	未设置
reportTo	Report-To	用法：设置 Content-Security-Policy	未设置
strictTransportSecurity	Strict-Transport-Security	max-age=15552000; includeSubDomains	是
xContentTypeOptions	X-Content-Type-Options	nosniff	是
xDnsPrefetchControl	X-DNS-Prefetch-Control	off	是
xDownloadOptions	X-Download-Options	noopen	是
xFrameOptions	X-Frame-Options	SAMEORIGIN	是
xPermittedCrossDomainPolicies	X-Permitted-Cross-Domain-Policies	none	是
xXssProtection	X-XSS-Protection	0	是
permissionPolicy	Permissions-Policy	用法：设置 Permission-Policy	未设置

中间件冲突

使用会操作同一头部的中间件时，请注意指定顺序。

此例中，Secure-headers 生效，x-powered-by 被移除：

const app = new Hono()
app.use(secureHeaders())
app.use(poweredBy())

此例中，Powered-By 生效，x-powered-by 被添加：

const app = new Hono()
app.use(poweredBy())
app.use(secureHeaders())

设置 Content-Security-Policy

const app = new Hono()
app.use(
  '/test',
  secureHeaders({
    reportingEndpoints: [
      {
        name: 'endpoint-1',
        url: 'https://example.com/reports',
      },
    ],
    // -- or alternatively
    // reportTo: [
    //   {
    //     group: 'endpoint-1',
    //     max_age: 10886400,
    //     endpoints: [{ url: 'https://example.com/reports' }],
    //   },
    // ],
    contentSecurityPolicy: {
      defaultSrc: ["'self'"],
      baseUri: ["'self'"],
      childSrc: ["'self'"],
      connectSrc: ["'self'"],
      fontSrc: ["'self'", 'https:', 'data:'],
      formAction: ["'self'"],
      frameAncestors: ["'self'"],
      frameSrc: ["'self'"],
      imgSrc: ["'self'", 'data:'],
      manifestSrc: ["'self'"],
      mediaSrc: ["'self'"],
      objectSrc: ["'none'"],
      reportTo: 'endpoint-1',
      reportUri: '/csp-report',
      sandbox: ['allow-same-origin', 'allow-scripts'],
      scriptSrc: ["'self'"],
      scriptSrcAttr: ["'none'"],
      scriptSrcElem: ["'self'"],
      styleSrc: ["'self'", 'https:', "'unsafe-inline'"],
      styleSrcAttr: ['none'],
      styleSrcElem: ["'self'", 'https:', "'unsafe-inline'"],
      upgradeInsecureRequests: [],
      workerSrc: ["'self'"],
    },
  })
)

nonce 属性

将从 hono/secure-headers 导入的 NONCE 添加到 scriptSrc 或 styleSrc，即可为 script 或 style 元素添加 nonce 属性：

import { secureHeaders, NONCE } from 'hono/secure-headers'
import type { SecureHeadersVariables } from 'hono/secure-headers'

// Specify the variable types to infer the `c.get('secureHeadersNonce')`:
type Variables = SecureHeadersVariables

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

// Set the pre-defined nonce value to `scriptSrc`:
app.get(
  '*',
  secureHeaders({
    contentSecurityPolicy: {
      scriptSrc: [NONCE, 'https://allowed1.example.com'],
    },
  })
)

// Get the value from `c.get('secureHeadersNonce')`:
app.get('/', (c) => {
  return c.html(
    <html>
      <body>
        {/** contents */}
        <script
          src='/js/client.js'
          nonce={c.get('secureHeadersNonce')}
        />
      </body>
    </html>
  )
})

要自行生成 nonce 值，也可以按以下方式指定函数：

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

const myNonceGenerator: ContentSecurityPolicyOptionHandler = (c) => {
  // This function is called on every request.
  const nonce = Math.random().toString(36).slice(2)
  c.set('myNonce', nonce)
  return `'nonce-${nonce}'`
}

app.get(
  '*',
  secureHeaders({
    contentSecurityPolicy: {
      scriptSrc: [myNonceGenerator, 'https://allowed1.example.com'],
    },
  })
)

app.get('/', (c) => {
  return c.html(
    <html>
      <body>
        {/** contents */}
        <script src='/js/client.js' nonce={c.get('myNonce')} />
      </body>
    </html>
  )
})

设置 Permission-Policy

Permission-Policy 响应头用于控制浏览器可以使用哪些功能和 API。以下是设置示例：

const app = new Hono()
app.use(
  '*',
  secureHeaders({
    permissionsPolicy: {
      fullscreen: ['self'], // fullscreen=(self)
      bluetooth: ['none'], // bluetooth=(none)
      payment: ['self', 'https://example.com'], // payment=(self "https://example.com")
      syncXhr: [], // sync-xhr=()
      camera: false, // camera=none
      microphone: true, // microphone=*
      geolocation: ['*'], // geolocation=*
      usb: ['self', 'https://a.example.com', 'https://b.example.com'], // usb=(self "https://a.example.com" "https://b.example.com")
      accelerometer: ['https://*.example.com'], // accelerometer=("https://*.example.com")
      gyroscope: ['src'], // gyroscope=(src)
      magnetometer: [
        'https://a.example.com',
        'https://b.example.com',
      ], // magnetometer=("https://a.example.com" "https://b.example.com")
    },
  })
)