Menggunakan kebijakan organisasi kustom

Halaman ini menunjukkan cara menggunakan batasan kustom Layanan Kebijakan Organisasi untuk membatasi operasi tertentu pada resource Google Cloud berikut:

  • secretmanager.googleapis.com/Secret

Untuk mempelajari Kebijakan Organisasi lebih lanjut, lihat Kebijakan organisasi kustom.

Tentang batasan dan kebijakan organisasi

Layanan Kebijakan Organisasi Google Cloud memberi Anda kontrol terpusat dan terprogram atas resource organisasi. Sebagai administrator kebijakan organisasi, Anda dapat menentukan kebijakan organisasi, yang merupakan serangkaian batasan yang disebut batasan yang berlaku untuk resourceGoogle Cloud dan turunan dari resource tersebut dalam Google Cloud hierarki resource. Anda dapat menerapkan kebijakan organisasi di tingkat organisasi, folder, atau project.

Kebijakan Organisasi memberikan batasan yang telah ditetapkan untuk berbagai layanan Google Cloud . Namun, jika ingin kontrol yang lebih terperinci dan dapat disesuaikan atas kolom tertentu yang dibatasi dalam kebijakan organisasi, Anda juga dapat membuat batasan khusus dan menggunakan batasan khusus tersebut dalam kebijakan organisasi.

Pewarisan kebijakan

Secara default, kebijakan organisasi diwarisi oleh turunan resource tempat Anda menerapkan kebijakan tersebut. Misalnya, jika Anda menerapkan kebijakan pada folder, Google Cloud akan menerapkan kebijakan tersebut pada semua project dalam folder tersebut. Untuk mempelajari lebih lanjut perilaku ini dan cara mengubahnya, lihat Aturan evaluasi hierarki.

Manfaat

Gunakan kebijakan organisasi kustom untuk melakukan hal berikut:

  • Terapkan persyaratan keamanan yang ketat dengan mewajibkan pengguna menambahkan anotasi ke secret, menetapkan tanggal habis masa berlaku pada secret, atau menyiapkan penghancuran versi secret yang tertunda.
  • Mendukung persyaratan rotasi tertentu dengan mewajibkan semua secret dalam project atau folder tertentu menyiapkan jadwal rotasi.
  • Pastikan anotasi dan alias versi cocok dengan ekspresi yang dipilih dalam skrip otomatis.
  • Kontrol biaya cloud dengan membatasi jenis secret yang diizinkan dalam organisasi Anda.

Batasan

  • Anda dapat menentukan masa berlaku secret menggunakan expire_time (titik waktu tertentu) atau ttl (durasi). Dalam kebijakan organisasi kustom, Anda hanya dapat menggunakan expire_time untuk menentukan kapan masa berlaku secret berakhir. Jika Anda menetapkan ttl untuk secret, Secret Manager akan mengonversinya menjadi nilai expire_time untuk memproses dan mengevaluasi kebijakan.

Sebelum memulai

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.
  5. To initialize the gcloud CLI, run the following command:

    gcloud init
  6. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  7. Make sure that billing is enabled for your Google Cloud project.

  8. Install the Google Cloud CLI.
  9. To initialize the gcloud CLI, run the following command:

    gcloud init
  10. Pastikan Anda mengetahui ID organisasi Anda.

Peran yang diperlukan

Untuk mendapatkan izin yang diperlukan untuk mengelola kebijakan organisasi, minta administrator untuk memberi Anda peran IAM berikut:

Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Peran bawaan ini berisi izin yang diperlukan untuk mengelola kebijakan organisasi. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

Izin yang diperlukan

Izin berikut diperlukan untuk mengelola kebijakan organisasi:

  • orgpolicy.* di resource organisasi
  • Untuk membuat atau memperbarui secret Secret Manager:
    • secretmanager.secrets.create pada resource project
    • secretmanager.secrets.get pada resource project
    • secretmanager.secrets.list pada resource project
    • secretmanager.secrets.update pada resource project

Anda mungkin juga bisa mendapatkan izin ini dengan peran khusus atau peran bawaan lainnya.

Membuat batasan khusus

Batasan kustom ditentukan dalam file YAML oleh resource, metode, kondisi, dan tindakan yang didukung oleh layanan tempat Anda menerapkan kebijakan organisasi. Kondisi untuk batasan kustom Anda ditentukan menggunakan Common Expression Language (CEL). Untuk mengetahui informasi selengkapnya tentang cara membangun kondisi dalam batasan khusus menggunakan CEL, lihat bagian CEL tentang Membuat dan mengelola batasan kustom.

Untuk membuat batasan khusus, buat file YAML menggunakan format berikut:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- RESOURCE_NAME
methodTypes:
- CREATE
- UPDATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

