基本身份验证守卫

基本身份验证守卫是 HTTP 身份验证框架的一种实现，客户端必须通过 Authorization 头传递以 base64 编码的字符串形式的用户凭据。如果凭据有效，服务器将允许请求。否则，将显示一个原生的网页提示，要求重新输入凭据。

配置守卫

身份验证守卫在 config/auth.ts 文件中定义。你可以在此文件的 guards 对象下配置多个守卫。

import { defineConfig } from '@adonisjs/auth'
import { basicAuthGuard, basicAuthUserProvider } from '@adonisjs/auth/basic_auth'

const authConfig = defineConfig({
  default: 'basicAuth',
  guards: {
    basicAuth: basicAuthGuard({
      provider: basicAuthUserProvider({
        model: () => import('#models/user'),
      }),
    })
  },
})

export default authConfig

basicAuthGuard 方法创建 BasicAuthGuard 类的实例。它接受一个用户提供者，该提供者可用于在身份验证期间查找用户。

basicAuthUserProvider 方法创建 BasicAuthLucidUserProvider 类的实例。它接受一个模型引用，用于验证用户凭据。

准备用户模型

使用 basicAuthUserProvider 配置的模型（在此示例中为 User 模型）必须使用 AuthFinder 混入，以便在身份验证期间验证用户凭据。

import { DateTime } from 'luxon'
import { compose } from '@adonisjs/core/helpers'
import { BaseModel, column } from '@adonisjs/lucid/orm'
import hash from '@adonisjs/core/services/hash'
import { withAuthFinder } from '@adonisjs/auth/mixins/lucid'

const AuthFinder = withAuthFinder(() => hash.use('scrypt'), {
  uids: ['email'],
  passwordColumnName: 'password',
})

export default class User extends compose(BaseModel, AuthFinder) {
  @column({ isPrimary: true })
  declare id: number

  @column()
  declare fullName: string | null

  @column()
  declare email: string

  @column()
  declare password: string

  @column.dateTime({ autoCreate: true })
  declare createdAt: DateTime

  @column.dateTime({ autoCreate: true, autoUpdate: true })
  declare updatedAt: DateTime
}

保护路由

配置好守卫后，你可以使用 auth 中间件来保护路由，防止未经验证的请求。该中间件在 start/kernel.ts 文件中注册，位于命名中间件集合下。

import router from '@adonisjs/core/services/router'

export const middleware = router.named({
  auth: () => import('#middleware/auth_middleware')
})

import { middleware } from '#start/kernel'
import router from '@adonisjs/core/services/router'

router
  .get('dashboard', ({ auth }) => {
    return auth.user
  })
  .use(middleware.auth({
    guards: ['basicAuth']
  }))

处理身份验证异常

如果用户未通过身份验证，auth 中间件将抛出 E_UNAUTHORIZED_ACCESS 异常。该异常会自动转换为带有 WWW-Authenticate 头的 HTTP 响应。WWW-Authenticate 头会挑战身份验证，并触发一个原生的网页提示，要求重新输入凭据。

访问已身份验证的用户

你可以使用 auth.user 属性访问已登录的用户实例。由于你使用了 auth 中间件，auth.user 属性将始终可用。

import { middleware } from '#start/kernel'
import router from '@adonisjs/core/services/router'

router
  .get('dashboard', ({ auth }) => {
    return `You are authenticated as ${auth.user!.email}`
  })
  .use(middleware.auth({
    guards: ['basicAuth']
  }))

获取已身份验证的用户或失败

如果你不喜欢在 auth.user 属性上使用非空断言操作符，你可以使用 auth.getUserOrFail 方法。此方法将返回用户对象或抛出 E_UNAUTHORIZED_ACCESS 异常。

import { middleware } from '#start/kernel'
import router from '@adonisjs/core/services/router'

router
  .get('dashboard', ({ auth }) => {
    const user = auth.getUserOrFail()
    return `You are authenticated as ${user.email}`
  })
  .use(middleware.auth({
    guards: ['basicAuth']
  }))

身份认证

访问令牌守卫