Módulo SiemplifyConnectors

class SiemplifyConnectors.SiemplifyConnectorExecution

SiemplifyConnectors.SiemplifyConnectorExecution(mock_stdin=None)

Bases: 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)

Recebe um parâmetro de script de conector.
Cada conector tem parâmetros que são preenchidos quando ele é configurado. Esse método permite extrair o valor de um parâmetro selecionado do conector em execução.\

Observação: conceitos relacionados: Parâmetros de configuração e script de integração

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
param_name	{string}	Nome do parâmetro	N/A	N/A
default_value	{any}	O valor padrão do parâmetro.	N/A	(Opcional) O valor fornecido será retornado se o parâmetro não tiver sido definido (se is_mandatory estiver definido como False). O padrão é None
input_type	{obj}	O tipo do parâmetro. Por exemplo, {int}	N/A	(Opcional) O valor retornado será convertido para o tipo de entrada selecionado. O padrão é str
is_mandatory	{boolean}	Define se o parâmetro é obrigatório.	N/A	Se definido como True e o parâmetro não tiver sido preenchido, uma exceção será gerada. O padrão é False
print_value	{boolean}	Define se o valor buscado do parâmetro deve ser enviado aos registros.	N/A	O padrão é False

Retorna

O valor do parâmetro, {string} por padrão, a menos que input_type seja especificado.

Exemplo

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)

Comportamento do resultado

O valor do parâmetro selecionado será retornado, convertido para o tipo selecionado.

Valor do resultado

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

Extraia o carimbo de data/hora e salve-o no contexto do caso.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
datetime_format	{boolean}	Formato de data/hora	True para obter no formato de data e hora, False para Unix	False por padrão (opcional)
timezone	O parâmetro não é mais compatível
new_timestamp	{int}	A marca de data e hora a ser salva	N/A	Horário Unix por padrão (opcional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Receba o carimbo de data/hora salvo com save_timestamp.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
datetime_format	{boolean}	Se True, retorne o carimbo de data/hora como data e hora. Caso contrário, retorne no Unix	Verdadeiro/Falso	O padrão é "falso" (opcional).
timezone	O parâmetro não é mais compatível

Retorna

Horário/data e hora do Unix salvos.

get_connector_context_property

get_connector_context_property(identifier, property_key)

Recebe uma propriedade de contexto do conector.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	A propriedade de chave solicitada	N/A	N/A

Retorna

{string} o valor da propriedade

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)

Verifique se o alerta está transbordando.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
ambiente	{string}	Nome do ambiente	Exemplo	N/A
alert_identifier	{string}	Identificador de alerta	12345	N/A
ingestion_time	{long}	Tempo de ingestão do alerta	N/A	Se não for fornecido, o padrão será o horário atual (formato de horário Unix).
original_file_path	{string}	Caminho para o arquivo que contém os dados brutos originais do alerta.	N/A	N/A
original_file_content	{string}	Conteúdo do arquivo com os dados brutos originais do alerta.	N/A	N/A
alert_name	{string}	Nome do alerta	N/A	N/A
produto	{string}	O nome do produto do dispositivo que gerou o alerta	QRadar, Trellix ESM	N/A
source_ip	{string}	O endereço IP de origem associado ao alerta	198.51.100.1	N/A
source_host	{string}	O endereço do host de origem associado ao alerta	[e-mail], source.example.com	N/A
destination_ip	{string}	Endereço IP de destino associado ao alerta	203.0.113.1	N/A
destination_host	{string}	Endereço do host de destino associado ao alerta	destination.example.com	N/A

Retorna

{boolean} Verdadeiro/Falso

Exemplo

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)

Comportamento do resultado

True se o alerta vai transbordar durante o processo de ingestão. Caso contrário, False.

Valor do resultado

Verdadeiro/Falso

property is_test_run

property log_location

Parâmetros de propriedade

return_package

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

Retornar dados.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
cases	{[CaseInfo]}	A lista de objetos CaseInfo	N/A	N/A
output_variables				Descontinuado
log_items				Descontinuado

Retorna

NoneType

Exemplo

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

Valor do resultado

Nenhum

return_test_result

return_test_result(is_success, result_params_dictionary)

Descontinuado: a função foi descontinuada.

property run_folder

Crie o run_folder com base no nome do script.

Retorna

Caminho completo {string}

Valor do resultado

C:Siemplify_ServerScriptingSiemplifyAction<script name>

save_timestamp

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

Salva o carimbo de data/hora no contexto de script atual.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
datetime_format	{boolean}	N/A	True para formato de data e hora, False para Unix	O padrão é False (opcional)
timezone	O parâmetro não é mais compatível
new_timestamp	{long}	Marcação de tempo para salvar no contexto	N/A	O carimbo de data/hora padrão é o carimbo de data/hora do Unix de quando o método foi chamado.

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

Defina uma propriedade de contexto de caso usando o par de chave-valor.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	Chave da propriedade	N/A	N/A
property_value	{string}	Valor da propriedade	N/A	N/A

property whitelist