Collecter les journaux d'audit CircleCI

Compatible avec:

Google SecOps SIEM

Remarque :Cette fonctionnalité est couverte par les Conditions des offres avant disponibilité générale des conditions spécifiques du service Google Security Operations. Les fonctionnalités pré-DG (avant disponibilité générale) sont susceptibles de présenter une compatibilité limitée, et les modifications apportées à ces fonctionnalités peuvent ne pas être compatibles avec d'autres versions avant disponibilité générale. Pour en savoir plus, consultez les Consignes relatives au service d'assistance technique Google Security Operations et les Conditions spécifiques du service Google Security Operations.

Cet analyseur extrait des champs des journaux d'audit CircleCI aux formats CSV et JSON, et les transforme en modèle de données unifié (UDM). Il gère les deux formats, effectue des transformations et des enrichissements de données, et met en correspondance les champs extraits avec leurs champs UDM correspondants dans l'objet event. Elle se concentre sur les actions des utilisateurs, l'accès aux ressources et les événements de mise à jour, les catégorise et renseigne les champs UDM pertinents, tels que principal, target, network et metadata.

Avant de commencer

• Assurez-vous de disposer d'une instance Google SecOps.
• Assurez-vous de disposer d'un accès privilégié à CircleCI.

Configurer un flux dans Google SecOps pour ingérer les journaux CircleCI

1. Accédez à Paramètres du SIEM > Flux.
2. Cliquez sur Ajouter.
3. Dans le champ Nom du flux, saisissez un nom pour le flux (par exemple, Journals CircleCI).
4. Sélectionnez Webhook comme type de source.
5. Sélectionnez CircleCI comme Type de journal.
6. Cliquez sur Suivant.
7. Facultatif: spécifiez des valeurs pour les paramètres d'entrée suivants :
   • Délimiteur de fractionnement: délimiteur utilisé pour séparer les lignes de journal, par exemple \n.
   • Espace de noms des éléments: espace de noms des éléments.
   • Libellés d'ingestion: libellé appliqué aux événements de ce flux.
8. Cliquez sur Suivant.
9. Vérifiez la configuration du flux dans l'écran Finaliser, puis cliquez sur Envoyer.
10. Cliquez sur Générer une clé secrète pour générer une clé secrète permettant d'authentifier ce flux.
11. Copiez et stockez la clé secrète. Vous ne pourrez plus afficher cette clé secrète. Si nécessaire, vous pouvez générer une nouvelle clé secrète, mais cette action rend l'ancienne clé secrète obsolète.
12. Dans l'onglet Détails, copiez l'URL du point de terminaison du flux dans le champ Informations sur le point de terminaison. Vous devez spécifier cette URL de point de terminaison dans votre application cliente.
13. Cliquez sur OK.

Créer une clé API pour le flux webhook

1. Accédez à la console Google Cloud > Identifiants.

   Accéder à "Identifiants"

2. Cliquez sur Créer des identifiants, puis sélectionnez Clé API.

3. Limitez l'accès de la clé API à l'API Google Security Operations.

Spécifier l'URL du point de terminaison

1. Dans votre application cliente, spécifiez l'URL du point de terminaison HTTPS fournie dans le flux de webhook.

2. Activez l'authentification en spécifiant la clé API et la clé secrète dans l'en-tête personnalisé au format suivant:

   X-goog-api-key = API_KEY
   X-Webhook-Access-Key = SECRET
   

   Recommandation: Spécifiez la clé API en tant qu'en-tête plutôt que dans l'URL.

3. Si votre client webhook n'est pas compatible avec les en-têtes personnalisés, vous pouvez spécifier la clé API et la clé secrète à l'aide de paramètres de requête au format suivant:

   ENDPOINT_URL?key=API_KEY&secret=SECRET
   

   Remplacez les éléments suivants :

   • ENDPOINT_URL: URL du point de terminaison du flux.
   • API_KEY: clé API permettant de s'authentifier auprès de Google SecOps.
   • SECRET: clé secrète que vous avez générée pour authentifier le flux.

Configurer un webhook dans CircleCI

1. Connectez-vous à l'interface Web CircleCI.
2. Sélectionnez le projet à partir duquel vous souhaitez ingérer les journaux.
3. Cliquez sur Paramètres du projet.
4. Sélectionnez Webhooks.
5. Cliquez sur Add Webhook (Ajouter un Webhook).

