Benutzerdefinierte Module mit Security Health Analytics verwenden

Google Cloud console

So erstellen Sie ein benutzerdefiniertes Modul in der Google Cloud Konsole:

1. Rufen Sie in derGoogle Cloud Console die Seite Einstellungen des Security Command Center auf.

   Einstellungen aufrufen

2. Wählen Sie bei Aufforderung die Organisation, den Ordner oder das Projekt aus, in dem Sie das benutzerdefinierte Modul erstellen müssen.

3. Klicken Sie auf der Karte Security Health Analytics auf Einstellungen verwalten.

4. Klicke auf den Tab Module.

5. Klicken Sie auf add_box Modul erstellen. Die Seite Modul für Security Health Analytics erstellen wird geöffnet.

6. Legen Sie im Bereich Modul konfigurieren den Anzeigenamen, die zu scannenden Ressourcen und die Erkennungslogik fest:

   1. Geben Sie im Feld Modulname einen Namen für das Modul an. Der Name muss zwischen 1 und 128 Zeichen lang sein und mit einem Kleinbuchstaben beginnen. Er darf nur alphanumerische Zeichen oder Unterstriche enthalten. Dieser Name wird zur Ergebniskategorie der Ergebnisse, die von diesem Detektor generiert werden. Sie können den Namen nach dem Erstellen des Moduls nicht mehr ändern.

   2. Geben Sie unter Ressourcentyp hinzufügen einen bis fünf Ressourcentypen an, die gescannt werden sollen. Sie können einen Ressourcentyp nur einmal angeben.

      Eine Liste der unterstützten Ressourcentypen finden Sie unter Unterstützte Ressourcentypen.

   3. Schreiben Sie im Ausdruckseditor CEL-Ausdrücke, um boolesche Prüfungen für eine oder mehrere Eigenschaften der Ressource auszuführen, die Sie im letzten Schritt angegeben haben. Damit ein Problem ausgelöst wird, muss der Ausdruck in TRUE aufgelöst werden. Der folgende Ausdruck löst beispielsweise einen Befund aus, wenn für eine CryptoKey-Ressource ein Rotationszeitraum definiert ist und dieser länger als 2.592.000 Sekunden (30 Tage) ist:

      has(resource.rotationPeriod) && (resource.rotationPeriod > duration('2592000s'))
      

      Hier finden Sie weitere Informationen:

      • CEL-Ausdrücke schreiben
      • Ressourcen- und Richtlinienattribute in benutzerdefinierten Modulen referenzieren
      • Liste der Standard-CEL-Definitionen

   4. Klicken Sie auf Weiter. Der Bereich Details zu Ergebnissen definieren wird geöffnet.

7. Beschreiben Sie im Bereich Details zu Ergebnissen definieren das Problem, das vom benutzerdefinierten Modul erkannt wird, einschließlich des Schweregrads, der Art des Problems, der Vorgehensweise zur Behebung des Problems und aller Daten, die Sie als benutzerdefinierte Quellattribute in die Ergebnisse aufnehmen möchten:

   1. Geben Sie im Feld Schweregrad den Schweregrad des Problems an. Sie können Low, Medium, High oder Critical angeben. Standardmäßig ist Medium ausgewählt.

      Informationen zu Schweregraden finden Sie unter Schweregradklassifizierungen für Ergebnisse.

   2. Erklären Sie im Feld Beschreibung des Ergebnisses das Problem, das vom benutzerdefinierten Modul erkannt wird. Diese Erklärung wird in jeder Instanz eines Ergebnisses angezeigt, damit Sicherheitsteams das erkannte Problem nachvollziehen und beheben können.

   3. Erklären Sie im Feld Finding next steps (Nächste Schritte) die Schritte, die Ihr Sicherheitsteam unternehmen kann, um das erkannte Problem zu beheben oder anderweitig zu beheben.

      Die Schritte werden bei jeder Instanz des Ergebnisses angezeigt. Geben Sie konkrete Schritte an, die das Sicherheitsteam unternehmen kann, um das Problem so schnell wie möglich zu beheben.

   4. Optional: Geben Sie im Feld Benutzerdefinierte Ergebniseigenschaften bis zu 10 Name-Wert-Paare an, um benutzerdefinierte Quelleigenschaften zu definieren, die mit jeder Ergebnisinstanz zurückgegeben werden sollen. Die Informationen werden als Quellattribute im JSON-Ergebnis zurückgegeben und auf dem Tab Quellattribute in den Ergebnisdetails in derGoogle Cloud -Konsole angezeigt. Geben Sie den Text oder die Attributwerte als Schlüssel/Wert-Paare an:

      • Geben Sie im Feld Name der Property einen Namen für die benutzerdefinierte Quellproperty an. Der Name muss den folgenden Regeln entsprechen:
        • Der Name muss mit einem Kleinbuchstaben beginnen.
        • Der Name darf nur alphanumerische Zeichen oder Unterstriche enthalten.
        • Der Name muss zwischen 1 und 128 Zeichen lang sein.
        • Jeder Name muss unter den anderen Quelleigenschaften eindeutig sein.
      • Geben Sie im Feld Eigenschaftswert einen der folgenden Werte mit maximal 1.024 Zeichen an:
        • Ein Textstring in Anführungszeichen. Die Anführungszeichen werden auf das Limit von 1.024 Zeichen angerechnet. Beispiel: "This string provides additional useful information.".
        • Jedes Attribut der Ressource, die gescannt wird. Wenn Sie beispielsweise die Ressource CryptoKey prüfen, können Sie resource.rotationPeriod angeben. Der Wert der Property rotationPeriod wird zurückgegeben.

   5. Klicken Sie auf Weiter. Der Bereich Modul aktivieren wird geöffnet.

