Melakukan orientasi ke Cloud HSM untuk Google Workspace

Halaman ini menjelaskan cara melakukan orientasi Cloud HSM untuk Google Workspace (CHGWS), layanan kunci enkripsi untuk Google Workspace yang ditawarkan oleh Cloud Key Management Service (Cloud KMS). Cloud HSM untuk Google Workspace memberikan kontrol privasi yang ditingkatkan untuk Google Workspace, sehingga membantu Anda memenuhi standar peraturan seperti DISA IL5 dan meningkatkan keamanan data. Cloud HSM adalah key management service yang sesuai standar, dengan tingkat ketersediaan tinggi, dan terkelola sepenuhnya, yang dioperasikan dalam skala cloud dengan kunci yang didukung hardware yang disimpan dalam HSM (modul keamanan hardware) yang mematuhi FIPS 140-2 Level 3.

CHGWS kompatibel dengan kunci Cloud HSM Multi-tenant dan Cloud HSM Tenant Tunggal.

Untuk mengetahui informasi selengkapnya, lihat Cloud HSM untuk Google Workspace.

Dukungan orientasi otomatis

Konsol Admin Google Workspace memiliki proses orientasi otomatis yang jauh lebih cepat daripada orientasi manual. Namun, aktivasi otomatis hanya didukung jika Anda memenuhi semua kriteria berikut:

  • Anda menyiapkan enkripsi sisi klien Google Workspace (CSE) untuk pertama kalinya.
  • Anda menggunakan Google Identity sebagai penyedia identitas (IdP).
  • Anda menggunakan kunci Cloud HSM Multi-tenant.

Jika Anda memenuhi semua kriteria ini, buka konsol Admin dan selesaikan proses aktivasi otomatis.

Anda harus melakukan aktivasi secara manual jika memenuhi salah satu kriteria berikut:

  • Anda menggunakan IdP pihak ketiga.
  • Anda menggunakan Cloud HSM Tenant Tunggal.
  • Anda berencana memigrasikan kunci dari layanan kunci enkripsi lain.
  • Anda ingin mengubah konfigurasi Cloud HSM untuk Google Workspace yang ada.

Jika Anda memenuhi salah satu kriteria ini, ikuti petunjuk penyiapan dalam dokumen ini.

Sebelum memulai

Sebelum melakukan aktivasi Cloud HSM untuk Google Workspace, selesaikan prasyarat berikut:

  • Siapkan Google Workspace.
  • Aktifkan enkripsi sisi klien Google Workspace (CSE) di Google Workspace Anda.
  • Konfigurasikan Penyedia Identitas (IdP) Anda di CSE Google Workspace. Catat Client ID untuk IdP Anda. Jika Anda menggunakan Google Identity Platform, temukan Client ID di project Google Cloud Anda.
  • Opsional: Jika Anda mengizinkan akses ke konten terenkripsi CSE di aplikasi platform selain web (seperti seluler atau desktop), tambahkan client ID untuk platform tersebut di setelan IdP Anda di Konsol Admin Google Workspace. Catat semua client ID untuk IdP ini. Jika Anda menggunakan Google Identity Platform, temukan client ID ini di project Google Cloud Anda. Untuk Penyedia Identitas lainnya, buat client ID ini secara terpisah.

Lokasi yang kompatibel

Anda dapat menyimpan kunci Cloud KMS di lokasi regional atau multi-regional mana pun dalam area geografis Amerika Serikat atau Eropa. Cloud HSM untuk Google Workspace mendukung kunci Cloud HSM Multi-tenant dan Cloud HSM Tenant Tunggal. Untuk menemukan lokasi tertentu, buka Lokasi Cloud KMS dan filter menurut jenis HSM Anda.

Cloud HSM untuk Google Workspace otomatis menyediakan endpoint di salah satu multi-region berikut yang terdekat dengan lokasi kunci Anda:

  • us
  • eur3

Menyiapkan project Google Cloud untuk Cloud KMS

