Menggunakan modul kustom dengan Security Health Analytics

Google Cloud console

Untuk membuat modul kustom di konsol Google Cloud , selesaikan langkah-langkah berikut:

1. Buka halaman Setelan Security Command Center di konsolGoogle Cloud .

   Buka Setelan

2. Jika diminta, pilih organisasi, folder, atau project tempat Anda perlu membuat modul kustom.

3. Di kartu Security Health Analytics, klik Manage Settings.

4. Klik tab Modul.

5. Klik add_box Create module. Halaman Buat modul untuk Security Health Analytics akan terbuka.

6. Di panel Configure module, tentukan nama tampilan, resource yang akan dipindai, dan logika deteksi:

   1. Di kolom Module name, tentukan nama untuk modul. Nama harus terdiri dari 1 hingga 128 karakter, diawali dengan huruf kecil, dan hanya berisi karakter alfanumerik atau garis bawah. Nama ini menjadi kategori temuan dari temuan yang dihasilkan oleh pendeteksi ini. Anda tidak dapat mengubah nama setelah modul dibuat.

   2. Di bagian Tambahkan jenis resource, tentukan satu hingga lima jenis resource yang akan dipindai. Anda tidak dapat menentukan jenis resource lebih dari sekali.

      Untuk mengetahui daftar jenis resource yang didukung, lihat Jenis resource yang didukung.

   3. Di Editor ekspresi, tulis ekspresi CEL untuk menjalankan pemeriksaan boolean pada satu atau beberapa properti resource yang Anda tentukan pada langkah terakhir. Untuk memicu temuan, ekspresi harus diselesaikan menjadi TRUE. Misalnya, ekspresi berikut memicu temuan jika resource CryptoKey memiliki periode rotasi yang ditentukan dan periode rotasi lebih lama dari 2.592.000 detik (30 hari):

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

      Untuk informasi selengkapnya, lihat referensi berikut:

      • Menulis ekspresi CEL
      • Mereferensikan properti resource dan kebijakan dalam modul kustom
      • Daftar Definisi CEL Standar

   4. Klik Berikutnya. Panel Tentukan detail temuan akan terbuka.

7. Di panel Tentukan detail temuan, jelaskan masalah yang dideteksi oleh modul kustom, termasuk tingkat keparahannya, apa masalahnya, cara memperbaiki masalah, dan data apa pun yang ingin Anda sertakan dalam temuan sebagai properti sumber kustom:

   1. Di kolom Keparahan, tentukan tingkat keparahan masalah. Anda dapat menentukan Low, Medium, High, atau Critical. Medium adalah defaultnya.

      Untuk mengetahui informasi tentang tingkat keparahan, lihat Klasifikasi tingkat keparahan temuan.

   2. Di kolom Deskripsi temuan, jelaskan masalah yang dideteksi modul kustom. Penjelasan ini muncul di setiap instance temuan untuk membantu tim keamanan memahami dan mengatasi masalah yang terdeteksi.

   3. Di kolom Menemukan langkah berikutnya, jelaskan langkah-langkah yang dapat dilakukan tim keamanan Anda untuk memperbaiki atau mengatasi masalah yang terdeteksi.

      Langkah-langkah ditampilkan dengan setiap instance temuan. Sertakan langkah-langkah spesifik yang dapat dilakukan tim keamanan untuk mengatasi masalah secepat mungkin.

   4. Opsional: Di kolom Properti temuan kustom, tentukan hingga 10 pasangan nama-nilai untuk menentukan properti sumber kustom yang akan ditampilkan dengan setiap instance temuan. Informasi ditampilkan sebagai properti sumber dalam JSON temuan dan ditampilkan di tab Properti sumber dalam detail temuan di konsolGoogle Cloud . Tentukan nilai teks atau properti sebagai pasangan nilai kunci:

      • Di kolom Nama properti, tentukan nama untuk properti sumber kustom. Nama harus sesuai dengan aturan berikut:
        • Nama harus diawali dengan huruf kecil.
        • Nama hanya boleh berisi karakter alfanumerik atau garis bawah.
        • Panjang nama harus antara 1 dan 128 karakter.
        • Setiap nama harus unik di antara properti sumber lainnya.
      • Di kolom Nilai properti, tentukan salah satu nilai berikut dalam 1.024 karakter atau kurang:
        • String teks yang diapit tanda kutip. Tanda petik disertakan dalam batas 1024 karakter. Misalnya, "This string provides additional useful information."
        • Properti resource yang sedang dipindai. Misalnya, jika Anda memeriksa resource CryptoKey, Anda dapat menentukan resource.rotationPeriod. Nilai properti rotationPeriod ditampilkan.

   5. Klik Berikutnya. Panel Aktifkan modul akan terbuka.

