Manage VPC firewall rule 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.

Cloud NGFW supported resources

For VPC firewall rules, you can set custom constraints on the following resources and fields.

Firewall: compute.googleapis.com/Firewall
- Name: resource.name
- Description: resource.description
- Network: resource.network
- Priority: resource.priority
- Source ranges: resource.sourceRanges[]
- Destination ranges: resource.destinationRanges[]
- Source tags: resource.sourceTags[]
- Target tags: resource.targetTags[]
- Allow rules: resource.allowed[]
  - Protocol: resource.allowed[].IPProtocol
  - Ports: resource.allowed[].ports[]
- Deny rules: resource.denied[]
  - Protocol: resource.denied[].IPProtocol
  - Ports: resource.denied[].ports[]
- Direction: resource.direction
- Is disabled: resource.disabled

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.

In addition to the standard CEL functions, you can use the custom CEL function containsFirewallPort to create custom constraints for firewall rules. You can use this function to create a constraint that refers to a particular protocol, or a protocol and port combination.

Protocol only: resource.allowed.containsFirewallPort('PROTOCOL')
Protocol and port: resource.allowed.containsFirewallPort('PROTOCOL', 'PORT_NUMBER')

For information about allowed protocols, see Protocols and ports.

Before you begin

If you haven't already, set up authentication. Authentication verifies your identity 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. After installation, initialize the Google Cloud CLI by running the following command:
  gcloud init
  If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
  
  Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.
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.
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 Cloud Next Generation Firewall resources, ask your administrator to grant you the following IAM roles:

Organization policy administrator (roles/orgpolicy.policyAdmin) on the organization resource
To test the constraints:
- Compute Network Admin (roles/compute.networkAdmin) on the project
- Service Account User (roles/iam.serviceAccountUser) on the project

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 Cloud Next Generation Firewall 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 Cloud Next Generation Firewall 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

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

Go to Organization policies
Select the Project picker at the top of the page.
From the Project picker, select the resource for which you want to set the organization policy.
Click Custom constraint.
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.
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.httpFirewallRule. The maximum length of this field is 70 characters, not counting the prefix, for example, organizations/123456789/customConstraints/custom..
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.
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/Firewall.
Under Enforcement method, select whether to enforce the constraint on the REST CREATE method only or on both the REST CREATE and UPDATE methods.
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.
Under Action, select whether to allow or deny the evaluated method if the previous condition is met.
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.httpFirewallRule. 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, Firewall.
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.

Console

To create a custom constraint, do the following:

In the Google Cloud console, go to the Organization policies page.
Go to Organization policies
From the project picker, select the project that you want to set the organization policy for.
Click Custom constraint.
In the Display name box, enter a human-readable name for the constraint. This name is used in error messages and can be used for identification and debugging. Don't use PII or sensitive data in display names because this name could be exposed in error messages. This field can contain up to 200 characters.
In the Constraint ID box, enter the name that you want for your new custom constraint. A custom constraint can only contain letters (including upper and lowercase) or numbers, for example custom.disableGkeAutoUpgrade. This field can contain up to 70 characters, not counting the prefix (custom.), for example, organizations/123456789/customConstraints/custom. Don't include PII or sensitive data in your constraint ID, because it could be exposed in error messages.
In the Description box, enter a human-readable description of the constraint. This description is used as an error message when the policy is violated. Include details about why the policy violation occurred and how to resolve the policy violation. Don't include PII or sensitive data in your description, because it could be exposed in error messages. This field can contain up to 2000 characters.
In the Resource type box, select the name of the Google Cloud REST resource containing the object and field that you want to restrict—for example, container.googleapis.com/NodePool. Most resource types support up to 20 custom constraints. If you attempt to create more custom constraints, the operation fails.
Under Enforcement method, select whether to enforce the constraint on a REST CREATE method or on both CREATE and UPDATE methods. If you enforce the constraint with the UPDATE method on a resource that violates the constraint, changes to that resource are blocked by the organization policy unless the change resolves the violation.

Not all Google Cloud services support both methods. To see supported methods for each service, find the service in Supported services.

To define a condition, click Edit condition.

In the Add condition panel, create a CEL condition that refers to a supported service resource, for example, resource.management.autoUpgrade == false. This field can contain up to 1000 characters. For details about CEL usage, see Common Expression Language. For more information about the service resources you can use in your custom constraints, see Custom constraint supported services.
Click Save.

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

The deny action means that the operation to create or update the resource is blocked if the condition evaluates to true.

The allow action means that the operation to create or update the resource is permitted only if the condition evaluates to true. Every other case except ones explicitly listed in the condition is blocked.

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, create a YAML file using the following format:

      name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
      resourceTypes:
      - RESOURCE_NAME
      methodTypes:
      - CREATE
      condition: "CONDITION"
      actionType: ACTION
      displayName: DISPLAY_NAME
      description: DESCRIPTION

Replace the following:

ORGANIZATION_ID: your organization ID, such as 123456789.
CONSTRAINT_NAME: the name that you want for your new custom constraint. A custom constraint can only contain letters (including upper and lowercase) or numbers, for example, custom.httpFirewallRule. This field can contain up to 70 characters.
RESOURCE_NAME: the fully qualified name of the Google Cloud resource containing the object and field that you want to restrict. For example, compute.googleapis.com/Firewall.
CONDITION: a CEL condition that is written against a representation of a supported service resource. This field can contain up to 1000 characters. For example, "resource.allowed.containsFirewallPort('tcp', '80')".

For more information about the resources available to write conditions against, see Supported resources.

ACTION: the action to take if the condition is met. Can only be ALLOW.

