Gerenciar recursos do Google Cloud Armor usando restrições personalizadas

A política da organização do Google Cloud 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 limites chamado restrições que se aplicam aos recursos do Google Cloud e aos descendentes desses recursos na Hierarquia de recursos do Google 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 do 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 aplique-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, o Google Cloud aplicará a política a todos os projetos da pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação da hierarquia.

Recursos compatíveis com o Google Cloud Armor

Para os recursos do Google Cloud Armor, é possível definir restrições personalizadas nos seguintes recursos e campos.

  • Política de segurança: compute.googleapis.com/SecurityPolicy

    • Nome: resource.name
    • Descrição: resource.description
    • Regras: resource.rules[]
      • Ação de cabeçalho: resource.headerAction
      • Cabeçalhos da solicitação a serem adicionados: resource.headerAction.requestHeadersToAdds[]
        • Nome do cabeçalho: resource.requestHeadersToAdds.requestHeadersToAdds[].headerName
        • Valor do cabeçalho: resource.requestHeadersToAdds.requestHeadersToAdds[].headerValue
      • Correspondência: resource.rules[].match
      • Expressão com versão: resource.rules[].versionedExpr
      • Configuração: resource.rules[].config
        • Intervalos de IPs de origem: resource.rules[].config.srcIpRanges[]
      • Expressão: resource.rules[].expr
      • Opções de expressão: resource.rules[].exprOptions
        • Opções do reCAPTCHA: resource.rules[].exprOption.recaptchaOptions
        • Chaves do site do token de ação: resource.rules[].exprOption.recaptchaOptions.actionTokenSiteKeys
        • Chaves de site do token de sessão: resource.rules[].exprOption.recaptchaOptions.sessionTokenSiteKeys
      • Correspondência de rede: resource.rules[].networkMatch
      • Correspondência de campo definida pelo usuário: resource.rules[].userDefinedFieldMatch
        • Nome: resource.rules[].userDefinedFieldMatch.name
        • Valores: resource.rules[].userDefinedFieldMatch.values
      • Intervalos de IPs de origem: resource.rules[].srcIpRanges
      • Intervalos de IP de destino: resource.rules[].destIpRanges
      • Protocolos IP: resource.rules[].ipProtocols
      • Portas de origem: resource.rules[].srcPorts
      • Portas de destino: resource.rules[].destPorts
      • Códigos de região de origem: resource.rules[].srcRegionCodes
      • ASNs de origem: resource.rules[].srcAsns
      • Configuração do WAF pré-configurada: resource.rules[].preconfiguredWafConfig
      • Exclusões: resource.rules[].preconfiguredWafConfig.exclusions[]
        • Conjunto de regras de destino: resource.rules[].preconfiguredWafConfig.exclusions[].targetRuleSet
        • IDs das regras de destino: resource.rules[].preconfiguredWafConfig.exclusions[].targetRuleIds[]
        • Cabeçalhos da solicitação a serem excluídos: resource.rules[].preconfiguredWafConfig.exclusions[].requestHeadersToExclude[]
        • Valor: resource.rules[].preconfiguredWafConfig.exclusions[].requestHeadersToExclude[].val
        • Operação: resource.rules[].preconfiguredWafConfig.exclusions[].requestHeadersToExclude[].op
        • Solicitar cookies para excluir: resource.rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[]
        • Valor: resource.rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[].val
        • Operação: resource.rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[].op
        • Solicitar parâmetros de consulta para excluir: resource.rules[].preconfiguredWafConfig.exclusions[].requestQueryParamsToExclude[]
        • Valor: resource.rules[].preconfiguredWafConfig.exclusions[].requestQueryParamsToExclude[].val
        • Operação: resource.rules[].preconfiguredWafConfig.exclusions[].requestQueryParamsToExclude[].op
        • URIs de solicitação a serem excluídos: resource.rules[].preconfiguredWafConfig.exclusions[].requestUrisToExclude[]
        • Valor: resource.rules[].preconfiguredWafConfig.exclusions[].requestUrisToExclude[].val
        • Operação: resource.rules[].preconfiguredWafConfig.exclusions[].requestUrisToExclude[].op
      • Opções de redirecionamento: resource.rules[].redirectOptions[]
      • Tipo: resource.rules[].redirectOptions[].type
      • Destino: resource.rules[].redirectOptions[].target
      • Opções de limite de taxa: resource.rules[].rateLimitOptions[]
      • Limite de taxa: resource.rules[].rateLimitOptions[].rateLimitThreshold
        • Contagem: resource.rules[].rateLimitOptions[].rateLimitThreshold.count
        • Segundos de intervalo: resource.rules[].rateLimitOptions[].rateLimitThreshold.intervalSec
      • Conformação da ação: resource.rules[].rateLimitOptions[].conformAction
      • Ação excedida: resource.rules[].rateLimitOptions[].exceedAction
      • Opções de redirecionamento excedidas: resource.rules[].rateLimitOptions[].exceedRedirectOptions
        • Tipo: resource.rules[].rateLimitOptions[].exceedRedirectOptions.type
        • Destino: resource.rules[].rateLimitOptions[].exceedRedirectOptions.target
      • Status da RPC de ação excedida: resource.rules[].rateLimitOptions[].exceedActionRpcStatus
        • Código: resource.rules[].rateLimitOptions[].exceedActionRpcStatus.code
        • Mensagem: resource.rules[].rateLimitOptions[].exceedActionRpcStatus.message
      • Aplicar na chave: resource.rules[].rateLimitOptions[].enforceOnKey
      • Aplicar no nome da chave: resource.rules[].rateLimitOptions[].enforceOnKeyName
      • Aplicar nas configurações de chaves: resource.rules[].rateLimitOptions[].enforceOnKeyConfigs
        • Aplicar no tipo de chave: resource.rules[].rateLimitOptions[].enforceOnKeyConfigs.enforceOnKeyType
        • Aplicar no nome da chave: resource.rules[].rateLimitOptions[].enforceOnKeyConfigs.enforceOnKeyName
      • Limite de proibição: resource.rules[].rateLimitOptions[].banThreshold
        • Contagem: resource.rules[].rateLimitOptions[].banThreshold.count
        • Segundos de intervalo: resource.rules[].rateLimitOptions[].banThreshold.intervalSec
      • Segundos de duração da proibição: resource.rules[].rateLimitOptions[].banDurationSec
      • Destino do redirecionamento: resource.rules[].redirectTarget
      • Número da regra: resource.rules[].ruleNumber
    • Configuração da proteção adaptativa: resource.adaptiveProtectionConfig
      • Configuração de defesa contra DDoS de camada 7: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig
      • Ativar: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.enable
      • Visibilidade da regra: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.ruleVisibility
      • Configurações de limite: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[]
        • Nome: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].name
        • Limite de carga de implantação automática: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployLoadThreshold
        • Limite de confiança de implantação automática: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployConfidenceThreshold
        • Limite do valor de referência afetado pela implantação automática: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployImpactedBaselineThreshold
        • Segundos de expiração da implantação automática: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployExpirationSec
        • Limite de carga de detecção: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionLoadThreshold
        • QPS absoluta da detecção: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionAbsoluteQps
        • Detecção relativa ao QPS de referência: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionRelativeToBaselineQps
        • Configurações de granularidade de tráfego: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[]
        • Tipo: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].type
        • Valor: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].value
        • Ative cada valor exclusivo: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].enableEachUniqueValue
      • Configuração de implantação automática: resource.adaptiveProtectionConfig.autoDeployConfig
      • Limite de carregamento: resource.adaptiveProtectionConfig.autoDeployConfig.loadThreshold
      • Limite de confiança: resource.adaptiveProtectionConfig.autoDeployConfig.confidenceThreshold
      • Limite do valor de referência afetado: resource.adaptiveProtectionConfig.autoDeployConfig.impactedBaselineThreshold
      • Segundos de expiração: resource.adaptiveProtectionConfig.autoDeployConfig.expirationSec
    • Configuração de opções avançadas: resource.advancedOptionsConfig
      • Análise JSON: resource.advancedOptionsConfig,jsonParsing
      • Configuração personalizada JSON: resource.advancedOptionsConfig,jsonCustomConfig
      • Tipos de conteúdo: resource.advancedOptionsConfig,jsonCustomConfig.contentTypes[]
      • Nível de registro: resource.advancedOptionsConfig.logLevel
      • Cabeçalhos da solicitação de IP do usuário: resource.advancedOptionsConfig.userIpRequestHeaders[]
    • Configuração de proteção contra DDoS: resource.ddosProtectionConfig
      • Proteção contra DDoS: resource.ddosProtectionConfig.ddosProtection
    • Configuração de opções do reCAPTCHA: resource.recaptchaOptionsConfig
      • Chave do site de redirecionamento: resource.recaptchaOptionsConfig.redirectSiteKey
    • Tipo: resource.type
    • Campos definidos pelo usuário: resource.userDefinedFields[]
      • Nome: resource.userDefinedFields[].name
      • Base: resource.userDefinedFields[].base
      • Deslocamento: resource.userDefinedFields[].offset
      • Tamanho: resource.userDefinedFields[].size
      • Máscara: resource.userDefinedFields[].mask
  • Serviço de segurança de borda de rede: compute.googleapis.com/NetworkEdgeSecurityService

    • Nome: resource.name
    • Descrição: resource.description
    • Política de segurança: resource.securityPolicy