8. Opsional: Gunakan menu drop-down panel Aktifkan modul untuk menentukan apakah modul kustom diaktifkan atau dinonaktifkan saat dibuat. Secara default, modul kustom diaktifkan saat dibuat. Jika Anda menentukan Nonaktifkan, Anda dapat mengaktifkan modul nanti di tab Modul di halaman setelan Security Health Analytics.

9. Klik Berikutnya. Panel Test module akan terbuka.

10. Opsional: Sebelum membuat modul kustom, sebaiknya Anda mengujinya.

    Untuk menguji modul kustom, ikuti langkah-langkah berikut:

    1. Buat file YAML yang berisi definisi resource pengujian untuk resource yang diperiksa oleh modul kustom Anda.

       Untuk mengetahui informasi tentang cara membuat file data pengujian, lihat Membuat resource pengujian dalam file YAML.

    2. Di bagian Upload the YAML file, klik Browse untuk mengupload file YAML yang berisi definisi resource pengujian. Pengujian dimulai secara otomatis saat file diupload.

    3. Di bagian Pratinjau hasil pengujian, periksa hasilnya.

       • Jika ada sintaksis atau error lain dalam file YAML, pesan error mengambang akan ditampilkan di dekat bagian bawah halaman browser.

       • Jika pengujian berhasil, pengujian akan menampilkan informasi berikut:

         • Nama tampilan modul kustom.
         • Nama arbitrer yang Anda tentukan di properti resource dalam file data pengujian.
         • Organisasi, folder, atau project tempat modul kustom dibuat, atau akan dibuat.

    Hasil pengujian tidak disimpan atau ditulis ke Security Command Center.

    Untuk mengetahui informasi selengkapnya, lihat Menguji modul kustom.

11. Klik Buat. Anda akan kembali ke halaman Modul dan akan melihat modul yang Anda buat dengan status Diaktifkan.

Modul kustom baru tidak langsung tersedia untuk digunakan oleh Security Health Analytics dalam pemindaian. Untuk mengetahui informasi selengkapnya, lihat Latensi deteksi.

gcloud CLI

Untuk membuat modul kustom menggunakan perintah gcloud, Anda harus mengodekan definisi modul kustom dalam file YAML yang mencakup ekspresi CEL untuk logika deteksi dan properti output.

Setelah definisi selesai, Anda mengupload definisi ke Security Command Center menggunakan perintah gcloud CLI.

1. Buat kode definisi modul kustom dalam file YAML sesuai dengan petunjuk di Membuat kode modul kustom untuk Security Health Analytics.
2. Simpan file YAML ke lokasi yang dapat diakses oleh instance gcloud CLI Anda.

3. Upload definisi kustom ke 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
   

   Ganti kode berikut:

   • PARENT_FLAG: tingkat pembuatan modul kustom, yaitu --organization, --folder, atau --project.
   • PARENT_ID: ID organisasi, folder, atau project tempat Anda membuat modul kustom.
   • ENABLEMENT_STATE: enabled atau disabled.
   • MODULE_DISPLAY_NAME: nama kategori temuan yang ingin Anda tampilkan saat modul kustom menampilkan temuan. Nama harus terdiri dari 1 hingga 128 karakter, diawali dengan huruf kecil, dan hanya berisi karakter alfanumerik atau garis bawah.
   • MODULE_FILE_NAME: jalur dan nama file file YAML yang berisi definisi modul kustom.

