Manage Google Cloud Armor resources by using custom constraints

Google Cloud Organization Policy gives you centralized, programmatic control over your organization's resources. As the organization policy administrator, you can define an organization policy, which is a set of restrictions called constraints that apply to Google Cloud resources and descendants of those resources in the Google Cloud resource hierarchy. You can enforce organization policies at the organization, folder, or project level.

Organization Policy provides predefined constraints for various Google Cloud services. However, if you want more granular, customizable control over the specific fields that are restricted in your organization policies, you can also create custom constraints and enforce those custom constraints in a custom organization policy.

Policy inheritance

By default, organization policies are inherited by the descendants of the resources on which you enforce the policy. For example, if you enforce a policy on a folder, Google Cloud enforces the policy on all projects in the folder. To learn more about this behavior and how to change it, see Hierarchy evaluation rules.

Google Cloud Armor supported resources

For Google Cloud Armor resources, you can set custom constraints on the following resources and fields.

  • Security Policy: compute.googleapis.com/SecurityPolicy

    • Name: resource.name
    • Description: resource.description
    • Rules: resource.rules[]
      • Header action: resource.headerAction
      • Request headers to add: resource.headerAction.requestHeadersToAdds[]
        • Header name: resource.requestHeadersToAdds.requestHeadersToAdds[].headerName
        • Header value: resource.requestHeadersToAdds.requestHeadersToAdds[].headerValue
      • Matcher: resource.rules[].match
      • Versioned expression: resource.rules[].versionedExpr
      • Config: resource.rules[].config
        • Source IP ranges: resource.rules[].config.srcIpRanges[]
      • Expression: resource.rules[].expr
      • Expression options: resource.rules[].exprOptions
        • reCAPTCHA options: resource.rules[].exprOption.recaptchaOptions
        • Action token site keys: resource.rules[].exprOption.recaptchaOptions.actionTokenSiteKeys
        • Session token site keys: resource.rules[].exprOption.recaptchaOptions.sessionTokenSiteKeys
      • Network matcher: resource.rules[].networkMatch
      • User defined field match: resource.rules[].userDefinedFieldMatch
        • Name: resource.rules[].userDefinedFieldMatch.name
        • Values: resource.rules[].userDefinedFieldMatch.values
      • Source IP ranges: resource.rules[].srcIpRanges
      • Destination IP ranges: resource.rules[].destIpRanges
      • IP protocols: resource.rules[].ipProtocols
      • Source ports: resource.rules[].srcPorts
      • Destination ports: resource.rules[].destPorts
      • Source region codes: resource.rules[].srcRegionCodes
      • Source ASNs: resource.rules[].srcAsns
      • Preconfigured WAF config: resource.rules[].preconfiguredWafConfig
      • Exclusions: resource.rules[].preconfiguredWafConfig.exclusions[]
        • Target rule set: resource.rules[].preconfiguredWafConfig.exclusions[].targetRuleSet
        • Target rule IDs: resource.rules[].preconfiguredWafConfig.exclusions[].targetRuleIds[]
        • Request headers to exclude: resource.rules[].preconfiguredWafConfig.exclusions[].requestHeadersToExclude[]
        • Value: resource.rules[].preconfiguredWafConfig.exclusions[].requestHeadersToExclude[].val
        • Operation: resource.rules[].preconfiguredWafConfig.exclusions[].requestHeadersToExclude[].op
        • Request cookies to exclude: resource.rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[]
        • Value: resource.rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[].val
        • Operation: resource.rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[].op
        • Request query params to exclude: resource.rules[].preconfiguredWafConfig.exclusions[].requestQueryParamsToExclude[]
        • Value: resource.rules[].preconfiguredWafConfig.exclusions[].requestQueryParamsToExclude[].val
        • Operation: resource.rules[].preconfiguredWafConfig.exclusions[].requestQueryParamsToExclude[].op
        • Request URIs to exclude: resource.rules[].preconfiguredWafConfig.exclusions[].requestUrisToExclude[]
        • Value: resource.rules[].preconfiguredWafConfig.exclusions[].requestUrisToExclude[].val
        • Operation: resource.rules[].preconfiguredWafConfig.exclusions[].requestUrisToExclude[].op
      • Redirect options: resource.rules[].redirectOptions[]
      • Type: resource.rules[].redirectOptions[].type
      • Target: resource.rules[].redirectOptions[].target
      • Rate limit options: resource.rules[].rateLimitOptions[]
      • Rate limit threshold: resource.rules[].rateLimitOptions[].rateLimitThreshold
        • Count: resource.rules[].rateLimitOptions[].rateLimitThreshold.count
        • Interval seconds: resource.rules[].rateLimitOptions[].rateLimitThreshold.intervalSec
      • Conform action: resource.rules[].rateLimitOptions[].conformAction
      • Exceed action: resource.rules[].rateLimitOptions[].exceedAction
      • Exceed redirect options: resource.rules[].rateLimitOptions[].exceedRedirectOptions
        • Type: resource.rules[].rateLimitOptions[].exceedRedirectOptions.type
        • Target: resource.rules[].rateLimitOptions[].exceedRedirectOptions.target
      • Exceed action RPC status: resource.rules[].rateLimitOptions[].exceedActionRpcStatus
        • Code: resource.rules[].rateLimitOptions[].exceedActionRpcStatus.code
        • Message: resource.rules[].rateLimitOptions[].exceedActionRpcStatus.message
      • Enforce on key: resource.rules[].rateLimitOptions[].enforceOnKey
      • Enforce on key name: resource.rules[].rateLimitOptions[].enforceOnKeyName
      • Enforce on key configs: resource.rules[].rateLimitOptions[].enforceOnKeyConfigs
        • Enforce on key type: resource.rules[].rateLimitOptions[].enforceOnKeyConfigs.enforceOnKeyType
        • Enforce on key name: resource.rules[].rateLimitOptions[].enforceOnKeyConfigs.enforceOnKeyName
      • Ban threshold: resource.rules[].rateLimitOptions[].banThreshold
        • Count: resource.rules[].rateLimitOptions[].banThreshold.count
        • Interval seconds: resource.rules[].rateLimitOptions[].banThreshold.intervalSec
      • Ban duration seconds: resource.rules[].rateLimitOptions[].banDurationSec
      • Redirect target: resource.rules[].redirectTarget
      • Rule number: resource.rules[].ruleNumber
    • Adaptive protection config: resource.adaptiveProtectionConfig
      • Layer 7 DDoS defense config: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig
      • Enable: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.enable
      • Rule visibility: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.ruleVisibility
      • Threshold configs: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[]
        • Name: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].name
        • Auto deploy load threshold: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployLoadThreshold
        • Auto deploy confidence threshold: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployConfidenceThreshold
        • Auto deploy impacted baseline threshold: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployImpactedBaselineThreshold
        • Auto deploy expiration seconds: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployExpirationSec
        • Detection load threshold: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionLoadThreshold
        • Detection absolute QPS: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionAbsoluteQps
        • Detection relative to baseline QPS: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionRelativeToBaselineQps
        • Traffic granularity configs: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[]
        • Type: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].type
        • Value: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].value
        • Enable each unique value: resource.adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].enableEachUniqueValue
      • Auto deploy config: resource.adaptiveProtectionConfig.autoDeployConfig
      • Load threshold: resource.adaptiveProtectionConfig.autoDeployConfig.loadThreshold
      • Confidence threshold: resource.adaptiveProtectionConfig.autoDeployConfig.confidenceThreshold
      • Impacted baseline threshold: resource.adaptiveProtectionConfig.autoDeployConfig.impactedBaselineThreshold
      • Expiration seconds: resource.adaptiveProtectionConfig.autoDeployConfig.expirationSec
    • Advanced options config: resource.advancedOptionsConfig
      • JSON parsing: resource.advancedOptionsConfig,jsonParsing
      • JSON custom config: resource.advancedOptionsConfig,jsonCustomConfig
      • Content types: resource.advancedOptionsConfig,jsonCustomConfig.contentTypes[]
      • Log level: resource.advancedOptionsConfig.logLevel
      • User IP request headers: resource.advancedOptionsConfig.userIpRequestHeaders[]
    • DDoS protection config: resource.ddosProtectionConfig
      • DDoS protection: resource.ddosProtectionConfig.ddosProtection
    • reCAPTCHA options config: resource.recaptchaOptionsConfig
      • Redirect site key: resource.recaptchaOptionsConfig.redirectSiteKey
    • Type: resource.type
    • User defined fields: resource.userDefinedFields[]
      • Name: resource.userDefinedFields[].name
      • Base: resource.userDefinedFields[].base
      • Offset: resource.userDefinedFields[].offset
      • Size: resource.userDefinedFields[].size
      • Mask: resource.userDefinedFields[].mask

  • Network Edge Security Service: compute.googleapis.com/NetworkEdgeSecurityService

    • Name: resource.name
    • Description: resource.description
    • Security policy: resource.securityPolicy

