Google Workspace (formerly known as G Suite)

This guide covers the basics of setting up Pomerium to use GCP and Google Workspace / G Suite as your identity provider.

caution

Google changes their configuration screens frequently. Please refer to Google's documentation for authoritative instructions.

• Setting up OAuth 2.0
• Perform Google Workspace Domain-Wide Delegation of Authority

Setting up OAuth 2.0

You need OAuth 2.0 credentials, including a client ID and client secret, to authenticate users.

Create OAuth 2.0

Log in to your Google account and go to the APIs & services.

1. Navigate to Credentials using the left-hand menu. If you're not already in a project, you can select one here.

2. On the Credentials page, click Create credentials and choose OAuth Client ID.

caution

If you don't currently have an OAuth consent page configured, Google will not allow you to create credentials until this is completed. Please follow Google's instructions for doing so.

1. For the Application type choose Web application.

2. Give the client ID a Name, and add an Authorized redirect URI. The redirect URI format is https://${authenticate_service_url}/oauth2/callback (e.g.https://authenticate.localhost.pomerium.io/oauth2/callback).

Click Create once complete.

1. The Google Cloud Console will display your Client ID and Client Secret. Temporarily save these values to import into Pomerium later.

Configure Pomerium

Edit config.yaml or set your environment variables to connect Pomerium to Google:

config.yaml

/etc/pomerium/config.yaml

idp_provider: 'google'
idp_client_id: 'yyyy.apps.googleusercontent.com'
idp_client_secret: 'xxxxxx'

Environment Variables

IDP_PROVIDER="google"
IDP_CLIENT_ID="yyyy.apps.googleusercontent.com"
IDP_CLIENT_SECRET="xxxxxx"

Getting Groups

Custom claims

Unfortunately, Google doesn't support getting groups data with a custom claim. To get and use groups data from your Google directory, you must enable directory sync in the Enterprise Console.

Pomerium Enterprise

See the Directory Sync page for more information about syncing directory data in the Enterprise Console.

Or, contact sales if you want to learn more about Pomerium Enterprise.

Set Up Directory Sync

Create a service account

In order for Pomerium to validate group membership, you must configure a service account with G-suite domain-wide delegation enabled:

1. Open the Service accounts page. If prompted, select a project.

2. Click + Create Service Account, enter a name and description for the service account. You can use the default service account ID, or choose a different, unique one. When done click Create and continue.

3. The next sections, labeled Grant this service account access to project and Grant users access to this service account, are not required. Click Continue to both, and then Create.

4. Select your new service account, and click on the KEYS tab. Select Add key, then Create new key. In the side panel, select the JSON format for your key:

5. Click Create. Your new public/private key pair is generated and downloaded to your machine; it serves as the only copy of this key. For information on how to store it securely, see Managing service account keys.

6. Click Close on the Private key saved to your computer dialog, then click ← to return to the table of your service accounts.

Enable domain-wide delegation

Next, we need to enable domain-wide delegation:

1. Locate the newly-created service account in the table. Under Actions, click Manage Details.

2. In the service account details, click Advanced settings. Show domain-wide delegation, then ensure the Enable G Suite Domain-wide Delegation checkbox is checked.

   caution

   Domain-wide delegation may not be possible from here, depending on what type of Google account you have, as well as Google's updates to their interface. Consult their documentation on Domain-Wide Delegation of Authority as needed.

   If you haven't yet configured your app's OAuth consent screen, you must do so before you can enable domain-wide delegation. Follow the on-screen instructions to configure the OAuth consent screen, then repeat the above steps and re-check the checkbox.

3. Click Save to update the service account, and return to the table of service accounts. A new column, Domain-wide delegation, can be seen. Click View Client ID, to obtain and make a note of the client ID.

Set directory permissions for Workspaces

Next, we need to give that service account permissions on the G Suite / Workspace side of the house.

1. From your Google Workspace domain's Admin console Main menu, go to Security > Access and data control > API controls.

2. In the Domain wide delegation pane, select Manage Domain Wide Delegation.

3. Click Add new.

4. In the Client ID field, enter the client ID obtained from the service account creation steps above.

5. In the OAuth Scopes field, enter a comma-delimited list of the scopes required for your application (for a list of possible scopes, see Authorize requests). At a minimum, include the following scopes:

   • https://www.googleapis.com/auth/admin.directory.group.readonly
   • https://www.googleapis.com/auth/admin.directory.user.readonly

6. Click the Authorize button.

Configure Pomerium Enterprise Console

Under Settings → Identity Providers:

1. Select Google as the identity provider

2. In the Impersonate User field, enter an email address to impersonate

   note

   You must enter a valid user email address available in your Google Workspace directory, not a service account email address.

3. Upload the JSON file from earlier