IP Restriction Middleware

IP Restriction Middleware 是一个中间件，它基于用户的 IP 地址来限制对资源的访问。

Import

import { Hono } from 'hono'
import { ipRestriction } from 'hono/ip-restriction'

Usage

对于在 Bun 上运行的应用程序，如果您只想允许来自本地的访问，您可以像下面这样编写。 在 denyList 中指定您想要拒绝的规则，并在 allowList 中指定您想要允许的规则。

import { Hono } from 'hono'
import { getConnInfo } from 'hono/bun'
import { ipRestriction } from 'hono/ip-restriction'

const app = new Hono()

app.use(
  '*',
  ipRestriction(getConnInfo, {
    denyList: [],
    allowList: ['127.0.0.1', '::1'],
  })
)

app.get('/', (c) => c.text('Hello Hono!'))

将适用于您环境的 ConnInfo helper 中的 getConninfo 作为 ipRestriction 的第一个参数传递。 例如，对于 Deno，它看起来像这样：

import { getConnInfo } from 'hono/deno'
import { ipRestriction } from 'hono/ip-restriction'

//...

app.use(
  '*',
  ipRestriction(getConnInfo, {
    // ...
  })
)

Rules

请按照以下说明编写规则。

IPv4

• 192.168.2.0 - 静态 IP 地址
• 192.168.2.0/24 - CIDR 表示法
• * - 所有地址

IPv6

• ::1 - 静态 IP 地址
• ::1/10 - CIDR 表示法
• * - 所有地址

Error handling

要自定义错误处理，请在第三个参数中返回一个 Response。

app.use(
  '*',
  ipRestriction(
    getConnInfo,
    {
      denyList: ['192.168.2.0/24'],
    },
    async (remote, c) => {
      return c.text(`Blocking access from ${remote.addr}`, 403) // 阻止来自 ${remote.addr} 的访问
    }
  )
)