Endpoint Cloud HSM untuk Google Workspace mengandalkan kunci Cloud KMS untuk operasi kriptografis. Siapkan project Google Cloud baru untuk menghosting kunci Cloud KMS.

  1. Buat project Google Cloud . Ini adalah project utama Anda. Catat project ID dan nomor project; Anda memerlukannya untuk menyelesaikan penyiapan.

  2. Aktifkan penagihan pada project yang Anda buat.

  3. Aktifkan Cloud KMS API di project kunci Google Cloud Anda.

    Mengaktifkan API

  4. Aktifkan Workspace Key Access API (Pratinjau) di project kunciGoogle Cloud Anda.

    Mengaktifkan API

  5. Di konsol Google Cloud , klik terminal Activate Cloud Shell.

  6. Pastikan Anda berada di project yang benar dengan membandingkan project ID Anda dengan project ID di prompt Cloud Shell.

  7. Dengan menggunakan Cloud Shell, buat akun layanan Cloud HSM untuk Google Workspace:

    gcloud beta services identity create \
        --service=cloudkmskacls-pa.googleapis.com
    

    Catat identitas layanan yang dibuat oleh perintah ini. Anda memerlukan nama identitas layanan di langkah berikutnya.

  8. Berikan peran CHGWS key Service Agent dan Browser ke akun layanan yang Anda buat:

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudkmskacls.iam.gserviceaccount.com \
        --role=roles/cloudkmskacls.serviceAgent
    
    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudkmskacls.iam.gserviceaccount.com \
        --role=roles/browser
    

    Ganti kode berikut:

    • PROJECT_ID: Project ID dari project kunci Anda.
    • PROJECT_NUMBER: Nomor project dari project kunci Anda.
  9. Berikan peran Workspace Key Access API Admin (roles/workspacekeyaccess.admin) (Pratinjau) kepada administrator yang membuat dan mengelola konfigurasi dan endpoint CHGWS:

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=user:ADMIN_USER_EMAIL \
        --role=roles/workspacekeyaccess.admin
    

    Ganti kode berikut:

    • PROJECT_ID: Project ID dari project kunci Anda.
    • ADMIN_USER_EMAIL: Alamat email administratorGoogle Cloud yang membuat dan mengelola konfigurasi dan endpoint CHGWS.

Menyiapkan kunci Cloud KMS

Siapkan resource Cloud KMS untuk endpoint layanan kunci CHGWS Anda.

  1. Buat key ring di salah satu wilayah yang didukung:

    gcloud kms keyrings create KEY_RING --location LOCATION
    

    Ganti kode berikut:

    • KEY_RING: Nama yang ingin Anda gunakan untuk key ring CHGWS—misalnya, CHGWS_KEY_RING.
    • LOCATION: Lokasi tempat Anda ingin membuat key ring—misalnya, us.
  2. Membuat kunci Cloud HSM.

    Cloud HSM multi-tenant

    Untuk membuat kunci dengan tingkat perlindungan hsm:

    gcloud kms keys create KEY_NAME \
        --protection-level "hsm" \
        --keyring KEY_RING \
        --location LOCATION \
        --purpose "encryption" \
        --rotation-period ROTATION_PERIOD \
        --next-rotation-time NEXT_ROTATION_TIME
    

    Ganti kode berikut:

    • KEY_NAME: Nama yang ingin Anda gunakan untuk kunci Anda—misalnya, CHGWS_KEY.
    • KEY_RING: Nama key ring Anda—misalnya, CHGWS_KEY_RING.
    • LOCATION: Lokasi tempat Anda membuat key ring—misalnya, us.
    • ROTATION_PERIOD: Frekuensi yang Anda inginkan untuk merotasi kunci, misalnya, 7d.
    • NEXT_ROTATION_TIME: Tanggal dan waktu saat rotasi kunci berikutnya terjadi—misalnya, 2024-03-20T01:00:00.

    Cloud HSM tenant tunggal

    Untuk membuat kunci dengan tingkat perlindungan hsm_single_tenant, Anda harus terlebih dahulu menyediakan instance Cloud HSM Single-tenant di lokasi yang sama.

    1. Membuat dan menyediakan instance Cloud HSM tenant tunggal: Ikuti petunjuk dalam panduan Membuat dan mengelola instance Cloud HSM tenant tunggal. Catat ID Instance yang disediakan. Anda akan menggunakannya pada langkah berikutnya.

    2. Membuat kunci:

      gcloud kms keys create KEY_NAME \
          --protection-level "hsm_single_tenant" \
          --keyring KEY_RING \
          --location LOCATION \
          --purpose "encryption" \
          --crypto-key-backend "projects/PROJECT_ID/locations/LOCATION/singleTenantHsmInstances/INSTANCE_NAME" \
          --rotation-period ROTATION_PERIOD \
          --next-rotation-time NEXT_ROTATION_TIME
      

      Ganti kode berikut:

      • KEY_NAME: Nama yang ingin Anda gunakan untuk kunci Anda—misalnya, CHGWS_KEY.
      • KEY_RING: Nama key ring Anda—misalnya, CHGWS_KEY_RING.
      • LOCATION: Lokasi tempat Anda membuat key ring—misalnya, us.
      • PROJECT_ID: Project ID dari project kunci Anda.
      • INSTANCE_NAME: Nama instance Cloud HSM Single-tenant tempat Anda ingin membuat kunci.
      • ROTATION_PERIOD: Frekuensi yang Anda inginkan untuk merotasi kunci—misalnya, 7d.
      • NEXT_ROTATION_TIME: Tanggal dan waktu saat rotasi kunci berikutnya terjadi—misalnya, 2024-03-20T01:00:00.

    Untuk mengetahui detail selengkapnya tentang opsi pembuatan kunci, lihat Membuat kunci.

Melakukan aktivasi menggunakan Workspace Key Access API mandiri

