NestJS Passport 教程

NestJS Passport 教程

passportPassport module for Nest framework (node.js) 🔑项目地址:https://gitcode.com/gh_mirrors/passp/passport

项目介绍

NestJS Passport 是一个结合 Nest.js 框架与 Passport.js 身份验证库的中间件，它简化了在 Nest.js 应用程序中实现各种身份验证策略的过程。通过 Passport.js 强大的插件系统，开发者可以轻松地添加本地认证、OAuth、JWT（JSON Web Tokens）等多种认证方式。这使得在构建复杂且安全的Web应用程序时，能够高效管理用户认证流程。

项目快速启动

要迅速开始使用 NestJS Passport，首先确保你的开发环境已经安装了 Node.js 和 npm。接下来，遵循以下步骤：

环境准备

1. 创建新的 Nest.js 项目

   npm i -g @nestjs/cli
   nest new my-auth-app
   

2. 安装 NestJS Passport 及其依赖 在项目根目录下执行：

   cd my-auth-app
   npm install --save @nestjs/passport passport passport-local
   

配置认证策略

• 创建一个新的策略服务，如 local.strategy.ts。

  // src/auth/local.strategy.ts
  import { Injectable } from '@nestjs/common';
  import { PassportStrategy } from '@nestjs/passport';
  import { ExtractJwt, Strategy } from 'passport-jwt';
  
  @Injectable()
  export class LocalStrategy extends PassportStrategy(Strategy) {
    constructor() {
      super({
        usernameField: 'username',
      });
    }
  
    async validate(username: string, password: string): Promise<any> {
      // 这里应当添加逻辑去数据库查找用户并验证密码
      // 示例逻辑省略，实际应实现对用户的查找和密码验证
      const user = { username };
      if (!user || password !== 'password') return null;
      return user;
    }
  }
  

• 修改 auth.module.ts 来注册策略和服务。

  // src/auth/auth.module.ts
  imports: [
    PassportModule.register({ defaultStrategy: 'local' }), // 注册PassportModule
  ],
  providers: [AuthService, LocalStrategy],
  

• 更新 app.controller.ts 或相应的控制器来应用认证。

  // src/app.controller.ts
  @UseGuards(AuthGuard('local')) // 使用局部守卫进行身份验证
  @Get('login')
  login(@Request() req) {
    return req.user; // 返回登录成功的用户信息
  }
  

应用案例和最佳实践

在实际应用中，采用 JWT 进行无状态认证是一种常见且推荐的做法。JWT允许你在无需在服务器端存储会话信息的情况下实现安全的身份验证。务必采取措施保护 JWT 的密钥，避免硬编码，并且定期轮换密钥增加安全性。此外，实施适当的错误处理和重试机制，以应对认证失败的情况。

示例：JWT 策略集成

• 安装 JWT 相关包：

  npm install jsonwebtoken passport-jwt
  

• 更新或创建 JWT 策略服务类似上例，使用 passport-jwt 替代 passport-local。

典型生态项目

NestJS Passport 通常与 NestJS 用户模块和其他认证相关的库一起使用，构建完整的认证系统。例如，结合NestJS GraphQL扩展认证至GraphQL接口，或是与NestJS Swagger集成，以便自动生成带有认证要求的API文档，都是该项目生态系统中的典型应用场景。

通过这些组件的组合运用，开发者能够构建出既安全又易于维护的现代Web服务。

passportPassport module for Nest framework (node.js) 🔑项目地址:https://gitcode.com/gh_mirrors/passp/passport