Benutzerdefinierte Organisationsrichtlinien verwenden

Auf dieser Seite erfahren Sie, wie Sie benutzerdefinierte Einschränkungen des Organisationsrichtliniendienstes verwenden, um bestimmte Vorgänge für die folgenden Google Cloud Ressourcen einzuschränken:

• secretmanager.googleapis.com/Secret

Weitere Informationen zu Organisationsrichtlinien finden Sie unter Benutzerdefinierte Organisationsrichtlinien.

Informationen zu Organisationsrichtlinien und Einschränkungen

Mit dem Google Cloud Organisationsrichtliniendienst können Sie die Ressourcen Ihrer Organisation zentral und programmatisch steuern. Als Administrator für Organisationsrichtlinien können Sie eine Organisationsrichtlinie definieren, also eine Reihe von Einschränkungen, die fürGoogle Cloud -Ressourcen und untergeordnete Elemente dieser Ressourcen in der Google Cloud -Ressourcenhierarchie gelten. Sie können Organisationsrichtlinien auf Organisations-, Ordner- oder Projektebene erzwingen.

Die Organisationsrichtlinie bietet integrierte verwaltete Einschränkungen für verschiedene Google Cloud -Dienste. Wenn Sie jedoch eine detailliertere, anpassbare Steuerung der spezifischen Felder wünschen, die in Ihren Organisationsrichtlinien eingeschränkt werden, können Sie auch benutzerdefinierte Einschränkungen erstellen und diese benutzerdefinierten Einschränkungen in einer Organisationsrichtlinie verwenden.

Übernahme von Richtlinien

Standardmäßig werden Organisationsrichtlinien von den Nachfolgerelementen der Ressourcen übernommen, für die Sie die Richtlinie erzwingen. Wenn Sie beispielsweise eine Richtlinie für einen Ordner erzwingen, erzwingt Google Cloud die Richtlinie für alle Projekte in dem Ordner. Weitere Informationen zu diesem Verhalten und zu dessen Änderung finden Sie unter Regeln für die Evaluierung der Hierarchie.

Vorteile

Mit benutzerdefinierten Organisationsrichtlinien können Sie Folgendes tun:

• Sie können strenge Sicherheitsanforderungen erzwingen, indem Sie festlegen, dass Nutzer Secrets mit Anmerkungen versehen, Ablaufdaten für Secrets festlegen oder die verzögerte Vernichtung von Secret-Versionen einrichten müssen.
• Unterstützung bestimmter Rotationsanforderungen durch die Anforderung, dass für alle Secrets in bestimmten Projekten oder Ordnern Rotationszeitpläne eingerichtet werden.
• Prüfen Sie, ob Anmerkungen und Versionsaliase mit ausgewählten Ausdrücken in automatisierten Skripts übereinstimmen.
• Cloud-Kosten steuern, indem Sie die Arten von Secrets einschränken, die in Ihrer Organisation zulässig sind.

Beschränkungen

• Sie können das Ablaufdatum eines Secrets entweder mit expire_time (einem bestimmten Zeitpunkt) oder mit ttl (einer Dauer) definieren. In benutzerdefinierten Organisationsrichtlinien können Sie nur expire_time verwenden, um festzulegen, wann das Secret abläuft. Wenn Sie einen ttl für ein Secret festlegen, konvertiert Secret Manager ihn in einen expire_time-Wert, um die Richtlinie zu verarbeiten und auszuwerten.

Hinweise

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.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

1. Sie müssen Ihre Organisations-ID kennen.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zur Verwaltung von Organisationsrichtlinien benötigen:

• Administrator für Organisationsrichtlinien (roles/orgpolicy.policyAdmin) für die Organisationsressource
• So erstellen oder aktualisieren Sie ein Secret: Secret Manager Admin (roles/secretmanager.admin) für das Projekt

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Diese vordefinierten Rollen enthalten die Berechtigungen, die zum Verwalten von Organisationsrichtlinien erforderlich sind. Erweitern Sie den Abschnitt Erforderliche Berechtigungen, um die erforderlichen Berechtigungen anzuzeigen:

Erforderliche Berechtigungen

Die folgenden Berechtigungen sind für die Verwaltung von Organisationsrichtlinien erforderlich:

• orgpolicy.* für die Organisationsressource
• So erstellen oder aktualisieren Sie ein Secret Manager-Secret:
  • secretmanager.secrets.create für die Projektressource
  • secretmanager.secrets.get für die Projektressource
  • secretmanager.secrets.list für die Projektressource
  • secretmanager.secrets.update für die Projektressource

Sie können diese Berechtigungen auch mit benutzerdefinierten Rollen oder anderen vordefinierten Rollen erhalten.

Benutzerdefinierte Einschränkung erstellen

Eine benutzerdefinierte Einschränkung wird in einer YAML-Datei durch die Ressourcen, Methoden, Bedingungen und Aktionen definiert, die von dem Dienst unterstützt werden, für den Sie die Organisationsrichtlinie erzwingen. Bedingungen für Ihre benutzerdefinierten Einschränkungen werden mithilfe der Common Expression Language (CEL) definiert. Weitere Informationen zum Erstellen von Bedingungen in benutzerdefinierten Einschränkungen mit CEL finden Sie im Abschnitt CEL unter Benutzerdefinierte Einschränkungen erstellen und verwalten.

Zum Erstellen einer benutzerdefinierten Einschränkung erstellen Sie eine YAML-Datei im folgenden Format:

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

Ersetzen Sie Folgendes:

• ORGANIZATION_ID: Ihre Organisations-ID, z. B. 123456789.

• CONSTRAINT_NAME: Name, den Sie für Ihre neue benutzerdefinierte Einschränkung verwenden möchten. Eine benutzerdefinierte Einschränkung muss mit custom. beginnen und darf nur Großbuchstaben, Kleinbuchstaben oder Ziffern enthalten. Beispiel: custom.ensureVersionDestroyTTL. Die maximale Länge dieses Feldes beträgt 70 Zeichen.

• RESOURCE_NAME: Der vollständig qualifizierte Name derGoogle Cloud -Ressource, die das Objekt und das Feld enthält, das Sie einschränken möchten. Beispiel: secretmanager.googleapis.com/Secret

• CONDITION: eine CEL-Bedingung, die für eine Darstellung einer unterstützten Dienstressource geschrieben wird. Dieses Feld hat eine maximale Länge von 1000 Zeichen. Weitere Informationen zu den verfügbaren Ressourcen, auf die Bedingungen geschrieben werden können, finden Sie unter Unterstützte Ressourcen. Beispiel: "resource.versionDestroyTtl < duration('30h')".

• ACTION: Aktion, die ausgeführt werden soll, wenn condition erfüllt ist. Mögliche Werte sind ALLOW und DENY.

• DISPLAY_NAME: Ein nutzerfreundlicher Name für die Einschränkung. Dieses Feld hat eine maximale Länge von 200 Zeichen.

• DESCRIPTION: Eine nutzerfreundliche Beschreibung der Einschränkung, die als Fehlermeldung angezeigt werden soll, wenn die Richtlinie verletzt wird Dieses Feld hat eine maximale Länge von 2000 Zeichen.

Weitere Informationen zum Erstellen einer benutzerdefinierten Einschränkung finden Sie unter Benutzerdefinierte Einschränkungen definieren.

Benutzerdefinierte Einschränkung einrichten

Nachdem Sie die YAML-Datei für eine neue benutzerdefinierte Einschränkung erstellt haben, müssen Sie sie einrichten, um sie für Organisationsrichtlinien in Ihrer Organisation verfügbar zu machen. Verwenden Sie zum Einrichten einer benutzerdefinierten Einschränkung den Befehl gcloud org-policies set-custom-constraint:

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

Ersetzen Sie CONSTRAINT_PATH durch den vollständigen Pfad zu Ihrer benutzerdefinierten Einschränkungsdatei. Beispiel: /home/user/customconstraint.yaml Nach Abschluss des Vorgangs sind Ihre benutzerdefinierten Einschränkungen als Organisationsrichtlinien in der Liste der Google Cloud Organisationsrichtlinien verfügbar. Prüfen Sie mit dem Befehl gcloud org-policies list-custom-constraints, ob die benutzerdefinierte Einschränkung vorhanden ist:

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

Ersetzen Sie ORGANIZATION_ID durch die ID Ihrer Organisationsressource. Weitere Informationen finden Sie unter Organisationsrichtlinien aufrufen.

Benutzerdefinierte Organisationsrichtlinie erzwingen

Sie können eine Einschränkung erzwingen, indem Sie eine Organisationsrichtlinie erstellen, die darauf verweist, und diese Organisationsrichtlinie dann auf eine Google Cloud -Ressource anwenden.

Console

1. Rufen Sie in der Google Cloud Console die Seite Organisationsrichtlinien auf.

   Zu den Organisationsrichtlinien

2. Wählen Sie in der Projektauswahl das Projekt aus, für das Sie die Organisationsrichtlinie festlegen möchten.
3. Wählen Sie auf der Seite Organisationsrichtlinien die gewünschte Einschränkung aus, um die Seite Richtliniendetails aufzurufen.
4. Zum Konfigurieren der Organisationsrichtlinie für diese Ressource klicken Sie auf Richtlinie verwalten.
5. Wählen Sie auf der Seite Richtlinie bearbeiten die Option Richtlinie der übergeordneten Ressource überschreiben aus.
6. Klicken Sie auf Regel hinzufügen.
7. Wählen Sie im Abschnitt Erzwingung aus, ob die Erzwingung dieser Organisationsrichtlinie aktiviert oder deaktiviert werden soll.
8. Klicken Sie optional auf Bedingung hinzufügen, um die Organisationsrichtlinie von einem Tag abhängig zu machen. Wenn Sie einer Organisationsrichtlinie eine bedingte Regel hinzufügen, müssen Sie mindestens eine bedingungsfreie Regel hinzufügen oder die Richtlinie kann nicht gespeichert werden. Weitere Informationen finden Sie unter Organisationsrichtlinie mit Tags festlegen.
9. Klicken Sie auf Änderungen testen, um die Auswirkungen der Organisationsrichtlinie zu simulieren. Die Richtliniensimulation ist für Legacy-Verwaltungseinschränkungen nicht verfügbar. Weitere Informationen finden Sie unter Änderungen an Organisationsrichtlinien mit dem Richtliniensimulator testen.
10. Klicken Sie auf Richtlinie festlegen, um den Vorgang abzuschließen und die Organisationsrichtlinie anzuwenden. Es kann bis zu 15 Minuten dauern, bis die Richtlinie wirksam wird.