Anda dapat menggunakan Google Cloud CLI dengan Workspace Key Access API untuk membuat dan mengelola resource CHGWS berikut:

  • Config: Menyimpan detail organisasi Google Workspace dan IdP Anda, termasuk ID pelanggan, alamat email administrator, domain yang diizinkan, dan parameter autentikasi JSON Web Token (JWT).
  • Endpoint: Menghubungkan konfigurasi CHGWS Anda ke kunci Cloud KMS dan menyediakan URL layanan kunci enkripsi (uri) yang Anda daftarkan di konsol Admin Google Workspace untuk CSE.

Bagian berikut menunjukkan cara membuat dan mengelola konfigurasi dan endpoint CHGWS menggunakan Google Cloud CLI.

Atau, Anda dapat Meminta endpoint CHGWS dengan menghubungi Account Representative Anda.

Membuat konfigurasi CHGWS

Konfigurasi CHGWS Anda menyimpan informasi tentang organisasi Google Workspace dan penyedia identitas (IdP) yang digunakan pengguna untuk melakukan autentikasi. Anda dapat menggunakan CHGWS hanya dengan IdP utama, atau Anda dapat mengonfigurasi IdP utama dan tamu.

Untuk mengonfigurasi CHGWS agar hanya menggunakan IdP utama, lakukan hal berikut:

  • Buat konfigurasi CHGWS untuk mendaftarkan Google Workspace Anda menggunakan perintah workspace-key-access configs create:

    gcloud beta workspace-key-access configs create CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION \
        --customer-id=CUSTOMER_ID \
        --admin-emails=ADMIN_EMAILS \
        --kacls-owner-domains=OWNER_DOMAINS \
        --idp-configs='
            idpType=PRIMARY_IDP,
            issuer=IDP_ISSUER,
            jwksUri=IDP_JWKS_URI,
            audience=IDP_AUDIENCE,
            additionalAudiences=[ADDITIONAL_IDP_AUDIENCES]
        '
    

    Ganti kode berikut:

    • CONFIG_ID: ID untuk konfigurasi Anda—misalnya, my-workspace-config.
    • PROJECT_ID: Project ID dari project kunci Anda.
    • ENDPOINT_LOCATION: Lokasi tempat Anda ingin membuat konfigurasi—misalnya, us. Tentukan salah satu Lokasi yang kompatibel.
    • CUSTOMER_ID: ID pelanggan Google Workspace Anda. Untuk menemukan ID pelanggan Anda, lihat Menemukan ID pelanggan Anda.
    • ADMIN_EMAILS: Daftar alamat email administrator Google Workspace yang dipisahkan koma.
    • OWNER_DOMAINS: Daftar domain pelanggan Google Workspace yang diizinkan dan dipisahkan koma, tempat Anda mendaftarkan layanan kunci. Temukan domain Anda di konsol Admin Google Workspace di halaman Kelola domain.
    • IDP_ISSUER: URL penerbit JWT IdP utama Anda. Untuk Google Identity Platform, gunakan https://accounts.google.com.
    • IDP_JWKS_URI: URL JSON Web Key Set (JWKS) dari IdP utama Anda. Untuk Google Identity Platform, gunakan https://www.googleapis.com/oauth2/v3/certs.
    • IDP_AUDIENCE: Client ID OAuth 2.0 IdP utama Anda untuk aplikasi web.
    • ADDITIONAL_IDP_AUDIENCES: Opsional: Daftar client ID OAuth 2.0 untuk aplikasi platform non-web, yang dipisahkan dengan koma tanpa spasi. Aplikasi dapat mencakup aplikasi seluler atau desktop. Jika Anda tidak perlu mengonfigurasi audiens tambahan, hapus placeholder sehingga tanda kurung kosong (additionalAudiences=[]). Untuk Google Identity Platform, gunakan client ID yang diberikan di Jika Anda akan menggunakan identitas Google untuk CSE.

    Untuk mengetahui informasi selengkapnya tentang flag yang tersedia, lihat gcloud beta workspace-key-access configs create.

