Créer des contraintes de règle d'administration personnalisées pour Cloud KMS

Cette page vous explique comment utiliser des contraintes personnalisées du service de règles d'administration pour restreindre des opérations spécifiques sur les ressources Google Cloud suivantes:

  • cloudkms.googleapis.com/KeyHandle
  • cloudkms.googleapis.com/AutokeyConfig
  • cloudkms.googleapis.com/CryptoKey
  • cloudkms.googleapis.com/CryptoKeyVersion
  • cloudkms.googleapis.com/EkmConnection
  • cloudkms.googleapis.com/EkmConfig
  • cloudkms.googleapis.com/ImportJob

Pour en savoir plus sur les règles d'administration, consultez la section Règles d'administration personnalisées.

À propos des règles et des contraintes de l'organisation

Grâce au service de règles d'administration de Google Cloud, vous disposez d'une gestion un contrôle total sur les ressources de votre organisation. En tant que administrateur des règles d'administration, vous pouvez définir une organisation Il s'agit d'un ensemble de restrictions appelées contraintes qui s'appliquent aux ressources Google Cloud et aux descendants de ces ressources Hiérarchie des ressources Google Cloud : Vous pouvez appliquer des règles d'administration au niveau d'une organisation, d'un dossier ou d'un projet.

Les règles d'administration fournissent des contraintes prédéfinies pour divers services Google Cloud. Toutefois, si vous souhaitez exercer un contrôle plus précis et personnalisable sur les champs spécifiques restreints dans vos règles d'administration, vous pouvez également créer des contraintes personnalisées et les utiliser dans une règle d'administration.

Héritage des règles

Par défaut, les règles d'administration sont héritées par les descendants des ressources sur lesquelles vous les appliquez. Par exemple, si vous appliquez une stratégie au niveau d'un dossier, Google Cloud l'applique à tous les projets du dossier. Pour mieux comprendre ce comportement et savoir comment le modifier, consultez la page Règles d'évaluation hiérarchique.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
  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. Assurez-vous de connaître votre ID d'organisation.

Rôles requis

Pour obtenir les autorisations nécessaires pour gérer des règles d'administration, demandez à votre administrateur de vous accorder le rôle IAM Administrateur des règles d'administration (roles/orgpolicy.policyAdmin) sur la ressource de l'organisation. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

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

Créer une contrainte personnalisée

Une contrainte personnalisée est définie dans un fichier YAML par les ressources, les méthodes, les conditions et les actions compatibles avec le service sur lequel vous appliquez la règle d'administration. Les conditions de vos contraintes personnalisées sont définies à l'aide du langage CEL (Common Expression Language). Pour en savoir plus sur la création de conditions dans des contraintes personnalisées à l'aide du CEL, consultez la section CEL de la page Créer et gérer des contraintes personnalisées.

Pour créer une contrainte personnalisée, créez un fichier YAML au format suivant:

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

Remplacez les éléments suivants :

  • ORGANIZATION_ID : ID de votre organisation (par exemple, 123456789).

  • CONSTRAINT_NAME : nom souhaité pour votre nouvelle contrainte personnalisée. Une contrainte personnalisée doit commencer par custom. et ne peut inclure que des lettres majuscules, minuscules ou des chiffres, comme par exemple custom.maxKeyRotationPeriod. La longueur maximale de ce champ est de 70 caractères.

  • RESOURCE_NAME: nom complet du Ressource Google Cloud contenant l'objet et le champ que vous voulez restreindre l'accès. Exemple :cloudkms.googleapis.com/CryptoKey

  • CONDITION : condition CEL écrite pour une représentation d'une ressource de service acceptée. Ce champ ne doit pas comporter plus de 1 000 caractères. Consultez la section Ressources compatibles pour en savoir plus sur les ressources disponibles pour l'écriture de conditions. Par exemple, "resource.rotationPeriod <= 90".

  • ACTION : action à effectuer si la condition est remplie. Les valeurs possibles sont ALLOW et DENY.

  • DISPLAY_NAME : nom convivial de la contrainte. Ce champ ne doit pas comporter plus de 200 caractères.

  • DESCRIPTION : description conviviale de la contrainte, qui sera affichée dans un message d'erreur en cas de non-respect de la règle. Ce champ ne doit pas comporter plus de 2 000 caractères.

Pour en savoir plus sur la création d'une contrainte personnalisée, consultez la page Définir des contraintes personnalisées.

Configurer une contrainte personnalisée

Après avoir créé le fichier YAML pour une nouvelle contrainte personnalisée, vous devez la configurer pour pour les règles d'administration de votre organisation. Pour configurer une contrainte personnalisée, utilisez la commande gcloud org-policies set-custom-constraint :
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
Remplacez CONSTRAINT_PATH par le chemin d'accès complet à votre fichier de contrainte personnalisée. Par exemple, /home/user/customconstraint.yaml. Une fois l'opération terminée, vos contraintes personnalisées sont disponibles en tant que règles d'administration dans votre liste de règles d'administration Google Cloud. Pour vérifier que la contrainte personnalisée existe, utilisez la commande gcloud org-policies list-custom-constraints :
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
Remplacez ORGANIZATION_ID par l'ID de votre ressource d'organisation. Pour en savoir plus, consultez la page Afficher les règles d'administration.

Appliquer une règle d'administration personnalisée

Vous pouvez appliquer une contrainte booléenne en créant une règle d'administration qui la référence, puis en appliquant cette règle d'administration à une ressource Google Cloud.

Console

  1. Dans la console Google Cloud, accédez à la page Règles d'administration.

    Accéder à la page Règles d'administration

  2. Dans le sélecteur de projets, choisissez le projet pour lequel vous souhaitez définir la règle d'administration.
  3. Dans la liste de la page Règles d'administration, sélectionnez la contrainte à afficher. la page Détails de la règle pour cette contrainte.
  4. Pour configurer la règle d'administration pour cette ressource, cliquez sur Gérer la règle.
  5. Sur la page Modifier la stratégie, sélectionnez Remplacer la stratégie parente.
  6. Cliquez sur Ajouter une règle.
  7. Dans la section Application, indiquez si l'application de cette règle d'administration est activé ou désactivé.
  8. Facultatif: Pour rendre la règle d'administration conditionnelle sur un tag, cliquez sur Ajouter une condition Notez que si vous ajoutez une règle conditionnelle à une règle d'administration, vous devez ajouter au moins une règle inconditionnelle, sinon la règle ne pourra pas être enregistrée. Pour en savoir plus, consultez Définir une règle d'administration avec des tags.
  9. S'il s'agit d'une contrainte personnalisée, vous pouvez cliquer sur Tester les modifications pour simuler l'effet de cette règle d'administration. Pour en savoir plus, consultez la section Tester les modifications apportées aux règles d'administration à l'aide de Policy Simulator.
  10. Pour finaliser et appliquer la règle d'administration, cliquez sur Définir la règle. La prise en compte de la règle peut prendre jusqu'à 15 minutes.

gcloud

Pour créer une règle d'administration qui applique une contrainte booléenne, créez un fichier YAML de règle qui référence la contrainte :

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

Remplacez les éléments suivants :

  • PROJECT_ID : projet sur lequel vous souhaitez appliquer votre contrainte.
  • CONSTRAINT_NAME : nom que vous avez défini pour la contrainte personnalisée Par exemple, custom.maxKeyRotationPeriod.

Pour appliquer la règle d'administration contenant la contrainte, exécutez la commande suivante :

    gcloud org-policies set-policy POLICY_PATH
    

Remplacez POLICY_PATH par le chemin d'accès complet au fichier YAML de votre règle d'administration. La prise en compte de la règle peut prendre jusqu'à 15 minutes.

Exemples de règles d'administration personnalisées pour les cas d'utilisation courants

Le tableau suivant fournit la syntaxe de certaines contraintes personnalisées pour les cas d'utilisation courants :

Description Syntaxe de la contrainte
Définissez une période de rotation maximale de 90 jours
    name: organizations/ORGANIZATION_ID/customConstraints/custom.maxRotationPeriod
    resourceTypes:
    - cloudkms.googleapis.com/CryptoKey
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.rotationPeriod <= 90"
    actionType: ALLOW
    displayName: Enforce maximum rotation period for Cloud KMS keys
    description: The maximum rotation period for Cloud KMS keys is 90 days.
    
Définissez une durée maximale de 180 jours pour l'état destruction programmée.
    name: organizations/ORGANIZATION_ID/customConstraints/custom.maxRotationPeriod
    resourceTypes:
    - cloudkms.googleapis.com/CryptoKey
    methodTypes:
    - CREATE
    condition: "resource.destroyScheduledDuration <= 180"
    actionType: ALLOW
    displayName: Enforce maximum scheduled for destruction duration
    description: The maximum length of the scheduled for destruction period is 180 days.
    
Exiger le niveau de protection HSM pour les clés importées
    name: organizations/ORGANIZATION_ID/customConstraints/custom.importToHSM
    resourceTypes:
    - cloudkms.googleapis.com/ImportJob
    methodTypes:
    - CREATE
    condition: "resource.protectionLevel == HSM"
    actionType: ALLOW
    displayName: Import to HSM keys only
    description: New ImportJob resources must use the HSM protection level.
    

Ressources et opérations compatibles avec Cloud Key Management Service

Le tableau suivant répertorie les ressources Cloud Key Management Service que vous pouvez référencer dans les contraintes personnalisées.

Ressource Champ
cloudkms.googleapis.com/AutokeyConfig resource.keyProject
resource.name
cloudkms.googleapis.com/CryptoKey resource.cryptoKeyBackend
resource.destroyScheduledDuration
resource.importOnly
resource.keyAccessJustificationsPolicy.allowedAccessReasons
resource.nextRotationTime
resource.purpose
resource.rotationPeriod
resource.versionTemplate.algorithm
resource.versionTemplate.protectionLevel
cloudkms.googleapis.com/CryptoKeyVersion resource.externalProtectionLevelOptions.ekmConnectionKeyPath
resource.externalProtectionLevelOptions.externalKeyUri
resource.state
cloudkms.googleapis.com/EkmConfig resource.defaultEkmConnection
cloudkms.googleapis.com/EkmConnection resource.cryptoSpacePath
resource.keyManagementMode
resource.serviceResolvers.endpointFilter
resource.serviceResolvers.hostname
resource.serviceResolvers.serviceDirectoryService
cloudkms.googleapis.com/ImportJob resource.importMethod
resource.protectionLevel
cloudkms.googleapis.com/KeyHandle resource.name
resource.resourceTypeSelector

Étape suivante