Habilita Autokey de Cloud KMS

En esta página, se muestra cómo habilitar y configurar Cloud KMS Autokey en una carpeta de recursos. Para obtener más información sobre Autokey, consulta Descripción general de las claves automáticas. Un administrador de seguridad debe completar los pasos que se indican en esta página.

Antes de comenzar

Antes de habilitar Autokey de Cloud KMS, debes tener lo siguiente:

• Es un recurso de organización que contiene una carpeta en la que deseas habilitar Autokey. Si no tienes una carpeta en la que quieras habilitar Autokey, puedes crear una nueva carpeta de recursos. Si habilitas Autokey en esta carpeta, se habilitará para todos los proyectos de recursos dentro de la carpeta.
• Si tienes proyectos de recursos en los que quieres usar Autokey, pero no están dentro de una carpeta en la que habilitarás Autokey, puedes mover los proyectos de recursos existentes a carpetas nuevas.

Roles obligatorios

Para obtener los permisos que necesitas para habilitar y configurar Autokey, pídele a tu administrador que te otorgue los siguientes roles de IAM en la organización o la carpeta:

• Administrador de Autokey de Cloud KMS (roles/cloudkms.autokeyAdmin)
• Administrador de IAM de carpeta (roles/resourcemanager.folderIamAdmin)
• Usuario de cuenta de facturación (roles/billing.user)

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Estos roles predefinidos contienen los permisos necesarios para habilitar y configurar Autokey. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.

Decide cómo quieres habilitar Autokey

Puedes habilitar Autokey como parte de tu estrategia de infraestructura como código con Terraform para realizar los cambios de configuración necesarios. Si deseas usar Terraform para habilitar Autokey, consulta Cómo habilitar Autokey con Terraform en esta página. Si no quieres usar Terraform, comienza siguiendo las instrucciones de la siguiente sección.

Configura el proyecto de claves

Te recomendamos que crees un proyecto de claves nuevo para que contenga los recursos de Cloud KMS creados por Autokey. Debes crear el proyecto de clave dentro del recurso de organización. Si ya tienes un proyecto de claves que deseas usar para las claves creadas por Autokey, puedes omitir la sección Crea un proyecto de claves y continuar desde Configura el proyecto de claves de Autokey en esta página.

El proyecto de claves se puede crear dentro de la misma carpeta en la que planeas habilitar Autokey. No debes crear otros recursos dentro del proyecto de clave. Si intentas crear recursos protegidos por Autokey en el proyecto de claves, Autokey rechazará la solicitud de una clave nueva.

Si es posible que desees migrar a Assured Workloads en el futuro, crea el proyecto de claves dentro de la misma carpeta que los recursos protegidos por esas claves.

Si tu organización usa la restricción de política de la organización constraints/gcp.restrictCmekCryptoKeyProjects para garantizar que todas las CMEK provengan de proyectos clave especificados, debes agregar tu proyecto clave a la lista de proyectos permitidos. Para obtener más información sobre la política de la organización de CMEK, consulta Políticas de la organización de CMEK.

Crea un proyecto clave

Prepara el proyecto de claves de Autokey

Habilita Autokey de Cloud KMS en una carpeta de recursos

curl "https://cloudkms.googleapis.com/v1/folders/FOLDER_ID/autokeyConfig?updateMask=keyProject" \
    --request "PATCH" \
    --header "authorization: Bearer TOKEN" \
    --header "content-type: application/json" \
    --data '{"key_project": "projects/PROJECT_ID"}'

Configura el agente de servicio de Cloud KMS

El agente de servicio de Cloud KMS para un proyecto de claves crea claves y aplica vinculaciones de políticas de IAM durante la creación de recursos, en nombre de un administrador humano de Cloud KMS. Para poder crear y asignar claves, el agente de servicio de Cloud KMS requiere permisos de administrador de Cloud KMS.

1. Crea el agente de servicio de Cloud KMS:

   gcloud beta services identity create --service=cloudkms.googleapis.com \
       --project=PROJECT_NUMBER
   

   Reemplaza PROJECT_NUMBER por el número del proyecto clave.

   El resultado es similar a este:

   Service identity created: service-PROJECT_NUMBER@gcp-sa-ekms.iam.gserviceaccount.com
   

   El resultado del comando indica que se creó la cuenta de servicio de Cloud EKM (con el subdominio gcp-sa-ekms). Sin embargo, el comando también crea el agente de servicio de Cloud KMS (con el subdominio gcp-sa-cloudkms), que es el agente de servicio que usarás más adelante en estas instrucciones.