Untuk mengonfigurasi CHGWS agar menggunakan IdP utama dan tamu, lakukan hal berikut:

  • Buat konfigurasi CHGWS untuk mendaftarkan Google Workspace Anda menggunakan perintah workspace-key-access configs create dan tentukan flag --idp-configs dua kali:

    gcloud beta workspace-key-access configs create CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION \
        --customer-id=CUSTOMER_ID \
        --admin-emails=ADMIN_EMAILS \
        --kacls-owner-domains=OWNER_DOMAINS \
        --idp-configs='
            idpType=PRIMARY_IDP,
            issuer=IDP_ISSUER,
            jwksUri=IDP_JWKS_URI,
            audience=IDP_AUDIENCE,
            additionalAudiences=[ADDITIONAL_IDP_AUDIENCES]
        ' \
        --idp-configs='
            idpType=GUEST_IDP,
            issuer=GUEST_IDP_ISSUER,
            jwksUri=GUEST_IDP_JWKS_URI,
            audience=GUEST_IDP_AUDIENCE,
            additionalAudiences=[GUEST_ADDITIONAL_IDP_AUDIENCES]
        '
    

    Ganti kode berikut:

    • CONFIG_ID: ID untuk konfigurasi Anda—misalnya, my-workspace-config.
    • PROJECT_ID: Project ID dari project kunci Anda.
    • ENDPOINT_LOCATION: Lokasi tempat Anda ingin membuat konfigurasi—misalnya, us. Tentukan salah satu Lokasi yang kompatibel.
    • CUSTOMER_ID: ID pelanggan Google Workspace Anda. Untuk menemukan ID pelanggan Anda, lihat Menemukan ID pelanggan Anda.
    • ADMIN_EMAILS: Daftar alamat email administrator Google Workspace yang dipisahkan koma.
    • OWNER_DOMAINS: Daftar domain pelanggan Google Workspace yang diizinkan dan dipisahkan koma, tempat Anda mendaftarkan layanan kunci. Temukan domain Anda di konsol Admin Google Workspace di halaman Kelola domain.
    • IDP_ISSUER: URL penerbit JWT IdP utama Anda. Untuk Google Identity Platform, gunakan https://accounts.google.com.
    • IDP_JWKS_URI: URL JSON Web Key Set (JWKS) dari IdP utama Anda. Untuk Google Identity Platform, gunakan https://www.googleapis.com/oauth2/v3/certs.
    • IDP_AUDIENCE: Client ID OAuth 2.0 IdP utama Anda untuk aplikasi web.
    • ADDITIONAL_IDP_AUDIENCES: Opsional: Daftar client ID OAuth 2.0 untuk aplikasi platform non-web, yang dipisahkan dengan koma tanpa spasi. Aplikasi dapat mencakup aplikasi seluler atau desktop. Jika Anda tidak perlu mengonfigurasi audiens tambahan, hapus placeholder sehingga tanda kurung kosong (additionalAudiences=[]). Untuk Google Identity Platform, gunakan client ID yang diberikan di Jika Anda akan menggunakan identitas Google untuk CSE.
    • GUEST_IDP_ISSUER: URL penerbit JWT dari IdP tamu Anda. Untuk Google Identity Platform, gunakan https://accounts.google.com.
    • GUEST_IDP_JWKS_URI: URL JWKS IdP tamu Anda. Untuk Google Identity Platform, gunakan https://www.googleapis.com/oauth2/v3/certs.
    • GUEST_IDP_AUDIENCE: Client ID OAuth 2.0 IdP tamu Anda untuk aplikasi web, kecuali untuk Google Meet.
    • GUEST_ADDITIONAL_IDP_AUDIENCES: Opsional: Daftar client ID OAuth 2.0 untuk aplikasi platform non-web yang Anda konfigurasi untuk IdP tamu, dipisahkan dengan koma tanpa spasi. Aplikasi dapat mencakup aplikasi seluler atau desktop. Jika Anda tidak perlu mengonfigurasi audiens tambahan, hapus placeholder sehingga tanda kurung kosong (additionalAudiences=[]). Untuk Google Identity Platform, gunakan client ID yang diberikan di bagian Jika Anda akan menggunakan identitas Google untuk CSE.

    Untuk mengetahui informasi selengkapnya tentang flag yang tersedia, lihat gcloud beta workspace-key-access configs create.

Opsional: Untuk memverifikasi bahwa konfigurasi Anda sudah disiapkan dengan benar, lakukan hal berikut:

  • Deskripsikan konfigurasi untuk melihat detailnya:

    gcloud beta workspace-key-access configs describe CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

Membuat endpoint CHGWS

  1. Buat endpoint layanan kunci CHGWS, lalu lampirkan ke konfigurasi CHGWS dan kunci Cloud KMS Anda:

    gcloud beta workspace-key-access endpoints create ENDPOINT_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION \
        --config=projects/PROJECT_ID/locations/ENDPOINT_LOCATION/configs/CONFIG_ID \
        --kms-key=projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME
    

    Ganti kode berikut:

    • ENDPOINT_ID: ID untuk endpoint layanan kunci enkripsi Anda—misalnya, my-kacls-endpoint.
    • PROJECT_ID: Project ID dari project kunci Anda.
    • ENDPOINT_LOCATION: Lokasi konfigurasi dan endpoint Anda—misalnya, us. Tentukan salah satu Lokasi yang kompatibel.
    • CONFIG_ID: ID konfigurasi yang Anda buat sebelumnya.
    • LOCATION: Lokasi tempat Anda membuat key ring Cloud KMS—misalnya, us.
    • KEY_RING: Nama key ring Cloud KMS Anda.
    • KEY_NAME: Nama kunci Cloud KMS Anda.
  2. Deskripsikan endpoint untuk mengambil uri yang dihasilkan dan verifikasi bahwa state-nya adalah ACTIVE:

    gcloud beta workspace-key-access endpoints describe ENDPOINT_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

    Salin nilai uri dari output. Anda akan menggunakan URL ini di Mengonfigurasi endpoint CHGWS di CSE Google Workspace.

Meminta endpoint CHGWS

