Activer Cloud KMS Autokey

Preview — Autokey

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" dans la section "Conditions d'utilisation générales" des Conditions spécifiques au service. Les fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une assistance limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Cette page explique comment activer et configurer Cloud KMS Autokey sur un dossier de ressources. Pour en savoir plus sur Autokey, consultez la présentation d'Autokey. Les étapes décrites sur cette page doivent être effectuées par un administrateur de la sécurité.

Avant de commencer

Pour pouvoir activer Cloud KMS Autokey, vous devez disposer des éléments suivants:

• Une ressource Organisation contenant un dossier dans lequel vous souhaitez activer Autokey. Si vous n'avez pas de dossier dans lequel activer Autokey, vous pouvez créer un dossier de ressources. L'activation d'Autokey sur ce dossier active Autokey pour tous les projets de ressources du dossier.
• Si vous avez des projets de ressources dans lesquels vous souhaitez utiliser Autokey, mais qu'ils ne se trouvent pas dans un dossier dans lequel vous activerez Autokey, vous pouvez déplacer des projets de ressources existants dans de nouveaux dossiers.

Rôles requis

Pour obtenir les autorisations nécessaires pour activer et configurer Autokey, demandez à votre administrateur de vous attribuer les rôles IAM suivants sur l'organisation ou le dossier:

• Administrateur Autokey de Cloud KMS (roles/cloudkms.autokeyAdmin)
• Administrateur IAM de dossier (roles/resourcemanager.folderIamAdmin)
• Utilisateur de compte de facturation (roles/billing.user)

Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Ces rôles prédéfinis contiennent les autorisations requises pour activer et configurer Autokey. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour activer et configurer Autokey:

• cloudkms.autokeyConfigs.*
• cloudkms.projects.showEffectiveAutokeyConfig
• resourcemanager.folders.get
• resourcemanager.folders.getIamPolicy
• resourcemanager.folders.setIamPolicy
• billing.resourceAssociations.create

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Choisissez la manière dont vous souhaitez activer Autokey

Vous pouvez activer Autokey dans le cadre de votre stratégie Infrastructure as a Service en utilisant Terraform pour apporter les modifications de configuration requises. Si vous souhaitez utiliser Terraform pour activer Autokey, consultez la section Activer Autokey à l'aide de Terraform sur cette page. Si vous ne voulez pas utiliser Terraform, commencez par suivre les instructions de la section suivante.

Configurer le projet clé

Nous vous recommandons de créer un projet de clé contenant les ressources Cloud KMS créées par Autokey. Vous devez créer le projet de clé dans votre ressource "Organisation". Si vous disposez déjà d'un projet de clé que vous souhaitez utiliser pour les clés créées par Autokey, vous pouvez ignorer la section Créer un projet de clé et passer à la section Configurer le projet de clé Autokey de cette page.

Le projet de clé peut être créé dans le dossier où vous prévoyez d'activer Autokey. Vous ne devez pas créer d'autres ressources dans le projet de clé. Si vous tentez de créer des ressources protégées par Autokey dans le projet de clé, Autokey rejette la demande de nouvelle clé.

Si vous souhaitez migrer vers Assured Workloads à l'avenir, créez le projet de clé dans le même dossier que les ressources protégées par ces clés.

Si votre organisation utilise la contrainte de règle d'administration constraints/gcp.restrictCmekCryptoKeyProjects pour garantir que toutes les clés CMEK proviennent de projets de clé spécifiés, vous devez ajouter votre projet de clé à la liste des projets autorisés. Pour en savoir plus sur les règles d'administration des CMEK, consultez la page Règles d'administration des CMEK.

Créer un projet de clé

Console

1. Dans la console Google Cloud, accédez à la page Gérer les ressources.

   Accéder à la page Gérer les ressources