Como definir restrições personalizadas

Uma restrição personalizada é definida pelos recursos, métodos, condições e ações compatíveis com o serviço em que a política da organização está sendo aplicada. 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 da página Como criar e gerenciar políticas da organização.

Antes de começar

  • Configure a autenticação, caso ainda não tenha feito isso. A autenticação é o processo de verificação da sua identidade para acesso a serviços e APIs do Google Cloud. Para executar códigos ou amostras de um ambiente de desenvolvimento local, autentique-se no Compute Engine selecionando uma das seguintes opções:

    Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    1. Install the Google Cloud CLI, then initialize it by running the following command:

      gcloud init
    2. Set a default region and zone.
    3. REST

      Para usar as amostras da API REST nesta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para gcloud CLI.

        Install the Google Cloud CLI, then initialize it by running the following command:

        gcloud init

      Para mais informações, consulte Autenticar para usar REST na documentação de autenticação do Google Cloud.

* Saiba o ID da organização.

Funções exigidas

Para receber as permissões necessárias para gerenciar políticas da organização em recursos do Google Cloud Armor, peça ao administrador para conceder a você as seguintes funções 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ção em recursos do Google Cloud Armor. 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 políticas da organização em recursos do Google Cloud Armor:

  • orgpolicy.constraints.list
  • orgpolicy.policies.create
  • orgpolicy.policies.delete
  • orgpolicy.policies.list
  • orgpolicy.policies.update
  • orgpolicy.policy.get
  • orgpolicy.policy.set

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

Configurar uma restrição personalizada

É possível criar uma restrição personalizada e configurá-la para uso nas políticas da organização usando o console do Google Cloud ou a Google Cloud CLI.

Console

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

    Acessar as políticas da organização

  2. Selecione o Seletor de projetos na parte superior da página.

  3. No Seletor de projetos, selecione o recurso em que você quer definir a política da organização.

  4. Clique em Restrição personalizada.

  5. Na caixa Nome de exibição, insira um nome legível para a restrição. Esse campo tem um comprimento máximo de 200 caracteres. Não use PII ou dados confidenciais em nomes de restrições, porque eles podem ser expostos em mensagens de erro.

  6. Na caixa ID da restrição, insira o nome que você quer para a 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.requireSecurityPolicyWithStandardJsonParsing. O tamanho máximo desse campo é de 70 caracteres, sem contar o prefixo (por exemplo, organizations/123456789/customConstraints/custom.).

  7. Na caixa Descrição, insira uma descrição legível a ser exibida como uma mensagem de erro quando a política for violada. Esse campo tem um comprimento máximo de 2.000 caracteres.

  8. 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, compute.googleapis.com/SecurityPolicy.

  9. Em Método de aplicação, selecione se quer aplicar a restrição. somente no método REST CREATE ou nos REST CREATE e UPDATE.

  10. Para definir uma condição, clique em Editar condição.

    1. No painel Adicionar condição, crie uma condição CEL que se refira a um recurso de serviço compatível. Esse campo tem um comprimento máximo de 1.000 caracteres.

    2. Clique em Salvar.

  11. Em Ação, selecione se você quer permitir ou negar o método avaliado quando a condição acima é atendida.

  12. Clique em Criar restrição.

