איסוף יומני ביקורת של CircleCI
גרסת המנתח: 2.0
המנתח הזה מחלץ שדות מיומני הביקורת של CircleCI בפורמטים CSV ו-JSON, וממיר אותם למודל הנתונים המאוחד (UDM). הוא מטפל בשני הפורמטים, מבצע טרנספורמציות והעשרות של נתונים, וממפה את השדות שחולצו לשדות ה-UDM התואמים שלהם באובייקט event. הוא מתמקד בפעולות של משתמשים, בגישה למשאבים ובאירועי עדכון, מסווג אותם ומאכלס שדות UDM רלוונטיים כמו principal, target, network ו-metadata.
לפני שמתחילים
ודאו שאתם עומדים בדרישות המוקדמות הבאות:
- מופע של Google SecOps.
- גישה מיוחדת ל-CircleCI.
הגדרת פידים
כדי להגדיר פיד:
- עוברים אל הגדרות > ניהול נתונים > פידים. אם אתם משתמשים בפלטפורמה של SIEM בלבד, עוברים אל הגדרות > פידים.
- לוחצים על הוספת פיד חדש.
- בדף הבא, לוחצים על הגדרת פיד יחיד.
- בשדה Feed name, נותנים שם לפיד (לדוגמה, CircleCI Logs).
- בוחרים באפשרות Webhook בתור סוג המקור.
- בוחרים באפשרות CircleCI בתור סוג היומן.
- לוחצים על הבא.
- אופציונלי: מציינים ערכים לפרמטרים הבאים של הקלט:
- Split delimiter: התו המשמש להפרדה בין שורות ביומן, כמו
\n. - מרחב השמות של הנכס: מרחב השמות של הנכס.
- תוויות הטמעה: התווית שנוספה לאירועים מהפיד הזה.
- Split delimiter: התו המשמש להפרדה בין שורות ביומן, כמו
- לוחצים על הבא.
- בודקים את הגדרות הפיד במסך סיום ולוחצים על שליחה.
- לוחצים על יצירת מפתח סודי כדי ליצור מפתח סודי לאימות הפיד הזה.
- מעתיקים את המפתח הסודי ושומרים אותו. לא תוכלו לראות שוב את המפתח הסודי הזה. במקרה הצורך, אפשר ליצור מחדש מפתח סודי, אבל הפעולה הזו מבטלת את המפתח הסודי הקודם.
- בכרטיסייה פרטים, מעתיקים את כתובת ה-URL של נקודת הקצה של הפיד מהשדה פרטי נקודת הקצה. צריך לציין את כתובת ה-URL של נקודת הקצה הזו באפליקציית הלקוח.
- לוחצים על סיום.
יצירת מפתח API לפיד ה-Webhook
עוברים אל מסוףGoogle Cloud > Credentials.
לוחצים על Create credentials ואז על מפתח API.
מגבילים את הגישה של מפתח ה-API ל-Google Security Operations API.
מציינים את כתובת ה-URL של נקודת הקצה
- באפליקציית הלקוח, מציינים את כתובת ה-URL של נקודת הקצה (endpoint) ב-HTTPS שסופקה בפיד ה-webhook.
כדי להפעיל את האימות, צריך לציין את מפתח ה-API ואת המפתח הסודי כחלק מהכותרת בהתאמה אישית, בפורמט הבא:
X-goog-api-key = API_KEY X-Webhook-Access-Key = SECRETהמלצה: ציינו את מפתח ה-API ככותרת במקום לציין אותו בכתובת ה-URL.
אם לקוח ה-webhook שלכם לא תומך בכותרות בהתאמה אישית, אתם יכולים לציין את מפתח ה-API ואת המפתח הסודי באמצעות פרמטרים של שאילתה בפורמט הבא:
ENDPOINT_URL?key=API_KEY&secret=SECRETמחליפים את מה שכתוב בשדות הבאים:
-
ENDPOINT_URL: כתובת ה-URL של נקודת הקצה של הפיד. -
API_KEY: מפתח ה-API לאימות ב-Google SecOps. -
SECRET: המפתח הסודי שיצרתם כדי לאמת את הפיד.
-
הגדרת webhook ב-CircleCI
- נכנסים לממשק האינטרנט של CircleCI.
- בוחרים את הפרויקט שממנו רוצים להטמיע את היומנים.
- לוחצים על Project Settings (הגדרות הפרויקט).
- בוחרים באפשרות תגובות לפעולה מאתר אחר (webhooks).
- לוחצים על Add Webhook (הוספת תגובה לפעולה מאתר אחר).
מציינים ערכים לפרמטרים הבאים של הקלט:
- Webhook Name: נותנים שם תיאורי (לדוגמה, Google SecOps).
- כתובת ה-URL של נקודת קצה ל-API: מזינים את
<ENDPOINT_URL>של נקודת קצה ל-API של Google SecOps.
- אירועים: בוחרים את האירועים ב-CircleCI שיפעילו את ה-webhook (לדוגמה, בוחרים באפשרות workflow-completed כדי לשלוח נתונים אחרי שתהליך העבודה מסתיים).
לוחצים על שמירה כדי ליצור את ה-webhook.
טבלת מיפוי UDM
| שדה ביומן | מיפוי UDM | Logic (פונקציה לוגית) |
|---|---|---|
| account.id | read_only_udm.about.resource.attribute.labels.value | הערך של account.id מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.about.resource.attribute.labels.value, שבו ה-key התואם הוא account_id. |
| action | read_only_udm.metadata.product_event_type | הערך של action מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.metadata.product_event_type. |
| actor.id | read_only_udm.principal.user.product_object_id | הערך של actor.id מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.principal.user.product_object_id. |
| actor.name | read_only_udm.principal.user.userid | הקידומת "github:" הוסרה מהשדה actor.name ביומן הגולמי. הערך שנותר מוקצה לשדה ה-UDM read_only_udm.principal.user.userid. אם actor.name קיים ביומן הגולמי, הערך USER_RESOURCE_UPDATE_CONTENT מוקצה ל-read_only_udm.metadata.event_type. אחרת, מוקצה הערך USER_RESOURCE_ACCESS. |
| id | read_only_udm.metadata.product_log_id | הערך של id מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.metadata.product_log_id. המנתח מגדיר את read_only_udm.metadata.log_type ל-CIRCLECI. המנתח מגדיר את read_only_udm.metadata.product_name ל-CIRCLECI. המנתח מגדיר את read_only_udm.metadata.vendor_name ל-CIRCLECI. |
| occurred_at | read_only_udm.metadata.event_timestamp | הערך של occurred_at מהיומן הגולמי מנותח כחותמת זמן ומוקצה לשדה ה-UDM read_only_udm.metadata.event_timestamp. |
| organization.name | read_only_udm.target.administrative_domain | הקידומת "github:" מוסרת מהשדה organization.name ביומן הגולמי. הערך שנותר מוקצה לשדה ה-UDM read_only_udm.target.administrative_domain. |
| payload.job.id | read_only_udm.about.resource.attribute.labels.value | הערך של payload.job.id מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.about.resource.attribute.labels.value, שבו המפתח התואם הוא job_id. |
| payload.job.job_name | read_only_udm.about.resource.attribute.labels.value | הערך של payload.job.job_name מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.about.resource.attribute.labels.value, שבו ה-key התואם הוא job_name. |
| payload.job.job_status | read_only_udm.about.resource.attribute.labels.value | הערך של payload.job.job_status מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.about.resource.attribute.labels.value, שבו ה-key התואם הוא job_status. |
| payload.workflow.id | read_only_udm.about.resource.attribute.labels.value | הערך של payload.workflow.id מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.about.resource.attribute.labels.value, שבו ה-key התואם הוא workflow_id. |
| request.id | read_only_udm.network.session_id | הערך של request.id מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.network.session_id. |
| scope.id | read_only_udm.about.resource.attribute.labels.value | הערך של scope.id מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.about.resource.attribute.labels.value, שבו המפתח התואם הוא scope_id. המנתח מגדיר בהתחלה את sec_action ל-BLOCK. אם הערך בשדה success ביומן הגולמי הוא true, הערך של sec_action משתנה ל-ALLOW. הערך של sec_action מוקצה לשדה ה-UDM read_only_udm.security_result.action. |
| target.id | read_only_udm.target.resource.product_object_id | הערך של target.id מהיומן הגולמי מוקצה לשדה ה-UDM read_only_udm.target.resource.product_object_id. |
| target.name | read_only_udm.target.resource.name | הקידומת "github:" מוסרת מהשדה target.name ביומן הגולמי. הערך שנותר מוקצה לשדה ה-UDM read_only_udm.target.resource.name. המנתח מגדיר את read_only_udm.target.resource.resource_type ל-STORAGE_OBJECT. |
| גרסה | read_only_udm.target.resource.attribute.labels.value | הערך של version מהיומן הגולמי מומר למחרוזת ומוקצה לשדה ה-UDM read_only_udm.target.resource.attribute.labels.value, שבו ה-key התואם הוא version. |
יומן שינויים
הצגת יומן השינויים של המנתח הזה
הבעיה עדיין לא נפתרה? קבלת תשובות מחברי הקהילה וממומחי Google SecOps.