SiemplifyConnectors 模組

class 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

傳回

參數值，預設為 {string}，除非指定 input_type。

範例

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 (取得日期時間格式)、
False (取得 Unix 時間)		 預設為 False (選用)
時區 不再支援參數
new_timestamp {int} 要儲存的時間戳記 不適用 預設為 Unix 時間 (選填)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

取得使用 save_timestamp 儲存的時間戳記。

參數

參數名稱 參數類型 定義 可能的值 註解
datetime_format {boolean} 如果 True，則傳回時間戳記做為日期時間。
否則，以 Unix 格式傳回		 True/False 預設為 False (選用)
時區 不再支援參數

傳回

儲存的 Unix 時間/日期時間。

get_connector_context_property

get_connector_context_property(identifier, property_key)

取得連接器內容屬性。

參數

參數名稱 參數類型 定義 可能的值 註解
ID {string} 情境 ID 不適用 不適用
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} 快訊 ID 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

屬性 log_location

房地產參數

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 (適用於日期時間格式)、
False (適用於 Unix)		 預設值為 False (選填)
時區 不再支援參數
new_timestamp {long} 要儲存至情境的時間戳記 不適用 時間戳記預設為呼叫方法時的 Unix 時間戳記

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

使用鍵/值組合設定案件背景資訊屬性。

參數

參數名稱 參數類型 定義 可能的值 註解
ID {string} 情境 ID 不適用 不適用
property_key {string} 屬性的鍵 不適用 不適用
property_value {string} 屬性的值 不適用 不適用

屬性 whitelist