8. Optional: Verwenden Sie das Drop-down-Menü im Bereich Modul aktivieren, um festzulegen, ob das benutzerdefinierte Modul beim Erstellen aktiviert oder deaktiviert wird. Benutzerdefinierte Module sind standardmäßig aktiviert, wenn sie erstellt werden. Wenn Sie Deaktivieren angeben, können Sie das Modul später auf dem Tab Module auf der Seite mit den Security Health Analytics-Einstellungen aktivieren.

9. Klicken Sie auf Weiter. Der Bereich Testmodul wird geöffnet.

10. Optional: Bevor Sie Ihr benutzerdefiniertes Modul erstellen, sollten Sie es testen.

    So testen Sie ein benutzerdefiniertes Modul:

    1. Erstellen Sie eine YAML-Datei, die Testressourcendefinitionen für die Ressourcen enthält, die von Ihrem benutzerdefinierten Modul geprüft werden.

       Informationen zum Erstellen einer Testdatendatei finden Sie unter Testressourcen in einer YAML-Datei erstellen.

    2. Klicken Sie unter YAML-Datei hochladen auf Durchsuchen, um die YAML-Datei mit den Testressourcendefinitionen hochzuladen. Der Test wird automatisch gestartet, wenn die Datei hochgeladen wird.

    3. Sehen Sie sich die Ergebnisse unter Vorschau der Testergebnisse an.

       • Wenn Ihre YAML-Datei Syntax- oder andere Fehler enthält, wird unten auf der Browserseite eine schwebende Fehlermeldung angezeigt.

       • Wenn der Test erfolgreich ist, werden die folgenden Informationen zurückgegeben:

         • Der Anzeigename des benutzerdefinierten Moduls.
         • Der beliebige Name, den Sie für das Attribut resource in der Testdatendatei angegeben haben.
         • Die Organisation, der Ordner oder das Projekt, in dem das benutzerdefinierte Modul erstellt wurde oder wird.

    Testergebnisse werden nicht gespeichert oder in Security Command Center geschrieben.

    Weitere Informationen finden Sie unter Benutzerdefinierte Module testen.

11. Klicken Sie auf Erstellen. Sie werden zur Seite Module zurückgeleitet und sollten das von Ihnen erstellte Modul mit dem Status Aktiviert sehen.

Neue benutzerdefinierte Module sind nicht sofort für die Verwendung durch Security Health Analytics in Scans verfügbar. Weitere Informationen finden Sie unter Latenz bei der Erkennung.

gcloud-CLI

Wenn Sie ein benutzerdefiniertes Modul mit gcloud-Befehlen erstellen möchten, müssen Sie zuerst die Definition des benutzerdefinierten Moduls in einer YAML-Datei codieren, die CEL-Ausdrücke für die Erkennungslogik und Ausgabeeigenschaften enthält.

Nachdem Sie die Definition fertiggestellt haben, laden Sie sie mit gcloud CLI-Befehlen in Security Command Center hoch.

1. Programmieren Sie eine benutzerdefinierte Moduldefinition in einer YAML-Datei gemäß der Anleitung unter Benutzerdefiniertes Modul für Security Health Analytics programmieren.
2. Speichern Sie die YAML-Datei an einem Speicherort, auf den Ihre Instanz der gcloud CLI zugreifen kann.

