NestJS 中文文档

认证

认证是大多数应用程序的必备组件。有许多不同的方法和策略来处理认证。任何项目采用的方法取决于其特定的应用需求。本章介绍了几种可以适应各种不同需求的认证方法。

让我们完善一下我们的需求。在这个用例中，客户端将首先使用用户名和密码进行认证。一旦认证成功，服务器将颁发一个 JWT，可以在后续请求中作为 bearer token 在授权头中发送，以证明认证。我们还将创建一个受保护的路由，只有包含有效 JWT 的请求才能访问。

我们将从第一个需求开始：认证用户。然后我们将通过颁发 JWT 来扩展该功能。最后，我们将创建一个受保护的路由，用于检查请求中是否包含有效的 JWT。

创建认证模块

我们将首先生成一个 AuthModule，并在其中创建一个 AuthService 和一个 AuthController。我们将使用 AuthService 来实现认证逻辑，使用 AuthController 来暴露认证端点。

$ nest g module auth
$ nest g controller auth
$ nest g service auth

在实现 AuthService 时，我们会发现将用户操作封装在 UsersService 中很有用，所以现在让我们生成该模块和服务：

$ nest g module users
$ nest g service users

如下所示替换这些生成文件的默认内容。对于我们的示例应用，UsersService 只是维护一个硬编码的内存用户列表，以及一个通过用户名检索用户的方法。在实际应用中，这是你构建用户模型和持久层的地方，可以使用你选择的库（例如 TypeORM、Sequelize、Mongoose 等）。

import { Injectable } from '@nestjs/common';

// This should be a real class/interface representing a user entity
export type User = any;

@Injectable()
export class UsersService {
  private readonly users = [
    {
      userId: 1,
      username: 'john',
      password: 'changeme',
    },
    {
      userId: 2,
      username: 'maria',
      password: 'guess',
    },
  ];

  async findOne(username: string): Promise<User | undefined> {
    return this.users.find(user => user.username === username);
  }
}

@Injectable()
export class UsersService {
  constructor() {
    this.users = [
      {
        userId: 1,
        username: 'john',
        password: 'changeme',
      },
      {
        userId: 2,
        username: 'maria',
        password: 'guess',
      },
    ];
  }

  async findOne(username) {
    return this.users.find(user => user.username === username);
  }
}

在 UsersModule 中，唯一需要的更改是将 UsersService 添加到 @Module 装饰器的 exports 数组中，以便它在此模块外部可见（我们很快将在 AuthService 中使用它）。

import { Module } from '@nestjs/common';
import { UsersService } from './users.service';

@Module({
  providers: [UsersService],
  exports: [UsersService],
})
export class UsersModule {}

@Module({
  providers: [UsersService],
  exports: [UsersService],
})
export class UsersModule {}

实现"登录"端点

我们的 AuthService 负责检索用户并验证密码。为此我们创建一个 signIn() 方法。在下面的代码中，我们使用方便的 ES6 展开运算符在返回用户对象之前从中剥离密码属性。这是返回用户对象时的常见做法，因为你不想暴露密码或其他安全密钥等敏感字段。

import { Injectable, UnauthorizedException } from '@nestjs/common';
import { UsersService } from '../users/users.service';

@Injectable()
export class AuthService {
  constructor(private usersService: UsersService) {}

  async signIn(username: string, pass: string): Promise<any> {
    const user = await this.usersService.findOne(username);
    if (user?.password !== pass) {
      throw new UnauthorizedException();
    }
    const { password, ...result } = user;
    // TODO: Generate a JWT and return it here
    // instead of the user object
    return result;
  }
}

@Injectable()
@Dependencies(UsersService)
export class AuthService {
  constructor(usersService) {
    this.usersService = usersService;
  }

  async signIn(username: string, pass: string) {
    const user = await this.usersService.findOne(username);
    if (user?.password !== pass) {
      throw new UnauthorizedException();
    }
    const { password, ...result } = user;
    // TODO: Generate a JWT and return it here
    // instead of the user object
    return result;
  }
}

警告

当然，在实际应用中，你不会以明文形式存储密码。你应该使用像 bcrypt 这样的库，采用加盐单向哈希算法。使用这种方法，你只存储哈希密码，然后将存储的密码与传入密码的哈希版本进行比较，从而永远不会以明文形式存储或暴露用户密码。为了保持示例应用的简单性，我们违反了这一绝对规定，使用明文。不要在你的实际应用中这样做！