2. Otorga permisos de administrador de Cloud KMS al agente de servicio:

   gcloud projects add-iam-policy-binding PROJECT_NUMBER \
       --role=roles/cloudkms.admin \
       --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudkms.iam.gserviceaccount.com
   

   Reemplaza PROJECT_NUMBER por el número del proyecto clave.

Otorga roles de usuario de Autokey

Antes de que tus desarrolladores puedan usar Autokey, debes otorgarles el rol requerido. Puedes otorgar el rol a nivel de la carpeta o del proyecto. Este rol permite que los desarrolladores soliciten claves del agente de servicio de Cloud KMS mientras crean recursos en esa carpeta o proyecto.

Elige uno de los siguientes pasos o ambos:

• Otorga el rol roles/cloudkms.autokeyUser a nivel de la carpeta:

  gcloud resource-manager folders add-iam-policy-binding \
      FOLDER_ID --role=roles/cloudkms.autokeyUser \
      --member=user:USER_EMAIL
  

  Reemplaza lo siguiente:

  • FOLDER_ID: Es el ID de la carpeta en la que deseas habilitar Autokey.
  • USER_EMAIL: Es la dirección de correo electrónico del usuario al que deseas otorgar permiso para usar Autokey.

• Otorga el rol roles/cloudkms.autokeyUser a nivel del proyecto:

  gcloud projects add-iam-policy-binding PROJECT_ID \
      --role=roles/cloudkms.autokeyUser \
      --member=user:USER_EMAIL
  

  Reemplaza lo siguiente:

  • PROJECT_ID: Es el ID del proyecto del recurso.
  • USER_EMAIL: Es la dirección de correo electrónico del usuario al que deseas otorgar permiso para usar Autokey.

Tus desarrolladores de Autokey ahora pueden crear claves a pedido. Para obtener información sobre cómo crear recursos protegidos con claves creadas a pedido por Autokey, consulta Crea recursos protegidos con Autokey.

Habilita Autokey con Terraform

La siguiente muestra de Terraform automatiza los siguientes pasos de configuración:

• Crea una carpeta de recursos
• Crea un proyecto clave
• Cómo otorgar permisos de usuario
• Configura el agente de servicio de Cloud KMS
• Habilitar Autokey

Debes crear proyectos de recursos por separado dentro de la carpeta de recursos.

variable "organization_ID" {
  description = "Your Google Cloud Org ID"
  type        = string
  default     = "ORGANIZATION_ID"
}

variable "billing_account" {
  description = "Your Google Cloud Billing Account ID"
  type        = string
  default     = "BILLING_ACCOUNT_ID"
}

/* List the users who should have the authority to enable and configure
   Autokey at a folder level */
variable "autokey_folder_admins" {
  type    = list(string)
  default = [AUTOKEY_ADMIN_USER_IDS]
}

/* List the users who should have the authority to protect their resources
   with Autokey */
variable "autokey_folder_users" {
  type    = list(string)
  default = [AUTOKEY_DEVELOPER_USER_IDS]
}

/* List the users who should have the authority to manage crypto operations in
   the Autokey key project */
variable "autokey_project_kms_admins" {
  type    = list(string)
  default = [KEY_PROJECT_ADMIN_USER_IDS]
}

/* The project ID to use for the key project. The project ID must be 6 to 30
   characters with lowercase letters, digits, hyphens. The project ID must start
   with a letter. Trailing hyphens are prohibited */
variable "key_management_project_ID" {
  description = "Sets the project ID for the Key Management Project. This project will contain the Key Rings and Keys generated by Cloud KMS Autokey"
  type        = string
  default     = "KEY_PROJECT_ID"
}

# Create a new folder
resource "google_folder" "autokey_folder" {
  parent       = "organizations/${var.organization_ID}"
  display_name = "autokey_folder"
}

# Set permissions for key admins to use Autokey in this folder
resource "google_folder_iam_binding" "autokey_folder_admin" {
  folder  = google_folder.autokey_folder.name
  role    = "roles/cloudkms.autokeyAdmin"
  members = var.autokey_folder_admins
}

# Set permissions for users to protect resources with Autokey in this folder
resource "google_folder_iam_binding" "autokey_folder_users" {
  folder  = google_folder.autokey_folder.name
  role    = "roles/cloudkms.autokeyUser"
  members = var.autokey_folder_users
}

