Gestionar recursos de Firestore con restricciones personalizadas

Gestionar recursos de Firestore con restricciones personalizadas

En esta página se explica cómo usar las restricciones personalizadas del servicio de políticas de organización para restringir operaciones específicas en los siguientes recursos: Google Cloud

• firestore.googleapis.com/Database

Para obtener más información sobre la política de organización, consulta Políticas de organización personalizadas.

Acerca de las políticas y las restricciones de organización

El Google Cloud servicio de políticas de organización te permite controlar los recursos de tu organización de forma centralizada y programática. Como administrador de políticas de organización, puedes definir una política de organización, que es un conjunto de restricciones llamadas restricciones que se aplican a losGoogle Cloud recursos y a los elementos descendientes de esos recursos en la Google Cloud jerarquía de recursos. Puedes aplicar políticas de organización a nivel de organización, carpeta o proyecto.

La política de la organización proporciona restricciones gestionadas integradas para varios servicios de Google Cloud . Sin embargo, si quieres tener un control más granular y personalizable sobre los campos específicos que están restringidos en las políticas de tu organización, también puedes crear restricciones personalizadas y usarlas en una política de la organización.

Herencia de políticas

De forma predeterminada, las políticas de organización se heredan de los descendientes de los recursos en los que se aplican. Por ejemplo, si aplicas una política a una carpeta, Google Cloud se aplicará a todos los proyectos de la carpeta. Para obtener más información sobre este comportamiento y cómo cambiarlo, consulta las reglas de evaluación de la jerarquía.

Ventajas

• Seguridad, cumplimiento y gobierno: puedes usar políticas de organización personalizadas de las siguientes formas:

  • Para cumplir los requisitos de recuperación ante desastres, puedes exigir ajustes específicos de recuperación ante desastres en las bases de datos, como la protección contra eliminación y la recuperación a un momento dado.

  • Puede restringir la creación de bases de datos a determinadas ubicaciones.

  • Puedes requerir CMEK (clave de cifrado gestionada por el cliente) para las bases de datos.

• Auditoría: las restricciones de políticas de la organización personalizadas se registran en la auditoría. Cualquier operación, incluidas las modificaciones y las comprobaciones de restricciones, generará los registros de auditoría de Cloud correspondientes.

Antes de empezar

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.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

1. Asegúrate de que conoces el ID de tu organización.

Roles obligatorios

Para obtener los permisos que necesitas para gestionar políticas de organización personalizadas, pide a tu administrador que te conceda el rol de gestión de identidades y accesos Administrador de políticas de organización (roles/orgpolicy.policyAdmin) en el recurso de la organización. Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

Crear una restricción personalizada

Una restricción personalizada se define en un archivo YAML mediante los recursos, los métodos, las condiciones y las acciones que admite el servicio en el que se aplica la política de la organización. Las condiciones de tus restricciones personalizadas se definen mediante el lenguaje de expresión común (CEL). Para obtener más información sobre cómo crear condiciones en restricciones personalizadas con CEL, consulta la sección sobre CEL del artículo Crear y gestionar restricciones personalizadas.

Para crear una restricción personalizada, crea un archivo YAML con el siguiente formato:

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

Haz los cambios siguientes:

• ORGANIZATION_ID: el ID de tu organización, como 123456789.

• CONSTRAINT_NAME: el nombre que quieras asignar a la nueva restricción personalizada. Una restricción personalizada debe empezar por custom. y solo puede incluir letras mayúsculas, letras minúsculas o números. Por ejemplo, custom.deleteProtectionRequired. La longitud máxima de este campo es de 70 caracteres.

• RESOURCE_NAME: nombre completo del recursoGoogle Cloud que contiene el objeto y el campo que quieres restringir. Por ejemplo, firestore.googleapis.com/Database.

• CONDITION: una condición CEL que se escribe en una representación de un recurso de servicio compatible. Este campo tiene una longitud máxima de 1000 caracteres. Consulta los recursos admitidos para obtener más información sobre los recursos con los que puedes escribir condiciones. Por ejemplo, "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\"".

• ACTION: la acción que se debe llevar a cabo si se cumple la condición condition. Los valores posibles son ALLOW y DENY.

• DISPLAY_NAME: nombre descriptivo de la restricción. Este campo tiene una longitud máxima de 200 caracteres.

• DESCRIPTION: descripción de la restricción que se mostrará como mensaje de error cuando se infrinja la política. Este campo tiene una longitud máxima de 2000 caracteres.

Para obtener más información sobre cómo crear una restricción personalizada, consulta Definir restricciones personalizadas.

Configurar una restricción personalizada

Una vez que hayas creado el archivo YAML de una nueva restricción personalizada, debes configurarla para que esté disponible en las políticas de organización de tu organización. Para configurar una restricción personalizada, usa el comando gcloud org-policies set-custom-constraint:

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

Sustituye CONSTRAINT_PATH por la ruta completa a tu archivo de restricciones personalizadas. Por ejemplo, /home/user/customconstraint.yaml. Una vez completado el proceso, las restricciones personalizadas estarán disponibles como políticas de organización en la lista de Google Cloud políticas de organización. Para verificar que la restricción personalizada existe, usa el comando gcloud org-policies list-custom-constraints:

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

Sustituye ORGANIZATION_ID por el ID del recurso de tu organización. Para obtener más información, consulta Ver políticas de la organización.

Aplicar una política de organización personalizada

Para aplicar una restricción, crea una política de organización que haga referencia a ella y, a continuación, aplica esa política de organización a un Google Cloud recurso.

Consola

1. En la Google Cloud consola, ve a la página Políticas de la organización.

   Ir a Políticas de organización

2. En el selector de proyectos, elige el proyecto para el que quieras definir la política de organización.
3. En la lista de la página Políticas de organización, selecciona la restricción para ver la página Detalles de la política correspondiente.
4. Para configurar la política de la organización de este recurso, haz clic en Gestionar política.
5. En la página Editar política, selecciona Anular política del recurso superior.
6. Haz clic en Añadir regla.
7. En la sección Aplicación, selecciona si quieres activar o desactivar la aplicación de esta política de la organización.
8. Opcional: Para que la política de la organización dependa de una etiqueta, haz clic en Añadir condición. Ten en cuenta que, si añades una regla condicional a una política de organización, debes añadir al menos una regla incondicional o la política no se podrá guardar. Para obtener más información, consulta Configurar una política de organización con etiquetas.
9. Haz clic en Probar cambios para simular el efecto de la política de la organización. La simulación de políticas no está disponible para las restricciones gestionadas antiguas. Para obtener más información, consulta el artículo Probar los cambios en las políticas de la organización con el simulador de políticas.
10. Para finalizar y aplicar la política de organización, haz clic en Definir política. La política tarda hasta 15 minutos en aplicarse.

gcloud

Para crear una política de organización con reglas booleanas, crea un archivo YAML de política que haga referencia a la restricción:

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

Haz los cambios siguientes:

• PROJECT_ID: el proyecto en el que quieras aplicar la restricción.
• CONSTRAINT_NAME: el nombre que has definido para tu restricción personalizada. Por ejemplo, custom.deleteProtectionRequired.

Para aplicar la política de la organización que contiene la restricción, ejecuta el siguiente comando:

    gcloud org-policies set-policy POLICY_PATH
    

Sustituye POLICY_PATH por la ruta completa al archivo YAML de la política de tu organización. La política tarda hasta 15 minutos en aplicarse.

Probar la política de organización personalizada

Antes de empezar, debes saber lo siguiente:

• ID de tu organización

1. Crea el archivo deleteProtectionRequired.yaml de la siguiente manera:

    name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
    resourceTypes:
    - firestore.googleapis.com/Database
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""
    actionType: ALLOW
    displayName: Firestore Delete Protection Required
    description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
   

   De esta forma, todos los métodos CREATE y UPDATE de una base de datos de Firestore cumplen la restricción de que deleteProtectionState sea DELETE_PROTECTION_ENABLED. Por lo tanto, se rechazarán las operaciones de creación, actualización, restauración o clonación de bases de datos que no tengan habilitada explícitamente la protección contra eliminación.

2. Configura la restricción personalizada a nivel de organización:

   gcloud org-policies set-custom-constraint deleteProtectionRequired.yaml
   

Probar la política

Intenta crear una base de datos sin definir la marca --delete-protection en un proyecto de la organización:

gcloud firestore database create \
   --project=PROJECT_ID \
   --database=DATABASE_ID \

El resultado es el siguiente:

Operation denied by custom org policies: ["customConstraints/custom.deleteProtectionRequired": "To ensure the data security, Delete Protection is required to be enabled for Firestore databases"]

Probar y analizar los cambios en las políticas de la organización

Te recomendamos que pruebes y simules todos los cambios en las políticas de tu organización para entender mejor el estado de tu entorno y cómo le afectan los cambios.

El simulador de políticas de la organización te ayuda a entender el efecto de una restricción y una política de la organización en tu entorno actual. Con esta herramienta, puedes revisar todas las configuraciones de recursos para ver dónde se producen infracciones antes de que se apliquen en tu entorno de producción. Para obtener instrucciones detalladas, consulta el artículo Probar los cambios en las políticas de la organización con el simulador de políticas.

Cuando conozcas el efecto actual, podrás crear una política de la organización en modo de prueba para entender el impacto y las posibles infracciones de una política durante los próximos 30 días. Una política de la organización en modo de prueba es un tipo de política de la organización en el que las infracciones de la política se registran en un registro de auditoría, pero no se deniegan las acciones infractoras. Puedes crear una política de organización en modo de prueba desde una restricción personalizada mediante la Google Cloud consola o la CLI de Google Cloud. Para obtener instrucciones detalladas, consulta Crear una política de organización en modo de prueba.

Ejemplos de políticas de organización personalizadas para casos prácticos habituales

En esta tabla se muestran ejemplos de sintaxis de algunas restricciones personalizadas habituales.

Descripción	Sintaxis de las restricciones
Los nombres de las bases de datos deben seguir un patrón determinado. Ten en cuenta que el formato de un nombre de base de datos en las políticas de organización personalizadas es projects/project-id/databases/database-id, mientras que solo se especifica database-id en las operaciones de gestión de bases de datos.	name: organizations/ORGANIZATION_ID/customConstraints/custom.nameSuffixMobile resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE condition: "resource.name.endsWith('-mobile')" actionType: ALLOW displayName: Firestore database names end with "-mobile" description: Only allow the creation of database names ending with suffix "-mobile"
Las bases de datos solo se pueden crear en ubicaciones específicas.	name: organizations/ORGANIZATION_ID/customConstraints/custom.locationUsCentral1 resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE condition: "resource.locationId == 'us-central1'" actionType: ALLOW displayName: Firestore database location id us-central1 description: Only allow the creation of databases in region us-central1
Las bases de datos deben ser del tipo especificado.	name: organizations/ORGANIZATION_ID/customConstraints/custom.typeFirestore resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.type=="FIRESTORE_NATIVE"" actionType: ALLOW displayName: Firestore database type Firestore_Native description: Only allow creation and updating of databases if the type is Firestore in native mode.
Las bases de datos deben usar el modo de simultaneidad especificado.	name: organizations/ORGANIZATION_ID/customConstraints/custom.concurrencyNotPessimistic resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.concurrencyMode == 'PESSIMISTIC'" actionType: DENY displayName: Firestore database concurrencyMode not pessimistic description: Disallow the creation and updating of databases with pessimistic concurrency mode.
Las bases de datos deben habilitar la point-in-time-recovery.	name: organizations/ORGANIZATION_ID/customConstraints/custom.pitrEnforce resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.pointInTimeRecoveryEnablement == "POINT_IN_TIME_RECOVERY_ENABLED"" actionType: ALLOW displayName: Firestore database enables PiTR description: Only allow the creation and updating of a databases if PiTR is enabled.
Las bases de datos deben usar el modo de integración de App Engine especificado.	name: organizations/ORGANIZATION_ID/customConstraints/custom.enableAppEngineIntegrationMode resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.appEngineIntegrationMode == 'ENABLED'" actionType: ALLOW displayName: Firestore Database App Engine integration mode enabled description: Only allow the creation and updating of databases with App Engine Integration Mode enabled.
No permitir la creación de bases de datos a menos que se haya habilitado la protección contra la eliminación.	name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.deleteProtectionState == "DELETE_PROTECTION_ENABLED"" actionType: ALLOW displayName: Firestore Delete Protection Required description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
Las bases de datos deben usar la configuración de CMEK (clave de cifrado gestionada por el cliente) especificada.	name: organizations/ORGANIZATION_ID/customConstraints/custom.cmekKeyNotDev resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.cmekConfig.kmsKeyName.matches('dev$')" actionType: DENY displayName: Firestore database CMEK key not dev description: Disallow the creation and updating of databases with CMEK KMS keys ending with "dev".
Las bases de datos deben usar la edición de base de datos especificada.	name: organizations/ORGANIZATION_ID/customConstraints/custom.standardEditionRequired resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.databaseEdition == "STANDARD"" actionType: ALLOW displayName: Firestore Standard Edition Required description: Only allow the creation and updating of databases with Standard Edition.

Recursos compatibles con Firestore

En la siguiente tabla se enumeran los recursos de Firestore a los que puede hacer referencia en las restricciones personalizadas.

Recurso	Campo
firestore.googleapis.com/Database	resource.appEngineIntegrationMode
	resource.cmekConfig.kmsKeyName
	resource.concurrencyMode
	resource.deleteProtectionState
	resource.locationId
	resource.name
	resource.pointInTimeRecoveryEnablement
	resource.type

Siguientes pasos

• Consulta más información sobre el servicio de políticas de organización.
• Consulta más información sobre cómo crear y gestionar políticas de la organización.
• Consulta la lista completa de restricciones de políticas de la organización gestionadas.