SiemplifyConnectors 모듈

클래스 SiemplifyConnectors.SiemplifyConnectorExecution

SiemplifyConnectors.SiemplifyConnectorExecution(mock_stdin=None)

기본: SiemplifyBase

MAX_NUM_LOG_ROWS= 5000

extract_connector_param

extract_connector_param(param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)

커넥터 스크립트 매개변수를 가져옵니다.
각 커넥터에는 구성 시 채워지는 매개변수가 있습니다. 이 메서드를 사용하면 현재 실행 중인 커넥터의 선택된 매개변수 값을 추출할 수 있습니다.\

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 설명
param_name {string} 매개변수 이름 해당 사항 없음 해당 사항 없음
default_value {any} 매개변수의 기본값입니다. 해당 사항 없음 (선택사항)
매개변수가 설정되지 않은 경우 지정된 값이 반환됩니다.
(is_mandatory이 False로 설정된 경우).
기본값은 None입니다.
input_type {obj} 매개변수의 유형입니다. 예: {int} 해당 사항 없음 (선택사항)
반환된 값은 선택한 입력 유형으로 변환됩니다.
기본값은 str입니다.
is_mandatory {boolean} 파라미터가 필수인지 여부를 정의합니다. 해당 사항 없음 True로 설정되어 있고 매개변수가 입력되지 않은 경우 예외가 발생합니다.

기본값은 False입니다.
print_value {boolean} 매개변수의 가져온 값을 로그에 출력할지 여부를 정의합니다. 해당 사항 없음 기본값은 False입니다.

반환

매개변수 값이며, input_type이 지정되지 않는 한 기본적으로 {string}입니다.

예

from SiemplifyConnectors import SiemplifyConnectorExecution
siemplify = SiemplifyConnectorExecution()
param_value= siemplify.extract_connectors_param(
                                       "Logs Folder",
                                       default_value="C:\\Siemplify_Server\\Scripting\\JobLogs",
                                       input_type=str,
                                       is_mandatory=False,
                                       print_value=False)

결과 동작

선택한 매개변수의 값이 선택한 유형으로 변환되어 반환됩니다.

결과 값

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181328)

타임스탬프를 가져와 케이스 컨텍스트에 저장합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 설명
datetime_format {boolean} 날짜/시간 형식 True: datetime 형식으로 가져오기
False: Unix		 기본값은 False입니다(선택사항).
timezone 더 이상 지원되지 않는 매개변수
new_timestamp {int} 저장할 타임스탬프 해당 사항 없음 기본값은 Unix 시간입니다(선택사항).

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

save_timestamp로 저장된 타임스탬프를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 설명
datetime_format {boolean} True인 경우 타임스탬프를 날짜/시간으로 반환합니다.
그렇지 않으면 Unix에서 반환합니다.		 True/False 기본값은 false입니다 (선택사항).
timezone 더 이상 지원되지 않는 매개변수

반환

저장된 Unix time/datetime입니다.

get_connector_context_property

get_connector_context_property(identifier, property_key)

커넥터 컨텍스트 속성을 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 설명
identifier {string} 컨텍스트 식별자 해당 사항 없음 해당 사항 없음
property_key {string} 요청된 키 속성 해당 사항 없음 해당 사항 없음

반환

{string} 속성 값

is_overflowed_alert

is_overflowed_alert(environment, alert_identifier, ingestion_time=1683034181328, original_file_path=None, original_file_content=None, alert_name=None, product=None, source_ip=None, source_host=None, destination_ip=None, destination_host=None)

알림이 오버플로되었는지 확인합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
환경 {string} 환경 이름 예 해당 사항 없음
alert_identifier {string} 알림 식별자 12345 해당 사항 없음
ingestion_time {long} 알림 수집 시간 해당 사항 없음 제공되지 않으면 현재 시간 (Unix 시간 형식)이 기본값입니다.
original_file_path {string} 알림의 원본 원시 데이터가 포함된 파일의 경로 해당 사항 없음 해당 사항 없음
original_file_content {string} 알림의 원본 원시 데이터가 포함된 파일의 콘텐츠 해당 사항 없음 해당 사항 없음
alert_name {string} 알림 이름 해당 사항 없음 해당 사항 없음
제품 {string} 알림을 생성한 기기의 제품 이름 QRadar, Trellix ESM 해당 사항 없음
source_ip {string} 알림과 연결된 소스 IP 주소 198.51.100.1 해당 사항 없음
source_host {string} 알림과 연결된 소스 호스트 주소 source@example.com,
source.example.com		 해당 사항 없음
destination_ip {string} 알림과 연결된 대상 IP 주소 203.0.113.1 해당 사항 없음
destination_host {string} 알림과 연결된 대상 호스트 주소 destination.example.com 해당 사항 없음

반환

{boolean} True/False

예

from SiemplifyConnectors import SiemplifyConnectorExecution
siemplify = SiemplifyConnectorExecution()
siemplify.is_overflowed_alert(environment, alert_identifier, ingestion_time=SiemplifyUtils.unix_now(), original_file_path, original_file_content, alert_name, product, source_ip, source_host, destination_ip, destination_host)

결과 동작

True(경고가 수집 프로세스 중에 오버플로되는 경우) 그렇지 않은 경우 False입니다.

결과 값

True/False

property is_test_run

property log_location

property 매개변수

return_package

return_package(cases, output_variables={}, log_items=[])

데이터를 반환합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
cases {[CaseInfo]} CaseInfo 객체 목록 해당 사항 없음 해당 사항 없음
output_variables 지원 중단됨
log_items 지원 중단됨

반환

NoneType

예

from SiemplifyConnectors import SiemplifyConnectorExecution siemplify = SiemplifyConnectorExecution() siemplify.return_package(cases, output_variables, log_items)

결과 값

없음

return_test_result

return_test_result(is_success, result_params_dictionary)

property run_folder

스크립트 이름을 기반으로 run_folder를 빌드합니다.

반환

{string} 전체 경로

결과 값

C:Siemplify_ServerScriptingSiemplifyAction<script name>

save_timestamp

save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181328)

타임스탬프를 현재 스크립트 컨텍스트에 저장합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 설명
datetime_format {boolean} 해당 사항 없음 날짜/시간 형식의 경우 True,Unix의 경우
False		 기본값은 False입니다(선택사항).
timezone 더 이상 지원되지 않는 매개변수
new_timestamp {long} 컨텍스트에 저장할 타임스탬프 해당 사항 없음 타임스탬프는 메서드 호출의 Unix 타임스탬프로 기본 설정됩니다.

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

키/값 쌍을 사용하여 케이스 컨텍스트 속성을 설정합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 설명
identifier {string} 컨텍스트 식별자 해당 사항 없음 해당 사항 없음
property_key {string} 속성의 키 해당 사항 없음 해당 사항 없음
property_value {string} 속성 값 해당 사항 없음 해당 사항 없음

property whitelist