2. Pour Sélectionner une organisation, sélectionnez la ressource d'organisation dans laquelle vous souhaitez créer un projet.
3. Cliquez sur Créer un projet.
4. Dans la fenêtre Nouveau projet qui s'affiche, saisissez un nom de projet et sélectionnez un compte de facturation. Le nom du projet ne peut contenir que des lettres, des chiffres, des guillemets simples, des traits d'union, des espaces ou des points d'exclamation. Il doit comporter entre 4 et 30 caractères.
5. Dans le champ Emplacement, sélectionnez la ressource que vous souhaitez définir comme parent pour votre projet de clé.
6. Pour terminer la création du projet, cliquez sur Créer.

gcloud

• Créez un projet :

  gcloud projects create PROJECT_ID \
      --PARENT_TYPE=PARENT_ID
  

  Remplacez les éléments suivants :

  • PROJECT_ID: ID du projet contenant le trousseau de clés
  • PARENT_TYPE: type de la ressource dans laquelle vous souhaitez créer le projet de clé. Saisissez organization pour créer le projet de clé sous une organisation donnée ou folder pour créer le projet de clé sous un dossier donné.
  • PARENT_ID: ID de l'organisation ou du dossier dans lequel vous souhaitez créer le projet de clé.

Préparer le projet de clé Autokey

Console

1. Activez l'API Cloud KMS sur votre projet de clé.

   Activer l'API

2. Si vous utilisez un nouveau projet de clé, accordez à vos administrateurs Cloud KMS les autorisations d'administrateur sur le projet de clé:

   1. Dans la console Google Cloud, accédez à la page IAM.

      Accéder à IAM

   2. Sélectionnez le projet de clé.

   3. Cliquez sur Accorder l'accès , puis saisissez l'adresse e-mail de l'utilisateur.

   4. Sélectionnez le rôle Administrateur Cloud KMS.

   5. Cliquez sur Enregistrer.

gcloud

1. Activez l'API Cloud KMS sur votre projet de clé:

   gcloud services enable cloudkms.googleapis.com
   

2. Attribuez à vos administrateurs Cloud KMS des autorisations d'administrateur Cloud KMS sur le projet de clé:

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

   Remplacez les éléments suivants :

   • PROJECT_NUMBER: numéro du projet de clé.
   • KEY_ADMIN_EMAIL: adresse e-mail de l'utilisateur responsable de la gestion des clés Cloud KMS.

Activer Cloud KMS Autokey sur un dossier de ressources

Console

1. Dans la console Google Cloud, accédez à la page Commandes KMS.

   Accéder aux commandes KMS

2. Dans le sélecteur de contexte, sélectionnez le dossier dans lequel vous souhaitez activer Autokey.

3. Cliquez sur Activer.

4. Sélectionnez votre projet de clé, puis cliquez sur Submit (Envoyer).

   Un message confirme que Cloud KMS Autokey est activé sur le dossier.

API

Créez le AutokeyConfig pour le dossier dans lequel vous souhaitez activer Autokey:

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

Remplacez les éléments suivants :

• FOLDER_ID: ID du dossier dans lequel vous souhaitez activer Autokey.
• PROJECT_ID: ID du projet de clé.

Configurer l'agent de service Cloud KMS

L'agent de service Cloud KMS d'un projet de clé crée des clés et applique les liaisons de stratégie IAM lors de la création de ressources, au nom d'un administrateur Cloud KMS humain. Pour pouvoir créer et attribuer des clés, l'agent de service Cloud KMS nécessite des autorisations d'administrateur Cloud KMS.

1. Créez l'agent de service Cloud KMS:

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

   Remplacez PROJECT_NUMBER par le numéro du projet de clé.

2. Accordez des autorisations d'administrateur Cloud KMS à l'agent de service:

   gcloud projects add-iam-policy-binding PROJECT_NUMBER \
       --role=roles/cloudkms.admin \
       --member=serviceAccount:[e-mail]
   

   Remplacez PROJECT_NUMBER par le numéro du projet de clé.

Attribuer des rôles utilisateur Autokey

Pour que vos développeurs puissent utiliser Autokey, vous devez leur attribuer le rôle requis. Vous pouvez attribuer le rôle au niveau du dossier ou du projet. Ce rôle permet aux développeurs de demander des clés à l'agent de service Cloud KMS lors de la création de ressources dans ce dossier ou ce projet.

Choisissez l'une des options suivantes ou les deux:

• Accordez le rôle roles/cloudkms.autokeyUser au niveau du dossier:

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

  Remplacez les éléments suivants :

  • FOLDER_ID: ID du dossier dans lequel vous souhaitez activer Autokey.
  • USER_EMAIL: adresse e-mail de l'utilisateur auquel vous souhaitez accorder l'autorisation d'utiliser Autokey.

• Accordez le rôle roles/cloudkms.autokeyUser au niveau du projet:

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

  Remplacez les éléments suivants :

  • PROJECT_ID: ID du projet de ressources.
  • USER_EMAIL: adresse e-mail de l'utilisateur auquel vous souhaitez accorder l'autorisation d'utiliser Autokey.

Vos développeurs Autokey peuvent désormais créer des clés à la demande. Pour savoir comment créer des ressources protégées à l'aide de clés créées à la demande par Autokey, consultez la page Créer des ressources protégées à l'aide d'Autokey.

Activer Autokey à l'aide de Terraform

L'exemple Terraform suivant automatise les étapes de configuration suivantes:

• Créer un dossier de ressources
• Créer un projet de clé
• Accorder des autorisations à l'utilisateur
• Configurer l'agent de service Cloud KMS
• Activer Autokey

Vous devez créer séparément des projets de ressources dans le dossier de ressources.

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 = google_project.key_management_project.project_id
}

Remplacez les éléments suivants :

• BILLING_ACCOUNT_ID: ID de votre compte de facturation Google Cloud. L'ID du compte de facturation est une valeur alphanumérique de 18 caractères séparés par des tirets (par exemple, 010101-F0FFF0-10XX01).
• AUTOKEY_ADMIN_USER_IDS: liste des adresses e-mail des utilisateurs devant disposer du rôle roles/cloudkms.autokeyAdmin (par exemple, "[e-mail]", "[e-mail]").
• AUTOKEY_DEVELOPER_USER_IDS: liste des adresses e-mail des utilisateurs devant disposer du rôle roles/cloudkms.autokeyUser (par exemple, "[e-mail]", "[e-mail]").
• KEY_PROJECT_ADMIN_USER_IDS: liste des adresses e-mail des utilisateurs devant avoir le rôle roles/cloudkms.admin (par exemple, "[e-mail]", "[e-mail]").
• KEY_PROJECT_ID: ID à utiliser pour le projet de clé (par exemple, autokey-key-project).

Appliquer l'utilisation d'Autokey

Si vous souhaitez imposer l'utilisation d'Autokey dans un dossier, vous pouvez le faire en combinant le contrôle des accès IAM avec les règles d'administration CMEK. Cette opération consiste à supprimer les autorisations de création de clés des comptes principaux autres que l'agent de service Cloud KMS, puis à exiger que toutes les ressources soient protégées par une clé CMEK à l'aide du projet de clé Autokey.

Pour imposer l'utilisation d'Autokey dans un dossier, procédez comme suit:

1. Supprimez l'accès pour créer des clés manuellement dans le projet de clé. Si les clés ne peuvent pas être créées manuellement, seules les clés créées par Autokey peuvent être créées dans ce projet. Pour en savoir plus sur le contrôle des accès, consultez la page Contrôle des accès avec IAM.

2. Définissez une règle d'administration sur le dossier pour exiger que les ressources soient protégées avec une clé CMEK à l'aide de la contrainte constraints/gcp.restrictNonCmekServices. Pour en savoir plus, consultez la section Exiger la protection CMEK.

3. Définissez une règle d'administration sur le dossier pour exiger que les clés utilisées pour les CMEK proviennent du projet de clé Autokey utilisant la contrainte constraints/gcp.restrictCmekCryptoKeyProjects. Pour en savoir plus, consultez la section Limiter l'utilisation de clés Cloud KMS pour les CMEK.

Désactiver Autokey