现在，我们更新 AuthModule 以导入 UsersModule。

import { Module } from '@nestjs/common';
import { AuthService } from './auth.service';
import { AuthController } from './auth.controller';
import { UsersModule } from '../users/users.module';

@Module({
  imports: [UsersModule],
  providers: [AuthService],
  controllers: [AuthController],
})
export class AuthModule {}

@Module({
  imports: [UsersModule],
  providers: [AuthService],
  controllers: [AuthController],
})
export class AuthModule {}

有了这些，让我们打开 AuthController 并添加一个 signIn() 方法。客户端将调用此方法来认证用户。它将在请求体中接收用户名和密码，如果用户认证成功则返回 JWT 令牌。

import { Body, Controller, Post, HttpCode, HttpStatus } from '@nestjs/common';
import { AuthService } from './auth.service';

@Controller('auth')
export class AuthController {
  constructor(private authService: AuthService) {}

  @HttpCode(HttpStatus.OK)
  @Post('login')
  signIn(@Body() signInDto: Record<string, any>) {
    return this.authService.signIn(signInDto.username, signInDto.password);
  }
}

提示

理想情况下，我们应该使用 DTO 类来定义请求体的形状，而不是使用 Record<string, any> 类型。有关更多信息，请参阅验证章节。

JWT 令牌

我们已准备好进入认证系统的 JWT 部分。让我们回顾并完善我们的需求：

允许用户使用用户名/密码进行认证，返回一个 JWT 用于后续调用受保护的 API 端点。我们已经朝着满足这一需求的方向迈进了。为了完成它，我们需要编写颁发 JWT 的代码。
创建基于有效 JWT 作为 bearer token 存在而受保护的 API 路由

我们需要安装一个额外的包来支持我们的 JWT 需求：

$ npm install --save @nestjs/jwt

提示

@nestjs/jwt 包（在此处了解更多）是一个帮助处理 JWT 的实用程序包。这包括生成和验证 JWT 令牌。

为了保持服务的模块化，我们将在 authService 中处理 JWT 的生成。打开 auth 文件夹中的 auth.service.ts 文件，注入 JwtService，并更新 signIn 方法以生成 JWT 令牌，如下所示：

import { Injectable, UnauthorizedException } from '@nestjs/common';
import { UsersService } from '../users/users.service';
import { JwtService } from '@nestjs/jwt';

@Injectable()
export class AuthService {
  constructor(
    private usersService: UsersService,
    private jwtService: JwtService
  ) {}

  async signIn(
    username: string,
    pass: string,
  ): Promise<{ access_token: string }> {
    const user = await this.usersService.findOne(username);
    if (user?.password !== pass) {
      throw new UnauthorizedException();
    }
    const payload = { sub: user.userId, username: user.username };
    return {
      // 💡 Here the JWT secret key that's used for signing the payload 
      // is the key that was passsed in the JwtModule
      access_token: await this.jwtService.signAsync(payload),
    };
  }
}

@Dependencies(UsersService, JwtService)
@Injectable()
export class AuthService {
  constructor(usersService, jwtService) {
    this.usersService = usersService;
    this.jwtService = jwtService;
  }

  async signIn(username, pass) {
    const user = await this.usersService.findOne(username);
    if (user?.password !== pass) {
      throw new UnauthorizedException();
    }
    const payload = { username: user.username, sub: user.userId };
    return {
      // 💡 Here the JWT secret key that's used for signing the payload 
      // is the key that was passsed in the JwtModule
      access_token: await this.jwtService.signAsync(payload),
    };
  }
}

我们使用 @nestjs/jwt 库，它提供了 signAsync() 函数来从 user 对象属性的子集生成我们的 JWT，然后我们将其作为一个简单的对象返回，该对象具有单个 access_token 属性。注意：我们选择一个名为 sub 的属性来保存我们的 userId 值，以符合 JWT 标准。

现在我们需要更新 AuthModule 以导入新的依赖项并配置 JwtModule。

首先，在 auth 文件夹中创建 constants.ts，并添加以下代码：

export const jwtConstants = {
  secret: 'DO NOT USE THIS VALUE. INSTEAD, CREATE A COMPLEX SECRET AND KEEP IT SAFE OUTSIDE OF THE SOURCE CODE.',
};