Terraform

Membuat modul kustom untuk organisasi:

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"
  }
}

Membuat modul kustom untuk folder:

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"
  }
}

Membuat modul kustom untuk project:

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

Untuk memperbarui modul kustom yang ada di konsol Google Cloud , ikuti langkah-langkah berikut:

1. Buka halaman Setelan Security Command Center di konsolGoogle Cloud .

   Buka Setelan

2. Di pemilih project, pilih organisasi, folder, atau project tempat modul kustom awalnya dibuat. Anda tidak dapat mengedit modul kustom di tempat lain.

3. Di kartu Security Health Analytics, klik Manage Settings.

4. Pilih tab Modul. Semua modul deteksi Security Health Analytics ditampilkan.

5. Gunakan kolom filter di bagian atas daftar modul atau scroll untuk menemukan modul kustom yang perlu Anda ubah.

6. Di sisi kanan baris modul kustom, klik ikon menu Tindakan, more_vert.

7. Dari Menu tindakan, klik ikon Edit (edit). Halaman Lihat modul akan terbuka dan menampilkan tab Konfigurasi modul.

8. Edit kolom modul kustom setiap tab di halaman Lihat modul sesuai kebutuhan.

9. Opsional: Sebelum menyimpan pembaruan, sebaiknya Anda mengujinya.

   Untuk menguji modul kustom, ikuti langkah-langkah berikut:

   1. Buat file YAML yang berisi definisi resource pengujian untuk resource yang diperiksa oleh modul kustom Anda.

      Untuk mengetahui informasi tentang cara membuat file data pengujian, lihat Membuat resource pengujian dalam file YAML.

   2. Di bagian Upload file YAML, klik Browse untuk mengupload file YAML yang berisi definisi resource pengujian. Pengujian dimulai secara otomatis saat file diupload.

   3. Di bagian Pratinjau hasil pengujian, periksa hasilnya.

      • Jika ada sintaksis atau error lain dalam file YAML, pesan error mengambang akan ditampilkan di dekat bagian bawah halaman browser.

      • Jika pengujian berhasil, pengujian akan menampilkan informasi berikut:

        • Nama tampilan modul kustom.
        • Nama arbitrer yang Anda tentukan di properti resource dalam file data pengujian.
        • Organisasi, folder, atau project tempat modul kustom dibuat, atau akan dibuat.

   Hasil pengujian tidak disimpan atau ditulis ke Security Command Center.

   Untuk mengetahui informasi selengkapnya, lihat Menguji modul kustom.

10. Di bagian bawah halaman, klik Simpan. Perubahan Anda diterapkan ke modul kustom.

gcloud CLI

Untuk memperbarui modul kustom menggunakan gcloud CLI, Anda harus mengedit definisi YAML modul kustom terlebih dahulu, lalu menggunakan perintah gcloud untuk memperbarui modul kustom di Security Health Analytics.

1. Edit definisi modul kustom. Untuk mengetahui informasi tentang cara membuat kode definisi modul kustom, lihat Membuat kode modul kustom untuk Security Health Analytics.

2. Simpan file YAML yang diedit ke lokasi yang dapat diakses oleh gcloud CLI.

3. Perbarui modul kustom di Security Health Analytics dengan mengeluarkan perintah berikut:

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

   Ganti kode berikut:

   • MODULE_ID: ID atau nama lengkap resource modul kustom.
   • PARENT_FLAG: tingkat pembuatan modul kustom, yaitu --organization, --folder, atau --project.
   • PARENT_ID: ID organisasi, folder, atau project tempat modul kustom dibuat.
   • MODULE_FILE_NAME: jalur dan nama file file YAML yang berisi definisi modul kustom.