# Create a key project to store keys created by Autokey
 resource "google_project" "key_management_project" {
  project_id      = var.key_management_project_ID
  name            = var.key_management_project_ID
  billing_account = var.billing_account
  folder_id       = google_folder.autokey_folder.name
}

output "project_number" {
  value = google_project.key_management_project.number
}

# Grant role for Cloud KMS admins to use Autokey in the key project
resource "google_project_iam_binding" "autokey_project_admin" {
  project    = google_project.key_management_project.project_id
  role       = "roles/cloudkms.admin"
  members    = var.autokey_project_kms_admins
  depends_on = [ google_project.key_management_project ]
}

# Enable the Cloud KMS API in the key project
resource "google_project_service" "enable_api" {
  service                    = "cloudkms.googleapis.com"
  project                    = google_project.key_management_project.project_id
  disable_on_destroy         = false
  disable_dependent_services = false
  depends_on                 = [google_project.key_management_project]
}

# Create Cloud KMS service agent
resource "google_project_service_identity" "KMS_Service_Agent" {
  provider   = google-beta
  service    = "cloudkms.googleapis.com"
  project    = google_project.key_management_project.project_id
  depends_on = [google_project.key_management_project]
}

/* Grant role for the Cloud KMS service agent to use delegated
   Cloud KMS admin permissions */
resource "google_project_iam_member" "autokey_project_admin" {
  project = google_project.key_management_project.project_id
  role    = "roles/cloudkms.admin"
  member  = "serviceAccount:service-${google_project.key_management_project.number}@gcp-sa-cloudkms.iam.gserviceaccount.com"
}

/* Enable AutokeyConfig in this folder */
resource "google_kms_autokey_config" "autokey_config" {
  provider    = google-beta
  folder      = google_folder.autokey_folder.folder_id
  key_project = "projects/${google_project.key_management_project.project_id}"
}

Reemplaza lo siguiente:

• BILLING_ACCOUNT_ID: Es el ID de tu cuenta de facturación de Google Cloud . El ID de la cuenta de facturación es un valor alfanumérico de 18 caracteres separados por guiones, por ejemplo, 010101-F0FFF0-10XX01.
• AUTOKEY_ADMIN_USER_IDS: Es una lista de direcciones de correo electrónico de los usuarios que deben tener el rol de roles/cloudkms.autokeyAdmin, por ejemplo, "Ariel@example.com", "Charlie@example.com".
• AUTOKEY_DEVELOPER_USER_IDS: Es una lista de direcciones de correo electrónico de los usuarios que deben tener el rol de roles/cloudkms.autokeyUser, por ejemplo, "Kalani@example.com", "Mahan@example.com".
• KEY_PROJECT_ADMIN_USER_IDS: Es una lista de direcciones de correo electrónico de los usuarios que deben tener el rol roles/cloudkms.admin, por ejemplo, "Sasha@example.com", "Nur@example.com".
• KEY_PROJECT_ID: Es el ID que se usará para el proyecto clave, por ejemplo, autokey-key-project.

Aplicar el uso de Autokey

Si deseas aplicar el uso de Autokey dentro de una carpeta, puedes hacerlo combinando los controles de acceso de IAM con las políticas de la organización de CMEK. Esto se logra quitando los permisos de creación de claves de las entidades principales que no sean el agente de servicio de Cloud KMS y, luego, exigiendo que todos los recursos estén protegidos por CMEK con el proyecto de claves de Autokey.

Para aplicar el uso de Autokey en una carpeta, completa los siguientes pasos:

1. Quita el acceso para crear claves de forma manual en el proyecto de clave. Si no se pueden crear claves de forma manual, solo se podrán crear claves creadas por Autokey en este proyecto. Para obtener más información sobre el control de acceso, consulta Control de acceso con IAM.

2. Establece una política de la organización en la carpeta para exigir que los recursos estén protegidos con una CMEK usando la restricción constraints/gcp.restrictNonCmekServices. Para obtener más información, consulta Cómo exigir la protección con CMEK.

3. Establece una política de la organización en la carpeta para exigir que las claves que se usen para la CMEK provengan del proyecto de claves de Autokey con la restricción constraints/gcp.restrictCmekCryptoKeyProjects. Para obtener más información, consulta Limita el uso de claves de Cloud KMS para la CMEK.