我们将使用它在 JWT 签名和验证步骤之间共享我们的密钥。

警告

不要公开暴露此密钥。我们在这里这样做是为了让代码的作用更加清晰，但在生产系统中，你必须使用适当的措施（如密钥库、环境变量或配置服务）来保护此密钥。

现在，打开 auth 文件夹中的 auth.module.ts 并将其更新为如下所示：

import { Module } from '@nestjs/common';
import { AuthService } from './auth.service';
import { UsersModule } from '../users/users.module';
import { JwtModule } from '@nestjs/jwt';
import { AuthController } from './auth.controller';
import { jwtConstants } from './constants';

@Module({
  imports: [
    UsersModule,
    JwtModule.register({
      global: true,
      secret: jwtConstants.secret,
      signOptions: { expiresIn: '60s' },
    }),
  ],
  providers: [AuthService],
  controllers: [AuthController],
  exports: [AuthService],
})
export class AuthModule {}

@Module({
  imports: [
    UsersModule,
    JwtModule.register({
      global: true,
      secret: jwtConstants.secret,
      signOptions: { expiresIn: '60s' },
    }),
  ],
  providers: [AuthService],
  controllers: [AuthController],
  exports: [AuthService],
})
export class AuthModule {}

提示

我们将 JwtModule 注册为全局模块，以使事情更简单。这意味着我们不需要在应用程序的其他任何地方导入 JwtModule。

我们使用 register() 配置 JwtModule，传入一个配置对象。有关 Nest JwtModule 的更多信息，请参阅此处，有关可用配置选项的更多详细信息，请参阅此处。

让我们继续使用 cURL 再次测试我们的路由。你可以使用 UsersService 中硬编码的任何 user 对象进行测试。

