Guards

이 글은 Nest 공식문서를 번역한 글입니다. 원문

가드는 @Injectable() 데코레이터로 주석이 달린 클래스로, CanActivate 인터페이스를 구현합니다.

가드는 단일 책임이 있습니다. 이들은 런타임에 존재하는 특정 조건(권한, 역할, ACL 등)에 따라 특정 요청이 route handler에 의해 처리될지 여부를 결정합니다. 이를 authorization(권한 부여) 라고도 합니다. 권한 부여(그리고 일반적으로 함께 협력하는 사촌인 authentication)는 일반적으로 기존 Express 애플리케이션의 middleware가 처리해 왔습니다. 토큰 유효성 검사 및 요청 객체에 속성 첨부 등의 작업은 특정 경로 컨텍스트(및 해당 메타데이터)와 밀접하게 연결되어 있지 않으므로 미들웨어는 인증에 적합한 선택입니다.

하지만 미들웨어는 본질적으로 멍청합니다. next() 함수를 호출한 후 어떤 핸들러가 실행될지 모릅니다. 반면에 가드는 ExecutionContext 인스턴스에 액세스할 수 있으므로 다음에 무엇이 실행될지 정확히 알 수 있습니다. 예외 필터, 파이프, 인터셉터와 마찬가지로 요청/응답 주기의 정확한 지점에 처리 로직을 삽입할 수 있도록 설계되어 있으며 선언적으로 처리할 수 있습니다. 따라서 코드를 간결하고 선언적으로 유지하는 데 도움이 됩니다.

🖋️

HINT

가드는 모든 미들웨어 이후에 실행되지만 인터셉터나 파이프보다 먼저 실행 됩니다.

Authorization guard#

앞서 언급했듯이 authorization은 호출자(일반적으로 인증된 특정 사용자)에게 충분한 권한이 있는 경우에만 특정 경로를 사용할 수 있어야 하므로 가드에 매우 유용한 사용 사례입니다. 지금 빌드할 AuthGuard는 인증된 사용자(따라서 토큰이 요청 헤더에 첨부되어 있음)를 가정합니다. 토큰을 추출하여 유효성을 검사하고 추출된 정보를 사용하여 요청을 진행할 수 있는지 여부를 결정합니다.

import { Injectable, CanActivate, ExecutionContext } from "@nestjs/common";
import { Observable } from "rxjs";
 
@Injectable()
export class AuthGuard implements CanActivate {
  canActivate(context: ExecutionContext): boolean | Promise<boolean> | Observable<boolean> {
    const request = context.switchToHttp().getRequest();
    return validateRequest(request);
  }
}

🖋️

HINT

애플리케이션에서 인증 메커니즘을 구현하는 방법에 대한 실제 예시를 찾고 있다면 여기를 참조하세요. 마찬가지로 보다 정교한 인증 예제를 보려면 여기를 확인하세요.

validateRequest() 함수 내부의 로직은 필요에 따라 간단하거나 정교할 수 있습니다. 이 예제의 요점은 가드가 요청/응답 주기에 어떻게 들어맞는지 보여주는 것입니다.

모든 가드는 canActivate() 함수를 구현해야 합니다. 이 함수는 현재 요청이 허용되는지 여부를 나타내는 boolean을 반환해야 합니다. 이 함수는 응답을 동기식 또는 비동기식(Promise 또는 Observable을 통해)으로 반환할 수 있습니다. Nest는 반환값을 사용하여 다음 작업을 제어합니다.

• 반환값이 참이면 요청이 처리됩니다.
• 반환값이 거짓이면 Nest는 요청을 거부합니다.

Execution context#

canActivate() 함수는 단일 인수인 ExecutionContext 인스턴스를 받습니다. ExecutionContext는 ArgumentsHost에서 상속됩니다. 앞서 예외 필터 챕터에서 ArgumentsHost를 살펴봤습니다. 위의 샘플에서는 이전에 사용한 것과 동일한 헬퍼 메서드를 ArgumentsHost에 정의하여 요청 객체에 대한 참조를 가져오고 있습니다. 이 주제에 대한 자세한 내용은exception filters의 Arguments host 섹션을 다시 참조하세요.

ArgumentsHost를 확장함으로써 ExecutionContext는 현재 실행 프로세스에 대한 추가 세부 정보를 제공하는 몇 가지 새로운 헬퍼 메서드도 추가합니다. 이러한 세부 정보는 광범위한 컨트롤러, 메서드 및 실행 컨텍스트에서 작동할 수 있는 보다 일반적인 가드를 구축하는 데 유용할 수 있습니다. 여기에서 실행 컨텍스트에 대해 자세히 알아보세요.

