Panther 분석 도구 설치, 구성 및 인증하기

PAT로 시작하기

개요

예: 커맨드 라인이나 CI/CD 파이프라인에서 Panther Analysis Tool(PAT)을 사용하여 Panther 자산을 관리하기 전에, 먼저 설치해야 합니다, 구성 값을 제공해야 합니다, 및 인증을 위한 API 토큰을 생성해야 합니다입니다. 이러한 단계를 완료한 후에는 실행을 시작하세요 PAT 명령.

PAT의 새 버전이 출시되면, PAT를 업데이트할 수 있습니다.

PAT 설치

전제 조건

PAT를 설치하려면 환경에 다음 항목이 이미 설치되어 있어야 합니다:

• Python 3.11다음 방법 중 하나를 사용하여 Python을 설치하세요:

  • 의 다운로드 링크는 공식 릴리스 페이지

  • 사용하여 Homebrew다음 명령을 실행합니다 brew install [email protected]

  • 사용하여 pyenv Python 버전을 관리하려면

• Pipenv를 설치하려면 Pipenv다음을 실행하세요 pip install --user pipenv.

pip로 설치하기

PAT를 설치하려면 다음 명령을 실행하세요:

Mac 및 Linux:

pip3 install panther_analysis_tool

Windows (Powershell):

py -m pip install panther_analysis_tool

Windows에서 PAT를 PATH에 추가하기

Windows에서는 PAT를 설치해도 자동으로 PATH 환경 변수에 추가되지 않아 커맨드 라인에서 PAT를 제대로 사용할 수 없게 될 수 있습니다.

설치 시 다음 경고 메시지가 표시되면 PATH 환경 변수를 수동으로 수정해야 합니다.

경고: 스크립트 panther_analysis_tool.exe 및 pat.exe가 'C:\Users\<USERNAME>\AppData\Local\Programs\Python\Python313\Scripts'에 설치되었으나 PATH에 없습니다.
이 디렉터리를 PATH에 추가하거나, 이 경고를 숨기려면 --no-warn-script-location을 사용하십시오.

이를 해결하려면 다음 명령을 실행하세요:

[System.Environment]::SetEnvironmentVariable("Path", $env:Path + ";<SCRIPT_PATH>", [System.EnvironmentVariableTarget]::User)

반드시 다음을 바꾸세요 <SCRIPT_PATH> 오류 메시지에 언급된 경로로. 오류 메시지를 읽을 수 없으면 다음 명령을 실행하여 이 경로를 가져올 수도 있습니다:

py -c "import sysconfig; print(sysconfig.get_path('scripts'))"

완료되면 변경 사항이 적용되도록 터미널을 재시작하세요. 성공했는지 확인하려면 다음을 실행해 보세요 pat --version; 버전 번호가 반환되면 정상적으로 작동한 것입니다

소스에서 빌드하기

개발 목적으로 소스에서 실행하려면 먼저 환경을 설정하세요:

$ make install
$ pipenv run -- pip3 install -e .

가상 환경 외부에서 PAT 사용하기

가상 환경 외부에서 PAT를 사용하려면 직접 설치하세요:

$ make deps
$ pip3 install -e .

PAT CLI 별칭

PAT는 다음 별칭으로 설치되며—어떤 별칭이든 PAT 명령과 함께 사용할 수 있습니다:

• panther_analysis_tool

• pat

예시

$ pipenv run panther_analysis_tool test
...
$ pipenv run pat upload
...

PAT 업데이트

만약 당신이 pipenv 로 의존성을 관리한다면, PAT를 업데이트하려면 아래 단계를 따르세요:

1. Pipfile에서 PAT를 최신 버전으로 업데이트하세요 Pipfile.

2. 다음 명령을 실행하세요 pipenv install --dev.

또는 다음 명령을 실행하여 PAT를 업데이트할 수 있습니다:

$ pip3 install panther_analysis_tool --upgrade

PAT 구성

PAT는 커맨드 라인, 환경 변수 또는 구성 파일에서 구성 값을 읽을 수 있습니다.

구성 값 우선순위

플래그 값 소스의 우선순위는 다음과 같습니다(높음에서 낮음 순):

1. 커맨드로 전달된 값

2. 환경 변수

3. 구성 파일

환경 변수

모든 옵션은 변수 이름 앞에 PANTHER_.

예를 들어, api_token 및 api_host 인수는 다음 이름의 환경 변수를 통해 설정할 수 있습니다 PANTHER_API_TOKEN 및 PANTHER_API_HOST.

PAT 구성 파일

PAT는 작업 디렉터리에 있는 .panther_settings.yml 이라는 구성 파일에서 옵션을 읽습니다. 이 저장소에는 예시 구성 파일이 포함되어 있습니다: example_panther_config.yml입니다. 지원되는 옵션에 대한 예시 문법을 포함하고 있습니다.

API 토큰으로 인증하기

대부분의 PAT 명령은 API 토큰을 사용하여 Panther 인스턴스에 대해 인증이 필요합니다. 인증된 PAT 작업은 Panther 감사 로그.

1. 다음을 따라 이 지침에 따라 API 토큰을 생성하세요.

   • 다음에 유의하세요 PAT 명령별로 필요한 권한.

2. 토큰을 검증하려면 다음을 실행하세요 pipenv run pat check-connection --api-token <your-api-token> --api-host <your-api-host>.

   • 참조 여기에서 토큰을 검증하는 추가 방법.

3. API 토큰이 필요한 PAT 명령을 실행할 때, API 토큰(및 GraphQL 호스트)가 다음 중 하나의 방법으로 PAT에 보이도록 하세요 구성 옵션.

   • API 토큰과 호스트 값을 전달하는 가장 간단한 방법은 커맨드를 사용하는 것입니다, 즉 --api-token 및 --api-host.

API 토큰 회전

토큰은 만료되지 않습니다. 보안 모범 사례로서 정기적으로 API 토큰을 회전하는 것을 권장합니다. 지침은 API 토큰 회전.

비밀로서 API 토큰 관리하기

CI/CD 작업에서 PAT를 사용하는 경우, API 토큰을 비밀로 관리하는 방법에 대해 CI/CD 제공업체의 지침을 반드시 따르세요 — 다음에 설명된 대로 GitHub Actions를 통한 Panther 콘텐츠 관리 및 CircleCI를 통한 Panther 콘텐츠 관리.