Defining custom constraints

A custom constraint is defined by the resources, methods, conditions, and actions that are supported by the service on which you are enforcing the organization policy. Conditions for your custom constraints are defined using Common Expression Language (CEL). For more information about how to build conditions in custom constraints using CEL, see the CEL section of Creating and managing organization policies.

Before you begin

  • If you haven't already, then set up authentication. Authentication is the process by which your identity is verified for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine by selecting one of the following options:

    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.

    REST

    To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.

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

      gcloud init

    For more information, see Authenticate for using REST in the Google Cloud authentication documentation.

* Ensure that you know your organization ID.

Required roles

To get the permissions that you need to manage organization policies for Google Cloud Armor resources, ask your administrator to grant you the following IAM roles:

For more information about granting roles, see Manage access to projects, folders, and organizations.

These predefined roles contain the permissions required to manage organization policies for Google Cloud Armor resources. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to manage organization policies for Google Cloud Armor resources:

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

You might also be able to get these permissions with custom roles or other predefined roles.

Set up a custom constraint

You can create a custom constraint and set it up for use in organization policies by using the Google Cloud console or Google Cloud CLI.

Console

  1. In the Google Cloud console, go to the Organization policies page.

    Go to Organization policies

  2. Select the Project picker at the top of the page.

  3. From the Project picker, select the resource for which you want to set the organization policy.

  4. Click Custom constraint.

  5. In the Display name box, enter a human-friendly name for the constraint. This field has a maximum length of 200 characters. Don't use PII or sensitive data in constraint names, because they could be exposed in error messages.

  6. In the Constraint ID box, enter the name you want for your new custom constraint. A custom constraint must start with custom., and can only include uppercase letters, lowercase letters, or numbers, for example, custom.requireSecurityPolicyWithStandardJsonParsing. The maximum length of this field is 70 characters, not counting the prefix, for example, organizations/123456789/customConstraints/custom..

  7. In the Description box, enter a human-friendly description of the constraint to display as an error message when the policy is violated. This field has a maximum length of 2,000 characters.

  8. In the Resource type box, select the name of the Google Cloud REST resource containing the object and field you want to restrict. For example, compute.googleapis.com/SecurityPolicy.

  9. Under Enforcement method, select whether to enforce the constraint on the REST CREATE method only or on both the REST CREATE and UPDATE methods.

  10. To define a condition, click Edit condition.

    1. In the Add condition panel, create a CEL condition that refers to a supported service resource. This field has a maximum length of 1,000 characters.

    2. Click Save.

  11. Under Action, select whether to allow or deny the evaluated method if the above condition is met.

  12. Click Create constraint.

