요구 사항
- 지원되는 API 유형 중 하나를 사용하는 웹 API:
- REST API
- SOAP
- GraphQL
- 양식 본문, JSON 또는 XML
- 다음 형식 중 하나의 API 사양:
- Linux/amd64에서
docker
executor가 있는 GitLab Runner이 있어야 함. - 대상 애플리케이션이 배포되어 있어야 함. 자세한 내용은 배포 옵션을 참조하세요.
-
CI/CD 파이프라인 정의에
dast
단계 추가되어 있어야 함. 예를 들어 배포 단계 이후에dast
를 추가해야 함:stages: - build - test - deploy - dast
권장 사항
- 분석기의 최신 버전을 실행하기 위해 러너를 항상 풀 정책을 사용하도록 구성하세요.
-
기본적으로 API 보안 테스트는 파이프라인의 이전 작업에서 정의된 모든 artifact를 다운로드합니다. DAST 작업이
environment_url.txt
에 의존하지 않거나 이전 작업에서 생성된 다른 파일을 테스트 URL로 정의하지 않는 경우, artifact를 다운로드하지 않는 것이 좋습니다. artifact를 다운로드하지 않으려면 분석기 CI/CD 작업을 확장하여 종속성을 지정하세요. 예를 들어 DAST 프록시 기반 분석기의 경우.gitlab-ci.yml
파일에 다음을 추가하세요:api_security: dependencies: []
애플리케이션 배포 옵션
API 보안 테스트를 수행하려면 배포된 애플리케이션이 필요합니다.
대상 애플리케이션의 복잡성에 따라 API 보안 테스트 템플릿을 배포하고 구성하는 몇 가지 옵션이 있습니다.
리뷰 앱
리뷰 앱은 DAST 대상 애플리케이션을 배포하는 가장 복잡한 방법입니다. 프로세스를 돕기 위해 Google Kubernetes Engine (GKE)를 사용하여 리뷰 앱 배포를 만들었습니다. 이 예제는 리뷰 앱 - GKE 프로젝트에서 찾을 수 있으며, README.md에 DAST를 위해 리뷰 앱을 구성하는 자세한 지침이 포함되어 있습니다.
도커 서비스
만약 애플리케이션이 Docker 컨테이너를 사용한다면 DAST로 배포하고 검사할 수 있는 다른 옵션이 있습니다. Docker 빌드 작업이 완료되고 이미지가 컨테이너 레지스트리에 추가된 후 이미지를 서비스로 사용할 수 있습니다.
.gitlab-ci.yml
에 서비스 정의를 추가하여 DAST 분석기로 서비스를 검사할 수 있습니다.
작업에 services
섹션을 추가할 때, alias
는 애플리케이션에 액세스하는 데 사용될 수 있는 호스트 이름을 정의하는 데 사용됩니다. 다음 예에서 dast
작업 정의의 alias: yourapp
부분은 배포된 애플리케이션의 URL에 yourapp
을 호스트 이름으로 사용하는 것을 의미합니다(https://yourapp/
).
stages:
- build
- dast
include:
- template: API-Security.gitlab-ci.yml
# 컨테이너를 GitLab 컨테이너 레지스트리에 배포
deploy:
services:
- name: docker:dind
alias: dind
image: docker:20.10.16
stage: build
script:
- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
- docker pull $CI_REGISTRY_IMAGE:latest || true
- docker build --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA --tag $CI_REGISTRY_IMAGE:latest .
- docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
- docker push $CI_REGISTRY_IMAGE:latest
api_security:
services: # 서비스를 사용하여 앱 컨테이너를 DAST 작업에 연결
- name: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
alias: yourapp
variables:
APISEC_TARGET_URL: https://yourapp
대부분의 애플리케이션은 데이터베이스나 캐싱 서비스와 같은 여러 서비스에 의존합니다. 서비스 필드에 정의된 서비스는 기본적으로 서로 통신할 수 없습니다. 서비스 간 통신을 허용하려면 FF_NETWORK_PER_BUILD
기능 플래그를 활성화하세요.
variables:
FF_NETWORK_PER_BUILD: "true" # 모든 서비스가 동일한 네트워크에서 통신할 수 있도록 네트워크 당 빌드 활성화
services: # 서비스를 사용하여 컨테이너를 DAST 작업에 연결
- name: mongo:latest
alias: mongo
- name: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
alias: yourapp