Quando você insere um valor em cada campo, a configuração YAML equivalente para essa restrição personalizada é exibida à direita.

gcloud

Para criar uma restrição personalizada usando a CLI do Google Cloud, crie um arquivo YAML.

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resource_types: compute.googleapis.com/RESOURCE_NAME
method_types: METHOD1 METHOD2
condition: "CONDITION"
action_type: ACTION
display_name: 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.requireSecurityPolicyWithStandardJsonParsing. O tamanho máximo desse campo é de 70 caracteres, sem contar o prefixo (por exemplo, organizations/123456789/customConstraints/custom).

  • RESOURCE_NAME: o nome (não o URI) do recurso REST da API Compute Engine que contém o objeto e o campo que você quer restringir. Por exemplo, SecurityPolicy.

  • METHOD1,METHOD2,...: uma lista de métodos "RESTful" para aplicar a restrição. Pode ser CREATE ou CREATE e UPDATE.

  • 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 1.000 caracteres. Consulte Recursos compatíveis para mais informações sobre os recursos disponíveis para gravar condições.

  • ACTION: a ação a ser realizada se o condition for atendido. Pode ser ALLOW ou 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 2.000 caracteres.

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

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 políticas da organização do Google Cloud. 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 restrição personalizada

Para aplicar uma restrição booleana, crie uma política da organização com referência a ela e depois aplique essa política da organização a um recurso do 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.requireSecurityPolicyWithStandardJsonParsing.

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.

Exemplo: criar uma restrição que exija que todas as políticas de segurança tenham a análise JSON padrão ativada

Essa restrição impede a criação de políticas de segurança se elas não tiverem a análise JSON padrão ativada.

gcloud

  1. Crie um arquivo de restrição requireStandardJsonParsing.yaml com as seguintes informações.

    name: organizations/ORGANIZATION_ID/customConstraints/custom.requireStandardJsonParsing
    resource_types: compute.googleapis.com/SecurityPolicy
    condition: "resource.advancedOptionsConfig.jsonParsing != 'STANDARD'"
    action_type: DENY
    method_types: [CREATE, UPDATE]
    display_name: Security policies must have standard JSON parsing enabled.

    SubstituaORGANIZATION_ID pelo ID da organização.

  2. Defina a restrição personalizada.

    gcloud org-policies set-custom-constraint requireStandardJsonParsing.yaml
    
  3. Crie um arquivo de política requireStandardJsonParsing-policy.yaml com as informações fornecidas no exemplo abaixo e aplique a restrição no nível do projeto. Também é possível definir essa restrição no nível da organização ou da pasta.

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

    Substitua PROJECT_ID pela ID do seu projeto.

  4. Aplique a política.

    gcloud org-policies set-policy requireStandardJsonParsing-policy.yaml
    
  5. Para testar a restrição, crie uma política de segurança sem o campo de análise JSON definido.

    gcloud compute security-policies create my-policy \
        --type=CLOUD_ARMOR
    

    O resultado será assim:

    ERROR: (gcloud.compute.securityPolicies.create) Could not fetch resource:
    - Operation denied by custom org policy: [customConstraints/custom.requireStandardJsonParsing] : Security policies must have standard JSON parsing enabled.

Preços

O Organization Policy Service, incluindo políticas predefinidas e personalizadas, é oferecido sem custos financeiros.

A seguir