Inhabilita Autokey

Autokey de Cloud KMS se habilita y se inhabilita a nivel de la carpeta. Los mismos roles que pueden habilitar Autokey para una carpeta también pueden inhabilitarla para esa carpeta. Para inhabilitar Autokey en una carpeta, debes borrar AutokeyConfig para quitar la asociación entre la carpeta y el proyecto de claves de Autokey.

Después de que se quita la configuración de Autokey en la carpeta, el agente de servicio de Cloud KMS ya no puede crear claves para los desarrolladores cuando crean recursos en la carpeta. Si quitas la vinculación entre la carpeta y el proyecto de clave, se inhabilitará Autokey en la carpeta. Sin embargo, te recomendamos que también quites las vinculaciones de IAM para los roles roles/cloudkms.autokeyAdmin y roles/cloudkms.autokeyUser.

La inhabilitación de Autokey no afecta las claves existentes en el proyecto de claves. Puedes seguir usando estas claves para proteger tus recursos.

Borra AutokeyConfig.

curl "https://cloudkms.googleapis.com/v1/folders/FOLDER_ID/autokeyConfig?updateMask=keyProject" \
    --request "PATCH" \
    --header "authorization: Bearer TOKEN" \
    --header "content-type: application/json" \
    --data '{}'

Cómo revocar roles de Autokey

1. Opcional: Revoca el rol roles/cloudkms.autokeyAdmin:

   gcloud resource-manager folders remove-iam-policy-binding \
       FOLDER_ID --role=roles/cloudkms.autokeyAdmin \
       --member=user:USER_EMAIL
   

   Reemplaza lo siguiente:

   • FOLDER_ID: Es el ID de la carpeta en la que inhabilitaste Autokey.
   • USER_EMAIL: La dirección de correo electrónico del usuario al que deseas revocar el permiso para administrar Autokey.

2. Opcional: Revoca el rol roles/cloudkms.autokeyUser a nivel de la carpeta:

   gcloud resource-manager folders remove-iam-policy-binding \
       FOLDER_ID --role=roles/cloudkms.autokeyUser \
       --member=user:USER_EMAIL
   

   Reemplaza lo siguiente:

   • FOLDER_ID: Es el ID de la carpeta en la que inhabilitaste Autokey.
   • USER_EMAIL: Es la dirección de correo electrónico del usuario al que deseas revocar el permiso para usar Autokey.

3. Opcional: Revoca el rol roles/cloudkms.autokeyUser a nivel del proyecto:

   gcloud projects remove-iam-policy-binding RESOURCE_PROJECT_NUMBER \
       --role=roles/cloudkms.autokeyUser \
       --member=user:USER_EMAIL
   

   Reemplaza lo siguiente:

   • RESOURCE_PROJECT_NUMBER: Es el número del proyecto de un recurso dentro de la carpeta en la que inhabilitaste Autokey.
   • USER_EMAIL: Es la dirección de correo electrónico del usuario al que deseas revocar el permiso para usar Autokey.

4. Opcional: Si no planeas seguir usando el proyecto de claves para Autokey en otras carpetas, revoca el rol roles/cloudkms.admin para el agente de servicio de Cloud KMS:

   gcloud projects remove-iam-policy-binding KEY_PROJECT_NUMBER \
       --role=roles/cloudkms.admin \
       --member=serviceAccount:service-KEY_PROJECT_NUMBER@gcp-sa-cloudkms.iam.gserviceaccount.com
   

   Reemplaza KEY_PROJECT_NUMBER por el ID numérico del proyecto clave.

5. Opcional: Si no planeas seguir usando las claves creadas dentro del proyecto de claves, revoca el rol roles/cloudkms.admin para el administrador de Cloud KMS:

   gcloud projects remove-iam-policy-binding KEY_PROJECT_NUMBER \
       --role=roles/cloudkms.admin \
       --member=user:KEY_ADMIN_EMAIL
   

   Reemplaza lo siguiente:

   • KEY_PROJECT_NUMBER: Es el número del proyecto de la clave.
   • USER_EMAIL: Es la dirección de correo electrónico del usuario al que deseas revocar el permiso para usar Autokey.

¿Qué sigue?

• Obtén más información sobre cuándo usar Autokey.
• Obtén más información sobre cómo funciona Autokey.
• Tus desarrolladores de Autokey ahora pueden crear recursos protegidos con Autokey.