이 문서는 JFrog 플랫폼의 구성 요소들을 스캔하여 보안 및 라이선스 위반을 관리하기 위한 Watch의 가이드를 공유하기 위해 작성되었다.
도구명 | JFrog Artifactory |
---|---|
문서 작성 기준 버전 | 7.84.14 |
지원 Edition | COMMUNITY PRO PRO X ENTERPRISE X ENTERPRISE + |
목차
Watch란?
개념
Xray에서 Watch는 JFrog 플랫폼에서 보안 및 라이선스 위반을 보고 관리하는 데 중점을 둡니다.
정책 (Policy) 에서 보안 위반 기준 및 규칙을 정의하고 Watch에서 스캔할 리소스와 스캔 기준인 정책을 할당하여 유연성을 확보할 수 있습니다.
정책 생성 및 관리 등 정책에 대한 가이드는 다음 문서를 참고하시기 바랍니다.
JFrog Xray 정책 (Policy) 추가 및 관리하기
Xray가 아티팩트를 스캔하는 과정
- 할당된 리소스에 아티팩트가 있는지 확인
- 아티팩트가 해당 리소스에 대해 정의된 모든 필터와 일치하는지 확인
- Watch의 할당된 모든 정책을 독립적으로 처리
- 우선순위에 따라 규칙 처리
- 규칙의 기준 확인, 기준이 충족되면
- Xray는 위반을 생성 및 설정된 작업을 실행하며 정책은 처리된 것으로 간주
- 기준을 충족하지 못하면, 어떤 규칙도 적용되지 않을 경우 정책은 처리된 것으로 간주 후, 다음 정책으로 진행
Watch 추가하기
- 관리자 메뉴 → Xray - Watches & Policies → Watches → + New Watch
Watch 설정 구성하기
새로운 Watch 생성 페이지에서 Watch에 기본 정보 입력 및 수신자를 지정합니다.
- Watch의 이름 및 활성화 여부 설정
- Watch의 수신자 입력
- 정책 위반에 대해 Jira 티켓을 생성 설정 (티켓이 생성될 프로젝트가 있는 프로필 지정)
이에 대한 상세한 내용은 다음 문서를 참조하시기 바랍니다.
JFrog Xray와 Jira 통합하기
리소스 할당하기
리소스에 대한 권한 이슈
Watch에서 리소스를 보려면 해당 리소스가 Xray로 스캔되도록 인덱싱되어 있어야 하며 최소한 해당 리소스에 대한 "보기" 권한이 필요합니다.
Xray에서 스캔을 위해 해당 리소스에 대한 "관리" 권한이 있는 경우에만 리소스를 Watch에 추가하거나 제거할 수 있습니다.
리소스 : Watch가 모니터링하는 Artifactory 서비스의 저장소와 빌드의 집합입니다.
Projects를 사용하는 경우, Projects를 리소스로 선택할 수 있습니다.
Watch에 정책 할당하기
- Assigned Policies 섹션에서 + Manage Policies 클릭하여 할당할 정책 선택
저장소에 필터 설정하기
Watch에 대해 정의한 필터는 지정된 저장소의 어떤 아티팩트가 어떤 조건에서 위반을 생성할지 결정합니다.
Watch에 할당된 각 저장소에 원하는 수의 필터를 정의할 수 있으며, 아티팩트가 해당 리소스에 대해 정의된 모든 필터의 조건을 충족하는 경우에만 위반이 트리거됩니다.
- Filter 탭 클릭
- 저장소 선택
- 필터 목록에서 추가할 필터 선택 후, 필요한 값 입력
- Name
- Path
- Package Type
- Mime Type
- Property
필터 | 설명 | 예 |
---|---|---|
Name | 이름 필터는 정규 표현식을 사용하여 아티팩트의 이름을 지정합니다. | |
Path | 경로 필터는 정규 표현식을 사용하여 저장소의 아티팩트 경로를 지정합니다. | |
Package Type | 패키지 유형 필터는 아티팩트의 패키지 유형을 지정합니다. | |
MIME Type | Mime Type 필터는 아티팩트의 MIME 유형을 지정합니다. | |
Property | 속성 필터는 아티팩트와 해당 값을 주석으로 지정하는 속성을 지정합니다. |
Watch 수동으로 스캔하기
Watch가 생성되면 스캔 트리거 이벤트가 발생할 때 지정된 리소스의 아티팩트를 스캔하고 그에 따라 Violations를 발행합니다.
그러나 기존의 아티팩트는 스캔 트리거 이벤트가 발생할 때까지 Watch에서 스캔되지 않습니다. Watch가 관련 아티팩트를 즉시 적용 및 스캔하도록 수동으로 호출할 수 있습니다.
Watch에 할당된 리소스 중 어떤 것을 스캔할지 지정 후, 스캔할 아티팩트의 범위를 날짜로 지정할 수 있습니다.
ex) 지난 7일 동안 스캔된 아티팩트만 스캔한다면, Applay On → Last 7 Days 설정
참조
- https://jfrog.com/help/r/jfrog-security-documentation/configuring-xray-watches
- https://jfrog.com/help/r/jfrog-security-documentation/create-a-watch
- https://jfrog.com/help/r/jfrog-security-documentation/manually-activate-a-watch