3. Laden Sie die benutzerdefinierte Definition in Security Command Center hoch:

   gcloud scc custom-modules sha create \
       PARENT_FLAG=PARENT_ID \
       --display-name="MODULE_DISPLAY_NAME" \
       --enablement-state="ENABLEMENT_STATE" \
       --custom-config-from-file=MODULE_FILE_NAME.yaml
   

   Ersetzen Sie Folgendes:

   • PARENT_FLAG: Die Ebene, auf der Sie das benutzerdefinierte Modul erstellen, entweder --organization, --folder oder --project.
   • PARENT_ID: Die ID der Organisation, des Ordners oder des Projekts, in dem Sie das benutzerdefinierte Modul erstellen.
   • ENABLEMENT_STATE: entweder enabled oder disabled.
   • MODULE_DISPLAY_NAME: Der Name der Kategorie für die Ergebnisse, die angezeigt werden soll, wenn das benutzerdefinierte Modul ein Ergebnis zurückgibt. Der Name muss zwischen 1 und 128 Zeichen lang sein und mit einem Kleinbuchstaben beginnen. Er darf nur alphanumerische Zeichen oder Unterstriche enthalten.
   • MODULE_FILE_NAME: der Pfad und Dateiname der YAML-Datei, die die Definition des benutzerdefinierten Moduls enthält.

Terraform

So erstellen Sie ein benutzerdefiniertes Modul für eine Organisation:

resource "google_scc_management_organization_security_health_analytics_custom_module" "example" {
  organization = "123456789"
  display_name = "basic_custom_module"
  location = "global"
  enablement_state = "ENABLED"
  custom_config {
    predicate {
      expression = "resource.rotationPeriod > duration(\"2592000s\")"
    }
    resource_selector {
      resource_types = [
        "cloudkms.googleapis.com/CryptoKey",
      ]
    }
    description = "The rotation period of the identified cryptokey resource exceeds 30 days."
    recommendation = "Set the rotation period to at most 30 days."
    severity = "MEDIUM"
  }
}

So erstellen Sie ein benutzerdefiniertes Modul für einen Ordner:

resource "google_folder" "folder" {
  parent       = "organizations/123456789"
  display_name = "folder-name"
  deletion_protection = false
}

resource "google_scc_management_folder_security_health_analytics_custom_module" "example" {
  folder = google_folder.folder.folder_id
  location = "global"
  display_name = "basic_custom_module"
  enablement_state = "ENABLED"
  custom_config {
    predicate {
      expression = "resource.rotationPeriod > duration(\"2592000s\")"
    }
    resource_selector {
      resource_types = [
        "cloudkms.googleapis.com/CryptoKey",
      ]
    }
    description = "The rotation period of the identified cryptokey resource exceeds 30 days."
    recommendation = "Set the rotation period to at most 30 days."
    severity = "MEDIUM"
  }
}

So erstellen Sie ein benutzerdefiniertes Modul für ein Projekt:

resource "google_scc_management_project_security_health_analytics_custom_module" "example" {
  location = "global"
  display_name = "basic_custom_module"
  enablement_state = "ENABLED"
  custom_config {
    predicate {
      expression = "resource.rotationPeriod > duration(\"2592000s\")"
    }
    resource_selector {
      resource_types = [
        "cloudkms.googleapis.com/CryptoKey",
      ]
    }
    description = "The rotation period of the identified cryptokey resource exceeds 30 days."
    recommendation = "Set the rotation period to at most 30 days."
    severity = "MEDIUM"
  }
}

Google Cloud console

So aktualisieren Sie ein vorhandenes benutzerdefiniertes Modul in der Google Cloud -Konsole:

1. Rufen Sie in derGoogle Cloud Console die Seite Einstellungen des Security Command Center auf.

   Einstellungen aufrufen

2. Wählen Sie in der Projektauswahl die Organisation, den Ordner oder das Projekt aus, in dem das benutzerdefinierte Modul ursprünglich erstellt wurde. Sie können ein benutzerdefiniertes Modul nirgendwo anders bearbeiten.

3. Klicken Sie auf der Karte Security Health Analytics auf Einstellungen verwalten.

4. Wählen Sie den Tab Module aus. Alle Security Health Analytics-Erkennungsmodule werden angezeigt.

5. Verwenden Sie das Filterfeld oben in der Liste der Module oder scrollen Sie, um das benutzerdefinierte Modul zu finden, das Sie ändern möchten.

6. Klicken Sie rechts in der Zeile Ihres benutzerdefinierten Moduls auf das Symbol für das Aktionsmenü more_vert.

7. Klicken Sie im Aktionsmenü auf das Symbol Bearbeiten (edit). Die Seite Modul ansehen wird geöffnet und der Tab Modul konfigurieren wird angezeigt.

