Criar restrições personalizadas para o Access Context Manager

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 Google Cloud :

  • accesscontextmanager.googleapis.com/AccessPolicy
  • accesscontextmanager.googleapis.com/AccessLevel
  • accesscontextmanager.googleapis.com/AuthorizedOrgsDesc
  • accesscontextmanager.googleapis.com/ServicePerimeter

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 Serviço de políticas da organização 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 restrições chamado restrições que se aplicam aos recursosGoogle Cloud e aos descendentes desses recursos na hierarquia de recursosGoogle 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 fornece restrições predefinidas para vários serviços 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, Google Cloud vai aplicar a política 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.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  6. To initialize the gcloud CLI, run the following command: 

    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. Make sure that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  11. To initialize the gcloud CLI, run the following command: 

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

Funções exigidas

Para receber as permissões necessárias a fim de gerenciar políticas personalizadas da organização, peça ao administrador para conceder a você o papel do IAM de Administrador de políticas da organização (roles/orgpolicy.policyAdmin) no recurso da organização. 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á 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.disableCustomAccessLevels. 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, accesscontextmanager.googleapis.com/AccessLevel.

  • 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.basic.conditions.exists(c, has(c.devicePolicy))".

  • 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. Após a conclusão, as restrições personalizadas vão estar 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 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 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 dessa política da organização está ativada ou desativada.
  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 configurar 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 levará 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.disableCustomAccessLevels.

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 cria uma restrição e política personalizada que nega todos os níveis de acesso básicos em uma organização específica que usa o atributo devicePolicy.

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

  • O código da sua organização.
  • Um ID do projeto

Criar uma restrição personalizada

  1. Salve o seguinte arquivo como constraint-disable_custom_access_level.yaml:

    name: organizations/ORGANIZATION_ID/customConstraints/custom.disableCustomAccessLevels
resourceTypes:
- accesscontextmanager.googleapis.com/AccessLevel
methodTypes:
- CREATE
- UPDATE
condition: "resource.basic.conditions.exists(c, has(c.devicePolicy))"
actionType: DENY
displayName: Deny basic access levels using `devicePolicy`
description: Basic access levels must not use the `devicePolicy` attribute.

    SubstituaORGANIZATION_ID pelo ID da organização.

    Isso define uma restrição que permite apenas a criação de níveis de acesso básicos e nega a criação de níveis de acesso personalizados.

  2. Aplique a restrição:

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

  3. 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.disableCustomAccessLevels   DENY          CREATE         accesscontextmanager.googleapis.com/AccessLevel   Deny basic access levels using `devicePolicy`
...

Crie a política

  1. Salve o seguinte arquivo como policy-disable_custom_access_level.yaml:

    name: organizations/ORGANIZATION_ID/policies/custom.disableCustomAccessLevels
spec:
  rules:
  - enforce: true

    SubstituaORGANIZATION_ID pelo ID da organização.

  2. Aplique a política:

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

  3. Verifique se a política existe:

    gcloud org-policies list --organization=ORGANIZATION_ID

    O resultado será assim:

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

  1. Salve o seguinte arquivo de especificação de nível de acesso como example_access_level.yaml:

    - devicePolicy:
requireScreenlock: true

  2. Crie um nível de acesso:

    gcloud access-context-manager levels create ACCESS_LEVEL_NAME --policy=ACCESS_POLICY_ID --title=ACCESS_LEVEL_TITLE --basic-level-spec=example_access_level.yaml

    Substitua:

    • ACCESS_LEVEL_NAME: um nome exclusivo para o nível de acesso.

    • ACCESS_POLICY_ID: o ID da política de acesso da sua organização.

    • ACCESS_LEVEL_TITLE: um título curto para o nível de acesso.

    Para mais informações sobre como criar um nível de acesso básico, consulte Criar um nível de acesso básico.

    O resultado será assim:

    ERROR: (gcloud.access-context-manager.levels.create) [USER] does not have permission to access accessPolicies instance [ACCESS_POLICY_ID] (or it may not exist): The caller does not have permission. This command is authenticated as USER which is the active account specified by the [core/account] property
  '@type': type.googleapis.com/google.rpc.DebugInfo
  detail: '[ORIGINAL ERROR] generic::permission_denied: com.google.apps.framework.request.ForbiddenException:
    The user is not authorized!'

    Exemplos de políticas da organização personalizadas 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
    Desativar políticas com escopo 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.disableScopedPolicies
    resourceTypes:
    - accesscontextmanager.googleapis.com/AccessPolicy
    methodTypes:
    - CREATE
    - UPDATE
    condition: "size(resource.scopes) == 0"
    actionType: DENY
    displayName: Disable scoped policies
    description: Disables the creation of scoped policies.
    Desativar níveis de acesso personalizados 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denyBasicAccessLevels
    resourceTypes:
    - accesscontextmanager.googleapis.com/AccessLevel
    methodTypes:
    - CREATE
    - UPDATE
    condition: "has(resource.custom)"
    actionType: ALLOW
    displayName: Disable custom access levels
    description: Disables the creation of custom access levels. Allows only basic access levels.
    Desativar region_code nos níveis de acesso personalizados 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denyRegionCode
    resourceTypes:
    - accesscontextmanager.googleapis.com/AccessLevel
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.custom.expr.expression.contains('region_code')"
    actionType: DENY
    displayName: Disable region_code in custom access levels
    description: Disables the use of region_code attribute in custom access levels.
    Aplicar a descrição detalhada para os níveis de acesso 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enforseVerboseDescriptioninAccessLevels
    resourceTypes:
    - accesscontextmanager.googleapis.com/AccessLevel
    methodTypes:
    - CREATE
    - UPDATE
    condition: "size(resource.description) < 50"
    actionType: DENY
    displayName: Enforce access level descriptions to have at least 50 characters
    description: Denies access levels with a short description. The access level description must be at least 50 characters long.
    Desativar pontes do perímetro 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denyBridgePerimeters
    resourceTypes:
    - accesscontextmanager.googleapis.com/ServicePerimeter
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.perimeterType == 'PERIMETER_TYPE_BRIDGE'"
    actionType: DENY
    displayName: Disable perimeter bridges
    description: Disables the use of perimeter bridges. Instead, use ingress and egress rules.

    Recursos com suporte do Access Context Manager

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

    Recurso Campo
    accesscontextmanager.googleapis.com/AccessLevel resource.basic.combiningFunction
    resource.basic.conditions.devicePolicy.allowedDeviceManagementLevels
    resource.basic.conditions.devicePolicy.allowedEncryptionStatuses
    resource.basic.conditions.devicePolicy.osConstraints.minimumVersion
    resource.basic.conditions.devicePolicy.osConstraints.osType
    resource.basic.conditions.devicePolicy.osConstraints.requireVerifiedChromeOs
    resource.basic.conditions.devicePolicy.requireAdminApproval
    resource.basic.conditions.devicePolicy.requireCorpOwned
    resource.basic.conditions.devicePolicy.requireScreenlock
    resource.basic.conditions.ipSubnetworks
    resource.basic.conditions.members
    resource.basic.conditions.negate
    resource.basic.conditions.regions
    resource.basic.conditions.requiredAccessLevels
    resource.custom.expr.description
    resource.custom.expr.expression
    resource.custom.expr.location
    resource.custom.expr.title
    resource.description
    resource.title
    accesscontextmanager.googleapis.com/AccessPolicy resource.parent
    resource.scopes
    resource.title
    accesscontextmanager.googleapis.com/AuthorizedOrgsDesc resource.assetType
    resource.authorizationDirection
    resource.authorizationType
    resource.orgs
    accesscontextmanager.googleapis.com/ServicePerimeter resource.description
    resource.perimeterType
    resource.spec.accessLevels
    resource.spec.egressPolicies.egressFrom.identities
    resource.spec.egressPolicies.egressFrom.identityType
    resource.spec.egressPolicies.egressFrom.sourceRestriction
    resource.spec.egressPolicies.egressTo.externalResources
    resource.spec.egressPolicies.egressTo.operations.methodSelectors.method
    resource.spec.egressPolicies.egressTo.operations.methodSelectors.permission
    resource.spec.egressPolicies.egressTo.operations.serviceName
    resource.spec.egressPolicies.egressTo.resources
    resource.spec.ingressPolicies.ingressFrom.identities
    resource.spec.ingressPolicies.ingressFrom.identityType
    resource.spec.ingressPolicies.ingressFrom.sources.accessLevel
    resource.spec.ingressPolicies.ingressFrom.sources.resource
    resource.spec.ingressPolicies.ingressTo.operations.methodSelectors.method
    resource.spec.ingressPolicies.ingressTo.operations.methodSelectors.permission
    resource.spec.ingressPolicies.ingressTo.operations.serviceName
    resource.spec.ingressPolicies.ingressTo.resources
    resource.spec.resources
    resource.spec.restrictedServices
    resource.spec.vpcAccessibleServices.allowedServices
    resource.spec.vpcAccessibleServices.enableRestriction
    resource.status.accessLevels
    resource.status.egressPolicies.egressFrom.identities
    resource.status.egressPolicies.egressFrom.identityType
    resource.status.egressPolicies.egressFrom.sourceRestriction
    resource.status.egressPolicies.egressTo.externalResources
    resource.status.egressPolicies.egressTo.operations.methodSelectors.method
    resource.status.egressPolicies.egressTo.operations.methodSelectors.permission
    resource.status.egressPolicies.egressTo.operations.serviceName
    resource.status.egressPolicies.egressTo.resources
    resource.status.ingressPolicies.ingressFrom.identities
    resource.status.ingressPolicies.ingressFrom.identityType
    resource.status.ingressPolicies.ingressFrom.sources.accessLevel
    resource.status.ingressPolicies.ingressFrom.sources.resource
    resource.status.ingressPolicies.ingressTo.operations.methodSelectors.method
    resource.status.ingressPolicies.ingressTo.operations.methodSelectors.permission
    resource.status.ingressPolicies.ingressTo.operations.serviceName
    resource.status.ingressPolicies.ingressTo.resources
    resource.status.resources
    resource.status.restrictedServices
    resource.status.vpcAccessibleServices.allowedServices
    resource.status.vpcAccessibleServices.enableRestriction
    resource.title
    resource.useExplicitDryRunSpec

    A seguir