Utiliser des règles d'administration personnalisées

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

  • secretmanager.googleapis.com/Secret

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

Le service de règles d'administration Google Cloud vous offre un contrôle centralisé et automatisé sur les ressources de votre organisation. En tant qu'administrateur des règles d'administration, vous pouvez définir une règle d'administration, c'est-à-dire un ensemble de restrictions appelées Contraintes qui s'appliquent aux ressources Google Cloud et aux descendants de ces ressources dans la 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.

Avantages

Vous pouvez utiliser des règles d'administration personnalisées pour:

  • Appliquez des exigences de sécurité strictes en obligeant les utilisateurs à ajouter des annotations aux secrets, à définir des dates d'expiration sur les secrets ou à configurer la destruction différée des versions de secrets.
  • Respectez des exigences de rotation spécifiques en exigeant que tous les secrets de projets ou de dossiers spécifiques configurent des calendriers de rotation.
  • Vérifiez que les annotations et les alias de version correspondent aux expressions sélectionnées dans les scripts automatisés.
  • Contrôlez les coûts cloud en limitant les types de secrets autorisés dans votre organisation.

Limites

  • Vous pouvez définir l'expiration d'un secret à l'aide de expire_time (un moment spécifique) ou de ttl (une durée). Dans les règles d'administration personnalisées, vous ne pouvez utiliser expire_time que pour déterminer quand le secret expire. Si vous définissez un ttl pour un secret, Secret Manager le convertit en valeur expire_time pour le traitement et l'évaluation de la règle.

Avant de commencer

  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. Assurez-vous de connaître votre ID d'organisation.

Rôles requis

Pour obtenir les autorisations nécessaires pour gérer les règles d'administration d'administration de l'organisation, demandez à votre administrateur de vous accorder les rôles IAM suivants:

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.

Ces rôles prédéfinis contiennent les autorisations requises pour gérer les règles d'administration. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour gérer les règles d'administration :

  • orgpolicy.* sur la ressource d'organisation
  • Pour créer ou mettre à jour un secret Secret Manager :
    • secretmanager.secrets.create sur la ressource du projet
    • secretmanager.secrets.get sur la ressource du projet
    • secretmanager.secrets.list sur la ressource du projet
    • secretmanager.secrets.update sur la ressource du projet

Vous pouvez également obtenir ces autorisations avec 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, qui spécifie les ressources, méthodes, conditions et 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.ensureVersionDestroyTTL. La longueur maximale de ce champ est de 70 caractères.

  • RESOURCE_NAME: nom complet de la ressource Google Cloud contenant l'objet et le champ que vous souhaitez restreindre. Exemple :secretmanager.googleapis.com/Secret

  • 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.versionDestroyTtl < duration('30h')".

  • 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 le configurer de sorte qu'il soit disponible 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 et 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 votre contrainte pour afficher la page Détails de la règle associée.
  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 doit être activée ou désactivée.
  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 la section 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.ensureVersionDestroyTTL.

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.

Tester la règle d'administration personnalisée

L'exemple suivant montre comment configurer une contrainte et une règle personnalisées pour vous assurer que tous les nouveaux secrets créés dans un projet donné ont une durée de délai de destruction (version_destroy_ttl) d'au moins 30 heures.

Avant de commencer, vérifiez les points suivants :

Créer la contrainte

  1. Enregistrez le fichier suivant sous le nom 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

    Cela définit une contrainte qui refuse les opérations de création de secret si la version de secret version_destroy_ttl n'est pas appliquée ou si version_destroy_ttl est inférieur à 30 heures.

  2. Appliquez la contrainte :

    gcloud org-policies set-custom-constraint ~/constraint.yaml

  3. Vérifiez que la contrainte existe :

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

    Le résultat ressemble à ce qui suit :

    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
...

Créer la règle

  1. Enregistrez le fichier suivant sous le nom policy.yaml :

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

    Remplacez PROJECT_ID par l'ID de votre projet.

  2. Appliquez la règle :

    gcloud org-policies set-policy ~/policy.yaml

  3. Vérifiez que la règle existe :

    gcloud org-policies list --project=PROJECT_ID

    Le résultat ressemble à ce qui suit :

    CONSTRAINT                                    LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.ensureVersionDestroyTTLAtLeast30hours  -              SET               COCsm5QGENiXi2E=

Une fois la règle appliquée, attendez environ deux minutes que Google Cloud commence à l'appliquer.

Tester la stratégie

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

Le résultat est le suivant :

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

Exemples de règles d'administration personnalisées pour des 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
La valeur TTL de destruction de la version doit être supérieure à deux jours 
  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
Définir un sujet 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.
Refuser les annotations avec un préfixe 
    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-'.

Ressources compatibles avec Secret Manager

Le tableau de cette section répertorie les ressources Secret Manager que vous pouvez référencer dans des contraintes personnalisées.

Pour définir des contraintes d'emplacement des ressources, utilisez les règles d'administration d'emplacement des ressources. De même, pour définir des contraintes concernant l'utilisation de CMEK, nous vous recommandons d'utiliser les règles d'administration CMEK.

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

Étape suivante