In questa pagina viene spiegato come creare, visualizzare, aggiornare ed eliminare moduli personalizzati per Security Health Analytics utilizzando la console Google Cloud o Google Cloud CLI.
Per ulteriori informazioni introduttive, consulta Panoramica dei moduli personalizzati per Security Health Analytics.
Prima di iniziare
Prima di poter utilizzare i moduli personalizzati, devi soddisfare i seguenti prerequisiti:
- Security Health Analytics deve essere abilitato. Per informazioni sull'attivazione di Security Health Analytics, consulta Attiva o disattiva un servizio integrato.
- Al tuo account utente devono essere concessi uno o più ruoli Identity and Access Management (IAM) che contengono le autorizzazioni richieste. Per saperne di più, consulta Autorizzazioni IAM richieste.
- Se intendi scrivere i tuoi moduli personalizzati e caricarli su Security Command Center utilizzando i comandi
gcloud, devi disporre di Google Cloud CLI. Per informazioni sull'installazione di gcloud CLI, consulta Installa gcloud CLI. - Se l'API Security Command Center non è già abilitata, devi abilitarla prima di poter utilizzare i moduli personalizzati per Security Health Analytics. Puoi abilitare l'API Security Command Center nella pagina Libreria API della console Google Cloud .
- Per comprendere i limiti di utilizzo di Security Health Analytics, consulta Quote dei moduli personalizzati.
Autorizzazioni IAM obbligatorie
Per lavorare con i moduli personalizzati, devi disporre delle seguenti autorizzazioni Identity and Access Management (IAM):
| Autorizzazione | Ruolo |
|---|---|
| securitycentermanagement.securityhealthanalyticscustommodules.create securitycentermanagement.securityhealthanalyticscustommodules.update securitycentermanagement.securityhealthanalyticscustommodules.delete |
roles/securitycenter.settingsEditor roles/securitycenter.admin |
| securitycentermanagement.securityhealthanalyticscustommodules.get securitycentermanagement.securityhealthanalyticscustommodules.list |
roles/securitycenter.settingsViewer roles/securitycenter.adminViewer roles/securitycenter.admin |
| securitycentermanagement.securityhealthanalyticscustommodules.test | roles/securitycenter.securityHealthAnalyticsCustomModulesTester roles/securitycenter.adminViewer roles/securitycenter.adminEditor roles/securitycenter.admin |
Per saperne di più sui ruoli e sulle autorizzazioni IAM e su come concederli, consulta Concedi un ruolo IAM utilizzando la console Google Cloud .
Crea un modulo personalizzato
Questa sezione spiega come creare moduli personalizzati utilizzando la consoleGoogle Cloud , gcloud CLI o Terraform.
Per testare il modulo personalizzato come passaggio del processo di creazione, devi preparare le definizioni delle risorse di test in un file YAML. Per le istruzioni, consulta Crea risorse di test in un file YAML.
Per creare un modulo personalizzato, seleziona il metodo che vuoi utilizzare dalle seguenti schede:
Console Google Cloud
Per creare un modulo personalizzato nella console Google Cloud , completa i seguenti passaggi:
Vai alla pagina Impostazioni di Security Command Center nella consoleGoogle Cloud .
Se richiesto, seleziona l'organizzazione, la cartella o il progetto in cui devi creare il modulo personalizzato.
Nella scheda Security Health Analytics, fai clic su Gestisci impostazioni.
Fai clic sulla scheda Moduli.
Fai clic su Crea modulo. Viene visualizzata la pagina Crea modulo per Security Health Analytics.
Nel riquadro Configura modulo, definisci il nome visualizzato, le risorse da analizzare e la logica di rilevamento:
Nel campo Nome modulo, specifica un nome per il modulo. Il nome deve essere compreso tra 1 e 128 caratteri, iniziare con una lettera minuscola e contenere solo caratteri alfanumerici o trattini bassi. Questo nome diventa la categoria dei risultati generati da questo rilevatore. Non puoi modificare il nome dopo aver creato il modulo.
In Aggiungi tipo di risorsa, specifica da uno a cinque tipi di risorse da analizzare. Non puoi specificare un tipo di risorsa più di una volta.
Per un elenco dei tipi di risorse supportati, consulta Tipi di risorse supportati.
Nell'editor di espressioni, scrivi espressioni CEL per eseguire controlli booleani su una o più proprietà della risorsa specificata nell'ultimo passaggio. Per attivare un risultato, l'espressione deve essere risolta in
TRUE. Ad esempio, la seguente espressione attiva un risultato se una risorsaCryptoKeyha un periodo di rotazione definito e il periodo di rotazione è superiore a 2.592.000 secondi (30 giorni):has(resource.rotationPeriod) && (resource.rotationPeriod > duration('2592000s'))Per ulteriori informazioni, consulta le seguenti risorse:
Fai clic su Avanti. Viene visualizzato il riquadro Definisci i dettagli del risultato.
Nel riquadro Definisci i dettagli del risultato, descrivi il problema rilevato dal modulo personalizzato, inclusa la gravità, il tipo di problema, come risolverlo ed eventuali dati che vuoi includere nei risultati come proprietà dell'origine personalizzate:
Nel campo Gravità, specifica la gravità del problema. Puoi specificare
Low,Medium,HighoCritical.Mediumè l'impostazione predefinita.Per informazioni sui livelli di gravità, consulta Classificazioni della gravità dei risultati.
Nel campo Descrizione risultato, spiega il problema rilevato dal modulo personalizzato. Questa spiegazione viene visualizzata in ogni istanza del risultato per aiutare i team di sicurezza a comprendere e risolvere il problema rilevato.
Nel campo Ricerca dei passaggi successivi, spiega i passaggi che il tuo team di sicurezza può seguire per risolvere o affrontare il problema rilevato.
I passaggi vengono visualizzati con ogni istanza del risultato. Includi passaggi specifici che il team della sicurezza può seguire per risolvere il problema il più rapidamente possibile.
(Facoltativo) Nel campo Proprietà dei risultati personalizzati, specifica fino a 10 coppie nome-valore per definire le proprietà dell'origine personalizzata da restituire con ogni istanza dei risultati. Le informazioni vengono restituite come proprietà dell'origine nel JSON del risultato e vengono visualizzate nella scheda Proprietà dell'origine nei dettagli del risultato nella consoleGoogle Cloud . Specifica i valori di testo o delle proprietà come coppie chiave-valore:
- Nel campo Nome proprietà, specifica un nome per la proprietà sorgente personalizzata. Il nome deve essere conforme alle seguenti regole:
- Il nome deve iniziare con una lettera minuscola.
- Il nome deve contenere solo caratteri alfanumerici o trattini bassi.
- Il nome deve avere una lunghezza compresa tra 1 e 128 caratteri.
- Ogni nome deve essere univoco tra le altre proprietà sorgente.
- Nel campo Valore proprietà, specifica uno dei seguenti valori con un massimo di 1024 caratteri:
- Una stringa di testo racchiusa tra virgolette. Le virgolette sono incluse nel limite di 1024 caratteri. Ad esempio,
"This string provides additional useful information." - Qualsiasi proprietà della risorsa in fase di scansione.
Ad esempio, se stai controllando la risorsa
CryptoKey, puoi specificareresource.rotationPeriod. Viene restituito il valore della proprietàrotationPeriod.
- Una stringa di testo racchiusa tra virgolette. Le virgolette sono incluse nel limite di 1024 caratteri. Ad esempio,
- Nel campo Nome proprietà, specifica un nome per la proprietà sorgente personalizzata. Il nome deve essere conforme alle seguenti regole:
Fai clic su Avanti. Viene visualizzato il riquadro Abilita modulo.
(Facoltativo) Utilizza il menu a discesa del riquadro Abilita modulo per specificare se il modulo personalizzato è abilitato o disabilitato al momento della creazione. Per impostazione predefinita, i moduli personalizzati vengono abilitati al momento della creazione. Se specifichi Disabilita, puoi attivare il modulo in un secondo momento nella scheda Moduli della pagina delle impostazioni di Security Health Analytics.
Fai clic su Avanti. Si apre il riquadro Modulo di test.
(Facoltativo) Prima di creare il modulo personalizzato, ti consigliamo di testarlo.
Per testare un modulo personalizzato, segui questi passaggi:
Crea un file YAML contenente le definizioni delle risorse di test per le risorse controllate dal modulo personalizzato.
Per informazioni su come creare un file di dati di test, consulta Crea risorse di test in un file YAML.
In Carica il file YAML, fai clic su Sfoglia per caricare il file YAML contenente le definizioni delle risorse di test. Il test inizia automaticamente quando il file viene caricato.
Nella sezione Anteprima dei risultati del test, controlla i risultati.
- Se nel file YAML sono presenti errori di sintassi o di altro tipo, viene visualizzato un messaggio di errore mobile nella parte inferiore della pagina del browser.
Se il test ha esito positivo, restituisce le seguenti informazioni:
- Il nome visualizzato del modulo personalizzato.
- Il nome arbitrario specificato nella proprietà
resourcenel file di dati di test. - L'organizzazione, la cartella o il progetto in cui è stato o verrà creato il modulo personalizzato.
I risultati dei test non vengono archiviati o scritti in Security Command Center.
Per saperne di più, consulta Test dei moduli personalizzati.
Fai clic su Crea. Viene visualizzata di nuovo la pagina Moduli, dove dovresti vedere il modulo che hai creato con lo stato Attivato.
I nuovi moduli personalizzati non sono immediatamente disponibili per l'utilizzo da parte di Security Health Analytics nelle scansioni. Per saperne di più, consulta Latenza di rilevamento.
gcloud CLI
Per creare un modulo personalizzato utilizzando i comandi gcloud, devi prima codificare la definizione del modulo personalizzato in un file YAML che includa espressioni CEL per la logica di rilevamento e le proprietà di output.
Una volta completata la definizione, caricala su Security Command Center utilizzando i comandi gcloud CLI.
- Codifica una definizione di modulo personalizzato in un file YAML seguendo le istruzioni riportate in Codifica un modulo personalizzato per Security Health Analytics.
- Salva il file YAML in una posizione accessibile alla tua istanza di gcloud CLI.
Carica la definizione personalizzata in Security Command Center:
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
Sostituisci quanto segue:
PARENT_FLAG: il livello a cui stai creando il modulo personalizzato,--organization,--foldero--project.PARENT_ID: l'ID dell'organizzazione, della cartella o del progetto in cui stai creando il modulo personalizzato.ENABLEMENT_STATE:enabledodisabled.MODULE_DISPLAY_NAME: il nome della categoria di risultati che vuoi visualizzare quando il modulo personalizzato restituisce un risultato. Il nome deve essere compreso tra 1 e 128 caratteri, iniziare con una lettera minuscola e contenere solo caratteri alfanumerici o trattini bassi.MODULE_FILE_NAME: il percorso e il nome del file YAML che contiene la definizione del modulo personalizzato.
Terraform
Crea un modulo personalizzato per un'organizzazione:
Crea un modulo personalizzato per una cartella:
Crea un modulo personalizzato per un progetto:
Latenza di rilevamento
Dopo aver creato o aggiornato la definizione di un modulo personalizzato, potrebbe verificarsi un ritardo di alcune ore prima che il modulo personalizzato nuovo o aggiornato sia disponibile per l'utilizzo nelle scansioni.
La creazione o la modifica di un modulo personalizzato non attiva una scansione. Dopo che un modulo personalizzato è disponibile per l'uso, Security Health Analytics non inizia a utilizzarlo finché non viene eseguita la prima scansione batch o una modifica alla configurazione della risorsa di destinazione non attiva una scansione in tempo reale.
Per saperne di più sui tipi di scansione di Security Health Analytics, consulta Tipi di scansione di Security Health Analytics.
Aggiorna un modulo personalizzato
Puoi aggiornare la maggior parte delle proprietà dei moduli personalizzati di Security Health Analytics.
Le seguenti proprietà di un modulo personalizzato non possono essere modificate:
- Il nome visualizzato.
- L'ID del modulo personalizzato.
- Il nome completo della risorsa del modulo personalizzato.
Quando aggiorni un modulo personalizzato, i risultati generati in precedenza dal modulo personalizzato non vengono aggiornati contemporaneamente. Se le modifiche al modulo comportano modifiche ai risultati generati, questi rifletteranno le modifiche solo dopo la successiva scansione batch o in tempo reale di Security Health Analytics.
Per modificare un modulo personalizzato, puoi utilizzare la console Google Cloud o gcloud CLI. Fai clic su una delle seguenti schede per visualizzare le istruzioni.
Console Google Cloud
Per aggiornare un modulo personalizzato esistente nella console Google Cloud , segui questi passaggi:
Vai alla pagina Impostazioni di Security Command Center nella consoleGoogle Cloud .
Nel selettore di progetti, seleziona l'organizzazione, la cartella o il progetto in cui è stato creato originariamente il modulo personalizzato. Non puoi modificare un modulo personalizzato altrove.
Nella scheda Security Health Analytics, fai clic su Gestisci impostazioni.
Seleziona la scheda Moduli. Vengono visualizzati tutti i moduli di rilevamento di Security Health Analytics.
Utilizza il campo del filtro nella parte superiore dell'elenco dei moduli o scorri per trovare il modulo personalizzato che devi modificare.
Sul lato destro della riga del modulo personalizzato, fai clic sull'icona del menu Azioni .
Dal menu Azioni, fai clic sull'icona Modifica (edit). Si apre la pagina Visualizza modulo, che mostra la scheda Configura modulo.
Modifica i campi del modulo personalizzato di ogni scheda nella pagina Visualizza modulo in base alle tue esigenze.
(Facoltativo) Prima di salvare gli aggiornamenti, ti consigliamo di testarli.
Per testare un modulo personalizzato, segui questi passaggi:
Crea un file YAML contenente le definizioni delle risorse di test per le risorse controllate dal modulo personalizzato.
Per informazioni su come creare un file di dati di test, consulta Crea risorse di test in un file YAML.
In Carica il file YAML, fai clic su Sfoglia per caricare il file YAML contenente le definizioni delle risorse di test. Il test inizia automaticamente quando il file viene caricato.
Nella sezione Anteprima dei risultati del test, controlla i risultati.
- Se nel file YAML sono presenti errori di sintassi o di altro tipo, viene visualizzato un messaggio di errore mobile nella parte inferiore della pagina del browser.
Se il test ha esito positivo, restituisce le seguenti informazioni:
- Il nome visualizzato del modulo personalizzato.
- Il nome arbitrario specificato nella proprietà
resourcenel file di dati di test. - L'organizzazione, la cartella o il progetto in cui è stato o verrà creato il modulo personalizzato.
I risultati dei test non vengono archiviati o scritti in Security Command Center.
Per saperne di più, consulta Test dei moduli personalizzati.
Fai clic su Salva in fondo alla pagina. Le modifiche vengono applicate al modulo personalizzato.
gcloud CLI
Per aggiornare un modulo personalizzato utilizzando gcloud CLI,
devi prima modificare la definizione YAML del modulo personalizzato, quindi utilizzare
i comandi gcloud per aggiornare il modulo personalizzato in Security Health Analytics.
Modifica la definizione del modulo personalizzato. Per informazioni su come scrivere il codice di una definizione di modulo personalizzato, consulta Scrittura del codice di un modulo personalizzato per Security Health Analytics.
Salva il file YAML modificato in una posizione accessibile a gcloud CLI.
Aggiorna il modulo personalizzato in Security Health Analytics eseguendo questo comando:
gcloud scc custom-modules sha update MODULE_ID \ PARENT_FLAG=PARENT_ID \ --enablement-state="ENABLED" \ --custom-config-from-file=MODULE_FILE_NAME.yaml
Sostituisci quanto segue:
MODULE_ID: l'ID o il nome completo della risorsa del modulo personalizzato.PARENT_FLAG: il livello in cui è stato creato il modulo personalizzato, ovvero--organization,--foldero--project.PARENT_ID: l'ID dell'organizzazione, della cartella o del progetto in cui è stato creato il modulo personalizzato.MODULE_FILE_NAME: il percorso e il nome del file YAML che contiene la definizione del modulo personalizzato.
Visualizza un modulo personalizzato
Seleziona una scheda per scoprire come visualizzare la definizione di un modulo personalizzato.
Console Google Cloud
Per visualizzare i moduli personalizzati nella console Google Cloud , segui questi passaggi:
Vai alla pagina Security Health Analytics nelle impostazioni di Security Command Center.
Fai clic sulla scheda Moduli. Viene visualizzato il riquadro Moduli.
Se necessario, utilizza il campo di filtro nella parte superiore dell'elenco dei moduli per trovare il modulo personalizzato che devi modificare.
Per visualizzare i dettagli della definizione del modulo personalizzato, fai clic sull'icona del menu Azioni, , sul lato destro della riga del modulo personalizzato.
Nel menu Azioni, fai clic sull'icona Modifica, edit. Si apre la pagina Visualizza modulo, che mostra la scheda Configura modulo.
Fai clic sulle schede della pagina Visualizza modulo per visualizzare tutti i campi della definizione del modulo personalizzato.
gcloud CLI
Per visualizzare i dettagli di un modulo personalizzato, inserisci il seguente comando:
gcloud scc custom-modules sha get MODULE_ID \ PARENT_FLAG=PARENT_ID
Sostituisci quanto segue:
MODULE_ID: l'ID o il nome completo della risorsa del modulo personalizzato.PARENT_FLAG: il livello in cui è stato creato il modulo personalizzato, ovvero--organization,--foldero--project.PARENT_ID: l'ID dell'organizzazione, della cartella o del progetto in cui è stato creato il modulo personalizzato.
Elenca i moduli personalizzati
Seleziona una scheda per scoprire come visualizzare un elenco di moduli personalizzati.
Console Google Cloud
Vai alla pagina Security Health Analytics nelle impostazioni di Security Command Center.
Fai clic sulla scheda Moduli. Viene visualizzato il riquadro Moduli.
Fai clic nel campo del filtro nella parte superiore dell'elenco dei moduli per visualizzare l'elenco dei tipi di filtro.
Seleziona Tipo e inserisci
Custom. L'elenco dei moduli viene aggiornato per mostrare solo i moduli personalizzati.
gcloud CLI
Per visualizzare un elenco di moduli personalizzati, inserisci il seguente comando:
gcloud scc custom-modules sha list \ PARENT_FLAG=PARENT_ID
Sostituisci quanto segue:
PARENT_FLAG: il livello in cui è stato creato il modulo personalizzato, ovvero--organization,--foldero--project.PARENT_ID: l'ID dell'organizzazione, della cartella o del progetto in cui è stato creato il modulo personalizzato.
Elimina un modulo personalizzato
Puoi eliminare un modulo personalizzato dall'organizzazione, dalla cartella o dal progetto in cui è stato creato o da un'organizzazione o cartella principale. Non puoi eliminare un modulo personalizzato da una cartella o un progetto che lo eredita.
Per scoprire come eliminare un modulo personalizzato, seleziona una delle seguenti schede.
Console Google Cloud
Vai alla pagina Impostazioni di Security Command Center nella consoleGoogle Cloud .
Se ti viene chiesto, seleziona l'organizzazione, la cartella o il progetto.
Nella scheda Security Health Analytics, fai clic su Gestisci impostazioni.
Seleziona la scheda Moduli. Vengono visualizzati tutti i moduli di rilevamento di Security Health Analytics.
Utilizza il campo del filtro nella parte superiore dell'elenco dei moduli o scorri per trovare il modulo personalizzato che devi modificare.
Sul lato destro della riga del modulo personalizzato, fai clic sull'icona del menu Azioni .
Dal menu Azioni, fai clic su Elimina. Si apre la finestra di dialogo Elimina modulo personalizzato.
Nella finestra di dialogo, fai clic su Elimina.
gcloud CLI
Per eliminare un modulo personalizzato, inserisci il seguente comando:
gcloud scc custom-modules sha delete MODULE_ID \ PARENT_FLAG=PARENT_ID
Sostituisci quanto segue:
MODULE_ID: l'ID o il nome completo della risorsa del modulo personalizzato.PARENT_FLAG: il livello in cui è stato creato il modulo personalizzato, ovvero--organization,--foldero--project.PARENT_ID: l'ID dell'organizzazione, della cartella o del progetto in cui è stato creato il modulo personalizzato.
I risultati per i moduli personalizzati eliminati vengono contrassegnati come inattivi da Security Health Analytics nella scansione batch successiva.
Esamina i risultati
I risultati generati dai moduli personalizzati possono essere visualizzati nella consoleGoogle Cloud o nell'API Security Command Center.
Console
-
Nella console Google Cloud , vai alla pagina Risultati di Security Command Center.
- Seleziona il tuo progetto o la tua organizzazione Google Cloud .
- Nella sezione Filtri rapidi, nella sottosezione Nome visualizzato origine, seleziona Security Health Analytics personalizzato. I risultati della query sui risultati vengono aggiornati per mostrare solo i risultati di questa origine.
- Per visualizzare i dettagli di un risultato specifico, fai clic sul nome del risultato nella colonna Categoria. Si apre il riquadro dei dettagli del risultato e viene visualizzata la scheda Riepilogo.
- Nella scheda Riepilogo, esamina i dettagli del risultato, incluse le informazioni su ciò che è stato rilevato, la risorsa interessata e, se disponibili, i passaggi che puoi seguire per correggere il risultato.
- (Facoltativo) Per visualizzare la definizione JSON completa del risultato, fai clic sulla scheda JSON.
gcloud CLI
Per visualizzare i risultati, segui questi passaggi:
- Apri una finestra del terminale.
Per ottenere l'ID origine per Security Health Analytics, esegui il seguente comando:
gcloud scc sources describe organizations/ORGANIZATION_ID \ --source-display-name='Security Health Analytics Custom'
L'output visualizzato dovrebbe essere simile al seguente. Nell'esempio,
SOURCE_IDè un ID assegnato dal server per le origini di sicurezza.description: ... displayName: Security Health Analytics Custom name: organizations/ORGANIZATION_ID/sources/SOURCE_ID
Per elencare tutti i risultati generati dai moduli personalizzati, esegui questo comando:
gcloud scc findings list ORGANIZATION_ID --source=SOURCE_ID
Per elencare i risultati per un modulo personalizzato specifico, esegui questo comando:
gcloud scc findings list ORGANIZATION_ID --source=SOURCE_ID --filter="category=\"MODULE_NAME\""
Passaggi successivi
Puoi gestire i risultati generati dai moduli personalizzati come tutti i risultati in Security Command Center. Per istruzioni, consulta le seguenti informazioni: