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 :

  • binaryauthorization.googleapis.com/Policy
  • binaryauthorization.googleapis.com/Attestor

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

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

O serviço de políticas da organização do Google Cloud oferece controle centralizado e programático sobre os recursos da sua organização. Um administrador de políticas da organização pode definir políticas da organização, ou seja, conjuntos de restrições que se aplicam aos recursos doGoogle Cloud e aos elementos que descendem dele na hierarquia de recursos doGoogle Cloud . É possível aplicar políticas da organização no nível de projetos, de pastas ou da organização.

Uma política da organização oferece restrições gerenciadas e integradas para vários serviços do Google Cloud . No entanto, para ter controle mais granular e personalizável sobre os campos específicos restritos nas políticas da organização, também é possível criar restrições personalizadas e usá-las nessas políticas.

Herança de políticas

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

Vantagens

Use políticas personalizadas da organização para fazer o seguinte com as políticas de autorização binária:

  • Aplique requisitos de segurança exigindo autorização do usuário para a implantação de imagens do sistema.
  • Verifique se o atestado é obrigatório para todas as implantações de pods na política de autorização binária.
  • Verifique se atestadores específicos estão incluídos na política de autorização binária usada para verificação de atestado.
  • Restrinja as operações permitidas a um padrão de lista de permissões definido na política de autorização binária.

Use políticas personalizadas da organização para fazer o seguinte com atestados de autorização binária:

  • Verifique se os atestadores foram criados com metadados descritivos para definir claramente a finalidade deles.
  • Verifique se a chave criptográfica associada a cada atestador foi gerada usando um algoritmo de assinatura específico e predeterminado.

Antes de começar

  1. Faça login na sua conta do Google Cloud . Se você começou a usar o Google Cloud, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.
  2. 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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

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

  4. Instale a CLI do Google Cloud.

  5. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

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

    gcloud init
  7. 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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

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

  9. Instale a CLI do Google Cloud.

  10. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

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

    gcloud init
  12. Verifique qual é o ID da organização.

Funções exigidas

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

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 atualizar uma política de autorização binária:
    • binaryauthorization.policy.update no recurso do projeto
    • binaryauthorization.policy.get no recurso do projeto
  • Para criar ou atualizar um atestador de autorização binária:
    • binaryauthorization.attestors.get no recurso do projeto
    • binaryauthorization.attestors.list no recurso do projeto
    • binaryauthorization.attestors.create no recurso do projeto
    • binaryauthorization.attestors.update no recurso do projeto

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Configurar 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 saber como criar condições em restrições personalizadas usando a CEL, consulte a seção CEL em Como criar e gerenciar restrições personalizadas.

Console