Role-based authentication#

특정 역할을 가진 사용자에게만 액세스를 허용하는 보다 기능적인 가드를 구축해 보겠습니다. 기본 가드 템플릿으로 시작하여 다음 섹션에서 이를 기반으로 구축해 보겠습니다. 지금은 모든 요청이 진행되도록 허용합니다.

import { Injectable, CanActivate, ExecutionContext } from "@nestjs/common";
import { Observable } from "rxjs";
 
@Injectable()
export class RolesGuard implements CanActivate {
  canActivate(context: ExecutionContext): boolean | Promise<boolean> | Observable<boolean> {
    return true;
  }
}

Binding guards#

가드는 파이프 및 예외 필터와 마찬가지로 컨트롤러 범위, 메서드 범위 또는 전역 범위로 지정할 수 있습니다. 아래에서는 @UseGuards() 데코레이터를 사용하여 컨트롤러 범위 가드를 설정했습니다. 이 데코레이터는 단일 인수를 받거나 쉼표로 구분된 인수의 목록을 받을 수 있습니다. 이를 통해 하나의 선언으로 적절한 가드 집합을 쉽게 적용할 수 있습니다.

@Controller("cats")
@UseGuards(RolesGuard)
export class CatsController {}

위에서는 인스턴스 대신 RolesGuard 클래스를 전달하여 인스턴스화에 대한 책임을 프레임워크에 맡기고 종속성 주입을 활성화했습니다. 파이프 및 예외 필터와 마찬가지로 in-place instance를 전달할 수도 있습니다.

@Controller("cats")
@UseGuards(new RolesGuard())
export class CatsController {}

위의 구조는 이 컨트롤러가 선언한 모든 핸들러에 가드를 첨부합니다. 가드를 단일 메서드에만 적용하려면 메서드 수준에서 @UseGuards() 데코레이터를 적용하면 됩니다.

전역 가드를 설정하려면 Nest 애플리케이션 인스턴스의 useGlobalGuards() 메서드를 사용합니다.

const app = await NestFactory.create(AppModule);
app.useGlobalGuards(new RolesGuard());

🚨

NOTICE

하이브리드 앱의 경우 useGlobalGuards() 메서드는 기본적으로 게이트웨이 및 마이크로 서비스에 대한 가드를 설정하지 않습니다(이 동작을 변경하는 방법에 대한 자세한 내용은  Hybrid application을 참조하세요). "표준"(비하이브리드) 마이크로서비스 앱의 경우, useGlobalGuards()는 가드를 전역적으로 마운트합니다.

글로벌 가드는 모든 컨트롤러와 모든 라우트 핸들러에 대해 전체 애플리케이션에서 사용됩니다. 종속성 주입과 관련하여, 모듈 외부에서 등록된 글로벌 가드(위 예제에서와 같이 useGlobalGuards()로)는 모든 모듈의 컨텍스트 외부에서 수행되므로 종속성을 주입할 수 없습니다. 이 문제를 해결하기 위해 다음 구성을 사용하여 모든 모듈에서 직접 가드를 설정할 수 있습니다:

import { Module } from "@nestjs/common";
import { APP_GUARD } from "@nestjs/core";
 
@Module({
  providers: [
    {
      provide: APP_GUARD,
      useClass: RolesGuard,
    },
  ],
})
export class AppModule {}

🖋️

HINT

이 접근 방식을 사용하여 가드에 대한 종속성 주입을 수행할 때 이 구조가 사용되는 모듈에 관계없이 가드는 실제로 전역이라는 점에 유의하세요. 이 작업은 어디에서 수행해야 할까요? 가드가 정의된 모듈(위 예제에서는 RolesGuard)을 선택합니다. 또한 useClass가 사용자 지정 공급자 등록을 처리하는 유일한 방법은 아닙니다. 여기에서 자세히 알아보세요.

Setting roles per handler#

RolesGuard가 작동하고 있지만 아직은 그다지 똑똑하지는 않습니다. 가장 중요한 가드 기능인 실행 컨텍스트를 아직 활용하지 못하고 있습니다. 아직 역할이나 각 핸들러에 허용되는 역할에 대해 알지 못합니다. 예를 들어, CatsController는 경로마다 다른 권한 체계를 가질 수 있습니다. 일부는 관리자 사용자만 사용할 수 있고 다른 일부는 모든 사용자에게 개방되어 있을 수 있습니다. 어떻게 하면 유연하고 재사용 가능한 방식으로 역할을 경로에 일치시킬 수 있을까요?

