ZAP 스캔에 사용 가능한 매개변수

애플리케이션 저장소 내에서 trigger_zap_scans 파일을 작성하십시오 (예: scripts 디렉토리 내에서 선택한 위치에).

다음과 같이 trigger_zap_scans 에 이러한 행을 추가하여 해당 매개변수의 값을 설정하십시오. - set_env <parameter name> <value>. 참조 구현에 대한 자세한 정보는 hello-compliance-app를 참조하십시오.

다음 매개변수를 설정하고 사용자 정의하여 실행 중인 앱에서 침투 테스트를 실행하도록 ZAP 스캔을 구성할 수 있습니다.

ZAP API 스캔 구성

애플리케이션 저장소 내에 json 형식의 API 정의 파일이 하나 이상 있어야 합니다. 이 API 정의 파일은 올바른 swagger 또는 openapi 정의여야 합니다. 이러한 파일은 애플리케이션 저장소 내의 임의의 위치 (예: definitions 디렉토리 내) 에 있을 수 있습니다. 명확성을 위해 이러한 파일을 definitions1.json, definitions2.json 등과 같이 참조합니다.

ZAP API 스캔을 구성하려면 추가 매개변수가 필요합니다. 이러한 매개변수는 다음과 같이 trigger_zap_scans 에 다음 행을 추가하여 설정할 수 있습니다. - set_env <parameter name> <value>.

애플리케이션 저장소 내에서 선택한 위치 (예: scripts/zap-custom-scripts 디렉토리 내) 에 custom-api-script 파일을 작성하십시오. 이 파일의 이름도 다르게 지정할 수 있으며 zap-api-custom-script 매개변수에 대해 이 파일의 경로를 설정할 수 있습니다.

custom-api-script 파일을 사용하여 ZAP 스캐너로 이동하는 요청을 수정하십시오. 요청 페이로드에서 사용할 수 있는 매개변수는 다음과 같습니다.

신임 정보와 같은 민감한 정보의 경우 저장소 또는 시크릿 저장소에서 이러한 값을 읽어야 합니다.

ZAP UI 스캔 구성

ZAP API 스캔 구성과 유사하게, 선택한 위치 (예: scripts 디렉토리) 에서 애플리케이션 저장소 내에 trigger_zap_scans 파일을 작성하거나 업데이트하십시오.

다음과 같이 trigger_zap_scans 에 이러한 행을 추가하여 해당 매개변수의 값을 설정하십시오. - set_env <parameter name> <value>. 참조 구현에 대한 자세한 정보는 hello-compliance-app를 참조하십시오.

ZAP UI 스캔을 실행하려면 zap-ui-scan 매개변수를 true 로 설정하십시오.

ZAP UI 스캔을 구성하는 데 필요한 매개변수는 다음과 같습니다.

애플리케이션 저장소 내의 scripts/zap 디렉토리 내에 uiscripts 폴더를 작성하십시오. 또한 trigger_zap_scans 파일에서 zap-ui-script-directory 에 대해 이 폴더 경로를 설정하십시오. 이 폴더는 다른 위치에서도 작성할 수 있습니다. zap-ui-script-directory 에 대해 경로를 조정해야 합니다.

uiscripts 디렉토리 내에 run.sh 파일을 작성하십시오. run.sh 는 UI 테스트를 구동합니다. 우리는 견인기 기반 테스트 또는 기타 적합한 프레임워크를 구성할 수 있습니다.

uiscripts 디렉토리 내에 export.sh 파일을 작성하십시오. 이 파일은 테스트 프레임워크가 사용하는 데 필요한 모든 다른 환경 변수를 보유합니다. export <VARIABLE_NAME>=<VALUE> 를 추가하여 해당 환경 값을 설정하십시오.

테스트 프레임워크에 대한 구성 정보를 보유하려면 uiscripts 디렉토리 내에 conf 폴더를 작성하여 테스트 프레임워크에 대한 구성 정보를 보관하십시오.

테스트 프레임워크로 Protractor를 사용하는 참조 구현은 hello-compliance-app를 참조하십시오.

ZAP 스캔 결과 관리

opt-in-dynamic-api-scan 및 opt-in-dynamic-ui-scan 매개변수의 값을 기반으로 API 스캔 또는 UI 스캔 또는 둘 다 선택적으로 실행하도록 선택할 수 있습니다.

trigger_zap_scans 파일 내에서 다음과 같이 옵트 인 매개변수를 기반으로 개별 스캔을 트리거할 수 있습니다.

if [ -n "$(get_env opt-in-dynamic-api-scan "")" ]; then
    # start the api scan
    set_env "zap-ui-scan" "false"
    source "${COMMONS_PATH}"/owasp-zap/run_scan.sh
fi

if [ -n "$(get_env opt-in-dynamic-ui-scan "")" ]; then
    # set for zap-ui-scans and start zap-ui-scan
    set_env "zap-ui-scan" "true"
    source "${COMMONS_PATH}"/owasp-zap/run_scan.sh
fi

COMMONS_PATH 은 DevSecOps 파이프라인의 일부인 다양한 도구에 대한 빌드 스크립트 및 실행 스크립트를 보유하는 위치를 참조합니다. 자세한 정보는 공통 스크립트 를 참조하십시오.

API 스캔 또는 UI 스캔이 실행되었는지 여부에 따라 종료 코드를 설정하여 ZAP 스캔의 성공 여부를 계산할 수 있습니다. 발견된 모든 취약성도 보고됩니다. api-scan-result 및 ui-scan-result 변수를 눌러 이를 확인할 수 있습니다.

이러한 매개변수가 사용할 수 있는 가능한 값은 success 또는 failure 이며 기본값은 notRun 입니다.

ZAP_API_RESULT=$(get_env api-scan-result "notRun")
ZAP_UI_RESULT=$(get_env ui-scan-result "notRun")

if [[ "${ZAP_API_RESULT}" =~ ^(success|notRun)$ && "${ZAP_UI_RESULT}" =~ ^(success|notRun)$ ]]; then
   exit 0
else
   exit 1
fi

샘플 구현은 이 저장소내의 scripts/zap 디렉토리 내의 trigger_zap_scans 파일에서 찾을 수 있습니다.

CC 파이프라인에 대한 ZAP 스캔 구성

다음 표에는 CC 파이프라인 내에서 ZAP 스캔을 실행하는 데 필요한 추가 매개변수가 나열되어 있습니다.

UI 테스트를 압축하지 않고 사용자 정의 UI 테스트 이미지를 사용하도록 Zap UI 스캔 구성

다음 표에는 사용자 정의 UI 테스트 이미지를 사용하도록 ZAP UI 스캔을 구성하는 데 필요한 추가 매개변수가 나열되어 있습니다.

이 사용자 정의 UI 스캔 단계에서는 기본 케이스인 zip 파일에 Docker 이미지 정보를 넣는 대신 사용자의 사용자 정의 UI Docker 이미지를 사용하여 zap UI 스캔을 수행합니다. zap-custom-ui-image 는 사용자 정의 UI 테스트 이미지를 사용하도록 ZAP UI 스캔을 구성하기 위해 설정되는 필수 환경 변수입니다.