Untuk meminta aktivasi dan pembuatan endpoint, hubungi perwakilan akun Anda untuk mendapatkan bantuan, dan berikan informasi berikut:

  • Detail Google Workspace:

    • ID pelanggan Google Workspace: ID pelanggan Google Workspace Anda. Untuk menemukan ID pelanggan Anda, lihat Menemukan ID pelanggan Anda.

    • Alamat email administrator Google Workspace: Berikan daftar alamat email administrator yang dipisahkan koma.

  • Detail IdP:

    • Detail IdP utama:

      • IdP JWKS URL: Untuk Google Identity Platform, gunakan https://www.googleapis.com/oauth2/v3/certs.
      • JWT token issuer: Untuk Google Identity Platform, gunakan https://accounts.google.com.
      • Audiens JWT: Client ID IdP Anda untuk aplikasi web.
      • Additional JWT audiences: Opsional: berikan client ID untuk aplikasi platform non-web yang Anda konfigurasi. Untuk Google Identity Platform, gunakan client ID yang diberikan di bagian Jika Anda akan menggunakan identitas Google untuk CSE.
    • Detail IdP tamu: Opsional: lengkapi bagian ini jika Anda menggunakan IdP tamu.

      • URL JWKS IdP tamu: URL JWKS IdP tamu Anda.
      • Penerbit token JWT tamu: Penerbit token JWT dari IdP tamu Anda.
      • Audiens JWT tamu: Client ID IdP tamu Anda untuk aplikasi web, kecuali untuk Google Meet.
      • Audiens JWT tambahan tamu: Opsional: jika Anda mengonfigurasi client ID web Google Meet atau client ID aplikasi platform non-web lainnya, berikan client ID untuk masing-masing. Untuk Google Identity Platform, gunakan client ID yang diberikan di bagian Jika Anda akan menggunakan identitas Google untuk CSE.
  • Detail utama CSE:

    • Google Cloud project ID: PROJECT_ID
    • Google Cloud nomor project: PROJECT_NUMBER
    • Nama key ring Cloud KMS: KEY_RING
    • Lokasi key ring Cloud KMS: LOCATION
    • Nama kunci Cloud KMS: KEY_NAME
    • Tingkat perlindungan kunci Cloud KMS: hsm atau hsm_single_tenant
    • URL Dasar CHGWS: Opsional: Daftar URL untuk mengaktifkan migrasi kunci. Jika Anda menyiapkan CHGWS untuk pertama kalinya di Google Workspace ini, biarkan kolom ini kosong.
  • Detail Tambahan:

    • Nama Pelanggan: Berikan nama pelanggan.
    • Perkiraan jumlah pengguna: Berikan perkiraan jumlah pengguna di instance Google Workspace Anda.

Mengelola endpoint layanan CHGWS

Bagian berikut menunjukkan cara mengelola endpoint CHGWS Anda.

Mengonfigurasi endpoint CHGWS di CSE Google Workspace

Setelah membuat endpoint CHGWS, buka konsol Admin Google Workspace untuk mengonfigurasi Google Workspace agar menggunakan endpoint tersebut. URL endpoint dan setelan IdP di konsol Admin harus cocok dengan detail endpoint CHGWS. Jika Anda memperbarui konfigurasi endpoint CHGWS, Anda juga harus memperbarui konfigurasi layanan kunci enkripsi di konsol Admin Google Workspace agar sesuai dengan detail yang diperbarui. Untuk mengetahui informasi selengkapnya, lihat Menambahkan dan mengelola layanan kunci enkripsi untuk enkripsi sisi klien.

Migrasi layanan kunci enkripsi

CHGWS memberikan fleksibilitas untuk memindahkan layanan kunci enkripsi Anda ke atau dari CHGWS. Untuk memulai migrasi layanan kunci, hubungi account representative Anda untuk mendapatkan bantuan dalam mengirimkan permintaan migrasi. Dalam permintaan, sertakan informasi berikut:

  • ID Endpoint: ID endpoint CHGWS.
  • URL Layanan Kunci Enkripsi: Daftar URL untuk mengaktifkan migrasi layanan kunci enkripsi.

    • Jika Anda bermigrasi ke Cloud HSM untuk Google Workspace, berikan URL dasar setiap endpoint layanan kunci yang Anda migrasikan.
    • Jika Anda bermigrasi dari Cloud HSM untuk Google Workspace, berikan URL dasar endpoint layanan kunci yang ingin Anda tuju.

Mengupdate konfigurasi menggunakan Workspace Key Access API mandiri