여기서 사용자 지정 메타데이터가 중요한 역할을 합니다(여기에서 자세히 알아보기). Nest는 Reflector#createDecorator 정적 메서드를 통해 생성된 데코레이터 또는 기본 제공 @SetMetadata() 데코레이터를 통해 사용자 정의 메타데이터를 라우트 핸들러에 첨부할 수 있는 기능을 제공합니다.

예를 들어, 메타데이터를 핸들러에 첨부하는 Reflector#createDecorator 메서드를 사용하여 @Roles() 데코레이터를 생성해 보겠습니다. 리플렉터는 프레임워크에서 기본적으로 제공되며 @nestjs/core 패키지에서 노출됩니다.

import { Reflector } from "@nestjs/core";
 
export const Roles = Reflector.createDecorator<string[]>();

@Post()
@Roles(['admin'])
async create(@Body() createCatDto: CreateCatDto) {
  this.catsService.create(createCatDto);
}

여기에서는 관리자 역할이 있는 사용자만 이 경로에 액세스할 수 있도록 하기 위해 create() 메서드에 역할 데코레이터 메타데이터를 첨부했습니다.

또는 Reflector#createDecorator 메서드를 사용하는 대신 내장된 @SetMetadata() 데코레이터를 사용할 수 있습니다. 여기에서 자세히 알아보세요.

Putting it all together#

이제 돌아가서 이를 RolesGuard와 연결해 보겠습니다. 현재는 단순히 모든 경우에 참을 반환하여 모든 요청이 진행되도록 허용합니다. 현재 사용자에게 할당된 역할과 현재 처리 중인 경로에 필요한 실제 역할을 비교하여 반환 값을 조건부로 만들고 싶습니다. 경로의 역할(사용자 정의 메타데이터)에 액세스하기 위해 다음과 같이 Reflector 헬퍼 클래스를 다시 사용하겠습니다.

import { Injectable, CanActivate, ExecutionContext } from "@nestjs/common";
import { Reflector } from "@nestjs/core";
import { Roles } from "./roles.decorator";
 
@Injectable()
export class RolesGuard implements CanActivate {
  constructor(private reflector: Reflector) {}
 
  canActivate(context: ExecutionContext): boolean {
    const roles = this.reflector.get(Roles, context.getHandler());
    if (!roles) {
      return true;
    }
    const request = context.switchToHttp().getRequest();
    const user = request.user;
    return matchRoles(roles, user.roles);
  }
}

🖋️

HINT

node.js 세계에서는 권한이 부여된 사용자를 request 객체에 첨부하는 것이 일반적입니다. 따라서 위의 샘플 코드에서는 request.user에 사용자 인스턴스와 허용된 역할이 포함되어 있다고 가정합니다. 앱에서는 custom authentication guard또는 미들웨어)에서 이러한 연결을 만들 것입니다. 이 주제에 대한 자세한 내용은 여기를 확인하세요.

🚨

WARNING

matchRoles() 함수 내부의 로직은 필요에 따라 간단하거나 정교할 수 있습니다. 이 예제의 요점은 가드가 요청/응답 주기에 어떻게 들어맞는지 보여주는 것입니다.

상황에 맞는 방식으로 Reflector를 활용하는 방법에 대한 자세한 내용은 실행 컨텍스트 장의 Reflection and metadata 섹션을 참조하세요.

권한이 부족한 사용자가 엔드포인트를 요청하면 Nest는 자동으로 다음과 같은 응답을 반환합니다.

{
  "statusCode": 403,
  "message": "Forbidden resource",
  "error": "Forbidden"
}

이면에서 가드가 false를 반환하면 프레임워크는 ForbiddenException을 던집니다. 다른 오류 응답을 반환하려면 고유한 예외를 던져야 합니다. 예를 들어

throw new UnauthorizedException();

가드에서 던지는 모든 예외는  exceptions layer(전역 예외 필터 및 현재 컨텍스트에 적용되는 모든 예외 필터)에서 처리됩니다.

🖋️

HINT

인증을 구현하는 방법에 대한 실제 사례를 찾고 있다면 여기를 확인하세요.