8. Bearbeiten Sie die Felder des benutzerdefinierten Moduls auf der Seite Modul ansehen nach Bedarf.

9. Optional: Bevor Sie Ihre Änderungen speichern, empfehlen wir, sie zu testen.

   So testen Sie ein benutzerdefiniertes Modul:

   1. Erstellen Sie eine YAML-Datei, die Testressourcendefinitionen für die Ressourcen enthält, die von Ihrem benutzerdefinierten Modul geprüft werden.

      Informationen zum Erstellen einer Testdatendatei finden Sie unter Testressourcen in einer YAML-Datei erstellen.

   2. Klicken Sie unter YAML-Datei hochladen auf Durchsuchen, um die YAML-Datei mit den Testressourcendefinitionen hochzuladen. Der Test wird automatisch gestartet, wenn die Datei hochgeladen wird.

   3. Sehen Sie sich die Ergebnisse unter Vorschau der Testergebnisse an.

      • Wenn Ihre YAML-Datei Syntax- oder andere Fehler enthält, wird unten auf der Browserseite eine schwebende Fehlermeldung angezeigt.

      • Wenn der Test erfolgreich ist, werden die folgenden Informationen zurückgegeben:

        • Der Anzeigename des benutzerdefinierten Moduls.
        • Der beliebige Name, den Sie für das Attribut resource in der Testdatendatei angegeben haben.
        • Die Organisation, der Ordner oder das Projekt, in dem das benutzerdefinierte Modul erstellt wurde oder wird.

   Testergebnisse werden nicht gespeichert oder in Security Command Center geschrieben.

   Weitere Informationen finden Sie unter Benutzerdefinierte Module testen.

10. Klicken Sie unten auf der Seite auf Speichern. Ihre Änderungen werden auf das benutzerdefinierte Modul angewendet.

gcloud-CLI

Wenn Sie ein benutzerdefiniertes Modul mit der gcloud CLI aktualisieren möchten, bearbeiten Sie zuerst die YAML-Definition des benutzerdefinierten Moduls und verwenden dann gcloud-Befehle, um das benutzerdefinierte Modul in Security Health Analytics zu aktualisieren.

1. Bearbeiten Sie die Definition des benutzerdefinierten Moduls. Informationen zum Programmieren einer benutzerdefinierten Moduldefinition finden Sie unter Benutzerdefiniertes Modul für Security Health Analytics programmieren.

2. Speichern Sie die bearbeitete YAML-Datei an einem Speicherort, auf den die gcloud CLI zugreifen kann.

3. Aktualisieren Sie das benutzerdefinierte Modul in Security Health Analytics, indem Sie den folgenden Befehl ausführen:

   gcloud scc custom-modules sha update MODULE_ID \
      PARENT_FLAG=PARENT_ID \
      --enablement-state="ENABLED" \
      --custom-config-from-file=MODULE_FILE_NAME.yaml
   

   Ersetzen Sie Folgendes:

   • MODULE_ID: die ID oder der vollständige Ressourcenname des benutzerdefinierten Moduls.
   • PARENT_FLAG: Die Ebene, auf der das benutzerdefinierte Modul erstellt wurde, entweder --organization, --folder oder --project.
   • PARENT_ID: Die ID der Organisation, des Ordners oder des Projekts, in dem das benutzerdefinierte Modul erstellt wurde.
   • MODULE_FILE_NAME: der Pfad und Dateiname der YAML-Datei, die die Definition des benutzerdefinierten Moduls enthält.

Google Cloud console

So rufen Sie benutzerdefinierte Module in der Google Cloud Console auf:

1. Rufen Sie in den Security Command Center-Einstellungen die Seite Security Health Analytics auf.

   Einstellungen aufrufen

2. Klicke auf den Tab Module. Der Bereich Module wird geöffnet.

3. Verwenden Sie bei Bedarf das Filterfeld oben in der Liste der Module, um das benutzerdefinierte Modul zu finden, das Sie ändern möchten.

4. Wenn Sie die Details der benutzerdefinierten Moduldefinition aufrufen möchten, klicken Sie rechts neben der Zeile des benutzerdefinierten Moduls auf das Symbol Aktionsmenü more_vert.

5. Klicken Sie im Aktionsmenü auf das Symbol Bearbeiten edit. Die Seite View module (Modul ansehen) wird geöffnet und der Tab Configure module (Modul konfigurieren) wird angezeigt.

6. Klicken Sie auf der Seite Modul ansehen auf die Tabs, um alle Felder der benutzerdefinierten Moduldefinition aufzurufen.

gcloud-CLI

