vault-radar scan slack 명령어

vault-radar scan slack 명령어

scan slack 명령어는 Slack 채널(들)을 스캔하고 민감한 비밀(secrets)이 포함된 메시지를 식별하는 데 사용해요.

출처: 문서

본문

메모: Vault Radar CLI 버전 0.20.0 이상이 설치되어 있어야 해요. 현재 CLI의 버전은 version 명령어로 확인할 수 있어요.

scan slack 명령어는 Slack 채널(들)을 스캔하고 민감한 비밀이 포함된 메시지를 식별하는 데 사용돼요.

인증(Authentication)

scan slack은 Slack에 요청을 보내기 위해 몇 가지 인증 자격 증명이 필요해요. 아래 단계에 따라 User OAuth 토큰을 생성하고 Slack 채널을 스캔하려면 SLACK_USER_TOKEN 환경 변수를 지정해 주세요.

  • Slack 앱 생성
  • 스코프 요청: OAuth & Permissions 섹션에서 Scopes 섹션으로 스크롤해요. User Token Scopes 아래에 다음 스코프를 추가해요:
    • channels:history
    • channels:read
    • groups:history
    • groups:read
    • im:history
    • im:read
    • mpim:history
    • mpim:read
    • users:read
    • users:read.email

메모: Bot Token Scopes가 아니라 User Token Scopes를 사용하세요.

  • 앱 설치 및 승인(Install and Authorize)
  • OAuth & Permissions 섹션에서 OAuth Tokens for Your Workspace 섹션으로 스크롤해 User OAuth Token 값을 복사한다

사용법

Usage: vault-radar scan slack [options]

명령 옵션

  • --outfile, -o: 발견된 비밀 정보를 저장할 파일 지정 (필수)
  • --format, -f: 출력 형식 지정. csv와 json을 지원하며 기본값은 csv
  • --baseline, -b: 이전 스캔 결과가 있는 파일 지정. 새 비밀만 보고돼요.
  • --limit, -l: 보고할 최대 비밀 수 지정. 한도에 도달하면 스캔이 중지돼요.
  • --url, -u: 스캔할 Slack 기본 API 경로 지정 (필수)
  • --dm, -d: 스캔할 Slack DM 지정
  • --channel, -c: 스캔할 Slack 채널 지정
  • --app, -a: 스캔할 Slack 앱 지정
  • --index-file: 어떤 위험이 Vaulted인지 판단하는 데 사용할 인덱스 파일 경로 지정
  • --disable-ui: 스캔 요약이 stdout에 기록되지 않도록 지정
  • --skip-activeness: 지정하면 활성(activeness) 검사를 건너뜀

예시

아래 예시들은 모두 이미 적절한 환경 변수를 설정했다고 가정하거나, 실행하는 명령에 환경 변수를 포함하려는 의도가 있다고 가정해요.

접근 가능한 모든 채널의 메시지 스캔

Slack 앱(SLACK_USER_TOKEN과 연결된)이 접근 가능한 모든 공개·비공개 채널을 스캔하고 결과를 기본 형식인 CSV 파일로 작성해요. 기본 동작은 지난 하루 동안 추가된 메시지를 스캔하는 것이에요.

$ vault-radar scan slack -o <PATH TO OUTPUT>.csv

최근에 추가된 메시지 스캔

접근 가능한 모든 공개·비공개 채널의 지난 <TIME PERIOD> 일 동안 추가된 메시지를 스캔해요.

$ vault-radar scan slack -t <TIME PERIOD> -o <PATH TO OUTPUT>.csv

특정 채널의 메시지 스캔

Slack 채널의 모든 메시지를 스캔하고 결과를 CSV 파일로 작성해요.

$ vault-radar scan slack -c <CHANNEL ID> -o <PATH TO OUTPUT>.csv

접근 가능한 모든 채널을 스캔하고 JSON으로 출력

접근 가능한 모든 공개·비공개 채널을 스캔하고 결과를 JSON Lines 형식의 파일로 작성해요.

$ vault-radar scan slack -o <PATH TO OUTPUT>.jsonl -f json

HCP 연결 시 스캔 동작

scan 명령어는 스캔 간 일관성을 유지하기 위해 클라우드의 공유 솔트로 해시를 생성하려면 HCP 클라우드 연결이 필요해요. 필요한 HCP 연결 정보를 채우려면 HCP 업로드 페이지를 참조해 주세요.

Vault 인덱스 파일을 사용한 스캔

생성된 vault 인덱스를 사용해 스캔을 수행하고 결과를 출력 파일로 작성해요. 이 모드에서는 위험이 이전에 Vault에서 발견된 적이 있다면 스캔 결과에 Vault 내 위치도 함께 보고돼요.

$ vault-radar scan slack -o <PATH TO OUTPUT>.csv \
    --index-file <PATH TO VAULT INDEX>.jsonl \

Vault 인덱스를 생성하는 방법을 확인해 보세요.

스캔 시 발견할 비밀 수 제한

접근 가능한 모든 공개·비공개 채널을 스캔해 결과를 출력 파일로 작성하고, 정의된 비밀 수에 도달하면 스캔을 중지해요.

$ vault-radar scan slack -o <PATH TO OUTPUT>.csv \
    -l <NUM OF SECRETS> \

더 알아보기 (Learn more)