Creare un modulo personalizzato per Security Health Analytics

Questa pagina spiega come codificare una definizione di modulo personalizzato utilizzando il Common Expression Language (CEL) e YAML.

Utilizza Google Cloud CLI per caricare le definizioni dei moduli personalizzati in Security Health Analytics.

Nel file YAML, una definizione di modulo personalizzato è costituita da un insieme strutturato di proprietà che utilizzi per definire i seguenti elementi di un modulo personalizzato di Security Health Analytics:

• Le risorse da scansionare.
• La logica di rilevamento da utilizzare.
• Le informazioni da fornire ai team di sicurezza in modo che possano comprendere, classificare e risolvere rapidamente il problema rilevato.

Le proprietà obbligatorie e facoltative specifiche che compongono una definizione YAML sono trattate in Passaggi di codifica.

Evita di creare rilevatori ridondanti

Per controllare il volume delle ricerche, evita di creare ed eseguire moduli che contengono funzionalità ridondanti.

Ad esempio, se crei un modulo personalizzato che controlla la presenza di chiavi di crittografia che non vengono ruotate dopo 30 giorni, ti consigliamo di disattivare il rilevatore di Security Health Analytics KMS_KEY_NOT_ROTATED integrato, perché il suo controllo, che utilizza un valore di 90 giorni, sarebbe superfluo.

Per ulteriori informazioni sulla disattivazione dei rilevatori, consulta Attivare e disattivare i rilevatori.

Passaggi di codifica

La definizione di un modulo personalizzato per Security Health Analytics viene codificata come una serie di proprietà YAML, alcune delle quali contengono espressioni CEL.

Per codificare un modulo di definizione personalizzato:

1. Crea un file di testo con l'estensione del nome file yaml.

2. Nel file di testo, crea una proprietà resource_selector e specifica da uno a cinque tipi di risorse da scansionare per il modulo personalizzato. Un tipo di risorsa non può essere specificato più di una volta nella definizione di un modulo personalizzato. Ad esempio:

   resource_selector:
    resource_types:
    ‐ cloudkms.googleapis.com/CryptoKey

   I tipi di risorse specificati devono essere supportati da Security Command Center. Per un elenco dei tipi di risorse supportati, consulta Tipi di risorse supportati.

3. Crea una proprietà predicate e specifica una o più espressioni CEL che controllano le proprietà dei tipi di risorse da eseguire la scansione. Le proprietà a cui fai riferimento nelle espressioni CEL devono esistere nella definizione dell'API Google Cloud di ogni tipo di risorsa specificato in resource_selector. Per attivare un rilevamento, l'espressione deve risolvere in TRUE. Ad esempio, nell'espressione riportata di seguito, solo i valori di rotationPeriod superiori a 2592000s attivano un rilevamento.

   predicate:
    expression: resource.rotationPeriod > duration("2592000s")

   Per assistenza per la scrittura di espressioni CEL, consulta le seguenti risorse:

   • Tipi di risorse supportati. Fai clic su ogni risorsa per visualizzare le proprietà che puoi utilizzare nelle espressioni CEL.
   • Scrivere espressioni CEL.
   • Eseguire il riferimento alle proprietà delle risorse e dei criteri nei moduli personalizzati.

4. Crea una proprietà description che descriva la vulnerabilità o la configurazione errata rilevata dal modulo personalizzato. Questa spiegazione viene visualizzata in ogni istanza del rilevamento per aiutare gli investigatori a comprendere il problema rilevato. Il testo deve essere racchiuso tra virgolette. Ad esempio:

   description: "The rotation period of
    the identified cryptokey resource exceeds 30 days, the
    maximum rotation period that our security guidelines allow."

5. Crea una proprietà recommendation che spieghi come risolvere il problema rilevato. Gcloud CLI richiede un carattere di escape prima di determinati caratteri, ad esempio le virgolette. L'esempio seguente mostra l'utilizzo della barra di fuga per eseguire l'escapismo di ogni serie di virgolette:

   recommendation: "To fix this issue go to
     https://console.cloud.google.com/security/kms. Click the key-ring that
     contains the key. Click the key. Click \"Edit rotation period\". Then
     set the rotation period to at most 30 days."
   

   Se crei o aggiorni un modulo personalizzato utilizzando la console Google Cloud, i caratteri di escape non sono obbligatori.