6. Spécifiez les valeurs des paramètres d'entrée suivants:

   • Nom du webhook: indiquez un nom descriptif (par exemple, Google SecOps).
   • URL du point de terminaison: saisissez l'<ENDPOINT_URL> du point de terminaison de l'API Google SecOps.
   Important :Ajoutez <API_KEY> et <SECRET> à l'URL du point de terminaison <ENDPOINT_URL>?key=<API_KEY>&secret=<SECRET>.
   • Événements:sélectionnez les événements CircleCI qui doivent déclencher le webhook (par exemple, sélectionnez workflow-completed pour envoyer des données une fois qu'un workflow est terminé).

7. Cliquez sur Enregistrer pour créer le webhook.

Tableau de mappage UDM

Champ de journal	Mappage UDM	Logique
account.id	read_only_udm.about.resource.attribute.labels.value	La valeur de account.id du journal brut est attribuée au champ UDM read_only_udm.about.resource.attribute.labels.value, où la clé correspondante est account_id.
action	read_only_udm.metadata.product_event_type	La valeur action du journal brut est attribuée au champ UDM read_only_udm.metadata.product_event_type.
actor.id	read_only_udm.principal.user.product_object_id	La valeur de actor.id du journal brut est attribuée au champ UDM read_only_udm.principal.user.product_object_id.
actor.name	read_only_udm.principal.user.userid	Le préfixe "github: " est supprimé du champ actor.name dans le journal brut. La valeur restante est attribuée au champ UDM read_only_udm.principal.user.userid. Si actor.name existe dans le journal brut, la valeur USER_RESOURCE_UPDATE_CONTENT est attribuée à read_only_udm.metadata.event_type. Sinon, USER_RESOURCE_ACCESS est attribué.
id	read_only_udm.metadata.product_log_id	La valeur de id du journal brut est attribuée au champ UDM read_only_udm.metadata.product_log_id. L'analyseur définit read_only_udm.metadata.log_type sur CIRCLECI. L'analyseur définit read_only_udm.metadata.product_name sur CIRCLECI. L'analyseur définit read_only_udm.metadata.vendor_name sur CIRCLECI.
occurred_at	read_only_udm.metadata.event_timestamp	La valeur occurred_at du journal brut est analysée en tant que code temporel et attribuée au champ UDM read_only_udm.metadata.event_timestamp.
organization.name	read_only_udm.target.administrative_domain	Le préfixe "github: " est supprimé du champ organization.name dans le journal brut. La valeur restante est attribuée au champ UDM read_only_udm.target.administrative_domain.
payload.job.id	read_only_udm.about.resource.attribute.labels.value	La valeur de payload.job.id du journal brut est attribuée au champ UDM read_only_udm.about.resource.attribute.labels.value, où la clé correspondante est job_id.
payload.job.job_name	read_only_udm.about.resource.attribute.labels.value	La valeur de payload.job.job_name du journal brut est attribuée au champ UDM read_only_udm.about.resource.attribute.labels.value, où la clé correspondante est job_name.
payload.job.job_status	read_only_udm.about.resource.attribute.labels.value	La valeur de payload.job.job_status du journal brut est attribuée au champ UDM read_only_udm.about.resource.attribute.labels.value, où la clé correspondante est job_status.
payload.workflow.id	read_only_udm.about.resource.attribute.labels.value	La valeur de payload.workflow.id du journal brut est attribuée au champ UDM read_only_udm.about.resource.attribute.labels.value, où la clé correspondante est workflow_id.
request.id	read_only_udm.network.session_id	La valeur de request.id du journal brut est attribuée au champ UDM read_only_udm.network.session_id.
scope.id	read_only_udm.about.resource.attribute.labels.value	La valeur de scope.id du journal brut est attribuée au champ UDM read_only_udm.about.resource.attribute.labels.value, où la clé correspondante est scope_id. L'analyseur définit initialement sec_action sur BLOCK. Si le champ success du journal brut est défini sur "true", la valeur ALLOW est attribuée à sec_action. La valeur sec_action est ensuite attribuée au champ UDM read_only_udm.security_result.action.
target.id	read_only_udm.target.resource.product_object_id	La valeur de target.id du journal brut est attribuée au champ UDM read_only_udm.target.resource.product_object_id.
target.name	read_only_udm.target.resource.name	Le préfixe "github: " est supprimé du champ target.name dans le journal brut. La valeur restante est attribuée au champ UDM read_only_udm.target.resource.name. L'analyseur définit read_only_udm.target.resource.resource_type sur STORAGE_OBJECT.
version	read_only_udm.target.resource.attribute.labels.value	La valeur de version du journal brut est convertie en chaîne et attribuée au champ UDM read_only_udm.target.resource.attribute.labels.value, où la clé correspondante est version.

Modifications

2023-03-09

• Analyseur nouvellement créé.