Anda dapat memperbarui alamat email administrator, domain pelanggan yang diizinkan, atau detail IdP dari konfigurasi CHGWS yang ada menggunakan gcloud CLI. Memperbarui konfigurasi akan otomatis memperbarui semua endpoint yang menggunakan konfigurasi tersebut.

  1. Perbarui konfigurasi CHGWS Anda. Sertakan hanya flag untuk kolom yang ingin Anda perbarui, dan hapus flag untuk kolom yang ingin Anda pertahankan—setiap flag yang Anda sertakan akan menggantikan nilai yang ada untuk kolom tersebut:

    gcloud beta workspace-key-access configs update CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION \
        --admin-emails=ADMIN_EMAILS \
        --kacls-owner-domains=OWNER_DOMAINS \
        --idp-configs='
            idpType=PRIMARY_IDP,
            issuer=IDP_ISSUER,
            jwksUri=IDP_JWKS_URI,
            audience=IDP_AUDIENCE,
            additionalAudiences=[ADDITIONAL_IDP_AUDIENCES]
        ' \
        --idp-configs='
            idpType=GUEST_IDP,
            issuer=GUEST_IDP_ISSUER,
            jwksUri=GUEST_IDP_JWKS_URI,
            audience=GUEST_IDP_AUDIENCE,
            additionalAudiences=[GUEST_ADDITIONAL_IDP_AUDIENCES]
        '
    

    Ganti kode berikut:

    • CONFIG_ID: ID konfigurasi yang ingin Anda perbarui.
    • PROJECT_ID: Project ID dari project kunci Anda.
    • ENDPOINT_LOCATION: Lokasi konfigurasi Anda—misalnya, us. Tentukan salah satu Lokasi yang kompatibel.
    • ADMIN_EMAILS: Opsional: daftar alamat email administrator Google Workspace yang dipisahkan koma. Hapus --admin-emails jika Anda tidak ingin memperbarui alamat email administrator.
    • OWNER_DOMAINS: Opsional: daftar yang dipisahkan koma dari domain pelanggan Google Workspace yang diizinkan tempat Anda mendaftarkan layanan kunci enkripsi. Temukan domain Anda di konsol Admin Google Workspace di halaman Kelola domain. Hapus --kacls-owner-domains jika Anda tidak ingin memperbarui domain kustom yang diizinkan.
    • --idp-configs:
      • Jika Anda hanya mengonfigurasi IdP utama: Hapus flag --idp-configs kedua (GUEST_IDP) (dan garis miring terbalik di baris sebelumnya) dan perbarui detail di flag PRIMARY_IDP. IdP tamu Anda tetap tidak ditetapkan.
      • Jika Anda mengonfigurasi IdP utama dan IdP tamu: Anda harus menyertakan kedua flag --idp-configs meskipun Anda hanya mengupdate salah satunya—jika Anda menghilangkan flag GUEST_IDP, IdP tamu Anda akan ditimpa sebagai tidak ditetapkan, dan jika Anda menghilangkan flag PRIMARY_IDP, update akan gagal.
      • Jika Anda tidak ingin memperbarui IdP apa pun: Hapus kedua flag --idp-configs agar detail IdP yang ada tidak berubah.
    • Detail IdP utama: Diperlukan setiap kali Anda menyertakan --idp-configs:
      • IDP_ISSUER: URL penerbit JWT dari IdP utama Anda. Untuk Google Identity Platform, gunakan https://accounts.google.com.
      • IDP_JWKS_URI: URL JWKS IdP utama Anda. Untuk Google Identity Platform, gunakan https://www.googleapis.com/oauth2/v3/certs.
      • IDP_AUDIENCE: Client ID OAuth 2.0 IdP utama Anda untuk aplikasi web.
      • ADDITIONAL_IDP_AUDIENCES: Opsional: daftar client ID OAuth 2.0 yang dipisahkan koma untuk aplikasi platform non-web (seperti aplikasi Android, iOS, atau desktop), yang dipisahkan dengan koma tanpa spasi. Jika Anda tidak perlu mengonfigurasi audiens tambahan, hapus placeholder sehingga tanda kurung kosong (additionalAudiences=[]). Untuk Google Identity Platform, gunakan client ID yang diberikan di Jika Anda akan menggunakan identitas Google untuk CSE.
    • Detail IdP tamu: Opsional: hanya diperlukan jika Anda menyertakan flag --idp-configs kedua (GUEST_IDP):
      • GUEST_IDP_ISSUER: URL penerbit JWT dari IdP tamu Anda. Untuk Google Identity Platform, gunakan https://accounts.google.com.
      • GUEST_IDP_JWKS_URI: URL JWKS IdP tamu Anda. Untuk Google Identity Platform, gunakan https://www.googleapis.com/oauth2/v3/certs.
      • GUEST_IDP_AUDIENCE: Client ID OAuth 2.0 IdP tamu Anda untuk aplikasi web, kecuali untuk Google Meet.
      • GUEST_ADDITIONAL_IDP_AUDIENCES: Opsional: daftar client ID OAuth 2.0 yang dipisahkan koma jika Anda mengonfigurasi client ID web Google Meet atau client ID aplikasi platform non-web lainnya untuk IdP tamu Anda (dipisahkan dengan koma tanpa spasi). Jika Anda tidak perlu mengonfigurasi audiens tambahan, hapus placeholder sehingga tanda kurung kosong (additionalAudiences=[]). Untuk Google Identity Platform, gunakan client ID yang diberikan di Jika Anda akan menggunakan identitas Google untuk CSE.

    Untuk mengetahui informasi selengkapnya tentang flag yang tersedia, lihat gcloud beta workspace-key-access configs update.

  2. Opsional: Tinjau detail konfigurasi untuk mengonfirmasi bahwa konfigurasi telah diperbarui dengan benar:

    gcloud beta workspace-key-access configs describe CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    
  3. Opsional: Jika Anda memiliki konfigurasi yang tidak digunakan dan tidak terpasang ke endpoint mana pun, Anda dapat menghapusnya:

    gcloud beta workspace-key-access configs delete CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

