vault-radar install git pre-commit-hook 명령어
vault-radar install git pre-commit-hook 명령어
install git pre-commit-hook 명령어는 어떤 커밋이든 vault-radar 스캔을 실행하는 git pre-commit 훅을 손쉽게 설정하는 방법이에요.
출처: 문서
본문
install git pre-commit-hook 은 어떤 커밋이든 vault-radar 스캔을 실행하는 git pre-commit 훅을 설정하는 간단한 방법이에요.
수동으로 설치하고 pre-commit 단계에서 vault-radar를 호출하려면 기존 pre-commit 스크립트에 다음 명령어를 추가하면, 커밋 전에 vault-radar가 스캔을 수행해요.
vault-radar scan git pre-commit
메모: 권장되는 방법은 설치 명령어를 사용하는 거예요. 설치 명령어를 사용하면 기존 pre-commit 스크립트에 명령어가 추가되면서 기존 설정은 그대로 두어요.
인증(Authentication)
이 명령어는 유효한 vault-radar 라이선스가 필요해요. 라이선스 구성 방법을 확인해 주세요. 라이선스 생성에 대한 도움은 고객 지원 담당자에게 문의해 주세요.
사용법
pre-commit 훅을 설치하려는 저장소 안에서 다음 명령어를 실행해요.
vault-radar install git pre-commit-hook
다음 커밋을 만들 때, 방금 설치된 pre-commit 훅은 diff를 스캔하도록 구성돼요. 스캔이 구성된 임계값 이상의 심각도를 가진 위험을 감지하면 커밋이 거부돼요.
해결 옵션(Remediation Options)
개발자의 커밋을 막는 식별된 위험 중 허용해야 하는 것들을 처리하는 몇 가지 옵션이 있어요.
- Custom Ignore Rules
- Inline Ignore Rules
설정(Configuration)
pre-commit 훅 중에 발생하는 스캔은 다음 두 위치 중 한 곳에서 설정을 찾도록 구성돼 있어요.
- git으로 관리되는 저장소의 루트:
./.hashicorp/vault-radar/config.json - 또는 사용자의
HOME디렉터리에 전역으로 적용하기 위해:~/.hashicorp/vault-radar/config.json
메모: 두 위치 모두에 정의된 경우 로컬 버전의 설정이 전역 버전보다 우선해요.
샘플 config.json
{
"fail_severity": "high",
"pre_commit_skip_activeness": false
}
fail_severity- vault-radar의 실패 임계값을 정의해요. 구성된 fail-severity 이상의 심각도를 가진 위험이 식별되면vault-radar는 스캔을 실패로 간주해요. 심각도와 각 수준에 대한 자세한 내용은 여기를 확인해 주세요.pre_commit_skip_activeness-true면 활성 검사를 건너뜀. 기본적으로 활성 검사는 활성화되어 있어요. 즉 이 옵션의 기본값은false예요.
메모:
fail_severity설정 값을 지정하지 않으면 기본 동작은 어떤 심각도도 강제하지 않는 것이에요. 그 결과 식별된 모든 위험이 허용돼요.
더 알아보기 (Learn more)
- CLI 시작하기 — CLI 설치와 주요 명령어를 확인해요.
- 사용자 정의 무시 규칙 작성하기 — 위험을 무시하는 규칙을 만드는 방법을 확인해요.
- pre-receive 훅 개요 — 서버 쪽 스캔 훅을 확인해요.