When you have entered a value into each field, the equivalent YAML configuration for this custom constraint appears on the right.

gcloud

To create a custom constraint using the Google Cloud CLI, create a YAML file.

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

Replace the following:

  • ORGANIZATION_ID: your organization ID, such as 123456789.

  • CONSTRAINT_NAME: the name you want for your new custom constraint. A custom constraint must start with custom., and can only include uppercase letters, lowercase letters, or numbers, for example, custom.requireSecurityPolicyWithStandardJsonParsing. The maximum length of this field is 70 characters, not counting the prefix, for example, organizations/123456789/customConstraints/custom.

  • RESOURCE_NAME: the name (not the URI) of the Compute Engine API REST resource containing the object and field you want to restrict. For example, SecurityPolicy.

  • METHOD1,METHOD2,...: a list of RESTful methods for which to enforce the constraint. Can be CREATE or CREATE and UPDATE.

  • CONDITION: a CEL condition that is written against a representation of a supported service resource. This field has a maximum length of 1,000 characters. See Supported resources for more information about the resources available to write conditions against.

  • ACTION: the action to take if the condition is met. This can be either ALLOW or DENY.

  • DISPLAY_NAME: a human-friendly name for the constraint. This field has a maximum length of 200 characters.

  • DESCRIPTION: a human-friendly description of the constraint to display as an error message when the policy is violated. This field has a maximum length of 2,000 characters.

