Use políticas da organização personalizadas

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

  • secretmanager.googleapis.com/Secret

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

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

O Google Cloud serviço de políticas da organização dá-lhe um controlo centralizado e programático sobre os recursos da sua organização. Enquanto administrador de políticas da organização, pode definir uma política da organização, que é um conjunto de restrições denominadas restrições que se aplicam aGoogle Cloud recursos e descendentes desses recursos na Google Cloud hierarquia de recursos. Pode aplicar políticas de organização ao nível da organização, da pasta ou do projeto.

A política da organização oferece restrições geridas incorporadas para vários Google Cloud serviços. No entanto, se quiser um controlo mais detalhado e personalizável sobre os campos específicos que estão restritos nas políticas da sua organização, também pode criar restrições personalizadas e usar essas restrições personalizadas numa política da organização.

Herança de políticas

Por predefinição, as políticas da organização são herdadas pelos descendentes dos recursos nos quais aplica a política. Por exemplo, se aplicar uma política a uma pasta, Google Cloud aplica a política a todos os projetos na pasta. Para saber mais acerca deste comportamento e como o alterar, consulte as regras de avaliação da hierarquia.

Vantagens

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

  • Aplique requisitos de segurança rigorosos exigindo que os utilizadores adicionem anotações aos segredos, definam datas de validade para os segredos ou configurem a destruição atrasada de versões secretas.
  • Suporte requisitos de rotação específicos exigindo que todos os segredos em projetos ou pastas específicos configurem programações de rotação.
  • Verifique se as anotações e os alias de versão correspondem às expressões selecionadas nos scripts automatizados.
  • Controle os custos da nuvem restringindo os tipos de segredos permitidos na sua organização.