$ # POST to /auth/login
$ curl -X POST http://localhost:3000/auth/login -d '{"username": "john", "password": "changeme"}' -H "Content-Type: application/json"
{"access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}
$ # Note: above JWT truncated

实现认证守卫

我们现在可以解决我们的最后一个需求：通过要求请求中存在有效的 JWT 来保护端点。我们将通过创建一个 AuthGuard 来实现这一点，我们可以用它来保护我们的路由。

import {
  CanActivate,
  ExecutionContext,
  Injectable,
  UnauthorizedException,
} from '@nestjs/common';
import { JwtService } from '@nestjs/jwt';
import { Request } from 'express';

@Injectable()
export class AuthGuard implements CanActivate {
  constructor(private jwtService: JwtService) {}

  async canActivate(context: ExecutionContext): Promise<boolean> {
    const request = context.switchToHttp().getRequest();
    const token = this.extractTokenFromHeader(request);
    if (!token) {
      throw new UnauthorizedException();
    }
    try {
      // 💡 Here the JWT secret key that's used for verifying the payload 
      // is the key that was passsed in the JwtModule
      const payload = await this.jwtService.verifyAsync(token);
      // 💡 We're assigning the payload to the request object here
      // so that we can access it in our route handlers
      request['user'] = payload;
    } catch {
      throw new UnauthorizedException();
    }
    return true;
  }

  private extractTokenFromHeader(request: Request): string | undefined {
    const [type, token] = request.headers.authorization?.split(' ') ?? [];
    return type === 'Bearer' ? token : undefined;
  }
}

我们现在可以实现我们的受保护路由并注册我们的 AuthGuard 来保护它。

打开 auth.controller.ts 文件并按如下所示更新它：

import {
  Body,
  Controller,
  Get,
  HttpCode,
  HttpStatus,
  Post,
  Request,
  UseGuards
} from '@nestjs/common';
import { AuthGuard } from './auth.guard';
import { AuthService } from './auth.service';

@Controller('auth')
export class AuthController {
  constructor(private authService: AuthService) {}

  @HttpCode(HttpStatus.OK)
  @Post('login')
  signIn(@Body() signInDto: Record<string, any>) {
    return this.authService.signIn(signInDto.username, signInDto.password);
  }

  @UseGuards(AuthGuard)
  @Get('profile')
  getProfile(@Request() req) {
    return req.user;
  }
}

我们将刚刚创建的 AuthGuard 应用于 GET /profile 路由，使其受到保护。

确保应用程序正在运行，并使用 cURL 测试路由。

$ # GET /profile
$ curl http://localhost:3000/auth/profile
{"statusCode":401,"message":"Unauthorized"}

$ # POST /auth/login
$ curl -X POST http://localhost:3000/auth/login -d '{"username": "john", "password": "changeme"}' -H "Content-Type: application/json"
{"access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2Vybm..."}

$ # GET /profile using access_token returned from previous step as bearer code
$ curl http://localhost:3000/auth/profile -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2Vybm..."
{"sub":1,"username":"john","iat":...,"exp":...}

请注意，在 AuthModule 中，我们将 JWT 配置为具有 60 秒的过期时间。这是一个太短的过期时间，处理令牌过期和刷新的细节超出了本文的范围。然而，我们选择这个时间是为了演示 JWT 的一个重要特性。如果你在认证后等待 60 秒再尝试 GET /auth/profile 请求，你将收到 401 Unauthorized 响应。这是因为 @nestjs/jwt 会自动检查 JWT 的过期时间，省去了你在应用程序中这样做的麻烦。

我们现在已经完成了 JWT 认证实现。JavaScript 客户端（如 Angular/React/Vue）和其他 JavaScript 应用现在可以认证并与我们的 API 服务器安全通信。

全局启用认证

如果绝大多数端点默认应该受到保护，你可以将认证守卫注册为全局守卫，而不是在每个控制器上使用 @UseGuards() 装饰器，你可以简单地标记哪些路由应该是公开的。

首先，使用以下构造将 AuthGuard 注册为全局守卫（在任何模块中，例如在 AuthModule 中）：

providers: [
  {
    provide: APP_GUARD,
    useClass: AuthGuard,
  },
],

有了这个配置，Nest 将自动将 AuthGuard 绑定到所有端点。

现在我们必须提供一种机制来声明路由为公开的。为此，我们可以使用 SetMetadata 装饰器工厂函数创建一个自定义装饰器。

import { SetMetadata } from '@nestjs/common';

export const IS_PUBLIC_KEY = 'isPublic';
export const Public = () => SetMetadata(IS_PUBLIC_KEY, true);

在上面的文件中，我们导出了两个常量。一个是我们的元数据键，名为 IS_PUBLIC_KEY，另一个是我们的新装饰器本身，我们将称之为 Public（你也可以将其命名为 SkipAuth 或 AllowAnon，只要适合你的项目即可）。

现在我们有了一个自定义的 @Public() 装饰器，我们可以用它来装饰任何方法，如下所示：

@Public()
@Get()
findAll() {
  return [];
}

最后，我们需要 AuthGuard 在找到 "isPublic" 元数据时返回 true。为此，我们将使用 Reflector 类（在此处了解更多）。

@Injectable()
export class AuthGuard implements CanActivate {
  constructor(private jwtService: JwtService, private reflector: Reflector) {}

  async canActivate(context: ExecutionContext): Promise<boolean> {
    const isPublic = this.reflector.getAllAndOverride<boolean>(IS_PUBLIC_KEY, [
      context.getHandler(),
      context.getClass(),
    ]);
    if (isPublic) {
      // 💡 See this condition
      return true;
    }

    const request = context.switchToHttp().getRequest();
    const token = this.extractTokenFromHeader(request);
    if (!token) {
      throw new UnauthorizedException();
    }
    try {
      // 💡 Here the JWT secret key that's used for verifying the payload 
      // is the key that was passsed in the JwtModule
      const payload = await this.jwtService.verifyAsync(token);
      // 💡 We're assigning the payload to the request object here
      // so that we can access it in our route handlers
      request['user'] = payload;
    } catch {
      throw new UnauthorizedException();
    }
    return true;
  }

  private extractTokenFromHeader(request: Request): string | undefined {
    const [type, token] = request.headers.authorization?.split(' ') ?? [];
    return type === 'Bearer' ? token : undefined;
  }
}

Passport 集成

Passport 是最流行的 node.js 认证库，被社区广泛认可，并成功用于许多生产应用程序。使用 @nestjs/passport 模块将此库与 Nest 应用程序集成非常简单。

要了解如何将 Passport 与 NestJS 集成，请查看此章节。

示例

你可以在此处找到本章代码的完整版本。

#认证

#创建认证模块

#实现"登录"端点

#JWT 令牌

#实现认证守卫

#全局启用认证

#Passport 集成

#示例