gcloud

Wenn Sie eine Organisationsrichtlinie mit booleschen Regeln erstellen möchten, erstellen Sie eine YAML-Richtliniendatei, die auf die Einschränkung verweist:

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

Ersetzen Sie Folgendes:

• PROJECT_ID: das Projekt, für das Sie die Einschränkung erzwingen möchten
• CONSTRAINT_NAME: der Name, den Sie für Ihre benutzerdefinierte Einschränkung definiert haben. Beispiel: custom.ensureVersionDestroyTTL.

Führen Sie den folgenden Befehl aus, um die Organisationsrichtlinie mit der Einschränkung zu erzwingen:

    gcloud org-policies set-policy POLICY_PATH
    

Ersetzen Sie POLICY_PATH durch den vollständigen Pfad zur YAML-Datei Ihrer Organisationsrichtlinie. Es kann bis zu 15 Minuten dauern, bis die Richtlinie wirksam wird.

Benutzerdefinierte Organisationsrichtlinie testen

Im folgenden Beispiel wird gezeigt, wie Sie eine benutzerdefinierte Einschränkung und Richtlinie konfigurieren, um sicherzustellen, dass alle neuen Secrets, die in einem bestimmten Projekt erstellt werden, eine Verzögerungsdauer für das Löschen (version_destroy_ttl) von mindestens 30 Stunden haben.

Vor Beginn müssen folgende Voraussetzungen erfüllt sein:

• Aktivieren Sie die Secret Manager API einmal pro Projekt.
• Sie müssen Ihre Organisations-ID kennen.
• Sie kennen Ihre Projekt-ID.

Einschränkung erstellen

1. Speichern Sie die folgende Datei als 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
   

   Dies definiert eine Einschränkung, bei der für jedes neue Secret der Vorgang abgelehnt wird, wenn die Secret-Version version_destroy_ttl nicht angewendet wird oder die version_destroy_ttl weniger als 30 Stunden beträgt.

2. Wenden Sie die Einschränkung an:

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

3. Prüfen Sie, ob die Einschränkung vorhanden ist:

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

   Die Ausgabe sieht in etwa so aus:

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

Richtlinie erstellen

1. Speichern Sie die folgende Datei als policy.yaml:

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

   Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

2. Wenden Sie die Richtlinie an:

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

3. Prüfen Sie, ob die Richtlinie vorhanden ist:

   gcloud org-policies list --project=PROJECT_ID
   

   Die Ausgabe sieht etwa so aus:

   CONSTRAINT                                    LIST_POLICY    BOOLEAN_POLICY    ETAG
   custom.ensureVersionDestroyTTLAtLeast30hours  -              SET               COCsm5QGENiXi2E=
   

Warten Sie nach dem Anwenden der Richtlinie etwa zwei Minuten, bis Google Cloud die Richtlinie durchgesetzt hat.

Richtlinie testen

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

Die Ausgabe sieht so aus:

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

Beispiele für benutzerdefinierte Organisationsrichtlinien für häufige Anwendungsfälle

In der folgenden Tabelle finden Sie die Syntax einiger benutzerdefinierter Einschränkungen für gängige Anwendungsfälle:

Beschreibung	Einschränkungssyntax
Die TTL für das Löschen von Versionen muss mehr als zwei Tage betragen	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
Pub/Sub-Thema festlegen	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.
Anmerkungen mit Präfix ablehnen	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-'.

Unterstützte Secret Manager-Ressourcen

In der Tabelle in diesem Abschnitt sind die Secret Manager-Ressourcen aufgeführt, auf die Sie in benutzerdefinierten Einschränkungen verweisen können.

Um Einschränkungen für Ressourcenstandorte festzulegen, verwenden Sie Organisationsrichtlinien für Ressourcenstandorte. Wenn Sie Einschränkungen für die CMEK-Nutzung festlegen möchten, empfehlen wir die Verwendung von CMEK-Organisationsrichtlinien.

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

Nächste Schritte

• Weitere Informationen zum Organisationsrichtliniendienst
• Organisationsrichtlinien erstellen und verwalten
• Eine vollständige Liste der verwalteten Einschränkungen für Organisationsrichtlinien finden Sie hier.