6. Crea una proprietà severity e specifica la gravità predefinita per i risultati creati da questo modulo. I valori di uso comune per la proprietà severity sono LOW, MEDIUM, HIGH e CRITICAL. Ad esempio,

   severity: MEDIUM

7. Se vuoi, crea una proprietà custom_output e specifica informazioni aggiuntive da restituire con ogni risultato. Specifica le informazioni da restituire come una o più coppie nome-valore. Puoi restituire il valore di una proprietà della risorsa scansionata o una stringa letterale. Le proprietà devono essere specificate come resource.PROPERTY_NAME. Le stringhe letterali devono essere incluse tra virgolette. L'esempio seguente mostra una definizione custom_output che restituisce sia un valore della proprietà, il valore di rotationPeriod nella risorsa CryptoKey sottoposta a scansione, sia una stringa di testo, "Excessive rotation period for CryptoKey":

    custom_output:
      properties:
        - name: duration
          value_expression:
            expression: resource.rotationPeriod
        - name: note
          value_expression:
            expression: "Excessive rotation period for CryptoKey"
   

8. Salva il file in una posizione a cui può accedere lgcloud CLI.

9. Carica la definizione in Security Health Analytics con il seguente comando:

    gcloud scc custom-modules sha create \
        --organization=organizations/ORGANIZATION_ID \
        --display-name="MODULE_DISPLAY_NAME" \
        --enablement-state="ENABLED" \
        --custom-config-from-file=DEFINITION_FILE_NAME.yaml
   

   Sostituisci i seguenti valori:

   • ORGANIZATION_ID con l'ID dell'organizzazione principale del modulo personalizzato o sostituisci il flag --organization con --folders o --project e specifica l'ID della cartella o del progetto principale.
   • MODULE_DISPLAY_NAME con un nome da visualizzare come categoria di risultati quando il modulo personalizzato restituisce risultati. Il nome deve essere compreso tra 1 e 128 caratteri, deve iniziare con una lettera minuscola e contenere solo caratteri alfanumerici o trattini bassi.
   • DEFINITION_FILE_NAME con il percorso e il nome del file del file YAML che contiene la definizione del modulo personalizzato.

   Per saperne di più sull'utilizzo dei moduli personalizzati di Security Health Analytics, consulta Utilizzare i moduli personalizzati per Security Health Analytics.

Eseguire la scansione delle latenze per i nuovi moduli personalizzati

La creazione di un modulo personalizzato non attiva una nuova scansione.

Security Health Analytics non inizia a utilizzare un nuovo modulo personalizzato finché non si verifica una delle seguenti condizioni:

• La prima scansione batch dopo la creazione del modulo personalizzato. A seconda di quando crei un modulo personalizzato nella pianificazione delle analisi collettive, potresti dover attendere fino a 24 ore prima che Security Health Analytics inizi a utilizzare il modulo personalizzato.
• Una modifica a una risorsa di destinazione attiva una scansione in tempo reale.

Esempio di definizione di un modulo personalizzato

L'esempio seguente mostra una definizione di modulo personalizzato completata che attiva un rilevamento se il valore della proprietà rotationPeriod di una risorsa cloudkms.googleapis.com/CryptoKey è maggiore di 2.592.000 secondi (30 giorni). L'esempio restituisce due valori facoltativi nella sezione custom_output: il valore di resource.rotationPeriod e una nota come stringa di testo.

Nell'esempio, tieni presente i seguenti elementi:

• Il tipo di risorsa o asset da controllare è elencato nella resource_selector sezione resource_types.
• Il controllo eseguito dal modulo sulle risorse, ovvero la sua logica di rilevamento, è definito nella sezione predicate preceduta da expression.
• Nella sezione custom_output sono definite due proprietà di origine personalizzate, duration e violation.
• La spiegazione del problema rilevato è specificata nella proprietà description.
• Le indicazioni per risolvere il problema rilevato sono specificate nella proprietà recommendation. Poiché le virgolette vengono visualizzate nelle indicazioni, è necessario un carattere di escape barra sinistra prima di ogni virgola.