Para criar uma restrição personalizada, faça o seguinte:

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

    Acessar a página 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. Clique em Restrição personalizada.
  4. Na caixa Nome de exibição, insira um nome legível para a restrição. Esse nome é usado em mensagens de erro e pode ser usado para identificação e depuração. Não use informações de identificação pessoal (PII) ou dados sensíveis em nomes de exibição, porque eles podem ser expostos em mensagens de erro. Esse campo pode ter até 200 caracteres.
  5. Na caixa ID da restrição, insira o ID que você quer para a nova restrição personalizada. Uma restrição personalizada só pode conter letras (maiúsculas e minúsculas) ou números, por exemplo, custom.ensureBinaryAuthorizationEnforcementEnabled. Esse campo pode conter até 70 caracteres, sem contar o prefixo (custom.), por exemplo, organizations/123456789/customConstraints/custom. Não inclua PII ou dados sensíveis no ID da restrição, porque eles podem ser expostos em mensagens de erro.
  6. Na caixa Descrição, insira uma descrição legível da restrição. Essa descrição é usada como uma mensagem de erro quando a política é violada. Inclua detalhes sobre o motivo da violação e como resolver o problema. Não inclua PII ou dados sensíveis na descrição, porque eles podem ser expostos em mensagens de erro. Esse campo pode conter até 2.000 caracteres.
  7. Na caixa Tipo de recurso, selecione o nome do recurso REST do Google Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, container.googleapis.com/NodePool. A maioria dos tipos de recursos aceita até 20 restrições personalizadas. Se você tentar criar mais restrições personalizadas, a operação vai falhar.
  8. Em Método de aplicação, selecione se quer aplicar a restrição em um método REST CREATE ou em ambos os métodos CREATE e UPDATE. Se você aplicar a restrição com o método UPDATE em um recurso que a viola, as mudanças nesse recurso serão bloqueadas pela política da organização, a menos que a mudança resolva a violação.
  9. Para ver os métodos compatíveis para cada serviço, encontre o serviço em Serviços que aceitam restrições personalizadas.

  10. Para definir uma condição, clique em Editar condição.
    1. No painel Adicionar condição, crie uma condição de CEL que se refira a um recurso de serviço compatível, por exemplo, resource.management.autoUpgrade == false. Esse campo pode conter até 1.000 caracteres. Para detalhes sobre o uso da CEL, consulte Common Expression Language. Para mais informações sobre os recursos de serviço que você pode usar nas restrições personalizadas, consulte Serviços compatíveis com restrição personalizada.
    2. Clique em Salvar.
  11. Em Ação, selecione se você quer permitir ou negar o método avaliado quando a condição é atendida.
  12. A ação de negação significa que a operação para criar ou atualizar o recurso será bloqueada se a condição for avaliada como verdadeira.

    A ação de permissão significa que a operação para criar ou atualizar o recurso só é permitida se a condição for avaliada como verdadeira. Todos os outros casos, exceto os listados explicitamente na condição, estão bloqueados.

  13. Clique em Criar restrição.
  14. Quando você digita um valor em cada campo, a configuração YAML equivalente à restrição personalizada aparece à direita.

gcloud

  1. Para criar uma restrição personalizada, crie um arquivo YAML com o seguinte formato:
  2. 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 só pode conter letras (maiúsculas e minúsculas) ou números, por exemplo, custom.ensureBinaryAuthorizationEnforcementEnabled. Esse campo pode conter até 70 caracteres, sem contar o prefixo (custom.), por exemplo, organizations/123456789/customConstraints/custom. Não inclua PII ou dados sensíveis no ID da restrição, porque eles podem ser expostos em mensagens de erro.
    • RESOURCE_NAME: o nome totalmente qualificado do recurso Google Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, binaryauthorization.googleapis.com/Policy. A maioria dos tipos de recursos aceita até 20 restrições personalizadas. Se você tentar criar mais restrições personalizadas, a operação vai falhar.
    • methodTypes: os métodos REST em que a restrição é aplicada. Pode ser CREATE ou CREATE e UPDATE. Se você aplicar a restrição com o método UPDATE em um recurso que a viole, as mudanças nesse recurso serão bloqueadas pela política da organização, a menos que a mudança resolva a violação.
    • Para ver os métodos compatíveis com cada serviço, encontre o serviço em Serviços que aceitam restrições personalizadas.

    • CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo pode conter até 1.000 caracteres. Por exemplo, "resource.defaultAdmissionRule.enforcementMode == 'ENFORCED_BLOCK_AND_AUDIT_LOG'".
    • Para mais informações sobre os recursos disponíveis para gravação de condições, consulte Recursos compatíveis.

    • ACTION: a ação a ser realizada se o condition for atendido. Os valores possíveis são ALLOW e DENY.
    • A ação "permitir" significa que, se a condição for avaliada como verdadeira, a operação para criar ou atualizar o recurso será permitida. Isso também significa que todos os outros casos, exceto o listado explicitamente na condição, estão bloqueados.

      A ação de negação significa que, se a condição for avaliada como verdadeira, a operação para criar ou atualizar o recurso será bloqueada.

    • DISPLAY_NAME: um nome legível para a restrição. Esse nome é usado em mensagens de erro e pode ser usado para identificação e depuração. Não use PII ou dados sensíveis em nomes de exibição, porque eles podem ser expostos em mensagens de erro. Esse campo pode ter até 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 pode conter até 2.000 caracteres.
  3. Depois de criar o arquivo YAML para uma nova restrição personalizada, faça a configuração necessária 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:
  4. gcloud org-policies set-custom-constraint CONSTRAINT_PATH

    Substitua CONSTRAINT_PATH pelo caminho completo do arquivo de restrição personalizada. Por exemplo, /home/user/customconstraint.yaml.

    Após a conclusão, as restrições personalizadas vão estar disponíveis como políticas da organização na lista de políticas da organização do Google Cloud .

  5. Para verificar se a restrição personalizada existe, use o comando gcloud org-policies list-custom-constraints:
  6. 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 políticas da organização.

Aplicar uma política personalizada da organização

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

Console

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

    Acessar a página 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 uma restrição para acessar a página Detalhes da política associada.
  4. Para configurar 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 recurso pai.
  6. Clique em Adicionar uma regra.
  7. Na seção Aplicação, selecione se essa política da organização é aplicada ou não.
  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 para que a política seja salva. Para mais informações, consulte Definir o escopo das políticas da organização com tags.
  9. Clique em Testar mudanças para simular o efeito da política da organização. Para mais informações, consulte Testar mudanças na política da organização com o Simulador de política.
  10. Para aplicar a política da organização no modo de teste, clique em Definir política de simulação. Para mais informações, consulte Testar políticas da organização.
  11. Depois de verificar se a política da organização no modo de simulação funciona como esperado, clique em Definir política para definir a política ativa.

gcloud

  1. Para criar uma política da organização com regras booleanas, crie um arquivo YAML para a política que faça referência à restrição:
  2. name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
    spec:
      rules:
      - enforce: true
    
    dryRunSpec:
      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.ensureBinaryAuthorizationEnforcementEnabled.
  3. Para aplicar a política da organização no modo de teste, execute o seguinte comando com a flag dryRunSpec:
  4. gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec

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

  5. Depois de verificar se a política da organização no modo de simulação funciona conforme o esperado, defina a política ativa com o comando org-policies set-policy e a flag spec:
  6. gcloud org-policies set-policy POLICY_PATH --update-mask=spec

    Substitua POLICY_PATH pelo caminho completo para o 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 criar uma restrição e uma política personalizadas que garantem a aplicação da política de autorização binária em um projeto, impedindo implantações quando as declarações estão ausentes.

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

Criar a restrição

  1. Salve o seguinte arquivo como constraint.yaml:

    name: organizations/ORGANIZATION_ID/customConstraints/custom.ensureBinaryAuthorizationEnforcementEnabled
    resourceTypes:
    - binaryauthorization.googleapis.com/Policy
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.defaultAdmissionRule.enforcementMode == 'ENFORCED_BLOCK_AND_AUDIT_LOG'"
    actionType: ALLOW
    displayName: Ensure Binary Authorization Enforcement is enabled
    description: Binary Authorization policy must have enforcement enabled to block deployments if one or more required attestations are missing.
    

    Essa restrição impede atualizações da política de autorização binária, a menos que o defaultAdmissionRule.enforcementMode esteja definido como ENFORCED_BLOCK_AND_AUDIT_LOG.

  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 será o seguinte:

    CUSTOM_CONSTRAINT: custom.ensureBinaryAuthorizationEnforcementEnabled
    ACTION_TYPE: DENY
    METHOD_TYPES: CREATE,UPDATE
    RESOURCE_TYPES: binaryauthorization.googleapis.com/Policy
    DISPLAY_NAME: Ensure Binary Authorization Enforcement is enabled
    

Criar a política

  1. Salve o seguinte arquivo como policy.yaml:

    name: projects/PROJECT_ID/policies/custom.ensureBinaryAuthorizationEnforcementEnabled
    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 será o seguinte:

    CONSTRAINT: custom.ensureBinaryAuthorizationEnforcementEnabled
    LIST_POLICY: -
    BOOLEAN_POLICY: SET
    ETAG: CJSetr4GEPil1JAB-
    

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

cat > binauthzPolicy.yaml << EOM
globalPolicyEvaluationMode: DISABLE
defaultAdmissionRule:
  evaluationMode: ALWAYS_DENY
  enforcementMode: DRYRUN_AUDIT_LOG_ONLY
EOM
gcloud container binauthz policy import binauthzPolicy.yaml '--format=json'

A saída é esta:

Operation denied by org policy: ["customConstraints/custom.ensureBinaryAuthorizationEnforcementEnabled": "Pod deployment should be blocked when admission rule are not satisfied."].

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

Confira na tabela a sintaxe de algumas restrições personalizadas comuns.

Descrição Sintaxe da restrição
Verificar se os atestados estão presentes na política de autorização binária
  name: organizations/ORGANIZATION_ID/customConstraints/custom.podCreationRequireAttestations
  resourceTypes:
  - binaryauthorization.googleapis.com/Policy
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.defaultAdmissionRule.evaluationMode == 'REQUIRE_ATTESTATION'"
  actionType: ALLOW
  displayName: Attestations are required in Binary Authorization Policy
  description: Binary Authorization Policy evaluation requires attestations.
  
Garantir que um atestador específico esteja presente para a regra de admissão
  name: organizations/ORGANIZATION_ID/customConstraints/custom.policyWithParticularAttestor
  resourceTypes:
  - binaryauthorization.googleapis.com/Policy
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.defaultAdmissionRule.requireAttestationsBy.size() > 0 && resource.defaultAdmissionRule.requireAttestationsBy.exists(value, value.matches(r'^projects/[^/]+/attestors/qa-attestor$'))"
  actionType: ALLOW
  displayName: Ensure Binary Authorization policy contains qa-attestor.
  description: Ensure Binary Authorization policy contains qa-attestor.
  
Não permitir a criação de atestador se a descrição estiver ausente
    name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceAttestorDescription
    resourceTypes:
    - binaryauthorization.googleapis.com/Attestor
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.description == ''"
    actionType: DENY
    displayName: Deny Attestor creation that have no description.
    description: Binary Authorization Attestor should have description associated with it.
    
Permitir apenas um algoritmo de assinatura específico para uma chave
    name: organizations/ORGANIZATION_ID/customConstraints/custom.allowParticularKeySignatureAlgorithm
    resourceTypes:
    - binaryauthorization.googleapis.com/Attestor
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.userOwnedGrafeasNote.publicKeys.all(publicKey, publicKey.pkixPublicKey.signatureAlgorithm == 'ECDSA_P256_SHA256')"
    actionType: ALLOW
    displayName: Allow particular signature algorithm
    description: Only particular signature Algorithm is allowed.
    

Recursos compatíveis com a autorização binária

A tabela a seguir lista os recursos da Autorização binária que podem ser referenciados em restrições personalizadas.

Recurso Campo
binaryauthorization.googleapis.com/Attestor resource.description
resource.name
resource.userOwnedGrafeasNote.noteReference
resource.userOwnedGrafeasNote.publicKeys.asciiArmoredPgpPublicKey
resource.userOwnedGrafeasNote.publicKeys.comment
resource.userOwnedGrafeasNote.publicKeys.pkixPublicKey.keyId
resource.userOwnedGrafeasNote.publicKeys.pkixPublicKey.publicKeyPem
resource.userOwnedGrafeasNote.publicKeys.pkixPublicKey.signatureAlgorithm
binaryauthorization.googleapis.com/Policy resource.admissionWhitelistPatterns.namePattern
resource.clusterAdmissionRules[*].enforcementMode
resource.clusterAdmissionRules[*].evaluationMode
resource.clusterAdmissionRules[*].requireAttestationsBy
resource.defaultAdmissionRule.enforcementMode
resource.defaultAdmissionRule.evaluationMode
resource.defaultAdmissionRule.requireAttestationsBy
resource.description
resource.globalPolicyEvaluationMode
resource.istioServiceIdentityAdmissionRules[*].enforcementMode
resource.istioServiceIdentityAdmissionRules[*].evaluationMode
resource.istioServiceIdentityAdmissionRules[*].requireAttestationsBy
resource.kubernetesNamespaceAdmissionRules[*].enforcementMode
resource.kubernetesNamespaceAdmissionRules[*].evaluationMode
resource.kubernetesNamespaceAdmissionRules[*].requireAttestationsBy
resource.kubernetesServiceAccountAdmissionRules[*].enforcementMode
resource.kubernetesServiceAccountAdmissionRules[*].evaluationMode
resource.kubernetesServiceAccountAdmissionRules[*].requireAttestationsBy

A seguir