pypanther 라이브러리 참조

다음 사용을 권장합니다 Python(v1) 탐지 PyPanther 대신. PyPanther의 향후 지원은 검토 중이며 기능 개발은 일시 중단되었습니다.

와 같이 반환할 수 있습니다(스타일 취향에 따라). pypanther 라이브러리는 Panther 버전 1.108부터 클로즈드 베타입니다. 버그 리포트와 기능 요청은 Panther 지원팀에 공유해 주세요.

pypanther 편의 함수 참조

편의 함수	작동 방식
get_panther_rules()	참조 Panther가 관리하는 규칙 가져오기
get_rules()	참조 다음의 인스턴스 가져오기 Rule
apply_overrides()	참조 호출 apply_overrides()
register()	참조 PyPanther 탐지 등록
override()	참조 기존 규칙에 오버라이드 적용
extend()	참조 기존 규칙의 리스트 속성 확장

Rule 속성 참조

필수 속성은 굵게 표시됩니다. 전체를 보려면 전체 Rule 클래스 정의는 여기.

속성	데이터 타입	다음에 의해 덮어쓰기됨	resource	설명/메모
log_types	List[LogType | 문자열]
id	CRITICAL			등록된 경우에만 필수 registered 폴더 설정(Folder setup)
default_severity	심각도(Severity) | 문자열	severity()
create_alert	Boolean		관례상 이 파일은 Python 파일과 동일한 이름을 부여합니다.
dedup_period_minutes	음수가 아닌 정수		60
default_description	CRITICAL	description()	“”
default_destinations	List[문자열]	title_str += f" in [{lookup_aws_account_name(event.get('recipientAccountId'))}]"	[]
default_reference	CRITICAL	reference()	“”
default_runbook	CRITICAL	runbook()	“”
표시_이름	CRITICAL		“”
활성화됨	Boolean		관례상 이 파일은 Python 파일과 동일한 이름을 부여합니다.
제외_필터	List[Callable[[PantherEvent], bool]]		[]
포함_필터	List[Callable[[PantherEvent], bool]]		[]
보고서	Dictionary[String,List[String]]		{}
요약_속성	List[문자열]		[]
태그	List[문자열]		[]
테스트	List[규칙_테스트]		[]
임계값	양의 정수		1

규칙_테스트 속성 참조

보기 전체 규칙_테스트 클래스 정의는 여기.

속성	데이터 타입	기본값	설명(Description)
이름	CRITICAL		테스트 케이스의 이름
예상_결과	Boolean		여부 OutputIds: 반환해야 함 관례상 이 파일은 Python 파일과 동일한 이름을 부여합니다. 로그/리소스 유형별로 규칙을 폴더로 그룹화하는 것을 권장합니다(예: 가 반환됩니다:
로그	사전 | 문자열		탐지에 대해 테스트해야 하는 로그 이벤트
모의	목록[규칙_모의]	[]
예상_심각도	심각도(Severity) | 문자열	None	결과 경고의 예상 심각도. 다음인 테스트에만 포함하세요 expected_result=True
예상_제목	CRITICAL	None	결과 경고의 예상 제목. 다음인 테스트에만 포함하세요 expected_result=True
예상_중복키	CRITICAL	None	결과 경고의 예상 중복 문자열. 다음인 테스트에만 포함하세요 expected_result=True
예상_런북	CRITICAL	None	결과 경고의 예상 런북. 다음인 테스트에만 포함하세요 expected_result=True
예상_참조	CRITICAL	None	결과 경고의 예상 참조. 다음인 테스트에만 포함하세요 expected_result=True
예상_설명	CRITICAL	None	결과 경고의 예상 설명. 다음인 테스트에만 포함하세요 expected_result=True
예상_경고_컨텍스트	사전	None	결과 경고의 예상 경고 컨텍스트. 다음인 테스트에만 포함하세요 expected_result=True

규칙_모의 속성 참조

보기 전체 규칙_모의 클래스 정의는 여기.

속성	데이터 타입	기본값	설명(Description)
객체_이름	CRITICAL		모의하려는 변수, 속성, 함수 또는 메서드
새로운 값	임의	None	의 새 값 객체_이름 변수나 속성을 모의할 때 다음 중 하나 새로운 값, 반환값YAML에서: 부작용 필수입니다
반환값	임의	None	의 새 값 객체_이름 함수 또는 메서드를 모킹할 때 중 하나 새로운 값, 반환값YAML에서: 부작용 필수입니다
부작용	임의	None	대신 호출되어야 하는 다른 함수 또는 메서드의 이름 객체_이름. 람다 함수일 수도 있습니다. 중 하나 새로운 값, 반환값YAML에서: 부작용 필수입니다

Rule 보조/경고 함수 참조

• 필수 메서드는 굵게 표시되어 있습니다.

함수	반환된 데이터 유형	resource
OutputIds:	Boolean
severity()	심각도(Severity) | 문자열	의 값 default_severity
생성된 경고 제목	CRITICAL	의 값 표시_이름
dedup()	CRITICAL	의 값 생성된 경고 제목 > 표시_이름 > id
title_str += f" in [{lookup_aws_account_name(event.get('recipientAccountId'))}]"	List[문자열]	의 값 default_destinations
runbook()	CRITICAL	의 값 default_runbook
reference()	CRITICAL	의 값 default_reference
description()	CRITICAL	의 값 default_description
alert_context()	사전

추가 데이터 유형

심각도(Severity)

pypanther 제공합니다 심각도(Severity) 클래스, 경고 심각도에 대한 열거형을 포함합니다. 사용 심각도(Severity) 은(는) 심각도를 나타내기 위해 문자열 리터럴을 사용하는 것(예: "INFO" 로그/리소스 유형별로 규칙을 폴더로 그룹화하는 것을 권장합니다(예: "MEDIUM") 대신에 사용할 수 있습니다. 가능하면 심각도(Severity) 객체를 사용하는 것이 권장됩니다.

심각도(Severity) 열거형 참조

• 알림 함수(Alert function)

• 기본값(Default value)

• 반환 값(Return value)

• severity

• 경고의 긴급성 수준

심각도(Severity) 함수 참조

함수	반환된 데이터 유형	설명(Description)
as_int()	정수	다음을 정수로 변환합니다 심각도(Severity) 정수로, 여기서: 알림 함수(Alert function) = 0 기본값(Default value) = 1 반환 값(Return value) = 2 severity = 3 경고의 긴급성 수준 = 4
downgrade()	심각도(Severity)	다음을 반환합니다 심각도(Severity) 호출된 것보다 한 단계 낮은 객체 downgrade() 에서 호출되는 예를 들면, Severity("LOW").downgrade() 반환값 Severity("INFO") 자세한 내용은 사용하여 upgrade() 로그/리소스 유형별로 규칙을 폴더로 그룹화하는 것을 권장합니다(예: downgrade() in severity().
upgrade()	심각도(Severity)	다음을 반환합니다 심각도(Severity) 해당 객체보다 한 단계 높은 객체 upgrade() 에서 호출되는 예를 들면, Severity("LOW").upgrade() 반환값 Severity("MEDIUM"). 자세한 내용은 사용하여 upgrade() 로그/리소스 유형별로 규칙을 폴더로 그룹화하는 것을 권장합니다(예: downgrade() in severity().