Gerenciar recursos do Cloud Storage usando restrições personalizadas

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 :

  • storage.googleapis.com/Bucket

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.

Limitações

  • Os rótulos de bucket não são recomendados para uso em condições de restrição personalizadas. Em vez disso, use tags, que só podem ser definidas por indivíduos com os papéis necessários do Identity and Access Management (IAM) e são mais rigorosamente controladas do que os rótulos.

  • As restrições personalizadas recém-aplicadas não se aplicam aos recursos atuais. Os recursos atuais precisam ser atualizados para que a restrição seja aplicada.

    Para encontrar recursos que precisarão ser atualizados, aplique uma política da organização de simulação.

  • As restrições personalizadas não podem ser usadas para restringir ACLs ou políticas do IAM em objetos ou buckets.

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 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. 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 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. 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 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.* na organização
    • Teste o exemplo de política da organização nesta página criando um bucket: storage.buckets.create no 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 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 nome 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.disableGkeAutoUpgrade. 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. Nem todos os serviços do Google Cloud aceitam os dois métodos. Para ver os métodos compatíveis com cada serviço, encontre o serviço em Serviços compatíveis.

    9. 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 ter 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.
    10. Em Ação, selecione se você quer permitir ou negar o método avaliado quando a condição é atendida.

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

    11. Clique em Criar restrição.

      12. 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.bucketNamingRequirement. Esse campo pode ter até 70 caracteres.
      • RESOURCE_NAME: o nome totalmente qualificado do recurso Google Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, storage.googleapis.com/Bucket.
      • CONDITION: uma condição 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.name.matches('^[a-zA-Z]+$')".

        • 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 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.
    2. 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: 
      3.         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 .

    3. Para verificar se a restrição personalizada existe, use o comando gcloud org-policies list-custom-constraints: 
      4.       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 Como definir uma política 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 simulação, clique em Definir política de simulação. Para mais informações, consulte Criar uma política da organização no modo de simulaçã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.bucketNamingRequirement.
    2. Para aplicar a política da organização no modo de teste, execute o seguinte comando com a flag dryRunSpec: 
      3.         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.

    3. 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: 
      4.         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 cria uma restrição e política personalizada que exige que todos os buckets recém-criados tenham um nome que contenha apenas letras. É possível testar a política tentando realizar uma ação que ela precisa impedir.

    Criar a restrição

    1. Salve o seguinte arquivo como constraint-bucket-names.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.bucketNamingRequirement
resource_types: storage.googleapis.com/Bucket
method_types:
- CREATE
condition: "resource.name.matches('^[a-zA-Z]+$')"
action_type: ALLOW
display_name: Bucket names must match the specified regular expression
description: Newly created buckets must have a name that matches the specified regular expression. Only letters are allowed in the bucket name.

      Substitua ORGANIZATION_ID pelo ID da organização.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint ~/constraint-bucket-names.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.bucketNamingRequirement    ALLOW          CREATE          storage.googleapis.com/Bucket   Bucket names must match the specified regular expression
...

    Criar a política

    1. Salve o seguinte arquivo como policy-bucket-names.yaml:

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

      Substitua PROJECT_ID pela ID do seu projeto.

      Neste exemplo, aplicamos essa restrição no nível do projeto, mas também é possível defini-la no nível da organização ou da pasta.

    2. Aplique a política:

      gcloud org-policies set-policy ~/policy-bucket-names.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.bucketNamingRequirement    -              SET               CIqktscGELiZn6cC-

    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

    • Tente criar um bucket com um nome que contenha um caractere que não seja uma letra:

      gcloud storage buckets create gs://example-bucket --location=BUCKET_LOCATION

      Substitua BUCKET_LOCATION pelo local do bucket. Por exemplo, US.

      A solicitação falha com um erro semelhante a este:

      ERROR: (gcloud.storage.buckets.create) HTTPError 412: orgpolicy:projects/_/buckets/example-bucket violates customConstraints/custom.bucketNamingRequirement. Details: Newly created buckets must have a name that matches the specified regular expression. Only letters are allowed in the bucket name.

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

    Confira na tabela a sintaxe de algumas restrições personalizadas comuns. Para conferir uma lista de restrições predefinidas que podem ser usadas com o Cloud Storage, consulte Restrições da política da organização para o Cloud Storage.

    Descrição Sintaxe da restrição
    Os buckets precisam ter o controle de versões de objetos ativado 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceBucketVersioning
  method_types:
  - CREATE
  - UPDATE
  resource_types: storage.googleapis.com/Bucket
  condition: "resource.versioning.enabled == true"
  action_type: ALLOW
  display_name: Buckets must have Object Versioning enabled
  description: Newly created buckets and newly updated buckets must have Object Versioning enabled.
    Os buckets precisam ser nomeados usando uma expressão regular específica 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.bucketNamingRequirement
  method_types:
  - CREATE
  resource_types: storage.googleapis.com/Bucket
  condition: "resource.name.matches('^[a-zA-Z]+$')"
  action_type: ALLOW
  display_name: Bucket names must match the specified regular expression
  description: Newly created buckets must have a name that matches the specified regular expression. Only letters are allowed in the bucket name.
    Buckets não podem estar com o bloqueio de bucket ativado 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.prohibitBucketLock
  method_types:
  - CREATE
  - UPDATE
  resource_types: storage.googleapis.com/Bucket
  condition: "resource.retentionPolicy.isLocked == true"
  action_type: DENY
  display_name: Prohibit the use of Bucket Lock
  description: Newly created buckets and newly updated buckets cannot have Bucket Lock enabled.
    Buckets não podem ter o bloqueio de retenção de objetos ativado 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.prohibitObjectRetentionLock
  method_types:
  - CREATE
  - UPDATE
  resource_types: storage.googleapis.com/Bucket
  condition: "resource.objectRetention.mode == 'Enabled'"
  action_type: DENY
  display_name: Objects cannot have retention configurations
  description: Newly created buckets and newly updated buckets cannot have Object Retention Lock enabled.
    Buckets localizados nas multirregiões US ou EU precisam ter um período de armazenamento de 86.400 segundos 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.locationRetentionPolicy
  method_types:
  - CREATE
  - UPDATE
  resource_types: storage.googleapis.com/Bucket
  condition: "(resource.location.startsWith('US') || resource.location.startsWith('EU')) && resource.retentionPolicy.retentionPeriod != 86400"
  action_type: DENY
  display_name: All buckets in US and EU must have a retention policy of 86,400 seconds
  description: Newly created buckets and newly updated buckets located in US and EU regions must have a retention policy of 86,400 seconds.
    Buckets precisam ter rótulos1 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.labels
  method_types:
  - CREATE
  - UPDATE
  resource_types: storage.googleapis.com/Bucket
  condition: "'my_annotations.data.source' in resource.labels && resource.labels['my_annotations.data.source'] in ['SOURCE_IMAGES','SOURCE_TEXT','SOURCE_VIDEOS']"
  action_type: ALLOW
  display_name: Buckets must have a label classifying the contents of the bucket
  description: Newly created buckets and newly updated buckets must have the label my_annotations.data.source with the SOURCE_IMAGES, SOURCE_TEXT, or SOURCE_VIDEOS key.
    Os buckets precisam estar localizados em um local birregional. 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.dualRegionUS
  method_types:
  - CREATE
  - UPDATE
  resource_types: storage.googleapis.com/Bucket
  condition: "'US-EAST1' in resource.customPlacementConfig.dataLocations && 'US-EAST4' in resource.customPlacementConfig.dataLocations"
  action_type: ALLOW
  display_name: Buckets must be located in a dual-region
  description: Newly created buckets and newly updated buckets must be located in a dual-region composed of the us-east1 and us-east4 regions.
    Buckets não podem usar classes de armazenamento legadas 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.disableLegacyStorageClass
  method_types:
  - CREATE
  - UPDATE
  resource_types: storage.googleapis.com/Bucket
  condition: "resource.storageClass in ['STANDARD', 'NEARLINE', 'COLDLINE', 'ARCHIVE']"
  action_type: ALLOW
  display_name: Buckets cannot use legacy storage classes
  description: Newly created buckets and newly updated buckets must use Standard storage, Nearline storage, Coldline storage, or Archive storage.
    A filtragem de IP do bucket precisa restringir solicitações de toda a Internet pública. 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.IpFilter
  method_types:
  - CREATE
  resource_types: storage.googleapis.com/Bucket
  condition: "!has(resource.ipFilter) || (resource.ipFilter.mode == 'Disabled' || resource.ipFilter.publicNetworkSource.allowedIpCidrRanges.size() > 0)"
  action_type: DENY
  display_name: Bucket IP filter rules must restrict all the public network
  description: Newly created buckets must have IP filtering and IP filtering rules must restrict all public network resources.

    1 Especificar uma chave de rótulo do bucket que não existe retorna um erro BAD_CONDITION. Esse erro impede que os métodos CREATE e UPDATE sejam executados no bucket. Para evitar esse erro, sempre verifique se a chave do rótulo existe primeiro usando "my_annotations.data.source" in resource.labels.

    Políticas condicionais da organização

    É possível tornar uma política da organização personalizada condicional usando tags. Para mais informações, consulte Como definir uma política da organização com tags.

    Recursos compatíveis com o Cloud Storage

    A tabela a seguir lista os recursos do Cloud Storage que podem ser referenciados em restrições personalizadas.

    Recurso Campo
    storage.googleapis.com/Bucket resource.billing.requesterPays
    resource.cors.maxAgeSeconds
    resource.cors.method
    resource.cors.origin
    resource.cors.responseHeader
    resource.customPlacementConfig.dataLocations
    resource.defaultEventBasedHold
    resource.encryption.defaultKmsKeyName
    resource.iamConfiguration.publicAccessPrevention
    resource.iamConfiguration.uniformBucketLevelAccess.enabled
    resource.ipFilter.mode
    resource.ipFilter.publicNetworkSource.allowedIpCidrRanges
    resource.ipFilter.vpcNetworkSources.allowedIpCidrRanges
    resource.ipFilter.vpcNetworkSources.network
    resource.labels
    resource.lifecycle.rule.action.storageClass
    resource.lifecycle.rule.action.type
    resource.lifecycle.rule.condition.age
    resource.lifecycle.rule.condition.createdBefore
    resource.lifecycle.rule.condition.customTimeBefore
    resource.lifecycle.rule.condition.daysSinceCustomTime
    resource.lifecycle.rule.condition.daysSinceNoncurrentTime
    resource.lifecycle.rule.condition.isLive
    resource.lifecycle.rule.condition.matchesPrefix
    resource.lifecycle.rule.condition.matchesStorageClass
    resource.lifecycle.rule.condition.matchesSuffix
    resource.lifecycle.rule.condition.noncurrentTimeBefore
    resource.lifecycle.rule.condition.numNewerVersions
    resource.location
    resource.locationType
    resource.logging.logBucket
    resource.logging.logObjectPrefix
    resource.name
    resource.objectRetention.mode
    resource.retentionPolicy.isLocked
    resource.retentionPolicy.retentionPeriod
    resource.rpo
    resource.softDeletePolicy.retentionDurationSeconds
    resource.storageClass
    resource.versioning.enabled
    resource.website.mainPageSuffix
    resource.website.notFoundPage

    Observe o seguinte:

    • Use letras maiúsculas para especificar os valores dos seguintes campos:
      • resource.customPlacementConfig.dataLocations
      • resource.lifecycle.rule.action.storageClass
      • resource.location
      • resource.storageClass
    • O campo resource.retentionPolicy.isLocked só pode ser usado para proibir o uso do bloqueio de bucket, não para aplicá-lo.

    A seguir