Erste benutzerdefinierte Integration erstellen

Unterstützt in:

In diesem Dokument wird beschrieben, wie Sie in der integrierten Entwicklungsumgebung (IDE) eine benutzerdefinierte Integration mit derselben Struktur wie kommerzielle Integrationen erstellen. Benutzerdefinierte Integrationen werden im Google Security Operations Marketplace angezeigt. Dort können Sie sie für verschiedene Umgebungen konfigurieren, damit sie in Playbooks, manuellen Aktionen und Remote-Agents verwendet werden können. Sie können sie auch wie andere IDE-Elemente importieren und exportieren.

In diesem Beispiel für eine benutzerdefinierte Integration erstellen Sie eine benutzerdefinierte Integration für das Produkt WHOIS XML API. Erstellen Sie zuerst Ihre erste Integration, einschließlich des Registrierungsprozesses für das WHOIS-Produkt. Dazu müssen Sie sich für das Produkt registrieren und den erforderlichen API-Schlüssel erstellen.

Produkt für die Integration auswählen

  1. In diesem Beispiel integrieren Sie das Produkt WHOIS XML API, ein kostenloses Open-Source-Tool, das API-Zugriff auf Domaindaten bietet, einschließlich Name, Organisation, E-Mail-Adresse, Registrierungsadresse, Registrarinformationen, Erstellungs-, Ablauf- und Aktualisierungsdatum der Domain, Verfügbarkeit und Alter der Domain.
  2. Rufen Sie die WHOIS XML API auf und registrieren Sie sich.
  3. Nachdem Sie sich angemeldet haben, können Sie Ihren API-Schlüssel auf Ihrer Kontoseite abrufen: https://user.whoisxmlapi.com/products.
  4. Verwenden Sie diesen API-Schlüssel in Ihren Integrationsparametern.

Erste benutzerdefinierte Integration in der IDE erstellen

So erstellen Sie Ihre erste benutzerdefinierte Integration in der IDE:

  1. Klicken Sie auf der Seite Antwort > IDE auf Hinzufügen Hinzufügen, um ein neues IDE-Element hinzuzufügen.
  2. Wählen Sie das Optionsfeld Integration aus und geben Sie einen Namen für die Integration ein.
  3. Klicken Sie auf Erstellen. Die Integration wird mit einem benutzerdefinierten Integrationssymbol angezeigt.
  4. Klicken Sie auf Einstellungen.
  5. Legen Sie im Integrationsdialogfeld das Symbol, die Beschreibung, die Python-Abhängigkeiten und die Integrationsparameter fest.
    In diesem Beispiel werden die folgenden Details angezeigt:
    • Ein Bild des WhoisXML API-Logos wird hochgeladen. Dieses Bild wird zusammen mit der Integration im Google SecOps Marketplace angezeigt.
    • Neben der Integration in der IDE wurde ein SVG-Symbol mit einer kurzen Beschreibung und einem Parameter, dem API-Schlüssel, hinzugefügt. Dieser Parameter ist für die Konfiguration der Integration des Produkts Who Is XML API erforderlich.
    • Für diese Integration sind keine zusätzlichen Python-Bibliotheken erforderlich. Standardmäßig wird die Integration mit Python 3.7 ausgeführt. Sie können die Version in den Einstellungen ändern.

Standardinstanz konfigurieren

Nachdem Sie die Integration erstellt haben, können Sie sie in Ihren Google SecOps-Antwortintegrationen aufrufen. Suchen Sie dazu in der Suchleiste nach dem Namen der Integration oder filtern Sie den Integrationstyp nach Benutzerdefinierte Integrationen. Dort sehen Sie das Bild, die Beschreibung und den Parameter, die Sie für die Integration definiert haben.

  1. Klicken Sie auf  Einstellungen > Standardinstanz konfigurieren.
  2. Geben Sie Ihren API-Schlüssel ein und klicken Sie auf Speichern.
  3. Optional: Wenn Sie die Integration für eine andere Umgebung als die Standardumgebung konfigurieren möchten, klicken Sie auf den Tab Konfigurieren und legen Sie Parameter für diese Instanz fest.

Ping-Aktion erstellen

  1. Klicken Sie unter Antwort > IDE auf add Hinzufügen > Neues IDE-Element hinzufügen.
  2. Wählen Sie das Optionsfeld Aktion aus, geben Sie einen Namen ein und wählen Sie die Integration aus.
  3. Klicken Sie auf Erstellen. Sehen Sie sich die generierte Codevorlage an.
  4. Kopieren Sie den folgenden Code für die Aktion Ping. Bei der Aktion Ping wird der Parameter API Key verwendet, den Sie für die Integration konfiguriert haben. Er wird in die URL eingefügt, die vom Produkt zu Testzwecken bereitgestellt wird. Weitere Informationen finden Sie unter Benutzerdefinierte Aktionen erstellen. 
    5. from SiemplifyAction import SiemplifyAction
from SiemplifyUtils import output_handler
import requests

INTEGRATION_NAME = "My first Integration - Whois XML API"
SCRIPT_NAME = "Whois XML API Ping"

@output_handler
def main():
    siemplify = SiemplifyAction()
    siemplify.script_name = SCRIPT_NAME

    api_key = siemplify.extract_configuration_param(provider_name=INTEGRATION_NAME,
                                                    param_name="API Key")
    url = "https://www.whoisxmlapi.com/whoisserver/WhoisService?apiKey={api_key}&domainName=google.com".format(api_key=api_key)

    res = requests.get(url)
    res.raise_for_status()

    if "ApiKey authenticate failed" in res.content.decode("utf-8"):
        raise Exception("Error, bad credentials")

    siemplify.end("Successful Connection", True)
if __name__ == "__main__":
    main()
  5. Klicken Sie auf den Schalter über der Aktion und dann auf Speichern, um die Verbindung zum Produkt zu testen.
  6. Rufen Sie den Google SecOps Marketplace auf, klicken Sie auf  Standardinstanz konfigurieren und prüfen Sie, ob die Integration konfiguriert und gespeichert ist.
  7. Klicken Sie auf Testen, um die Integration zu testen. Eine erfolgreiche Verbindung wird durch ein grünes Häkchen angezeigt, eine fehlgeschlagene Verbindung durch ein „X“ mit dem zugehörigen Fehler.
  8. Nachdem Sie die Authentifizierung abgeschlossen haben, erstellen Sie Ihre erste benutzerdefinierte Aktion in der benutzerdefinierten Integration. Weitere Informationen finden Sie unter Benutzerdefinierte Aktionen erstellen.

Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten