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

Com a política da organização doGoogle Cloud , você controla de forma centralizada e programática 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 da organização, de pastas ou de projetos.

A política da organização fornece restrições predefinidas para diversos serviços doGoogle Cloud . No entanto, se você desejar um controle mais detalhado e personalizável sobre os campos específicos restritos nas políticas da organização, é possível criar restrições personalizadas e aplicá-las em uma política da organização própria.

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 desta pasta. Para saber mais sobre esse comportamento e como fazer alterações, confira Regras para a avaliação da hierarquia.

Recursos compatíveis com o Cloud Armor

Nos recursos do Google Cloud Armor, é possível definir restrições personalizadas para os recursos e campos apresentados a seguir.

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

    • Nome: resource.name
    • Descrição: resource.description
    • Regras: resource.rules[]
      • Ação do 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
      • Correspondente: resource.rules[].match
      • Expressão com controle de versões: resource.rules[].versionedExpr
      • Configuração: resource.rules[].config
        • Intervalos de IPs de origem: resource.rules[].config.srcIpRanges[]
      • Expressão: resource.rules[].expr
      • Opções para a expressão: resource.rules[].exprOptions
        • Opções para o reCAPTCHA: resource.rules[].exprOption.recaptchaOptions
        • Chaves do site para o token de ação: resource.rules[].exprOption.recaptchaOptions.actionTokenSiteKeys
        • Chaves de site para o token de sessão: resource.rules[].exprOption.recaptchaOptions.sessionTokenSiteKeys
      • Correspondente 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 da região de origem: resource.rules[].srcRegionCodes
      • ASNs de origem: resource.rules[].srcAsns
      • Configuração definida previamente para o WAF: 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
        • Cookies da solicitação a serem excluídos: resource.rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[]
        • Valor: resource.rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[].val
        • Operação: resource.rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[].op
        • Parâmetros de consulta da solicitação a serem excluídos: 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 para o redirecionamento: resource.rules[].redirectOptions[]
      • Tipo: resource.rules[].redirectOptions[].type
      • Destino: resource.rules[].redirectOptions[].target
      • Opções para a limitação de taxa: resource.rules[].rateLimitOptions[]
      • Valor limite para a limitação de taxa: resource.rules[].rateLimitOptions[].rateLimitThreshold
        • Contagem: resource.rules[].rateLimitOptions[].rateLimitThreshold.count
        • Intervalo em segundos: resource.rules[].rateLimitOptions[].rateLimitThreshold.intervalSec
      • Ação para conformidade: resource.rules[].rateLimitOptions[].conformAction
      • Ação para excesso: resource.rules[].rateLimitOptions[].exceedAction
      • Opções para o redirecionamento quando houver excesso: resource.rules[].rateLimitOptions[].exceedRedirectOptions
        • Tipo: resource.rules[].rateLimitOptions[].exceedRedirectOptions.type
        • Destino: resource.rules[].rateLimitOptions[].exceedRedirectOptions.target
      • Status de RPC da ação para excesso: resource.rules[].rateLimitOptions[].exceedActionRpcStatus
        • Código: resource.rules[].rateLimitOptions[].exceedActionRpcStatus.code
        • Mensagem: resource.rules[].rateLimitOptions[].exceedActionRpcStatus.message
      • Ação para aplicar na chave: resource.rules[].rateLimitOptions[].enforceOnKey
      • Ação para aplicar no nome da chave: resource.rules[].rateLimitOptions[].enforceOnKeyName
      • Ação para aplicar nas configurações da chave: resource.rules[].rateLimitOptions[].enforceOnKeyConfigs
        • Ação para aplicar no tipo de chave: resource.rules[].rateLimitOptions[].enforceOnKeyConfigs.enforceOnKeyType
        • Ação para aplicar no nome da chave: resource.rules[].rateLimitOptions[].enforceOnKeyConfigs.enforceOnKeyName
      • Limite de proibição: resource.rules[].rateLimitOptions[].banThreshold
        • Contagem: resource.rules[].rateLimitOptions[].banThreshold.count
        • Intervalo em segundos: resource.rules[].rateLimitOptions[].banThreshold.intervalSec
      • Duração da proibição em segundos: resource.rules[].rateLimitOptions[].banDurationSec
      • Destino para 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 na Camada 7: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig
      • Ação para 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 para implantação automática: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployLoadThreshold
        • Limite de confiança para implantação automática: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployConfidenceThreshold
        • Limite de impacto no valor de referência para implantação automática: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployImpactedBaselineThreshold
        • Tempo de expiração da implantação automática em segundos: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployExpirationSec
        • Limite de carga para detecção: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionLoadThreshold
        • QPS absolutas para detecção: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionAbsoluteQps
        • QPS para detecção em relação ao valor de referência: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionRelativeToBaselineQps
        • Configurações de granularidade do tráfego: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[]
        • Tipo: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].type
        • Valor: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].value
        • Ação para ativar cada valor único: 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 de impacto no valor de referência: resource.adaptiveProtectionConfig.autoDeployConfig.impactedBaselineThreshold
      • Tempo de expiração em segundos: resource.adaptiveProtectionConfig.autoDeployConfig.expirationSec
    • Configuração de opções avançadas: resource.advancedOptionsConfig
      • Análise JSON: resource.advancedOptionsConfig,jsonParsing
      • Configuração personalizada em JSON: resource.advancedOptionsConfig,jsonCustomConfig
      • Tipos de conteúdo: resource.advancedOptionsConfig,jsonCustomConfig.contentTypes[]
      • Nível do registro: resource.advancedOptionsConfig.logLevel
      • Cabeçalhos da solicitação para o 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 para o reCAPTCHA: resource.recaptchaOptionsConfig
      • Chave do site para 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 na 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 no qual a política da organização é aplicada. Você define as condições das restrições personalizadas usando a Common Expression Language (CEL). Para saber como definir condições em restrições personalizadas usando a CEL, confira a seção sobre CEL em Como criar e gerenciar políticas da organização.

Antes de começar

  • Configure a autenticação, caso ainda não tenha feito isso. Com isso, você confirma sua identidade para acesso a serviços e APIs do Google Cloud . Para executar código ou exemplos em um ambiente de desenvolvimento local, faça a autenticação no Compute Engine com um destes métodos:

    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. Instale a CLI do Google Cloud e faça login na gcloud CLI com sua identidade federada. Depois de fazer login, inicialize a CLI do Google Cloud executando o seguinte comando:

      gcloud init
    2. Set a default region and zone.

    REST

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

      Instale a CLI do Google Cloud e faça login na gcloud CLI com sua identidade federada. Depois de fazer login, inicialize a CLI do Google Cloud executando o seguinte comando:

      gcloud init

    Saiba mais em Autenticar para usar REST na documentação de autenticação do Google Cloud .

* Garanta que você saiba o ID da sua organização.

Papéis necessários

Para receber as permissões necessárias para gerenciar políticas da organização em recursos do Cloud Armor, solicite ao seu administrador que conceda os seguintes papéis do IAM:

Para mais informações sobre a concessão de papéis, confira Gerenciar o acesso a projetos, pastas e organizações.

Os papéis predefinidos fornecem as permissões necessárias para gerenciar as políticas da organização em recursos do Cloud Armor. Para acessar as permissões específicas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

Para gerenciar políticas da organização em recursos do Cloud Armor, são requeridas as seguintes permissões:

  • 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 por meio de papéis personalizados 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 CLI 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. Selecione o Seletor de projetos na parte de cima da página.

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

  4. Clique em Restrição personalizada.

  5. Na caixa Nome de exibição, digite um nome legível para a restrição. Esse campo pode ter no máximo 200 caracteres. Não use PII ou dados sensíveis nos nomes de restrições, porque eles podem ser expostos em mensagens de erro.

  6. Na caixa ID da restrição, digite o nome que você quer para a nova restrição personalizada. A 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, digite uma descrição legível a ser exibida como uma mensagem de erro quando a política for violada. Esse campo pode ter no máximo 2.000 caracteres.

  8. Na caixa Tipo de recurso, selecione o nome do recurso REST do Google Cloudque contém o objeto e o campo que você quer restringir. Por exemplo, compute.googleapis.com/SecurityPolicy.

  9. Em Método de restrição, selecione se a restrição será aplicada apenas ao método REST CREATE ou também aos métodos 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 pode ter no máximo 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ê digita um valor em cada campo, a configuração YAML equivalente à 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 nova restrição personalizada. A 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 nos quais a restrição será aplicada. Pode ser CREATE ou CREATE e UPDATE.

  • CONDITION: uma condição de CEL gravada com base na representação de um recurso de serviço compatível. Este campo pode ter, no máximo, 1.000 caracteres. Confira Recursos compatíveis para mais informações sobre os recursos disponíveis para a gravação de condições.

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

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

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. Saiba mais em Como visualizar políticas da organização.

Aplicar uma restrição personalizada

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.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 para o arquivo YAML da política da organização. A política pode demorar até 15 minutos para entrar em vigor.

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

Esta restrição impede a criação de políticas de segurança que não tenham a análise JSON padrão ativada.

gcloud

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

    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.

    Substitua ORGANIZATION_ID pelo ID da sua 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 a seguir 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 configurar o campo de análise JSON.

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

    O resultado deve ser parecido com o seguinte:

    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 serviço de políticas da organização, incluindo as políticas da organização predefinidas e personalizadas, é oferecido sem custos financeiros.

A seguir