Criar restrições de política da organização personalizadas para o Cloud KMS

Esta página mostra como usar restrições personalizadas do Organization Policy Service para restringir operações específicas nos seguintes recursos do Google Cloud:

• 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

Para saber mais sobre políticas da organização, consulte Políticas personalizadas da organização.

Sobre políticas e restrições da organização

O Organization Policy Service do Google Cloud oferece controle centralizado e programático sobre os recursos da sua organização. Conforme o administrador de política da organização, defina um nome de política, que é um conjunto de restrições chamadas restrições que se aplicam a os recursos do Google Cloud e os descendentes deles na Hierarquia de recursos do Google Cloud. É possível aplicar restrições de no nível da organização, da pasta ou do projeto.

A política da organização estabelece restrições predefinidas para vários serviços do Google Cloud. No entanto, se você quiser um controle mais granular e personalizável sobre os campos específicos restritos nas suas políticas da organização, crie também restrições personalizadas e use-as em uma política da organização.

Herança de políticas

Por padrão, as políticas da organização são herdadas pelos descendentes dos recursos em que a política é aplicada. Por exemplo, se você aplicar uma política em uma pasta, o Google Cloud aplicará a política a todos os projetos da pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação de hierarquia.

Antes de começar

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.

   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

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.

   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

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. Certifique-se de conhecer o ID da organização.

Funções exigidas

Para ter as permissões necessárias para gerenciar as políticas da organização, peça ao administrador para conceder a você Papel do IAM Administrador de políticas da organização (roles/orgpolicy.policyAdmin) ativado o recurso da organização do Google. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.

Criar uma restrição personalizada

Uma restrição personalizada é definida em um arquivo YAML pelos recursos, métodos condições e ações compatíveis com o serviço em que você está e aplicar a política da organização. As condições das restrições personalizadas são definidas usando a Common Expression Language (CEL). Para mais informações sobre como criar condições em restrições personalizadas usando a CEL, consulte a seção CEL de Como criar e gerenciar restrições personalizadas.

Para criar uma restrição personalizada, crie um arquivo YAML usando o seguinte formato:

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

Substitua:

• ORGANIZATION_ID: o ID da organização, como 123456789.

• CONSTRAINT_NAME: o nome da sua nova restrição personalizada. Uma restrição personalizada precisa começar com custom. e só pode incluir letras maiúsculas, minúsculas ou números, por exemplo, custom.maxKeyRotationPeriod. O comprimento máximo desse campo é de 70 caracteres.

• RESOURCE_NAME: o nome totalmente qualificado do recurso do Google Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, cloudkms.googleapis.com/CryptoKey.

• CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo tem um comprimento máximo de 1000 caracteres. Consulte Recursos compatíveis para mais informações sobre os recursos disponíveis para gravar condições. Por exemplo, "resource.rotationPeriod <= 90".

• ACTION: a ação a ser realizada se o condition for atendido. Os valores possíveis são ALLOW e DENY.

• DISPLAY_NAME: um nome legível para a restrição. Esse campo tem um comprimento máximo de 200 caracteres.

• DESCRIPTION: uma descrição legível da restrição a ser exibida como uma mensagem de erro quando a política for violada. Esse campo tem um comprimento máximo de 2000 caracteres.

Para mais informações sobre como criar uma restrição personalizada, consulte Como definir restrições personalizadas.

Configurar uma restrição personalizada

Depois de criar o arquivo YAML para uma nova restrição personalizada, configure-a para disponibilizá-la para as políticas da organização. Para configurar uma restrição personalizada, use o comando gcloud org-policies set-custom-constraint:

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

Substitua CONSTRAINT_PATH pelo caminho completo do arquivo da restrição personalizada. Por exemplo, /home/user/customconstraint.yaml. Depois de concluídas, as restrições personalizadas ficam disponíveis como políticas da organização na lista de políticas da organização do Google Cloud. Para verificar se a restrição personalizada existe, use o comando gcloud org-policies list-custom-constraints:

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

Substitua ORGANIZATION_ID pelo ID do recurso da organização. Para mais informações, consulte Como visualizar as políticas da organização.

Aplicar uma política da organização personalizada

Para aplicar uma restrição booleana, crie uma política da organização com referência a ela e aplique essa política da organização a um recurso do Google Cloud.

Console

1. No console do Google Cloud, acesse a página Políticas da organização.

   Acessar as políticas da organização

2. No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
3. Na lista da página Políticas da organização, selecione a restrição para acessar a página Detalhes da política dela.
4. Para personalizar a política da organização nesse recurso, clique em Gerenciar política.
5. Na página Editar política, selecione Substituir a política do editor principal.
6. Clique em Adicionar uma regra.
7. Na seção Aplicação, selecione se a aplicação da política da organização está ativado ou desativado.
8. Opcional: para tornar a política da organização condicional em uma tag, clique em Adicionar condição. Se você adicionar uma regra condicional a uma política da organização, inclua pelo menos uma regra não condicional. Caso contrário, não será possível salvar a política. Para mais informações, consulte Como definir uma política da organização com tags.
9. Se essa for uma restrição personalizada, clique em Testar alterações para simular o efeito da política da organização. Para mais informações, consulte Testar alterações na política da organização com o Simulador de política.
10. Para concluir e aplicar a política da organização, clique em Definir política. A política leva até 15 minutos para entrar em vigor.

gcloud

Para criar uma política da organização que aplica uma restrição booleana, crie um arquivo YAML da política com referência à restrição:

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

Substitua:

• PROJECT_ID: o projeto em que você quer aplicar a restrição.
• CONSTRAINT_NAME: o nome definido para a restrição personalizada. Por exemplo, custom.maxKeyRotationPeriod.

Para aplicar a política da organização que contém a restrição, execute o seguinte comando:

    gcloud org-policies set-policy POLICY_PATH
    

Substitua POLICY_PATH pelo caminho completo do arquivo YAML da política da organização. A política leva até 15 minutos para entrar em vigor.

Exemplo de políticas da organização personalizadas para casos de uso comuns

A tabela a seguir fornece a sintaxe de algumas restrições personalizadas para casos de uso comuns:

Descrição	Sintaxe de restrição
Defina um período máximo de rotação de 90 dias	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.
Defina uma duração máxima de programado para destruição de 180 dias	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.
Exigir o nível de proteção HSM para chaves importadas	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.

Recursos e operações compatíveis com o Cloud Key Management Service

A tabela a seguir lista os recursos do Cloud Key Management Service que podem ser referenciados em restrições personalizadas.

Recurso	Campo
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

A seguir

• Saiba mais sobre o Serviço de política da organização.
• Saiba mais sobre como criar e gerenciar políticas da organização.
• Confira a lista completa de restrições da política da organização predefinidas.