vault-radar scan folder 명령어

vault-radar scan folder 명령어

scan folder 명령어는 로컬 폴더를 스캔하는 데 사용해요.

출처: 문서

본문

메모: Vault Radar CLI 버전 요구사항을 확인해 주세요. (CLI 버전은 version 명령어로 확인할 수 있어요.)

scan folder 명령어는 로컬 폴더를 스캔하는 데 사용돼요.

사용법

Usage: vault-radar scan folder [options]

명령 옵션

  • --path, -p: 지정하면 주어진 폴더를 스캔하고, 그렇지 않으면 현재 작업 디렉터리를 스캔해요.
  • --outfile, -o: 발견된 비밀 정보를 저장할 파일 지정 (필수)
  • --format, -f: 출력 형식 지정. csv와 json을 지원하며 기본값은 csv
  • --baseline, -b: 이전 스캔 결과가 있는 파일 지정. 새 비밀만 보고돼요.
  • --limit, -l: 보고할 최대 비밀 수 지정. 한도에 도달하면 스캔이 중지돼요.
  • --host-name: 위험 URI에 사용할 호스트 이름 지정. 기본값은 로컬 호스트 이름
  • --path-prefix: 위험 URI에 사용할 경로 접두사 지정. 지정하지 않으면 전체 로컬 경로가 사용돼요.
  • --index-file: 어떤 위험이 Vaulted인지 판단하는 데 사용할 인덱스 파일 경로 지정

폴더 스캔

폴더를 스캔하고 결과를 기본 출력 형식인 CSV 파일로 작성해요.

$ vault-radar scan folder -p <PATH TO FOLDER> -o <PATH TO OUTPUT>.csv

폴더를 스캔하고 JSON으로 출력

폴더를 스캔하고 결과를 JSON Lines 형식의 파일로 작성해요.

$ vault-radar scan folder -p <PATH TO FOLDER> \
    -o <PATH TO OUTPUT>.jsonl \
    -f json

HCP 연결 시 스캔 동작

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

베이스라인 파일을 사용한 스캔

이전 스캔의 결과를 사용해 스캔을 수행하고 새로 바뀐 내용을 출력 파일에 작성해요. -b 옵션을 사용하면 이전 스캔에서 발견되지 않았던 새로운 위험만 보고돼요.

$ vault-radar scan folder -p <PATH TO FOLDER> \
    -b <PATH TO BASELINE>.csv \
    -o <PATH TO OUTPUT>.csv

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

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

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

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

스캔 시 발견할 비밀 수 제한

클론을 스캔해 결과를 출력 파일로 작성하고, 정의된 비밀 수에 도달하면 스캔을 중지해요.

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

출력 파일의 비밀 URI 수정

기본적으로 결과 파일의 비밀 URI는 비밀이 발견된 전체 로컬 파일 경로예요. 서로 다른 머신에서 실행된 스캔 결과를 추가 분석을 위해 결합해야 한다면 --host-name과 --path-prefix 옵션을 사용할 수 있어요. --host-name은 비밀 URI에 사용할 호스트 이름을 지정하며 기본값은 로컬 호스트 이름이에요. --path-prefix는 비밀 URI에 사용할 경로 접두사를 지정해요. 지정하지 않으면 전체 로컬 경로가 사용돼요.

$ vault-radar scan folder -p <PATH TO FOLDER> \
    -o <PATH TO OUTPUT>.csv \
    --host-name <HOST NAME> \
    --path-prefix <PATH PREFIX>

더 알아보기 (Learn more)