Mengupdate endpoint untuk menggunakan konfigurasi yang berbeda

Anda dapat memasang endpoint CHGWS ke konfigurasi yang berbeda di project dan lokasi yang sama Google Cloud ; namun, Anda tidak dapat mengubah kunci Cloud KMS pendukung yang terkait dengan endpoint.

Perbarui konfigurasi yang dilampirkan ke endpoint:

gcloud beta workspace-key-access endpoints update ENDPOINT_ID \
    --project=PROJECT_ID \
    --location=ENDPOINT_LOCATION \
    --config=projects/PROJECT_ID/locations/ENDPOINT_LOCATION/configs/NEW_CONFIG_ID

Ganti kode berikut:

  • ENDPOINT_ID: ID endpoint layanan kunci enkripsi yang ingin Anda update.
  • PROJECT_ID: Project ID dari project kunci Anda.
  • ENDPOINT_LOCATION: Lokasi endpoint dan konfigurasi Anda—misalnya, us. Tentukan salah satu Lokasi yang kompatibel.
  • NEW_CONFIG_ID: ID konfigurasi dalam project dan lokasi yang sama yang ingin Anda lampirkan ke endpoint.

Meminta pembaruan ke endpoint

Jika Anda melakukan aktivasi dengan meminta endpoint CHGWS dan perlu memperbarui detail CHGWS yang ada, hubungi perwakilan akun Anda untuk mengirimkan permintaan pembaruan. Dalam permintaan, sertakan ID pelanggan Google Workspace, ID project Google Cloud dan ID endpoint CHGWS, serta alamat email administrator Google Workspace yang diperbarui atau detail IdP yang tercantum di Meminta endpoint CHGWS.

Menonaktifkan dan mengaktifkan endpoint dan penagihan

Namun, Anda tidak dapat menghapus endpoint CHGWS. Jika Anda melakukan orientasi mandiri pada endpoint, Anda dapat menonaktifkan atau mengaktifkan kembali endpoint menggunakan Workspace Key Access dengan gcloud CLI. Menonaktifkan endpoint akan mentransisikannya ke status DISABLED dan menghentikan langganan penagihannya.

Untuk menonaktifkan endpoint yang Anda aktifkan sendiri, lakukan tindakan berikut:

  • Nonaktifkan endpoint aktif dan nonaktifkan penagihan:

    gcloud beta workspace-key-access endpoints disable ENDPOINT_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

    Ganti kode berikut:

    • ENDPOINT_ID: ID endpoint layanan kunci enkripsi yang ingin Anda nonaktifkan.
    • PROJECT_ID: Project ID dari project kunci Anda.
    • ENDPOINT_LOCATION: Lokasi endpoint Anda—misalnya, us. Tentukan salah satu Lokasi yang kompatibel.

Sebelum Anda dapat mengaktifkan kembali endpoint, kunci Cloud KMS dan versi kunci yang digunakan oleh endpoint harus dapat diakses dan aktif. Mengaktifkan endpoint akan memulai ulang langganan penagihannya dan mentransisikan endpoint ke status ACTIVE.

Untuk mengaktifkan kembali endpoint yang Anda nonaktifkan menggunakan perintah workspace-key-access endpoints disable, lakukan hal berikut:

  • Aktifkan kembali endpoint dan mulai ulang penagihan:

    gcloud beta workspace-key-access endpoints enable ENDPOINT_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

    Ganti kode berikut:

    • ENDPOINT_ID: ID endpoint layanan kunci enkripsi yang ingin Anda aktifkan.
    • PROJECT_ID: Project ID dari project kunci Anda.
    • ENDPOINT_LOCATION: Lokasi endpoint Anda—misalnya, us. Tentukan salah satu Lokasi yang kompatibel.

Menonaktifkan dan mengaktifkan versi kunci yang mendasarinya

Terlepas dari cara Anda melakukan aktivasi endpoint, Anda dapat menonaktifkan versi kunci Cloud KMS yang mendasarinya di Cloud KMS menggunakan konsolGoogle Cloud , gcloud CLI, atau Cloud KMS API. Menonaktifkan versi kunci yang mendasarinya akan menonaktifkan endpoint tanpa menghentikan langganan penagihan; Anda kemudian dapat menonaktifkan penagihan secara terpisah.