Ganti kode berikut:

  • ORGANIZATION_ID: ID organisasi Anda, seperti 123456789.

  • CONSTRAINT_NAME: nama yang Anda inginkan untuk batasan kustom baru. Batasan kustom harus diawali dengan custom., dan hanya dapat menyertakan huruf besar, huruf kecil, atau angka. Contohnya, custom.ensureVersionDestroyTTL. Panjang maksimum kolom ini adalah 70 karakter.

  • RESOURCE_NAME: nama lengkap resource Google Cloud yang berisi objek dan kolom yang ingin Anda batasi. Misalnya, secretmanager.googleapis.com/Secret.

  • CONDITION: kondisi CEL yang ditulis berdasarkan representasi resource layanan yang didukung. Kolom ini memiliki panjang maksimal 1.000 karakter. Lihat Resource yang didukung untuk mengetahui informasi selengkapnya tentang resource yang tersedia untuk menulis kondisi. Contoh, "resource.versionDestroyTtl < duration('30h')"

  • ACTION: tindakan yang akan diambil jika condition terpenuhi. Kemungkinan nilainya adalah ALLOW dan DENY.

  • DISPLAY_NAME: nama yang mudah dibaca manusia untuk batasan. Kolom ini memiliki panjang maksimal 200 karakter.

  • DESCRIPTION: deskripsi batasan yang mudah dipahami untuk ditampilkan sebagai pesan error saat kebijakan dilanggar. Kolom ini memiliki panjang maksimal 2.000 karakter.

Untuk mengetahui informasi selengkapnya tentang cara membuat batasan kustom, lihat Menentukan batasan kustom.

Menyiapkan batasan kustom

Setelah membuat file YAML untuk batasan khusus baru, Anda harus menyiapkannya agar tersedia untuk kebijakan organisasi di organisasi Anda. Untuk menyiapkan batasan kustom, gunakan perintah gcloud org-policies set-custom-constraint:
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
Ganti CONSTRAINT_PATH dengan jalur lengkap ke file batasan kustom Anda. Contohnya, /home/user/customconstraint.yaml Setelah selesai, batasan khusus Anda akan tersedia sebagai kebijakan organisasi dalam daftar kebijakan organisasi Google Cloud . Untuk memverifikasi bahwa ada batasan kustom, gunakan perintah gcloud org-policies list-custom-constraints:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
Ganti ORGANIZATION_ID dengan ID fasilitas organisasi Anda. Untuk mengetahui informasi selengkapnya, lihat Melihat kebijakan organisasi.

Menerapkan kebijakan organisasi kustom

Anda dapat menerapkan batasan boolean dengan membuat kebijakan organisasi yang mereferensikannya, lalu menerapkan kebijakan organisasi tersebut ke resource Google Cloud .

Konsol

  1. Di konsol Google Cloud , buka halaman Kebijakan organisasi.

    Buka Organization policies

  2. Dari pemilih project, pilih project yang ingin Anda tetapkan kebijakan organisasinya.
  3. Dari daftar di halaman Organization policies, pilih batasan untuk melihat halaman Policy details untuk batasan tersebut.
  4. Untuk mengonfigurasi kebijakan organisasi untuk resource ini, klik Manage policy.
  5. Di halaman Edit policy, pilih Override parent's policy.
  6. Klik Add a rule.
  7. Di bagian Enforcement, pilih apakah penerapan kebijakan organisasi ini diaktifkan atau dinonaktifkan.
  8. Opsional: Untuk membuat kebijakan organisasi bersyarat pada tag, klik Add condition. Perhatikan bahwa jika menambahkan aturan kondisional ke kebijakan organisasi, Anda harus menambahkan setidaknya satu aturan tanpa syarat atau kebijakan tidak dapat disimpan. Untuk mengetahui informasi selengkapnya, lihat Menetapkan kebijakan organisasi dengan tag.
  9. Jika ini adalah batasan kustom, Anda dapat mengklik Uji perubahan untuk menyimulasikan efek kebijakan organisasi ini. Untuk mengetahui informasi selengkapnya, lihat Menguji perubahan kebijakan organisasi dengan Policy Simulator.
  10. Untuk menyelesaikan dan menerapkan kebijakan organisasi, klik Set policy. Kebijakan ini memerlukan waktu hingga 15 menit untuk diterapkan.

gcloud

Untuk membuat kebijakan organisasi yang menerapkan batasan boolean, buat file YAML kebijakan yang merujuk batasan tersebut:

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true
    

Ganti kode berikut:

  • PROJECT_ID: project tempat Anda ingin menerapkan batasan.
  • CONSTRAINT_NAME: nama yang Anda tentukan untuk batasan kustom. Contoh, custom.ensureVersionDestroyTTL

Untuk menerapkan kebijakan organisasi yang berisi batasan, jalankan perintah berikut:

    gcloud org-policies set-policy POLICY_PATH
    

Ganti POLICY_PATH dengan jalur lengkap ke file YAML kebijakan organisasi Anda. Kebijakan ini memerlukan waktu hingga 15 menit untuk diterapkan.

Menguji kebijakan organisasi kustom

Contoh berikut menunjukkan cara mengonfigurasi batasan dan kebijakan kustom untuk memastikan bahwa semua secret baru yang dibuat dalam project tertentu memiliki durasi penundaan pemusnahan (version_destroy_ttl) minimal 30 jam.

Sebelum memulai, pastikan hal-hal berikut:

Membuat batasan

  1. Simpan file berikut sebagai constraint.yaml:

    name: organizations/ORGANIZATION_ID/customConstraints/custom.ensureVersionDestroyTTLAtLeast30hours
    resourceTypes:
    - secretmanager.googleapis.com/Secret
    methodTypes:
    - CREATE
    condition: "resource.versionDestroyTtl < duration('30h')"
    actionType: DENY
    displayName: Enable Secret Version Destroy TTL with at least 30 hours
    description: All new secrets must have Version Destroy TTL values of at least 30 hours
    

    Hal ini menentukan batasan untuk setiap secret baru, jika versi secret version_destroy_ttl tidak diterapkan atau version_destroy_ttl kurang dari 30 jam, operasi akan ditolak.

  2. Terapkan batasan:

    gcloud org-policies set-custom-constraint ~/constraint.yaml
    
  3. Pastikan batasan ada:

    gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
    

    Outputnya mirip dengan yang berikut ini:

    CUSTOM_CONSTRAINT                               ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                        DISPLAY_NAME
    custom.ensureVersionDestroyTTLAtLeast30hours    DENY         CREATE         secretmanager.googleapis.com/Secret   Enable Secret Version Destroy TTL with at least 30 hours
    ...
    

Membuat kebijakan

  1. Simpan file berikut sebagai policy.yaml:

    name: projects/PROJECT_ID/policies/custom.ensureVersionDestroyTTLAtLeast30hours
    spec:
      rules:
      - enforce: true
    

    Ganti PROJECT_ID dengan project ID Anda.

  2. Terapkan kebijakan:

    gcloud org-policies set-policy ~/policy.yaml
    
  3. Pastikan kebijakan ada:

    gcloud org-policies list --project=PROJECT_ID
    

    Outputnya mirip dengan hal berikut ini:

    CONSTRAINT                                    LIST_POLICY    BOOLEAN_POLICY    ETAG
    custom.ensureVersionDestroyTTLAtLeast30hours  -              SET               COCsm5QGENiXi2E=
    

Setelah Anda menerapkan kebijakan, tunggu sekitar dua menit hingga Google Cloud mulai menerapkan kebijakan tersebut.

Menguji kebijakan

gcloud secrets create org-policy-test-secret \
    --project=PROJECT_ID \
    --version-destroy-ttl=100000s

Outputnya adalah sebagai berikut:

Operation denied by custom org policies: ["customConstraints/custom.ensureVersionDestroyTTL": "All new secrets must have version destroy TTL values with at least 30 hours"]

Contoh kebijakan organisasi kustom untuk kasus penggunaan umum

Tabel berikut memberikan sintaksis beberapa batasan kustom untuk kasus penggunaan umum:

Deskripsi Sintaksis batasan
Harus menetapkan TTL penghapusan versi lebih dari dua hari
  name: organizations/ORGANIZATION_ID/customConstraints/custom.secretManagerEnableTTL
  resourceTypes:
  - secretmanager.googleapis.com/Secret
  methodTypes:
  - CREATE
  condition: "has(resource.versionDestroyTtl) && resource.versionDestroyTtl.getSeconds() > 172800"
  actionType: ALLOW
  displayName: Must set version destroy TTL more than one hour
  description: All new secrets must set version destroy TTL and version destroy TTL seconds should be more than two days
  
Menetapkan topik Pub/Sub
  name: organizations/ORGANIZATION_ID/customConstraints/custom.secretsWithPubSubTopic
  resourceTypes:
  - secretmanager.googleapis.com/Secret
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.topics) && size(resource.topics) > 0 && resource.topics[0].name.matches('projects/a_test_project/topics/a_topic_name')"
  actionType: ALLOW
  displayName: Set secret first topic as a_topic_name
  description: All secret must use a_topic_name Pub/Sub topic as the first topic for notifications.
  
Menolak anotasi dengan awalan
    name: organizations/ORGANIZATION_ID/customConstraints/custom.secretManagerAnnotationPrefixes
    resourceTypes:
    - secretmanager.googleapis.com/Secret
    methodTypes:
    - CREATE
    condition: "has(resource.annotations) && resource.annotations['key1'].startsWith('some-prefix-')"
    actionType: DENY
    displayName: Deny annotation of 'key1' with prefix 'some-prefix-'
    description: All new secrets should not have 'key1' annotations set with prefix 'some-prefix-'.
    

Resource yang didukung Secret Manager

Tabel di bagian ini mencantumkan resource Secret Manager yang dapat Anda referensikan dalam batasan kustom.

Untuk menetapkan batasan lokasi resource, gunakan kebijakan organisasi lokasi resource. Demikian pula, untuk menetapkan batasan terkait penggunaan CMEK, sebaiknya gunakan kebijakan organisasi CMEK.

Resource Kolom
secretmanager.googleapis.com/Secret resource.annotations
resource.expireTime
resource.rotation.nextRotationTime
resource.rotation.rotationPeriod
resource.topics.name
resource.versionAliases
resource.versionDestroyTtl

Langkah selanjutnya