Module 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)

Obtenez un paramètre de script de connecteur.
Chaque connecteur possède des paramètres qui sont renseignés lors de sa configuration. Cette méthode permet d'extraire la valeur d'un paramètre sélectionné du connecteur en cours d'exécution.\

Remarque : Concepts associés : Paramètres de configuration et de script d'intégration

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
param_name	{string}	Nom du paramètre	N/A	N/A
default_value	{any}	Valeur par défaut du paramètre.	N/A	(Facultatif) La valeur indiquée sera renvoyée si le paramètre n'a pas été défini (si is_mandatory est défini sur False). La valeur par défaut est None.
input_type	{obj}	Type du paramètre. Par exemple, {int}	N/A	(Facultatif) La valeur renvoyée sera convertie au type d'entrée sélectionné. La valeur par défaut est str.
is_mandatory	{boolean}	Définit si le paramètre est obligatoire.	N/A	Si la valeur est définie sur True et que le paramètre n'a pas été renseigné,une exception sera générée. La valeur par défaut est False.
print_value	{boolean}	Définit s'il faut afficher la valeur récupérée du paramètre dans les journaux.	N/A	La valeur par défaut est False

Renvoie

Valeur du paramètre, {string} par défaut, sauf si input_type est spécifié.

Exemple

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)

Comportement des résultats

La valeur du paramètre sélectionné sera renvoyée et convertie au type sélectionné.

Result value

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

Récupérez le code temporel et enregistrez-le dans le contexte de la demande.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
datetime_format	{boolean}	Format de date/heure	True pour obtenir le format datetime, False pour Unix	False par défaut (facultatif)
timezone	Paramètre plus accepté
new_timestamp	{int}	Code temporel à enregistrer	N/A	Heure Unix par défaut (facultatif)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Obtenez le code temporel enregistré avec save_timestamp.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
datetime_format	{boolean}	Si la valeur est True, renvoie l'horodatage sous forme de date et heure. Sinon, renvoie la valeur au format Unix	Vrai/Faux	False par défaut (facultatif)
timezone	Paramètre plus accepté

Renvoie

Date et heure Unix enregistrées.

get_connector_context_property

get_connector_context_property(identifier, property_key)

Obtenez une propriété de contexte de connecteur.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
identifiant	{string}	Identifiant de contexte	N/A	N/A
property_key	{string}	Propriété de clé demandée	N/A	N/A

Renvoie

{string} : valeur de la propriété

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)

Vérifiez si l'alerte est tronquée.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
de test	{string}	Nom de l'environnement	Exemple	N/A
alert_identifier	{string}	Identifiant de l'alerte	12345	N/A
ingestion_time	{long}	Heure d'ingestion de l'alerte	N/A	Si aucune valeur n'est fournie, la valeur par défaut est l'heure actuelle (au format Unix).
original_file_path	{string}	Chemin d'accès au fichier contenant les données brutes d'origine de l'alerte	N/A	N/A
original_file_content	{string}	Contenu du fichier contenant les données brutes d'origine de l'alerte	N/A	N/A
alert_name	{string}	Nom de l'alerte	N/A	N/A
produit	{string}	Nom du produit de l'appareil ayant généré l'alerte	QRadar, Trellix ESM	N/A
source_ip	{string}	Adresse IP source associée à l'alerte	198.51.100.1	N/A
source_host	{string}	Adresse hôte source associée à l'alerte	[e-mail], source.example.com	N/A
destination_ip	{string}	Adresse IP de destination associée à l'alerte	203.0.113.1	N/A
destination_host	{string}	Adresse hôte de destination associée à l'alerte	destination.example.com	N/A

Renvoie

{boolean} True/False

Exemple

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)

Comportement des résultats

True si l'alerte sera tronquée lors du processus d'ingestion. Sinon, False.

Result value

Vrai/Faux

property is_test_run

property log_location

Paramètres property

return_package

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

Renvoyez les données.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
cases	{[CaseInfo]}	Liste des objets CaseInfo	N/A	N/A
output_variables				Obsolète
log_items				Obsolète

Renvoie

NoneType

Exemple

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

Result value

Aucun

return_test_result

return_test_result(is_success, result_params_dictionary)

Obsolète : cette fonction est obsolète.

property run_folder

Créez le run_folder en fonction du nom du script.

Renvoie

Chemin complet {string}

Result value

C:Siemplify_ServerScriptingSiemplifyAction<script name>

save_timestamp

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

Enregistrez le code temporel dans le contexte de script actuel.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
datetime_format	{boolean}	N/A	True pour le format datetime, False pour Unix	La valeur par défaut est False (facultatif).
timezone	Paramètre plus accepté
new_timestamp	{long}	Code temporel à enregistrer dans le contexte	N/A	L'horodatage est défini par défaut sur le code temporel Unix de l'appel de la méthode.

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

Définissez une propriété de contexte de cas à l'aide de la paire clé/valeur.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
identifiant	{string}	Identifiant de contexte	N/A	N/A
property_key	{string}	Clé de la propriété	N/A	N/A
property_value	{string}	Valeur de la propriété	N/A	N/A

property whitelist