Basic 認証ミドルウェア

このミドルウェアは、特定のパスに Basic 認証を設定することができます。 Cloudflare Workers や他のプラットフォームで Basic 認証を実装することは思ったよりも複雑ですが、このミドルウェアを使えば簡単にできます。

Basic 認証方式が内部でどのように動くか知りたい場合は、 MDN のドキュメント をご覧ください。

Import

import { Hono } from 'hono'
import { basicAuth } from 'hono/basic-auth'

使い方

const app = new Hono()

app.use(
  '/auth/*',
  basicAuth({
    username: 'hono',
    password: 'acoolproject',
  })
)

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

特定のルート + メソッドを制限します:

const app = new Hono()

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

app.delete(
  '/auth/page',
  basicAuth({ username: 'hono', password: 'acoolproject' }),
  (c) => {
    return c.text('Page deleted')
  }
)

ユーザーを自分で検証したい場合は、 verifyUser オプションを指定してください。 true を返すことで、資格情報が受け入れられたことを示します。

const app = new Hono()

app.use(
  basicAuth({
    verifyUser: (username, password, c) => {
      return (
        username === 'dynamic-user' && password === 'hono-password'
      )
    },
  })
)

オプション

required username: string

認証されている人のユーザー名。

required password: string

そのユーザーのパスワード。

optional realm: string

The domain name of the realm, as part of the returned WWW-Authenticate challenge header. The default is "Secure Area". 詳しくは: https://developer.mozilla.org/ja/docs/Web/HTTP/Reference/Headers/WWW-Authenticate#digest

optional hashFunction: Function

パスワードを安全に比較するためのハッシュ関数。

optional verifyUser: (username: string, password: string, c: Context) => boolean | Promise<boolean>

ユーザーを検証する関数。

optional invalidUserMessage: string | object | MessageFunction

MessageFunction は (c: Context) => string | object | Promise<string | object> 。 ユーザーが無効だったときのメッセージ。

More Options

optional ...users: { username: string, password: string }[]

レシピ

複数ユーザーの設定

このミドルウェアでは、 username と password のペアを含む任意の数のオブジェクトをパラメータとして渡すこともできます。

app.use(
  '/auth/*',
  basicAuth(
    {
      username: 'hono',
      password: 'acoolproject',
      // Define other params in the first object
      realm: 'www.example.com',
    },
    {
      username: 'hono-admin',
      password: 'super-secure',
      // Cannot redefine other params here
    },
    {
      username: 'hono-user-1',
      password: 'a-secret',
      // Or here
    }
  )
)

Or less hardcoded:

import { users } from '../config/users'

app.use(
  '/auth/*',
  basicAuth(
    {
      realm: 'www.example.com',
      ...users[0],
    },
    ...users.slice(1)
  )
)