Esta página foi traduzida pela API Cloud Translation.

Usar políticas personalizadas da organização

Nesta página, mostramos como usar restrições personalizadas do serviço de políticas da organização para restringir operações específicas nos seguintes recursos do Google Cloud :

secretmanager.googleapis.com/Secret

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

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

O Google Cloud Organization Policy Service oferece controle centralizado e programático sobre os recursos da sua organização. Como administrador de políticas da organização, é possível definir uma política da organização, que é um conjunto de limites chamado restrições que se aplicam aosGoogle Cloud recursos e aos descendentes deles na hierarquia de recursos doGoogle Cloud . É possível aplicar políticas da organização no nível da organização, da pasta ou para envolvidos no projeto.

A política da organização oferece restrições gerenciadas integradas 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 vai 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.

Vantagens

Use políticas da organização personalizadas para fazer o seguinte:

Aplique requisitos de segurança rigorosos exigindo que os usuários adicionem anotações a chaves secretas, definam datas de expiração para elas ou configurem a destruição atrasada de versões de chaves secretas.
Ofereça suporte a requisitos de rotação específicos exigindo que todos os secrets em projetos ou pastas específicos configurem programações de rotação.
Verifique se as anotações e os aliases de versão correspondem às expressões selecionadas em scripts automatizados.
Controle os custos da nuvem restringindo os tipos de secrets permitidos na sua organização.

Limitações

É possível definir a validade de um secret usando expire_time (um momento específico) ou ttl (uma duração). Em políticas personalizadas da organização, só é possível usar expire_time para determinar quando o secret expira. Se você definir um ttl para um secret, o Secret Manager vai convertê-lo em um valor expire_time para processar e avaliar a política.

Antes de começar

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

Certifique-se de conhecer o ID da organização.

Funções exigidas

Para conseguir as permissões necessárias para gerenciar políticas da organização, peça ao administrador para conceder a você os seguintes papéis do IAM:

Administrador de políticas da organização (roles/orgpolicy.policyAdmin) no recurso da organização
Para criar ou atualizar um secret: Administrador do Secret Manager (roles/secretmanager.admin) no projeto

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para gerenciar políticas da organizações. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As permissões a seguir são necessárias para gerenciar as políticas da organização:

orgpolicy.* no recurso da organização
Para criar ou atualizar um secret do Secret Manager:
- secretmanager.secrets.create no recurso do projeto
- secretmanager.secrets.get no recurso do projeto
- secretmanager.secrets.list no recurso do projeto
- secretmanager.secrets.update no recurso do projeto

Essas permissões também podem ser concedidas com funções personalizadas ou 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á aplicando 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.ensureVersionDestroyTTL. O comprimento máximo desse campo é de 70 caracteres.
RESOURCE_NAME: o nome totalmente qualificado do recursoGoogle Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, secretmanager.googleapis.com/Secret.
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.versionDestroyTtl < duration('30h')".
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

gcloud org-policies set-custom-constraint

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

CONSTRAINT_PATH

/home/user/customconstraint.yaml

gcloud org-policies list-custom-constraints

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

ORGANIZATION_ID

Como visualizar as políticas da organização

Aplicar uma política da organização personalizada

Console

No console Google Cloud , acesse a página Políticas da organização.
Acessar as políticas da organização
No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
Na lista da página Políticas da organização, selecione a restrição para acessar a página Detalhes da política dela.
Para personalizar a política da organização nesse recurso, clique em Gerenciar política.
Na página Editar política, selecione Substituir a política do editor principal.
Clique em Adicionar uma regra.
Na seção Aplicação, selecione se a aplicação dessa política da organização está ativada ou desativada.
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 configurar uma política da organização com tags.
Clique em Testar mudanças para simular o efeito da política da organização. A simulação de política não está disponível para restrições gerenciadas legadas. Para mais informações, consulte Testar mudanças na política da organização com o Simulador de política.
Para concluir e aplicar a política da organização, clique em Definir política. A política levará até 15 minutos para entrar em vigor.

gcloud

Para criar uma política da organização com regras booleanas, crie um arquivo YAML da política que faça 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.ensureVersionDestroyTTL.

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.

Testar a política personalizada da organização

O exemplo a seguir mostra como configurar uma restrição e uma política personalizadas para garantir que todos os novos secrets criados em um determinado projeto tenham um período de atraso na destruição (version_destroy_ttl) de pelo menos 30 horas.

Antes de começar, verifique se você atendeu aos seguintes pré-requisitos:

Ative a API Secret Manager, uma vez por projeto.
Saiba o ID da sua organização.
Saiba o ID do projeto.

Crie a restrição.

Salve o seguinte arquivo como 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

Isso define uma restrição em que, para cada novo secret, se a versão version_destroy_ttl não for aplicada ou se o version_destroy_ttl for menor que 30 horas, a operação será negada.

Aplique a restrição:

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

Verifique se a restrição existe:

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

O resultado será assim:

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

Crie a política

Salve o seguinte arquivo como policy.yaml:

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

Substitua PROJECT_ID pela ID do seu projeto.

Aplique a política:

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

Verifique se a política existe:

gcloud org-policies list --project=PROJECT_ID

O resultado será assim:

CONSTRAINT                                    LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.ensureVersionDestroyTTLAtLeast30hours  -              SET               COCsm5QGENiXi2E=

Depois de aplicar a política, aguarde cerca de dois minutos para que o Google Cloud comece a aplicar a política.

Testar a política

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

A saída é esta:

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

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

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

Descrição	Sintaxe de restrição
É necessário definir o TTL de destruição da versão em mais de dois dias	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
Definir tópico do 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.
Negar anotações com prefixo	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-'.

Descrição

Sintaxe de restrição

É necessário definir o TTL de destruição da versão em mais de dois dias

  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

Definir tópico do 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.

Negar anotações com prefixo

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

Recursos compatíveis com o Secret Manager

A tabela nesta seção lista os recursos do Secret Manager que podem ser referenciados em restrições personalizadas.

Para definir restrições de locais de recursos, use as políticas da organização de locais de recursos. Da mesma forma, para definir restrições ao uso da CMEK, recomendamos que você use as políticas da organização de CMEK.

Recurso	Campo
secretmanager.googleapis.com/Secret	`resource.annotations`
	`resource.expireTime`
	`resource.rotation.nextRotationTime`
	`resource.rotation.rotationPeriod`
	`resource.topics.name`
	`resource.versionAliases`
	`resource.versionDestroyTtl`

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

Usar políticas personalizadas da organização Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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

Herança de políticas

Vantagens

Limitações

Antes de começar

Funções exigidas

Permissões necessárias

Criar uma restrição personalizada

Configurar uma restrição personalizada

Aplicar uma política da organização personalizada

Console

gcloud

Testar a política personalizada da organização

Crie a restrição.

Crie a política

Testar a política

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

Recursos compatíveis com o Secret Manager

A seguir

Usar políticas personalizadas da organização