Geben Sie den folgenden Befehl ein, um die Details eines benutzerdefinierten Moduls aufzurufen:

gcloud scc custom-modules sha get MODULE_ID \
      PARENT_FLAG=PARENT_ID

Ersetzen Sie Folgendes:

• MODULE_ID: die ID oder der vollständige Ressourcenname des benutzerdefinierten Moduls.
• PARENT_FLAG: Die Ebene, auf der das benutzerdefinierte Modul erstellt wurde, entweder --organization, --folder oder --project.
• PARENT_ID: Die ID der Organisation, des Ordners oder des Projekts, in dem das benutzerdefinierte Modul erstellt wurde.

Google Cloud console

1. Rufen Sie in den Security Command Center-Einstellungen die Seite Security Health Analytics auf.

   Einstellungen aufrufen

2. Klicke auf den Tab Module. Der Bereich Module wird geöffnet.

3. Klicken Sie oben in der Liste der Module auf das Filterfeld, um die Liste der Filtertypen aufzurufen.

4. Wählen Sie Typ aus und geben Sie Custom ein. Die Modulliste wird aktualisiert und enthält nur noch benutzerdefinierte Module.

gcloud-CLI

Geben Sie den folgenden Befehl ein, um eine Liste der benutzerdefinierten Module aufzurufen:

gcloud scc custom-modules sha list \
    PARENT_FLAG=PARENT_ID

Ersetzen Sie Folgendes:

• PARENT_FLAG: Die Ebene, auf der das benutzerdefinierte Modul erstellt wurde, entweder --organization, --folder oder --project.
• PARENT_ID: Die ID der Organisation, des Ordners oder des Projekts, in dem das benutzerdefinierte Modul erstellt wurde.

Google Cloud console

1. Rufen Sie in derGoogle Cloud Console die Seite Einstellungen des Security Command Center auf.

   Einstellungen aufrufen

2. Wählen Sie Ihre Organisation, Ihren Ordner oder Ihr Projekt aus, wenn Sie dazu aufgefordert werden.

3. Klicken Sie auf der Karte Security Health Analytics auf Einstellungen verwalten.

4. Wählen Sie den Tab Module aus. Alle Security Health Analytics-Erkennungsmodule werden angezeigt.

5. Verwenden Sie das Filterfeld oben in der Liste der Module oder scrollen Sie, um das benutzerdefinierte Modul zu finden, das Sie ändern möchten.

6. Klicken Sie rechts in der Zeile Ihres benutzerdefinierten Moduls auf das Symbol für das Aktionsmenü more_vert.

7. Klicken Sie im Aktionsmenü auf Löschen. Das Dialogfeld Benutzerdefiniertes Modul löschen wird geöffnet.

8. Klicken Sie im Dialogfeld auf Löschen.

gcloud-CLI

Geben Sie den folgenden Befehl ein, um ein benutzerdefiniertes Modul zu löschen:

gcloud scc custom-modules sha delete MODULE_ID \
    PARENT_FLAG=PARENT_ID

Ersetzen Sie Folgendes:

• MODULE_ID: die ID oder der vollständige Ressourcenname des benutzerdefinierten Moduls.
• PARENT_FLAG: Die Ebene, auf der das benutzerdefinierte Modul erstellt wurde, entweder --organization, --folder oder --project.
• PARENT_ID: Die ID der Organisation, des Ordners oder des Projekts, in dem das benutzerdefinierte Modul erstellt wurde.

Console

gcloud-CLI

So rufen Sie Ergebnisse auf:

1. Öffnen Sie ein Terminalfenster.

2. Führen Sie den folgenden Befehl aus, um die Quell-ID für Security Health Analytics abzurufen:

   gcloud scc sources describe organizations/ORGANIZATION_ID \
   --source-display-name='Security Health Analytics Custom'
   

   Die Ausgabe sollte in etwa so aussehen: Im Beispiel ist SOURCE_ID eine vom Server zugewiesene ID für Sicherheitsquellen.

   description: ...
   displayName: Security Health Analytics Custom
   name: organizations/ORGANIZATION_ID/sources/SOURCE_ID
   

3. Führen Sie den folgenden Befehl aus, um alle von Ihren benutzerdefinierten Modulen generierten Ergebnisse aufzulisten:

   gcloud scc findings list ORGANIZATION_ID --source=SOURCE_ID
   

4. Führen Sie den folgenden Befehl aus, um die Ergebnisse für ein bestimmtes benutzerdefiniertes Modul aufzulisten:

   gcloud scc findings list ORGANIZATION_ID --source=SOURCE_ID --filter="category=\"MODULE_NAME\""