Cloud KMS Autokey est activé et désactivé au niveau du dossier. Les mêmes rôles permettant d'activer Autokey pour un dossier peuvent désactiver Autokey pour ce dossier. Pour désactiver Autokey sur un dossier, vous devez effacer AutokeyConfig afin de supprimer l'association entre le dossier et le projet de clé Autokey.

Une fois la configuration Autokey du dossier supprimée, l'agent de service Cloud KMS ne peut plus créer de clés pour les développeurs lorsqu'ils créent des ressources dans le dossier. La suppression du lien entre le dossier et le projet de clé désactive Autokey dans le dossier. Toutefois, nous vous recommandons de supprimer également les liaisons IAM pour les rôles roles/cloudkms.autokeyAdmin et roles/cloudkms.autokeyUser.

La désactivation d'Autokey n'a aucune incidence sur les clés existantes du projet de clé. Vous pouvez continuer à utiliser ces clés pour protéger vos ressources.

Effacer AutokeyConfig

Console

1. Dans la console Google Cloud, accédez à la page Commandes KMS.

   Accéder aux commandes KMS

2. Dans le sélecteur de contexte, sélectionnez le dossier dans lequel vous souhaitez désactiver Autokey.

3. Cliquez sur Désactiver.

   Un message s'affiche pour vous inviter à confirmer que vous souhaitez désactiver Autokey.

4. Pour désactiver Autokey, cliquez sur Confirm (Confirmer).

   Un message confirme que Cloud KMS Autokey est désactivé sur le dossier.

API

Effacez le AutokeyConfig du dossier dans lequel vous souhaitez désactiver Autokey:

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

Remplacez les éléments suivants :

• FOLDER_ID: ID du dossier dans lequel vous souhaitez désactiver Autokey.

Révoquer des rôles Autokey

1. Facultatif: Révoquez le rôle roles/cloudkms.autokeyAdmin:

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

   Remplacez les éléments suivants :

   • FOLDER_ID: ID du dossier dans lequel vous avez désactivé Autokey.
   • USER_EMAIL: adresse e-mail de l'utilisateur pour lequel vous souhaitez révoquer l'autorisation de gérer Autokey.

2. Facultatif: Révoquez le rôle roles/cloudkms.autokeyUser au niveau du dossier:

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

   Remplacez les éléments suivants :

   • FOLDER_ID: ID du dossier dans lequel vous avez désactivé Autokey.
   • USER_EMAIL: adresse e-mail de l'utilisateur pour lequel vous souhaitez révoquer l'autorisation d'utiliser Autokey.

3. (Facultatif) Révoquez le rôle roles/cloudkms.autokeyUser au niveau du projet :

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

   Remplacez les éléments suivants :

   • RESOURCE_PROJECT_NUMBER: numéro d'un projet de ressources dans le dossier où vous avez désactivé Autokey.
   • USER_EMAIL: adresse e-mail de l'utilisateur pour lequel vous souhaitez révoquer l'autorisation d'utiliser Autokey.

4. Facultatif: Si vous ne prévoyez pas de continuer à utiliser le projet de clé pour Autokey pour d'autres dossiers, révoquez le rôle roles/cloudkms.admin pour l'agent de service Cloud KMS:

   gcloud projects remove-iam-policy-binding KEY_PROJECT_NUMBER \
       --role=roles/cloudkms.admin \
       --member=serviceAccount:[e-mail]
   

   Remplacez KEY_PROJECT_NUMBER par l'ID numérique du projet de clé.

5. Facultatif: Si vous ne prévoyez pas de continuer à utiliser les clés créées dans le projet de clé, révoquez le rôle roles/cloudkms.admin pour l'administrateur Cloud KMS:

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

   Remplacez les éléments suivants :

   • KEY_PROJECT_NUMBER: numéro du projet de clé.
   • USER_EMAIL: adresse e-mail de l'utilisateur pour lequel vous souhaitez révoquer l'autorisation d'utiliser Autokey.

Étapes suivantes

• Découvrez quand utiliser Autokey.
• En savoir plus sur le fonctionnement d'Autokey
• Vos développeurs Autokey peuvent désormais créer des ressources protégées à l'aide d'Autokey.