NestJS 패스포트 및 세션 사용 방법

1npm install @nestjs/passport passport passport-local express-session

1npm install --save-dev @types/passport-local @types/express-session

1/* ... */
2
3import * as session from "express-session";
4import * as passport from "passport";
5
6// NestJS를 실행시키는 함수
7// NestJS에서는 진입점을 bootstrap()으로 이름 짓는 것이 관례이다.
8async function bootstrap() {
9  /* ... */
10
11  // 세션 사용
12  app.use(
13    session({
14      secret: "very-important-secret", // 세션 암호화에 사용되는 키
15      resave: false, // 세션을 항상 저장할 지 여부
16      saveUninitialized: false, // 세션이 저장되기 전에는 초기화되지 않은 상태로 세션을 미리 만들어 저장
17      cookie: { maxAge: 1000 * 60 * 60 }, // 쿠키 유효기간: 1시간
18    }),
19  );
20
21  // passport 초기화 및 세션 저장소 초기화
22  app.use(passport.initialize());
23  app.use(passport.session());
24
25  /* ... */
26}
27
28bootstrap();

1// auth.guard.ts
2
3import { CanActivate, ExecutionContext, Injectable } from "@nestjs/common";
4import { AuthGuard } from "@nestjs/passport";
5
6// AuthGuard 상속
7@Injectable()
8export class LocalAuthGuard extends AuthGuard("local") {
9  async canActivate(context: ExecutionContext): Promise<boolean> {
10    const result = (await super.canActivate(context)) as boolean;
11
12    // 로컬 스트래티지 실행
13    const request = context.switchToHttp().getRequest();
14    await super.logIn(request); // 세션 저장
15    return result;
16  }
17}
18
19@Injectable()
20export class AuthenticatedGuard implements CanActivate {
21  canActivate(context: ExecutionContext): Promise<boolean> {
22    const request = context.switchToHttp().getRequest();
23    return request.isAuthenticated(); // 세션에서 정보를 읽어서 인증 확인
24  }
25}

1// local.strategy.ts
2
3import { Injectable } from "@nestjs/common";
4import { PassportStrategy } from "@nestjs/passport";
5import { Strategy } from "passport-local";
6import { AuthService } from "./auth.service";
7
8@Injectable()
9export class LocalStrategy extends PassportStrategy(Strategy) {
10  // PassportStrategy 믹스인
11  constructor(private authService: AuthService) {
12    super({ usernameField: "email" }); // 기본값이 username이므로 email로 변경해줌
13  }
14
15  // 유저 정보의 유효성 검증
16  async validate(email: string, password: string): Promise<any> {
17    const user = await this.authService.validateUser(email, password);
18    if (!user) {
19      return null; // null이면 401 에러 발생
20    }
21    return user; // null이 아니면 user 정보 반환
22  }
23}

1// session.serializer.ts
2
3import { Injectable } from "@nestjs/common";
4import { PassportSerializer } from "@nestjs/passport";
5import { UserService } from "../user/user.service";
6
7// PassportSerializer를 상속받음
8@Injectable()
9export class SessionSerializer extends PassportSerializer {
10  // userService를 주입받음
11  constructor(private userService: UserService) {
12    super();
13  }
14
15  // 세션에서 정보를 저장할 때 사용
16  serializeUser(user: any, done: (err: Error, user: any) => void): any {
17    done(null, user.email); // 세션에 저장할 정보
18  }
19
20  // 세션에서 정보를 꺼내올 때 사용
21  async deserializeUser(
22    payload: any,
23    done: (err: Error, payload) => void,
24  ): Promise<any> {
25    const user = await this.userService.getUser(payload);
26
27    // 유저 정보가 없는 경우 done() 함수에 에러 전달
28    if (!user) {
29      done(new Error("No User"), null);
30      return;
31    }
32
33    // eslint-disable-next-line @typescript-eslint/no-unused-vars
34    const { password, ...userInfo } = user;
35
36    // 유저 정보가 있다면 유저 정보 반환
37    done(null, userInfo);
38  }
39}

1import { Module } from "@nestjs/common";
2import { AuthController } from "./auth.controller";
3import { AuthService } from "./auth.service";
4import { UserModule } from "../user/user.module";
5import { PassportModule } from "@nestjs/passport";
6import { LocalStrategy } from "./local.strategy";
7import { SessionSerializer } from "./session.serializer";
8
9@Module({
10  imports: [UserModule, PassportModule.register({ session: true })],
11  controllers: [AuthController],
12  providers: [AuthService, LocalStrategy, SessionSerializer],
13})
14export class AuthModule {}

1// auth.controller.ts
2
3  /* ... */
4
5  @UseGuards(LocalAuthGuard)
6  @Post('login3')
7  login3(@Request() req) {
8    return req.user;
9  }
10
11  @UseGuards(AuthenticatedGuard)
12  @Get('test-guard2')
13  testGuardWithSession(@Request() req) {
14    return req.user;
15  }
16
17  /* ... */