Usar políticas personalizadas da organização para a federação de identidade da carga de trabalho

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 :

  • iam.googleapis.com/WorkloadIdentityPool
  • iam.googleapis.com/WorkloadIdentityPoolProvider
  • iam.googleapis.com/WorkloadIdentityPoolProviderKey

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.

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.

    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.

    Go to project selector

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

  4. Install the Google Cloud CLI.

  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 (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. Install the Google Cloud CLI.

  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.

    13. Funções exigidas

    Para receber 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:

    • Para gerenciar políticas da organização: Administrador de políticas da organização(roles/orgpolicy.policyAdmin) no recurso da organização
    • Para criar ou atualizar uma configuração da federação de identidade da carga de trabalho: Administrador de pool de Identidade da carga de trabalho (roles/iam.workloadIdentityPoolAdmin) no recurso do projeto

    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 usando papéis personalizados 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 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.

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

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

    • CONSTRAINT_NAME: o nome da 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.enableSamlWorkloadIdProviders. Esse campo pode ter no máximo 70 caracteres.

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

    • CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo pode ter no máximo 1000 caracteres. Consulte Recursos compatíveis para mais informações sobre os recursos disponíveis para gravação de condições. Por exemplo, "!has(resource.saml)".

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

    • DISPLAY_NAME: um nome legível para a restrição. Esse campo pode ter no máximo 200 caracteres.

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

    Para saber 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, 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: 
    gcloud org-policies set-custom-constraint CONSTRAINT_PATH
     Substitua CONSTRAINT_PATH pelo caminho completo para o arquivo da 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 . Para verificar a existência da restrição personalizada, 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 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 regra.
    7. Na seção Aplicação, escolha entre ativar ou desativar a aplicação dessa política da organizaçã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 Como configurar uma política da organização com tags.
    9. Clique em Testar mudanças para simular o efeito da política da organização. A simulação da 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.
    10. 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 para a 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.enableSamlWorkloadIdProviders.

    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 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 cria uma restrição e política personalizada que exige que todos os novos provedores de pool de identidade da carga de trabalho em um projeto específico sejam provedores SAML.

    Antes de começar, você precisa saber o seguinte:

    • O ID da sua organização.
    • Um ID de projeto

    Criar a restrição

    1. Salve o seguinte arquivo como constraint-enable-saml-idps.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.enableSamlWorkloadIdProviders
resourceTypes:
- iam.googleapis.com/WorkloadIdentityPoolProvider
methodTypes:
- CREATE
condition: "!has(resource.saml)"
actionType: DENY
displayName: Enable SAML workload identity pool providers
description: All new workload identity pool providers must be SAML providers.

      Isso define uma restrição em que, para cada novo provedor de pool de identidades da carga de trabalho, se o tipo não for SAML, a operação será negada.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint constraint-enable-saml-idps.yaml

    3. Verifique se a restrição existe:

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

      O resultado será o seguinte:

      CUSTOM_CONSTRAINT                      ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES         DISPLAY_NAME
custom.enableSamlWorkloadIdProviders   DENY         CREATE         iam.googleapis.com/WorkloadIdentityPoolProvider   Enable SAML workload identity pool providers
...

    Criar a política

    1. Salve o seguinte arquivo como policy-enable-saml-idps.yaml:

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

      Substitua PROJECT_ID pelo ID do seu projeto.

    2. Aplique a política:

      gcloud org-policies set-policy policy-enable-saml-idps.yaml

    3. Verifique se a política existe:

      gcloud org-policies list --project=PROJECT_ID

      O resultado será o seguinte:

      CONSTRAINT                             LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.enableSamlWorkloadIdProviders   -              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

    Crie um pool de identidades da carga de trabalho, se você ainda não tiver um:

    gcloud iam workload-identity-pools create POOL_ID \
    --location=global \
    --project=PROJECT_ID

    Tente criar um provedor OIDC no pool de identidades da carga de trabalho. Isso vai falhar se a restrição for aplicada:

    gcloud iam workload-identity-pools providers create-oidc org-policy-test \
    --location=global \
    --workload-identity-pool=POOL_ID \
    --issuer-uri='https://accounts.google.com' \
    --attribute-mapping='google.subject=assertion.sub'

    O resultado será assim:

    Operation denied by org policy on resource 'projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID': ["customConstraints/custom.enableSamlWorkloadIdProviders": "All new workload identity pool providers must be SAML providers."]

    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
    Exigir que os provedores SAML tenham chaves RSA de 4096 bits 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.requireRsa4096Keys
    resourceTypes:
    - iam.googleapis.com/WorkloadIdentityPoolProviderKey
    methodTypes:
    - CREATE
    condition: "resource.keyData.keySpec == 'RSA_4096'"
    actionType: ALLOW
    displayName: Require 4096-bit RSA keys
    description: All SAML workload identity pool providers must have 4096-bit RSA keys.
    Exigir que todos os novos provedores de identidade sejam provedores de OIDC com um URI de emissor específico 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.requireIssuerUri
    resourceTypes:
    - iam.googleapis.com/WorkloadIdentityPoolProvider
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.oidc.issuerUri == 'https://accounts.google.com'"
    actionType: ALLOW
    displayName: Require specify OIDC issuer
    description: All new workload identity pool providers must be OIDC providers with a specific issuer URI.

    Recursos compatíveis com o Identity and Access Management

    A tabela a seguir lista os recursos do Identity and Access Management que podem ser referenciados em restrições personalizadas.

    Recurso Campo
    iam.googleapis.com/WorkloadIdentityPool resource.description
    resource.disabled
    resource.displayName
    resource.mode
    iam.googleapis.com/WorkloadIdentityPoolProvider resource.attributeCondition
    resource.attributeMapping
    resource.aws.accountId
    resource.aws.stsUri
    resource.description
    resource.disabled
    resource.displayName
    resource.oidc.allowedAudiences
    resource.oidc.issuerUri
    resource.oidc.jwksJson
    resource.saml.idpMetadataXml
    resource.x509.trustStore.intermediateCas.pemCertificate
    resource.x509.trustStore.trustAnchors.pemCertificate
    iam.googleapis.com/WorkloadIdentityPoolProviderKey resource.keyData.keySpec
    resource.use

    A seguir