Limitações

  • Pode definir a validade de um segredo através de expire_time (um ponto específico no tempo) ou ttl (uma duração). Nas políticas de organização personalizadas, só pode usar expire_time para determinar quando o segredo expira. Se definir um ttl para um segredo, o Secret Manager converte-o num valor expire_time para processamento e avaliação da política.

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.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. Se estiver a usar um fornecedor de identidade (IdP) externo, primeiro, tem de iniciar sessão na CLI gcloud com a sua identidade federada.

  6. Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init

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

    Go to project selector

  8. Verify that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. Se estiver a usar um fornecedor de identidade (IdP) externo, primeiro, tem de iniciar sessão na CLI gcloud com a sua identidade federada.

  11. Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init
  12. Certifique-se de que sabe o seu ID da organização.

    13. Funções necessárias

    Para receber as autorizações de que precisa para gerir políticas de organização, peça ao seu administrador que lhe conceda as seguintes funções do IAM:

    Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

    Estas funções predefinidas contêm as autorizações necessárias para gerir as políticas da organização. Para ver as autorizações exatas que são necessárias, expanda a secção Autorizações necessárias:

    Autorizações necessárias

    São necessárias as seguintes autorizações para gerir políticas da organização:

    • orgpolicy.* no recurso da organização
    • Para criar ou atualizar um segredo 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

    Também pode conseguir estas autorizações com funções personalizadas ou outras funções predefinidas.

    Crie uma restrição personalizada

    Uma restrição personalizada é definida num ficheiro YAML pelos recursos, métodos, condições e ações suportados pelo serviço no qual está a aplicar a política da organização. As condições para as restrições personalizadas são definidas através do Idioma de expressão comum (IEC). Para mais informações sobre como criar condições em restrições personalizadas através da CEL, consulte a secção CEL do artigo Criar e gerir restrições personalizadas.

    Para criar uma restrição personalizada, crie um ficheiro YAML com 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 o seguinte:

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

    • CONSTRAINT_NAME: o nome que quer para a nova restrição personalizada. Uma restrição personalizada tem de começar por custom. e só pode incluir letras maiúsculas, letras minúsculas ou números. Por exemplo, custom.ensureVersionDestroyTTL. O comprimento máximo deste campo é de 70 carateres.

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

    • CONDITION: uma condição CEL escrita em função de uma representação de um recurso de serviço suportado. Este campo tem um comprimento máximo de 1000 carateres. Consulte o artigo Recursos suportados para mais informações sobre os recursos disponíveis para escrever condições. Por exemplo, "resource.versionDestroyTtl < duration('30h')".

    • ACTION: a ação a tomar se a condição condition for cumprida. Os valores possíveis são ALLOW e DENY.

    • DISPLAY_NAME: um nome simples para a restrição. Este campo tem um comprimento máximo de 200 carateres.

    • DESCRIPTION: uma descrição acessível da restrição a apresentar como uma mensagem de erro quando a política é violada. Este campo tem um comprimento máximo de 2000 carateres.

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

    Configure uma restrição personalizada

    Depois de criar o ficheiro YAML para uma nova restrição personalizada, tem de o configurar para o disponibilizar para as políticas da organização na sua 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 para o seu ficheiro de restrições personalizado. Por exemplo, /home/user/customconstraint.yaml. Após a conclusão, as restrições personalizadas ficam disponíveis como políticas da organização na sua lista de Google Cloud políticas da organização. 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 sua organização. Para mais informações, consulte o artigo Ver políticas da organização.

    Aplique uma política da organização personalizada

    Pode aplicar uma restrição criando uma política da organização que a referencie e, em seguida, aplicando essa política da organização a um Google Cloud recurso.

    Consola

    1. Na Google Cloud consola, aceda à página Políticas da organização.

      Aceda às políticas da organização

    2. No seletor de projetos, selecione o projeto para o qual quer definir a política de organização.
    3. Na lista da página Políticas da organização, selecione a restrição para ver a página Detalhes da política dessa restrição.
    4. Para configurar a política da organização para este recurso, clique em Gerir política.
    5. Na página Editar política, selecione Substituir política do elemento principal.
    6. Clique em Adicionar regra.
    7. Na secção Aplicação, selecione se a aplicação desta política organizacional está ativada ou desativada.
    8. Opcional: para tornar a política de organização condicional a uma etiqueta, clique em Adicionar condição. Tenha em atenção que, se adicionar uma regra condicional a uma política da organização, tem de adicionar, pelo menos, uma regra incondicional. Caso contrário, não é possível guardar a política. Para mais informações, consulte o artigo Definir uma política de organização com etiquetas.
    9. Clique em Testar alterações para simular o efeito da política da organização. A simulação de políticas não está disponível para restrições geridas antigas. Para mais informações, consulte o artigo Teste as alterações da política da organização com o simulador de políticas.
    10. Para concluir e aplicar a política da organização, clique em Definir política. A política demora até 15 minutos a entrar em vigor.

    gcloud

    Para criar uma política da organização com regras booleanas, crie um ficheiro YAML de política que faça referência à restrição: 

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

    Substitua o seguinte:

    • PROJECT_ID: o projeto no qual quer aplicar a restrição.
    • CONSTRAINT_NAME: o nome que definiu 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 para o ficheiro YAML da política da organização. A política demora até 15 minutos a entrar em vigor.

    Teste a política da organização personalizada

    O exemplo seguinte mostra como configurar uma restrição e uma política personalizadas para garantir que todos os novos segredos criados num determinado projeto têm uma duração do atraso de destruição (version_destroy_ttl) de, pelo menos, 30 horas.

    Antes de começar, certifique-se do seguinte:

    Crie a restrição

    1. Guarde o seguinte ficheiro 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

      Isto define uma restrição em que, para cada novo segredo, se a versão do segredo version_destroy_ttl não for aplicada ou o version_destroy_ttl for inferior a 30 horas, a operação é recusada.

    2. Aplique a restrição:

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

    3. Verifique se a restrição existe:

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

      O resultado é semelhante ao seguinte:

      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

    1. Guarde o seguinte ficheiro como policy.yaml:

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

      Substitua PROJECT_ID pelo ID do seu projeto.

    2. Aplique a política:

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

    3. Verifique se a política existe:

      gcloud org-policies list --project=PROJECT_ID

      O resultado é semelhante ao seguinte:

      CONSTRAINT                                    LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.ensureVersionDestroyTTLAtLeast30hours  -              SET               COCsm5QGENiXi2E=

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

    Teste a política

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

    O resultado é o seguinte:

    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 da organização personalizadas para exemplos de utilização comuns

    A tabela seguinte apresenta a sintaxe de algumas restrições personalizadas para exemplos de utilização comuns:

    Descrição Sintaxe de restrição
    Tem de definir o TTL de destruição da versão para 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
    Defina o 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.
    Recuse 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 suportados do Secret Manager

    A tabela nesta secção apresenta os recursos do Secret Manager que pode referenciar em restrições personalizadas.

    Para definir restrições de localizações de recursos, use políticas da organização de localizações de recursos. Da mesma forma, para definir restrições em torno da utilização das CMEK, recomendamos que use as políticas organizacionais das CMEK.

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

    O que se segue?