튜토리얼: GitLab에서 퍼즈 테스트 수행하기

Tier: Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

Coverage-guided fuzz testing는 예기치 않거나 형식이 잘못되었거나 무작위 데이터를 애플리케이션에 보내고,
이후 애플리케이션의 불안정한 동작과 충돌을 모니터링합니다.

이 과정은 다른 QA 프로세스에서 놓칠 수 있는 버그와 잠재적인 보안 문제를 발견하는 데 도움을 줍니다.

퍼즈 테스트는 다른 보안 스캐너와 자체 테스트 프로세스와 함께 사용해야 합니다.

GitLab CI/CD를 사용하는 경우 CI/CD 워크플로의 일환으로 퍼즈 테스트를 실행할 수 있습니다.

이 튜토리얼에서 JavaScript를 사용하여 커버리지 기반 퍼즈 테스트를 설정, 구성 및 수행하려면 다음 단계를 따르세요:

프로젝트 템플릿 포크하기
퍼즈 테스트를 실행할 프로젝트를 생성합니다.
퍼즈 대상 만들기.
포크한 프로젝트에서 커버리지 기반 퍼즈 테스트 활성화하기.
퍼즈 테스트 실행하기
보안 취약점을 식별합니다.
퍼즈 테스트에서 식별된 취약점 수정하기.

프로젝트 템플릿 포크하기

먼저, 퍼즈 테스트를 시도할 프로젝트를 만들기 위해 fuzz-testing 프로젝트 템플릿을 포크해야 합니다:

fuzz-testing 프로젝트 템플릿 열기.
프로젝트 템플릿 포크하기.
프로젝트 템플릿을 포크할 때:
- 포크한 프로젝트의 이름을 fuzz-testing-demo로 지정합니다.
- 적절한 네임스페이스를 선택합니다.
- 프로젝트 가시성을 Private으로 설정합니다.

fuzz-testing 프로젝트 템플릿을 성공적으로 포크했습니다. 퍼즈 테스트를 시작하기 전에 프로젝트 템플릿과의 관계를 제거해야 합니다:

왼쪽 사이드바에서 Settings > General을 선택합니다.
Advanced를 확장합니다.
Remove fork relationship 섹션에서 Remove fork relationship를 선택합니다.
프롬프트가 표시되면 프로젝트의 이름을 입력합니다.

이제 프로젝트가 준비되었으며 퍼즈 테스트를 생성할 수 있습니다. 다음으로 퍼즈 대상을 생성합니다.

퍼즈 대상 만들기

이제 퍼즈 테스트를 위한 프로젝트가 있으므로 퍼즈 대상을 생성합니다. 퍼즈 대상은
입력을 제공받아 테스트하는 애플리케이션을 호출하는 함수 또는 프로그램입니다.

이 튜토리얼에서는 퍼즈 대상이 my-tools.js 파일의 함수를 호출하는 방법으로 무작위 버퍼를 매개변수로 사용합니다.

두 개의 퍼즈 대상 파일을 생성하려면:

왼쪽 사이드바에서 Search or go to를 선택하고 fuzz-testing-demo 프로젝트를 찾습니다.
프로젝트의 루트 디렉토리에 파일을 만듭니다.
파일의 이름을 fuzz-sayhello.js로 지정하고 다음 코드를 추가합니다:
```
let tools = require('./my-tools')

function fuzz(buf) {
  const text = buf.toString()
  tools.sayHello(text)
}

module.exports = {
  fuzz
}
```
이 코드 또한 fuzz-testing-demo/fuzzers/fuzz-sayhello.js 프로젝트 파일에서 복사할 수 있습니다.
Target Branch의 이름을 add-fuzz-test로 지정하고 설명적인 커밋 메시지를 작성합니다.
- Start a new merge request with these changes 체크박스를 아직 선택하지 마세요.
Commit changes를 선택합니다.
프로젝트의 루트 디렉토리로 돌아갑니다.
현재 브랜치가 add-fuzz-test인지 확인합니다.
두 번째 파일의 이름을 fuzz-readme.js로 지정하고 다음 코드를 추가합니다:
```
let tools = require('./my-tools')
function fuzz(buf) {
    const text = buf.toString()
    tools.readmeContent(text)
}
module.exports = {
    fuzz
}
```
이 코드 또한 fuzz-testing-demo/fuzzers/fuzz-readme.js 프로젝트 파일에서 복사할 수 있습니다.
설명적인 커밋 메시지를 작성합니다.
Target Branch가 add-fuzz-test인지 확인합니다.
Commit changes를 선택합니다.

이제 애플리케이션에 호출할 수 있는 두 개의 퍼즈 대상을 갖게 되었습니다. 다음으로 퍼즈 테스트를 활성화합니다.

커버리지 기반 퍼즈 테스트 활성화

커버리지 기반 퍼즈 테스트를 활성화하려면 gitlab-cov-fuzz CLI를 실행하여 두 퍼즈 타겟에서 퍼즈 테스트를 수행하는 CI/CD 파이프라인을 만듭니다.

파이프라인 파일을 생성하려면:

add-fuzz-test 브랜치에 있어야 합니다.
fuzz-testing-demo 프로젝트의 루트 디렉토리에서 새 파일을 만듭니다.