Untuk menonaktifkan versi kunci yang mendasarinya, lakukan hal berikut:

  • Untuk setiap versi kunci Cloud KMS yang mendukung endpoint, jalankan perintah berikut:

    gcloud kms keys versions disable KEY_VERSION --keyring \
        KEY_RING --location LOCATION --key KEY_NAME
    

    Ganti kode berikut:

    • KEY_VERSION: Versi kunci yang ingin Anda nonaktifkan—misalnya, 1.
    • KEY_RING: Nama key ring—misalnya, CHGWS_KEY_RING.
    • LOCATION: Lokasi versi kunci yang ingin Anda nonaktifkan—misalnya, us.
    • KEY_NAME: Nama kunci—misalnya, CHGWS_KEY.

Untuk mengaktifkan kembali endpoint CHGWS yang Anda nonaktifkan dengan menonaktifkan semua versi kunci Cloud KMS yang mendukung endpoint, lakukan hal berikut:

  • Untuk setiap versi kunci Cloud KMS yang mendukung endpoint, jalankan perintah berikut:

    gcloud kms keys versions enable KEY_VERSION --keyring \
        KEY_RING --location LOCATION --key KEY_NAME
    

    Ganti kode berikut:

    • KEY_VERSION: Versi kunci yang ingin Anda aktifkan—misalnya, 1.
    • KEY_RING: Nama key ring—misalnya, CHGWS_KEY_RING.
    • LOCATION: Lokasi versi kunci yang ingin Anda aktifkan—misalnya, us.
    • KEY_NAME: Nama kunci—misalnya, CHGWS_KEY.

Mengelola penagihan untuk CHGWS

Penagihan dimulai segera setelah endpoint CHGWS Anda dibuat dan aktif. Sejak saat itu, tagihan langganan berulang untuk Cloud HSM untuk Google Workspace akan berlanjut selama endpoint tetap ACTIVE di projectGoogle Cloud . Bagian ini menjelaskan berbagai cara untuk berhenti mengakumulasi biaya Cloud HSM untuk Google Workspace dan cara melanjutkannya.

Menonaktifkan dan mengaktifkan endpoint

Jika Anda melakukan aktivasi endpoint secara mandiri, Anda dapat menggunakan Workspace Key Access API untuk menonaktifkan endpoint CHGWS sambil tetap mengaktifkan resource lain di project Google Cloud Anda. Menonaktifkan endpoint akan mengubahnya ke status DISABLED dan menghentikan langganan penagihannya. Anda dapat mengaktifkan kembali endpoint nanti untuk memulai ulang langganan penagihannya dan mentransisikannya kembali ke status ACTIVE.

Untuk mengetahui informasi selengkapnya, lihat Menonaktifkan dan mengaktifkan endpoint dan penagihan.

Menonaktifkan atau mengaktifkan penagihan project

Anda dapat menonaktifkan penagihan untuk project yang berisi kunci Cloud KMS Anda untuk Cloud HSM untuk Google Workspace. Menonaktifkan penagihan akan membuat semua layanan yang dapat dikenai biaya dalam project berhenti berfungsi. Setelah penagihan tingkat project dinonaktifkan, biaya langganan Cloud HSM untuk Google Workspace akan berhenti dalam waktu 24 jam.

Jika ingin melanjutkan penggunaan Cloud HSM untuk Google Workspace, Anda dapat mengaktifkan kembali penagihan pada project. Setelah penagihan diaktifkan kembali, biaya langganan Anda akan dilanjutkan dan endpoint CHGWS serta kunci Cloud KMS Anda akan berfungsi normal kembali.

Meminta penonaktifan atau pengaktifan manual

Jika Anda melakukan aktivasi dengan meminta endpoint CHGWS dan perlu menonaktifkan endpoint tersebut sambil tetap mengaktifkan resource project lainnya, ajukan permintaan yang mirip dengan permintaan aktivasi. Berikan detail Google Workspace, ID endpoint CHGWS, dan detail relevan lainnya, serta jelaskan persyaratan Anda. Tiket manual dapat memerlukan waktu 48 jam untuk diselesaikan oleh tim CHGWS. Setelah permintaan selesai, tagihan langganan Cloud HSM untuk Google Workspace akan berhenti dalam waktu 24 jam.

Anda dapat mengaktifkan kembali endpoint CHGWS dan penagihannya dengan membuat permintaan serupa.

Menghapus atau memulihkan project

Anda dapat menghapus project yang berisi kunci Cloud KMS Anda untuk Cloud HSM untuk Google Workspace. Menghapus project akan menghentikan semua layanan dalam project. Anda dapat memulihkan project yang dihapus dalam waktu 30 hari setelah penghapusan. Namun, kunci Cloud KMS dalam project tidak dapat dipulihkan, sehingga semua dokumen dan data lain yang dienkripsi dengan kunci dalam project yang dipulihkan akan tetap di-crypto-shred secara permanen. Memulihkan project yang dihapus akan melanjutkan biaya langganan Cloud HSM untuk Google Workspace meskipun kunci Cloud KMS tetap tidak dapat dipulihkan.

Langkah berikutnya