severity: HIGH
description: "Regular key rotation helps provide protection against
compromised keys, and limits the number of encrypted messages available
to cryptanalysis for a specific key version."
recommendation: "To fix this issue go to
https://console.cloud.google.com/security/kms. Click the key-ring that
contains the key. Click the key. Click \"Edit rotation period\". Then
set the rotation period to at most 30 days."
resource_selector:
  resource_types:
  - cloudkms.googleapis.com/CryptoKey
predicate:
  expression: resource.rotationPeriod > duration("2592000s")
custom_output:
  properties:
    - name: duration
      value_expression:
        expression: resource.rotationPeriod
    - name: violation
      value_expression:
        expression:
          "Excessive rotation period for CryptoKey"

Fare riferimento alle proprietà delle risorse e delle norme nei moduli personalizzati

Indipendentemente dal metodo utilizzato per creare un modulo personalizzato, utilizzando la console Google Cloud o scrivendo la definizione autonomamente, devi essere in grado di cercare le proprietà che puoi valutare nel modulo personalizzato. Devi anche sapere come fare riferimento a queste proprietà in una definizione del modulo personalizzato.

Trovare le proprietà di una risorsa o di un criterio

Le proprietà di una risorsa Google Cloud sono definite nella definizione dell'API della risorsa. Puoi trovare questa definizione facendo clic sul nome della risorsa in Tipi di risorse supportati.

Puoi trovare le proprietà di un criterio nella documentazione di riferimento dell'API IAM. Per le proprietà di un criterio, consulta Criterio.

Fare riferimento a una proprietà della risorsa in una definizione del modulo personalizzato

Quando crei un modulo personalizzato, tutti i riferimenti diretti alla proprietà di una risorsa sottoposta a scansione devono iniziare con resource, seguiti da eventuali proprietà principali e infine dalla proprietà di destinazione. Le proprietà sono separate da un punto, utilizzando una notazione a punti in stile JSON.

Di seguito sono riportati alcuni esempi di proprietà delle risorse e di come possono essere recuperate:

• resourceName: memorizza il nome completo di una risorsa in Cloud Asset Inventory, ad esempio //cloudresourcemanager.googleapis.com/projects/296605646631.
• resource.rotationPeriod: dove rotationPeriod è una proprietà di resource.
• resource.metadata.name: dove name è una proprietà secondaria di metadata, che è una proprietà secondaria di resource.

Fare riferimento alle proprietà dei criteri IAM

Puoi creare espressioni CEL che valutano il criterio IAM di una risorsa facendo riferimento alle proprietà del criterio IAM della risorsa. Le uniche proprietà disponibili sono le associazioni e i ruoli all'interno delle associazioni.

Quando fai riferimento alle proprietà dei criteri IAM, policy è la proprietà di primo livello.

Di seguito sono riportati alcuni esempi di proprietà dei criteri IAM e di come possono essere recuperate:

• policy.bindings, dove bindings è una proprietà di policy.
• policy.version, dove version è una proprietà di policy.

Per altri esempi, consulta Espressioni CEL di esempio.

Per informazioni sulle proprietà di un criterio, consulta Criterio.

Scrivere espressioni CEL

Quando crei un modulo personalizzato, utilizzi le espressioni CEL per valutare le proprietà della risorsa sottoposta a scansione. Facoltativamente, puoi anche utilizzare le espressioni CEL per definire coppie name-value personalizzate che restituiscono informazioni aggiuntive con i risultati.

Che tu stia creando un modulo personalizzato nella console Google Cloud o stia scrivendo la definizione del modulo personalizzato in un file YAML, le espressioni CEL che definisci sono le stesse.

Espressioni CEL per la logica di rilevamento

Codifica la logica di rilevamento di un modulo personalizzato utilizzando espressioni CEL con operatori CEL standard per valutare le proprietà delle risorse sottoposte a scansione.

Le espressioni possono essere semplici controlli di un singolo valore o espressioni composte più complesse che controllano più valori o condizioni. In ogni caso, l'espressione deve risolvere in un valore booleano true per attivare un rilevamento.

Se stai creando un modulo personalizzato nella console Google Cloud, scrivi queste espressioni nell'editor di espressioni nella pagina Configura modulo.

Se stai codificando un modulo personalizzato in un file YAML, aggiungi queste espressioni nella proprietà predicate.

Indipendentemente dall'utilizzo della console Google Cloud o di un file YAML, le espressioni CEL che valutano le proprietà delle risorse devono essere conformi alle seguenti regole:

