요구 사항
- 지원되는 API 유형 중 하나를 사용하는 웹 API:
- REST API
- SOAP
- GraphQL
- Form bodies, JSON 또는 XML
- 다음 형식 중 하나의 API 사양:
- Linux/amd64의
docker
executor가 있는 GitLab Runner가 있어야 함. - 대상 응용 프로그램이 배포되어 있어야 함. 자세한 내용은 배포 옵션을 참조하십시오.
-
CI/CD 파이프라인 정의에
dast
단계가 추가되어 있어야 함. 예를 들어 배포 단계 이후에 추가해야 합니다.stages: - build - test - deploy - dast
권장 사항
- 분석기의 최신 버전을 실행하기 위해 러너를 항상 풀 정책으로 구성하세요.
-
기본적으로 API 보안 테스트는 파이프라인의 이전 작업에서 정의된 모든 artifact를 다운로드합니다. DAST 작업이
environment_url.txt
에 의존하지 않거나 이전 작업에서 생성된 다른 파일을 사용하지 않는 경우 artifact를 다운로드하지 않도록 권장합니다. artifact를 다운로드하지 않으려면, 분석기 CI/CD 작업을 확장하여 의존성을 지정하세요. 예를 들어, DAST 프록시 기반 분석기에 다음을.gitlab-ci.yml
파일에 추가하세요.dast_api: dependencies: []
응용 프로그램 배포 옵션
API 보안 테스트를 위해서는 스캔할 수 있는 배포된 응용 프로그램이 있어야 합니다.
대상 응용 프로그램의 복잡성에 따라 API 보안 테스트 템플릿을 배포하고 구성하는 몇 가지 옵션이 있습니다.
리뷰 앱
리뷰 앱은 DAST 대상 응용 프로그램을 배포하는 가장 복잡한 방법입니다. 이 프로세스를 돕기 위해 Google Kubernetes Engine (GKE)를 사용한 리뷰 앱 배포를 만들었습니다. 이 예제는 Review apps - GKE 프로젝트에서 찾을 수 있으며, DAST용 리뷰 앱을 구성하는 자세한 지침은 README.md에 나와 있습니다.
도커 서비스
응용 프로그램이 Docker 컨테이너를 사용하는 경우 DAST로 배포 및 스캔할 수 있는 다른 옵션이 있습니다. Docker 빌드 작업이 완료되고 이미지가 컨테이너 레지스트리에 추가된 후 이미지를 서비스로 사용할 수 있습니다.
.gitlab-ci.yml
에서 서비스 정의를 사용하여 DAST 분석기로 서비스를 스캔할 수 있습니다.
작업에 services
섹션을 추가하는 경우, alias
는 서비스에 액세스하는 데 사용되는 호스트 이름을 정의하는 데 사용됩니다. 다음 예제에서 dast
작업 정의의 alias: yourapp
부분은 배포된 응용 프로그램의 URL에 호스트 이름으로 yourapp
를 사용한다는 것을 의미합니다 (https://yourapp/
).
stages:
- build
- dast
include:
- template: DAST-API.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
dast_api:
services: # 서비스를 사용하여 응용 프로그램 컨테이너를 DAST 작업에 연결
- name: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
alias: yourapp
variables:
DAST_API_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