The allow action means that if the condition evaluates to true, the operation to create or update the resource is permitted. This also means that every other case except the one explicitly listed in the condition is blocked.

DISPLAY_NAME: a human-friendly name for the constraint. This field can contain up to 200 characters.
DESCRIPTION: a human-friendly description of the constraint to display as an error message when the policy is violated. This field can contain up to 2000 characters.

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.

After this operation is complete, 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 constraint by creating an organization policy that references it, and then applying that organization policy to a Google Cloud resource.

Console

In the Google Cloud console, go to the Organization policies page.
Go to Organization policies
From the project picker, select the project that you want to set the organization policy for.
From the list on the Organization policies page, select your constraint to view the Policy details page for that constraint.
To configure the organization policy for this resource, click Manage policy.
On the Edit policy page, select Override parent's policy.
Click Add a rule.
In the Enforcement section, select whether this organization policy is enforced or not.
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.
Click Test changes to simulate the effect of the organization policy. For more information, see Test organization policy changes with Policy Simulator.
To enforce the organization policy in dry-run mode, click Set dry run policy. For more information, see Create an organization policy in dry-run mode.
After you verify that the organization policy in dry-run mode works as intended, set the live policy by clicking Set policy.

gcloud

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

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

Replace the following:

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

To enforce the organization policy in dry-run mode, run the following command with the dryRunSpec flag:

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=dryRunSpec

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

After you verify that the organization policy in dry-run mode works as intended, set the live policy with the org-policies set-policy command and the spec flag:

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=spec

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 restricts creating firewall rules that allow SSH connections

This constraint prevents the creation of ingress firewall rules that allow SSH connections from any IP address range other than the following ranges:

10.0.0.0/8: an internal IP address range used in the VPC network.
192.168.0.0/16: an internal IP address range used in the VPC network.
35.235.240.0/20: the IP address range used by Identity-Aware Proxy (IAP) for TCP forwarding.

All IP address ranges that include TCP port 22 are also blocked.

gcloud

Create a restrictSshRanges.yaml constraint file with the following information.

name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictSshRanges
resource_types: compute.googleapis.com/Firewall
condition: "resource.direction.matches('INGRESS') && resource.allowed.containsFirewallPort('tcp', '22') && !resource.sourceRanges.all(range, range == '35.235.240.0/20' || range.startsWith('10.') || range.startsWith('192.168.'))"
action_type: DENY
method_types: CREATE
display_name: Limit firewall rules that allow ingress SSH traffic
description: Firewall rules that allow ingress SSH traffic can only be created with allowed source ranges.

Replace ORGANIZATION_ID with your organization ID.

Set the custom constraint.

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

Create a restrictSshRanges-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.restrictSshRanges
    spec:
      rules:
      – enforce: true
```
Replace PROJECT_ID with your project ID.

Enforce the policy.

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

To test the constraint, create an auto mode VPC network.

gcloud compute firewall-rules create ssh-firewall-rule \
    --action=ALLOW  --direction=INGRESS  --network=NETWORK \
    --priority=1000  --rules=tcp:22  --source-ranges=0.0.0.0/0

Replace NETWORK with your network name. The output is similar to the following:

ERROR: (gcloud.compute.networks.create) Could not fetch resource:
- Operation denied by custom org policy: [customConstraints/custom.restrictSshRanges] : Firewall rules that allow ingress SSH traffic can only be created with allowed source ranges.

Example: Restrict ingress traffic to only standard web ports

This constraint blocks the creation of ingress firewall rules that allow traffic from 0.0.0.0/0 on TCP ports other than 80 or 443.

gcloud

Create a restrictWebPorts.yaml constraint file with the following information.

name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictWebPorts
resource_types: compute.googleapis.com/Firewall
condition: "resource.direction.matches('INGRESS') && resource.sourceRanges.all(range, range == '0.0.0.0/0') && resource.allowed.exists(allowed, allowed.IPProtocol != 'tcp' || allowed.ports.exists(port, port != '80' && port != '443'))"
action_type: DENY
method_types: CREATE
display_name: Limit firewall rules that allow ingress traffic from 0.0.0.0/0
description: Firewall rules that allow ingress traffic from 0.0.0.0/0 on TCP ports other than 80 or 443.

Replace ORGANIZATION_ID with your organization ID.

Set the custom constraint.

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

Create a restrictWebPorts-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.restrictWebPorts
    spec:
      rules:
      – enforce: true
```
Replace PROJECT_ID with your project ID.

Enforce the policy.

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

To test the constraint, create an auto mode VPC network.

gcloud compute firewall-rules create ssh-firewall-rule \
    --action=ALLOW  --direction=INGRESS  --network=NETWORK \
    --priority=1000  --rules=tcp:22  --source-ranges=0.0.0.0/0

Replace NETWORK with your network name. The output is similar to the following:

ERROR: (gcloud.compute.firewall-rules.create) Could not fetch resource:
- Operation denied by custom org policy: [customConstraints/custom.restrictWebPorts] : Firewall rules that allow ingress traffic from 0.0.0.0/0 on TCP ports other than 80 or 443.

Pricing

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

Manage VPC firewall rule resources by using custom constraints Stay organized with collections Save and categorize content based on your preferences.

Policy inheritance

Cloud NGFW supported resources

Defining custom constraints

Before you begin

Console

gcloud

REST

Required roles

Required permissions

Set up a custom constraint

Console

gcloud

Console

gcloud

Enforce a custom constraint

Console

gcloud

Example: Create a constraint that restricts creating firewall rules that allow SSH connections

gcloud

Example: Restrict ingress traffic to only standard web ports

gcloud

Pricing

What's next

Manage VPC firewall rule resources by using custom constraints