• Le proprietà specificate in un'espressione CEL devono essere proprietà della risorsa sottoposta a scansione, come definito nella definizione dell'API del tipo di risorsa.

• Se un modulo personalizzato valuta più tipi di risorse, le proprietà specificate nelle espressioni CEL devono essere comuni a ogni tipo di risorsa valutato dal modulo personalizzato.

  Ad esempio, se definisci un modulo personalizzato chiamato invalid_cryptokey che controlla due tipi di risorse: cloudkms.googleapis.com/CryptoKey e cloudkms.googleapis.com/CryptoKeyVersion, puoi scrivere la seguente expression, perché entrambi i tipi di risorse CryptoKey e CryptoKeyVersion includono la proprietà name:

  predicate:
  resource.name.matches("projects/project1/locations/us-central1/keyRings/keyring1/cryptoKeys/.*")

  Tuttavia, non puoi specificare la seguente espressione nel modulo personalizzato invalid_cryptokey perché le proprietà importTime e rotationPeriod valutate dall'espressione non sono condivise da entrambi i tipi di risorse:

  predicate:
  resource.importTime >= timestamp("2022-10-02T15:01:23Z") || resource.rotationPeriod > duration("2592000s")

• Tutti gli enum in un'espressione CEL devono essere rappresentati come stringhe. Ad esempio, la seguente è un'espressione valida per il tipo di risorsa cloudkms.googleapis.com/CryptoKeyVersion:

  resource.state = "PENDING_GENERATION"

• Il risultato delle espressioni CEL che definisci nella proprietà predicate deve essere un valore booleano. Un rilevamento viene attivato solo se il risultato è true.

Per ulteriori informazioni su CEL, consulta le seguenti risorse:

• La specifica CEL
• La definizione del linguaggio CEL

Espressioni CEL di esempio

La tabella seguente elenca alcune espressioni CEL che possono essere utilizzate per valutare le proprietà delle risorse. Puoi utilizzarli sia nella console Google Cloud sia nelle definizioni dei moduli personalizzati YAML.

Espressioni CEL per le proprietà dei risultati personalizzati

Se vuoi, per restituire informazioni aggiuntive con ogni risultato che può essere utilizzato nelle query sui risultati, puoi definire fino a dieci proprietà personalizzate da restituire con i risultati generati dai tuoi moduli personalizzati.

Le proprietà personalizzate vengono visualizzate nelle proprietà di origine del rilevamento nel relativo file JSON e nella scheda Proprietà di origine dei dettagli del rilevamento nella console Google Cloud.

Le proprietà personalizzate vengono definite come coppie name-value.

Se stai creando un modulo personalizzato nella console Google Cloud, definisci le coppie name-value nella sezione Proprietà dei risultati personalizzati nella pagina Definire i dettagli del risultato.

Se stai codificando un modulo personalizzato in un file YAML, elenca le coppie name-value come properties nella proprietà custom_output.

Indipendentemente dall'utilizzo della console Google Cloud o di un file YAML, si applicano le seguenti regole:

• Specifica name come stringa di testo senza virgolette.

• Specifica value come uno dei seguenti valori:

  • Per restituire il valore di una proprietà, specifica la proprietà nel seguente formato:

    RESOURCE_TYPE.PROPERTY.PROPERTY_TO_RETURN

  Nell'esempio:

  • RESOURCE_TYPE può essere resource o policy.
  • PROPERTY una o più proprietà principali della proprietà che contiene il valore da restituire.

  • PROPERTY_TO_RETURN è la proprietà che contiene il valore da restituire.

  • Per restituire una stringa di testo, racchiudila tra virgolette.

L'esempio seguente mostra due coppie name-value correttamente definite in custom_output in un file YAML:

custom_output:
  properties:
    - name: duration
      value_expression:
        expression: resource.name
    - name: property_with_text
      value_expression:
        expression: "Note content"

Passaggi successivi

Per testare, inviare, visualizzare e aggiornare i moduli personalizzati, consulta le seguenti pagine:

• Per testare i moduli personalizzati, consulta Testare i moduli personalizzati per Security Health Analytics.
• Per caricare, visualizzare e aggiornare i moduli personalizzati, consulta Creare e gestire moduli personalizzati per Security Health Analytics.