NestJs swagger문서 보안

Swagger 문서 보안을 해야하는 이유

• 이미 서비스가 진행중인 웹사이트에서 swagger에 아무런 인증이나 권한없이 들어갈 수 있게 된다면 그 프로젝트의 구조를 다 알려주는 꼴이 돼 버리니 보안상에 아주 치명적인 손해를 받을 수 있다.

Swagger 문서 보안 모듈

npm install express-basic-auth

기본적으로 위 라이브러리는 express위에서 동작하고 nest또한 express위에서 동작하기때문에 사용 할 수 있다.

doc

• https://www.npmjs.com/package/express-basic-auth

사용예시

main.ts에 다음 미들웨어를 추가했다.
id/pw는 유출되면 안되니 환경변수로 설정.

  app.use(
    ['/docs', '/docs-json'],
    expressBasicAuth({
      challenge: true,
      users: {
        [process.env.SWAGGER_USER]: process.env.SWAGGER_PASSWORD,
      },
    }),
  );