파일 이름을 .gitlab-ci.yml로 지정하고 다음 코드를 추가합니다:

image: node:18

stages:
  - fuzz

include:
  - template: Coverage-Fuzzing.gitlab-ci.yml

readme_fuzz_target:
  extends: .fuzz_base
  tags: [saas-linux-large-amd64] # 선택적
  variables:
    COVFUZZ_ADDITIONAL_ARGS: '--fuzzTime=60'
  script:
    - npm config set @gitlab-org:registry https://gitlab.com/api/v4/packages/npm/ && npm i -g @gitlab-org/jsfuzz
    - ./gitlab-cov-fuzz run --engine jsfuzz -- fuzz-readme.js

hello_fuzzing_target:
  extends: .fuzz_base
  tags: [saas-linux-large-amd64] # 선택적
  variables:
    COVFUZZ_ADDITIONAL_ARGS: '--fuzzTime=60'
  script:
    - npm config set @gitlab-org:registry https://gitlab.com/api/v4/packages/npm/ && npm i -g @gitlab-org/jsfuzz
    - ./gitlab-cov-fuzz run --engine jsfuzz -- fuzz-sayhello.js

이 단계에서는 파이프라인에 다음을 추가합니다: - 템플릿을 사용한 fuzz 단계. - 각 작업이 jsfuzz 엔진을 사용하여 실행되는 readme_fuzz_target 및 hello_fuzzing_target의 두 작업. 이 엔진은 처리되지 않은 예외를 충돌로 보고합니다.

또한 이 코드를 fuzz-testing-demo/fuzzers/fuzzers.yml 프로젝트 파일에서 복사할 수 있습니다.

설명적인 커밋 메시지를 작성합니다.
대상 브랜치가 add-fuzz-test인지 확인합니다.
변경 사항 커밋을 선택합니다.

이제 커버리지 기반 퍼즈 테스트를 성공적으로 활성화했습니다. 다음으로 방금 생성한 파이프라인을 사용하여 퍼즈 테스트를 실행합니다.

퍼즈 테스트 실행

퍼즈 테스트를 실행하려면:

왼쪽 사이드바에서 코드 > 병합 요청을 선택합니다.
새 병합 요청을 선택합니다.
소스 브랜치 섹션에서 add-fuzz-test 브랜치를 선택합니다.
대상 브랜치 섹션에서 네임스페이스와 main 브랜치가 선택되어 있는지 확인합니다.
브랜치 비교 및 계속을 선택합니다.
병합 요청 만들기.

병합 요청을 생성하면 퍼즈 테스트를 실행하는 새 파이프라인이 트리거됩니다.

파이프라인 실행이 완료되면 병합 요청 페이지에서 보안 취약점 경고가 표시됩니다.

각 취약점에 대한 자세한 정보를 보려면 개별 Uncaught-exception 링크를 선택합니다.

퍼즈 테스트를 성공적으로 실행하고 수정할 취약점을 식별했습니다.

취약점 수정

퍼즈 테스트는 두 가지 보안 취약점을 식별했습니다. 이러한 취약점을 수정하기 위해 my-tools.js 라이브러리를 사용합니다.

my-tools.js 파일을 생성하려면:

프로젝트의 add-fuzz-test 브랜치에 있어야 합니다.
프로젝트의 루트 디렉토리로 이동하여 my-tools.js 파일을 엽니다.

이 파일의 내용을 다음 코드로 교체합니다:

const fs = require('fs')

function sayHello(name) {
  if(name.includes("z")) {
    //throw new Error("😡 error name: " + name)
    console.log("😡 error name: " + name)
  } else {
    return "😀 hello " + name
  }
}

function readmeContent(name) {

  let fileName = name => {
    if(name.includes("w")) {
      return "./README.txt"
    } else {
      return "./README.md"
    }
  }

  //const data = fs.readFileSync(fileName(name), 'utf8')
  try {
    const data = fs.readFileSync(fileName(name), 'utf8')
    return data
  } catch (err) {
    console.error(err.message)
    return ""
  }

}

module.exports = {
  sayHello, readmeContent
}

또한 이 코드를 fuzz-testing-demo/javascript/my-tools.js 프로젝트 파일에서 복사할 수 있습니다.

변경 사항 커밋을 선택합니다. 이것은 또 다른 파이프라인을 트리거 하여 또 다른 퍼즈 테스트를 실행합니다.
파이프라인 실행이 완료되면 병합 요청 개요 페이지를 확인합니다. 새 잠재적 취약점이 감지되지 않았음을 확인할 수 있습니다.
변경 사항을 병합합니다.

축하합니다, 퍼즈 테스트를 성공적으로 실행하고 식별된 보안 취약점을 수정했습니다!

자세한 내용은 커버리지 기반 퍼즈 테스트를 참조하세요.

튜토리얼: GitLab에서 퍼즈 테스트 수행하기

프로젝트 템플릿 포크하기

퍼즈 대상 만들기

커버리지 기반 퍼즈 테스트 활성화

퍼즈 테스트 실행

취약점 수정

도움말

기능 사용 가능성과 제품 평가판

도움받기