Gaia: 글로벌 API 무결성 평가자

종속성

• opam을(를) 설치하여 테스트 API를 빌드합니다.

• git, python3, pip 및 .NET을(를) 설치하여 RESTler 및 Schemathesis를 빌드합니다.

• cargo를 설치하여 Gaia를 빌드합니다.

• docker v26.0.1 및 docker compose v2.26.1을(를) 설치하여 ELK Stack과 함께 Gaia를 빌드합니다 (선택 사항, 그렇지 않으면 필요 없음).

• node >= v18.0.0 및 npm >= v8.6.0을(를) 설치합니다.

• opam 로컬 스위치를 생성하려면:

make opam-switch

• 모든 종속성을 설치하려면:

make deps

빌드

• Gaia를 빌드하려면:

make build

• 테스트 API를 빌드하려면:

make build-test

OpenAPI 명세

• 테스트를 위한 OpenAPI 명세를 생성하려면:

make generate-swagger

• 테스트를 위한 OpenAPI 명세를 제거하려면:

make clean-swagger

포매팅

• 프로젝트를 포맷하려면 (테스트 + 소스):

make format

정리

• 빌드 파일을 정리하려면 (테스트 + 소스):

make clean-build-files

• 모든 것을 정리하려면:

make clean

실행

• 빌드 후, GAIA 옵션을 확인하려면:

./_bin/gaia --help

• GAIA 사용법:

gaia --configuration <configuration> --openapi-path <openapi-path> --workdir-path <workdir-path> --verbose <verbose>

• workdir-path: 퍼저의 다양한 로그를 찾을 수 있는 작업 디렉토리입니다.

• openapi-path: 실제 API의 OpenAPI 파일 경로입니다. 퍼징 또는 모니터링 사용 시 필수, 통계 시에는 불필요

• verbose : 상세도 수준 {NOTHING, LOW, MID, HIGH, ALL} (기본값: NOTHING)

• configuration: 다음 내용을 포함하는 JSON 파일의 경로:

{
  "configuration": {
    // One of : fuzzing or monitoring
    "fuzzing": {
      //Required
      "config_fuzzer": {
        //Required
        // In hours
        "timeout": 1,
        //Optional
        // Disable fuzzers
        "disable_fuzzers": [{
           "Restler":{
             // Bfs, BfsFast, BfsCheap or RandomWalk
             "strategy" : "Bfs" 
            }
          },
          "Schemathesis",
          {"Custom": {"id": "1"}}
        ],
        //Optional
        "custom_fuzzers": [
          "<command line that can accept `--output_dir <PATH>`, `--openapi_path <PATH>` and `--timeout <FLOAT>` as arguments>"
        ],
        //Optional
        "generation_config": {
          //optional (Required if you set a function to generate a value)
          "lib_path": "Absolute path to the dynamic library (.so, .dll, or .rs).",
          //Optional
          "generate_string": {
            //One of : Command, Value, File path or Function
            "command": "<command line that returns a string array>",
            //Or
            "value": ["fuzzstring"],
            //Or
            "function": "<function() that returns a string array>",
            //Or
            "file": "The file path to the dictionary of values"
          },
          //Optional
          "generate_datetime": {
            //One of : Command, Value, File path or Function
            "command": "<command line that returns a datetime array in a string format>",
            //Or
            "value": ["2019-06-26T20:20:39+00:00"],
            //Or
            "function": "<function() that returns a datetime array in a string format>",
            //Or
            "file": "The file path to the dictionary of values"
          },
          //Optional
          "generate_date": {
            //One of : Command, Value, File path or Function
            "command": "<command line that returns a date array in a string format>",
            //Or
            "value": ["2019-06-26"],
            //Or
            "function": "<function() that returns a date array in a string format>",
            //Or
            "file": "The file path to the dictionary of values"
          },
          //Optional
          "generate_int": {
            //One of : Command, Value, File path or Function
            "command": "<command line that returns an int array in a string format>",
            //Or
            "value": ["0"],
            //Or
            "function": "<function() that returns an int array in a string format>",
            //Or
            "file": "The file path to the dictionary of values"
          },
          //Optional
          "generate_number": {
            //One of : Command, Value, File path or Function
            "command": "<command line that returns a float array in a string format>",
            //Or
            "value": ["1.5"],
            //Or
            "function": "<function() that returns a float array in a string format>",
            //Or
            "file": "The file path to the dictionary of values"
          },
          //Optional
          "generate_object": {
            //One of : Command, Value, File path or Function
            "command": "<command line that returns a json object array in a string format>",
            //Or
            "value": ["{\"k\" : {\"v\" : \"value\" }}"],
            //Or
            "function": "<function() that returns a json object array in a string format>",
            //Or
            "file": "The file path to the dictionary of values"
          },
          //Optional
          "generate_path_parameter": {
            //One of : Command, Value, File path or Function
            "command": "<command line that returns a key-value map with a string key referring to a path parameter and a string array of values>",
            //Or
            "value": {
              "k": {
                "v": ["value"]
              }
            },
            //Or
            "function": "<function() that returns a key-value map with a string key referring to a path parameter and a string array of values>",
            //Or
            "file": "The file path to the dictionary of values"
          },
          //Optional
          "generate_query_parameter": {
            //One of : Command, Value, File path or Function
            "command": "<command line that returns a key-value map with a string key referring to a query parameter and a string array of values>",
            //Or
            "value": {
              "k": {
                "v": ["value"]
              }
            },
            //Or
            "function": "<function() that returns a key-value map with a string key referring to a query parameter and a string array of values>",
            //Or
            "file": "The file path to the dictionary of values"
          }
        }
      },
      //Required
      "config_process_manager": {
        //Optional
        "config_reset": {
          //Required
          "reset_lib": "Absolute path to the dynamic library (.so, .dll, or .rs).",
          //Required
          "function": "Function name that takes two strings as arguments and returns a unit. The first string represents the log in JSON format, and the second represents the path to the real-time log file."
        },
        //Required
        "config_proxy": {
          //Optional
          "headers_config": {
            //Optional
            "custom_headers": [
              {
                //Required
                "title": "title",
                //Required
                "header_type": {
                  //One of : Command or Value
                  "Command": {
                    //Required
                    "cmd": "<Command that returns the value of the header>",
                    //Required
                    //Refresh value in milliseconds
                    "duration": 0
                  },
                  // or
                  "Value": { "value": "Header value" }
                }
              }
            ]
          },
          //Optional
          "openapi_config": {
            //Optional
            "responses_to_string": true, // Change the type of the responses to string
            //Optional