This page guides you through the process of securing your SaaS applications through the Chrome Enterprise Premium secure gateway.
A Chrome Enterprise Premium secure gateway functions as a forward proxy, enforcing a zero trust access framework and delivering granular, context-aware control over who accesses your SaaS applications.
How securing access to SaaS applications works
Following is a high level overview of how a secure gateway protects your SaaS applications:
- Client-side browser settings route application traffic through a secure gateway proxy.
- The secure gateway checks context-aware access policies to authorize client (user and device) access.
- If client access is allowed, the gateway forwards traffic to the application using unique source IP addresses assigned to that gateway and Google Cloud region. These assigned IP addresses are reserved exclusively for the gateway that you create and cannot be used by other users or gateways. To control access, you can add these dedicated source IP addresses to an allowlist in your SaaS application.
Before you begin
Before setting up the secure gateway, verify that you have the following:
- A Chrome Enterprise Premium license
- Access to the Google Admin console with an administrator account
- A Google Cloud project with an assigned billing account and the following API enabled: BeyondCorp API
The following Identity and Access Management (IAM) role granted to the administrator setting things up: Project level: Cloud BeyondCorp Admin (
beyondcorp.admin).A SaaS application that you want to protect. The application must support
IP allowlistingto enforce security checks by the Secure Gateway.
Limitations
A Chrome Enterprise Premium secure gateway has the following limitations:
- IPv6 connectivity: Chrome Enterprise Premium secure gateway doesn't support SaaS applications that use IPv6 connectivity.
- Identity provider as a SaaS application: An Identity provider must not be configured as a SaaS application to be protected by the secure gateway, if the end-user's authentication with Secure Gateway is dependent on the same IdP.
Set up your shell environment
To streamline the setup process and interact with the secure gateway APIs, define the following environment variables in your working shell.
General parameters
API="beyondcorp.googleapis.com" API_VERSION=v1 PROJECT_ID=
PROJECT_IDAPPLICATION_ID=APPLICATION_IDAPPLICATION_DISPLAY_NAME="APPLICATION_DISPLAY_NAME" HOST_NAME=HOST_NAMEReplace the following:
PROJECT_ID: The ID of the project where the secure gateway is created.APPLICATION_ID: The ID of your application, such asgithub. The name can be up to 63 characters, and can contain lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character can be a letter or number.APPLICATION_DISPLAY_NAME: The human-readable name to display.HOST_NAME: The hostname of your application. For example,github.com. The hostname can be up to 253 characters long, and must adhere to one of the following formats:- A valid IPv4 address
- A valid IPv6 address
- A valid DNS name
- An asterisk (*)
- An asterisk (*) followed by a valid DNS name
Secure gateway parameters
SECURITY_GATEWAY_ID=
SECURITY_GATEWAY_IDSECURITY_GATEWAY_DISPLAY_NAME="SECURITY_GATEWAY_DISPLAY_NAME"Replace the following:
SECURITY_GATEWAY_ID: The ID of the secure gateway. The ID can be up to 63 characters, and can contain lowercase letters, numbers, and hyphens. The first character should be a letter, and the last character can be a letter or number.SECURITY_GATEWAY_DISPLAY_NAME: The human-readable name of the secure gateway. The name can be up to 63 characters long and can only contain printable characters.
Create a secure gateway
A Chrome Enterprise Premium secure gateway is a fundamental building block for establishing secure connections to your applications. It allocates a dedicated project and network, providing isolation and security.
To create a secure gateway resource, use one of the following methods.
gcloud
Run the following command. For the --hubs flag, specify
one or more regions from the following list.
gcloud beyondcorp security-gateways create ${SECURITY_GATEWAY_ID} \
--project=${PROJECT_ID} \
--location=global \
--display-name="SECURITY_GATEWAY_DISPLAY_NAME" \
--hubs=us-central1
REST
Call the Create API method with the gateway details in the request
body. For the hubs object, specify one or more regions from the following
list.
curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-X POST \
-d '{ "display_name": "SECURITY_GATEWAY_DISPLAY_NAME", "hubs": { "us-central1": {} } }' \
"https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways?security_gateway_id=${SECURITY_GATEWAY_ID}"
The hubs represents the regional resources required for enabling egress
connectivity to the target application. You can have one hub for each region,
and each hub provides two IP addresses. You can specify the following regions:
africa-south1asia-east1asia-south1asia-south2asia-southeast1europe-central2europe-north1europe-southwest1europe-west1europe-west2europe-west3europe-west4europe-west8europe-west9northamerica-northeast1northamerica-northeast2northamerica-south1southamerica-east1southamerica-west1us-central1us-east1us-east4us-east5us-west1
Configure a SaaS application
After you create a secure gateway, you can configure your SaaS applications to use the secure gateway for secure access.
Get the IP addresses allocated by the secure gateway for each hub. Two IP addresses are allocated for a region.
gcloud
gcloud beyondcorp security-gateways describe ${SECURITY_GATEWAY_ID} \ --project=${PROJECT_ID} \ --location=global
REST
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}"
The following is a sample
GETresponse of a secure gateway withhubs. In the example,hubsare created in theus-central1andus-east1regions, and all of the IP addresses returned in the response must be allowed in the SaaS application.gcloud
createTime: 'CREATE_TIME' displayName: My security gateway hubs: us-central1: internetGateway: assignedIps: - IP_ADDRESS_1 - IP_ADDRESS_2 us-east1: internetGateway: assignedIps: - IP_ADDRESS_1 - IP_ADDRESS_2 name: projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID} state: RUNNING updateTime: 'UPDATE_TIME'
REST
{ "securityGateways": [ { "name": "projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}", "createTime": "CREATE_TIME", "updateTime": "UPDATE_TIME", "displayName": "My security gateway", "state": "RUNNING", "hubs": { "us-central1": { "internetGateway": { "assignedIps": [ "IP_ADDRESS_1", "IP_ADDRESS_2", ] } }, "us-east1": { "internetGateway": { "assignedIps": [ "IP_ADDRESS_1", "IP_ADDRESS_2", ] } } } } ] }
Add the IP addresses to the IP allowlist of your SaaS application. For example, for a GitHub application, you can follow this guide: Managing allowed IP addresses for your organization.
Create an application resource
The following information guides you through the process of setting up and configuring a secure gateway application resource.
Create a secure gateway application resource in Google Cloud
The Google Cloud application resource is a sub-resource of the secure
gateway resource. Create an application resource by calling the
Create
API.
gcloud
gcloud beyondcorp security-gateways applications create ${APPLICATION_ID} \ --project=${PROJECT_ID} \ --security-gateway=${SECURITY_GATEWAY_ID} \ --location=global \ --display-name="${APPLICATION_DISPLAY_NAME}" \ --endpoint-matchers="hostname=${HOST_NAME},ports=[443]"
REST
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -X POST \ -d "{ \"display_name\": \"${APPLICATION_DISPLAY_NAME}\", \"endpoint_matchers\": [{hostname: \"${HOST_NAME}\", ports: [443]}] }" \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}/applications?application_id=${APPLICATION_ID}"
Configure Google Chrome proxy mode
You can route application traffic through the secure gateway by applying a PAC file in the Chrome settings in the Google Admin console. To apply the PAC file, do the following:
Create or update a PAC file.
Create your first application by creating a
pac_config.jsfile using the following example PAC file.Update your existing
pac_config.jsfile and add the domains of your new application to the sites array, as shown in the following example PAC file.
function FindProxyForURL(url, host) { const PROXY = "HTTPS ingress.cloudproxy.app:443"; const sites = ["HOST_NAME"]; for (const site of sites) { if (shExpMatch(url, 'https://' + site + '/*') || shExpMatch(url, '*.' + site + '/*')) { return PROXY; } } return 'DIRECT'; }
Replace HOST_NAME with the hostname of your application—for example,
myapp.example.com.If you're using an existing PAC file that's not specific to a secure gateway, merge the PAC files by adding the domains of your application to the sites array.
Upload the file so that it's publicly downloadable. For example, you can upload the file to Cloud Storage, and make the file publicly downloadable by granting all of the users the Storage Object User role on the bucket.
To verify that the uploaded file is the latest version, you can adjust its caching behavior by setting the
Cache-Controlheader tono-cache. This setting prevents browsers and intermediate servers from storing a copy of the file, so that Chrome downloads the most recent version.For more information about
Cache-Controland how it affects browser caching, see Cache-Control header.Copy the public URL of the uploaded file.
Update proxy mode settings
- Go to the Google Admin console.
- Click Devices > Chrome > Settings.
- Select the organizational unit or group, and then click Proxy mode.
- In Proxy mode, select Always use the proxy auto-config specified below and enter the URL of the PAC file from Cloud Storage.
- To save the proxy mode settings, click Save.
Configure an access policy
You can apply an access policy to control access at either the secure gateway level, which affects all associated applications, or at the individual application level for more granular control.
Safely update an access policy
The setIamPolicy command replaces the entire existing policy with the one that
you provide. To avoid accidentally removing existing permissions, we recommend
that you use the following "read-modify-write" pattern. This pattern helps
prevent accidental removal of existing permissions.
Read: First, get the current access policy.
Modify: Edit the policy file locally to add or change permissions.
Write: Apply your updated policy file.
Get the current policy
Retrieve the current policy before making any changes.
The etag field in the policy acts as a version identifier. It prevents
conflicting updates if multiple administrators make changes simultaneously.
The following command retrieves the policy and saves it to a file named
policy.json.
gcloud
gcloud beta beyondcorp security-gateways applications get-iam-policy APPLICATION_ID \ --security-gateway=SECURITY_GATEWAY_ID \ --project=PROJECT_ID \ --location=global > policy.json
Replace the following:
APPLICATION_ID: the ID of the application resourceSECURITY_GATEWAY_ID: the ID of the security gatewayPROJECT_ID: the ID of the project where the security gateway is configured
REST
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://${API}/${API_VERSION}/projects/PROJECT_ID/locations/global/securityGateways/SECURITY_GATEWAY_ID/applications/APPLICATION_ID:getIamPolicy" > policy.json
Replace the following:
PROJECT_ID: the ID of the project where the security gateway is configuredSECURITY_GATEWAY_ID: the ID of the security gatewayAPPLICATION_ID: the ID of the application resource
The command creates a policy.json file that contains the current
policy.
Modify the policy file
Open the policy.json file in a text editor. To grant a group access to use the
secure gateway, add the group to the members list for the
roles/beyondcorp.securityGatewayUser role.
The policy.json file is similar to the following example:
{
"version": 3,
"bindings": [
{
"role": "roles/beyondcorp.securityGatewayUser",
"members": [
"group:existing-group@example.com"
]
}
],
"etag": "BwXN8_d-bOM="
}
To add an additional group, add a new entry to the members array. Include a
comma after the preceding entry.
The following example adds new-group@example.com:
{
"version": 3,
"bindings": [
{
"role": "roles/beyondcorp.securityGatewayUser",
"members": [
"group:existing-group@example.com",
"group:new-group@example.com"
]
}
],
"etag": "BwXN8_d-bOM="
}
You can also add other types of members, such as serviceAccount, user, group,
principal, and principalSet, in policy bindings. See
IAM principals for more information.
Apply the updated policy
After editing and saving your policy.json file, apply it to the resource using
the setIamPolicy command. This command uses the etag from your file to
ensure that you update the correct version.
gcloud
gcloud beta beyondcorp security-gateways applications set-iam-policy APPLICATION_ID policy.json \ --security-gateway=SECURITY_GATEWAY_ID \ --project=PROJECT_ID \ --location=global
Replace the following:
APPLICATION_ID: the ID of the application resourceSECURITY_GATEWAY_ID: the ID of the security gatewayPROJECT_ID: the ID of the project where the security gateway is configured
REST
jq '{policy: .}' policy.json | curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d @- \ "https://${API}/${API_VERSION}/projects/PROJECT_ID/locations/global/securityGateways/SECURITY_GATEWAY_ID/applications/APPLICATION_ID:setIamPolicy"
Replace the following:
PROJECT_ID: the ID of the project where the security gateway is configuredSECURITY_GATEWAY_ID: the ID of the security gatewayAPPLICATION_ID: the ID of the application resource
Add a conditional access policy
You can also set access policies with conditions. Conditions specify requirements, such as a user's IP address originating from a specific location.
The following example policy grants access only if the source IP address is within a specified access level:
{
"version": 3,
"bindings": [
{
"role": "roles/beyondcorp.securityGatewayUser",
"members": [
"group:group@example.com"
],
"condition": {
"expression": "request.auth.access_levels.contains('accessPolicies/1234567890/accessLevels/in_us')",
"title": "Source IP must be in US"
}
}
],
"etag": "BwXN8_d-bOM="
}
To apply this policy, follow the steps described earlier.
Install the Chrome Enterprise Premium extension
The Chrome Enterprise Premium extension is an integral part of a secure gateway, and it helps with authentication. Install the extension for all of the users of the secure gateway. For information about deploying the extension, see View and configure apps and extensions. To install the Chrome Enterprise Premium extension, do the following:
- Go to the Google Admin console.
- Click Chrome browser > Apps & Extensions.
- Click the Users & browsers tab.
- To add the Chrome extension, click the + button.
Search for the following extension, and then require it to be installed for all of the users in the organization unit or group:
ekajlcmdfcigmdbphhifahdfjbkciflj
Click the installed extension, and in the Policy for extensions field, enter the following JSON value:
{ "securityGateway": { "Value": { "authentication": {}, "context": { "resource": "projects/PROJECT_ID/locations/global/securityGateways/SECURITY_GATEWAY_ID" } } } }
Replace the following:
PROJECT_ID: the ID of the project where the security gateway is configuredSECURITY_GATEWAY_ID: the ID of the security gateway
To save the configuration, click Save.
End user experience
When the setup is complete, end users who access the protected SaaS application are granted or denied access based on the access policy applied to the application.
Accessing the application in Chrome
The Chrome Enterprise Premium extension is required to direct traffic through the secure gateway. The extension handles the authentication between the user and the secure gateway. The extension is automatically installed through the domain policy.
When users access the SaaS application that you configured, their traffic goes through the secure gateway, which checks if they satisfy the access policy. If the users pass the access policy checks, they're granted access to the application.
When browser access to the application is rejected by the authorization policy,
users receive an Access denied message.