Google Cloud console

Untuk melihat modul kustom di konsol Google Cloud , ikuti langkah-langkah berikut:

1. Buka halaman Security Health Analytics di setelan Security Command Center.

   Buka Setelan

2. Klik tab Modul. Panel Modul akan terbuka.

3. Jika perlu, gunakan kolom filter di bagian atas daftar modul untuk menemukan modul kustom yang perlu Anda ubah.

4. Untuk melihat detail definisi modul kustom, klik ikon Menu tindakan, more_vert, di sisi kanan baris modul kustom.

5. Dari menu Tindakan, klik ikon Edit, edit. Halaman Lihat modul akan terbuka dan menampilkan tab Konfigurasi modul.

6. Klik tab di halaman Lihat modul untuk melihat semua kolom definisi modul kustom.

gcloud CLI

Untuk melihat detail modul kustom, masukkan perintah berikut:

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

Ganti kode berikut:

• MODULE_ID: ID atau nama lengkap resource modul kustom.
• PARENT_FLAG: tingkat pembuatan modul kustom, yaitu --organization, --folder, atau --project.
• PARENT_ID: ID organisasi, folder, atau project tempat modul kustom dibuat.

Google Cloud console

1. Buka halaman Security Health Analytics di setelan Security Command Center.

   Buka Setelan

2. Klik tab Modul. Panel Modul akan terbuka.

3. Klik di kolom filter di bagian atas daftar modul untuk menampilkan daftar jenis filter.

4. Pilih Jenis dan masukkan Custom. Daftar modul diperbarui untuk menampilkan hanya modul kustom.

gcloud CLI

Untuk melihat daftar modul kustom, masukkan perintah berikut:

gcloud scc custom-modules sha list \
    PARENT_FLAG=PARENT_ID

Ganti kode berikut:

• PARENT_FLAG: tingkat pembuatan modul kustom, yaitu --organization, --folder, atau --project.
• PARENT_ID: ID organisasi, folder, atau project tempat modul kustom dibuat.

Google Cloud console

1. Buka halaman Setelan Security Command Center di konsolGoogle Cloud .

   Buka Setelan

2. Jika diminta, pilih organisasi, folder, atau project Anda.

3. Di kartu Security Health Analytics, klik Manage Settings.

4. Pilih tab Modul. Semua modul deteksi Security Health Analytics ditampilkan.

5. Gunakan kolom filter di bagian atas daftar modul atau scroll untuk menemukan modul kustom yang perlu Anda ubah.

6. Di sisi kanan baris modul kustom, klik ikon menu Tindakan, more_vert.

7. Dari menu Tindakan, klik Hapus. Dialog Hapus modul kustom akan terbuka.

8. Pada dialog, klik Hapus.

gcloud CLI

Untuk menghapus modul kustom, masukkan perintah berikut:

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

Ganti kode berikut:

• MODULE_ID: ID atau nama lengkap resource modul kustom.
• PARENT_FLAG: tingkat pembuatan modul kustom, yaitu --organization, --folder, atau --project.
• PARENT_ID: ID organisasi, folder, atau project tempat modul kustom dibuat.

Konsol

gcloud CLI

Untuk melihat temuan, lakukan tindakan berikut:

1. Buka jendela terminal.

2. Untuk mendapatkan ID sumber Security Health Analytics, jalankan perintah berikut:

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

   Output tampilan akan terlihat seperti berikut. Dalam contoh ini, SOURCE_ID adalah ID yang ditetapkan server untuk sumber keamanan.

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

3. Untuk mencantumkan semua temuan yang dihasilkan oleh modul kustom Anda, jalankan perintah berikut:

   gcloud scc findings list ORGANIZATION_ID --source=SOURCE_ID
   

4. Untuk mencantumkan temuan untuk modul kustom tertentu, jalankan perintah berikut:

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