For more information about how to create a custom constraint, see Defining custom constraints.

After you have created the YAML file for a new custom constraint, you must set it up to make it available for organization policies in your organization. To set up a custom constraint, use the gcloud org-policies set-custom-constraint command: 
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
Replace CONSTRAINT_PATH with the full path to your custom constraint file. For example, /home/user/customconstraint.yaml. Once completed, your custom constraints are available as organization policies in your list of Google Cloud organization policies. To verify that the custom constraint exists, use the gcloud org-policies list-custom-constraints command: 
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
Replace ORGANIZATION_ID with the ID of your organization resource. For more information, see Viewing organization policies.

Enforce a custom constraint

You can enforce a boolean constraint by creating an organization policy that references it, and then applying that organization policy to a Google Cloud resource.

Console

  1. In the Google Cloud console, go to the Organization policies page.

    Go to Organization policies

  2. From the project picker, select the project for which you want to set the organization policy.
  3. From the list on the Organization policies page, select your constraint to view the Policy details page for that constraint.
  4. To configure the organization policy for this resource, click Manage policy.
  5. On the Edit policy page, select Override parent's policy.
  6. Click Add a rule.
  7. In the Enforcement section, select whether enforcement of this organization policy is on or off.
  8. Optional: To make the organization policy conditional on a tag, click Add condition. Note that if you add a conditional rule to an organization policy, you must add at least one unconditional rule or the policy cannot be saved. For more information, see Setting an organization policy with tags.
  9. If this is a custom constraint, you can click Test changes to simulate the effect of this organization policy. For more information, see Test organization policy changes with Policy Simulator.
  10. To finish and apply the organization policy, click Set policy. The policy requires up to 15 minutes to take effect.

gcloud

To create an organization policy that enforces a boolean constraint, create a policy YAML file that references the constraint: 

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true

Replace the following:

  • PROJECT_ID: the project on which you want to enforce your constraint.
  • CONSTRAINT_NAME: the name you defined for your custom constraint. For example, custom.requireSecurityPolicyWithStandardJsonParsing.

To enforce the organization policy containing the constraint, run the following command: 

    gcloud org-policies set-policy POLICY_PATH

Replace POLICY_PATH with the full path to your organization policy YAML file. The policy requires up to 15 minutes to take effect.

Example: Create a constraint that requires all security policies to have standard JSON parsing enabled

This constraint prevents security policies from being created if they don't have standard JSON parsing enabled.

gcloud

  1. Create a requireStandardJsonParsing.yaml constraint file with the following information.

    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.

    Replace ORGANIZATION_ID with your organization ID.

  2. Set the custom constraint.

    gcloud org-policies set-custom-constraint requireStandardJsonParsing.yaml

  3. Create a requireStandardJsonParsing-policy.yaml policy file with the information provided in the following example and enforce the constraint at the project level. You can also set this constraint at the organization or folder level.

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

    Replace PROJECT_ID with your project ID.

  4. Enforce the policy.

    gcloud org-policies set-policy requireStandardJsonParsing-policy.yaml

  5. To test the constraint, create security policy without the JSON parsing field set.

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

    The output is similar to the following:

    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.

Pricing

The Organization Policy Service, including predefined and custom organization policies, is offered at no charge.

What's next