External key service setup for Google Workspace CSE
This section describes the steps required to use as an external key service for Google Workspace CSE. This involves deploying the Google Workspace CSE service in , as well as configuring a Key Access Control List Service (KACLS) and Identity Provider (IdP) in the Google Admin Console.
Open the web dashboard in a browser.
Log in to with the default admin identities.
Select the Google Workspace CSE (Client-side Encryption) service from the list of all available services on the Service Management page.
On the Google Workspace CSE service overview page, select [ Deploy ].
Specify a Service Name and Service Category, and select [ Next ].
(Optional) Select any roles and identities you want to be able to access the service, and select [ Next ].
In the Issuance Policy drop-down menu, select the Issuing CA issuance policy to use for Google CSE.
Select the Identity Provider Type you want to use, and fill in the required fields.
In the Service Account Info box, copy and paste in the information from your Google Service Account JSON file. Select [ Deploy ] when finished.
A message displays confirming that the Google Workspace CSE service was successfully deployed.
Selecting Manage Service opens a page where you can create new service users, view logs, read instructions for using the service, and manage access permissions.
After deployment, you can modify the Issuance Policy and Service Account Info for the service.
To modify the Issuance Policy:
Go to Deployed Services > Google Workspace CSE (Client-side Encryption).
In the management menu, select [ Edit Service ].
Under Issuance Policy, use the drop-down list to select a different Issuance Policy.
Select [ Save ] at the bottom of the window.
To modify the Service Account:
Go to Deployed Services > Google Workspace CSE (Client-side Encryption).
In the management menu, select [ Edit Service ].
In the Service Account Info box, copy and paste in the information from your Google Service Account JSON file for your new service account.
Select [ Save ] at the bottom of the window.
This section covers the Key Access Control List Service (KACLS) and Identity Provider (Idp) configuration steps. KACLS is the external key service (such as ) that uses this API to control access to encryption keys stored in an external system. The IdP is the service that authenticates users before they can encrypt files or access encrypted files.
This integration uses VirtuCrypt as the IdP for demonstration purposes, but you can use any IdP that supports OAuth.
Sign in to your Google admin console.
Sign in using an account with super administrator privileges.
In the main menu, select Security > Access and data control > Client-side encryption.
Select the External key service card to open it.
Select Add external key service.
Enter a name for your key service.
Enter the URL for your key service (such as https://<server ip>/v0/key-encrypt/client).
Google requires this connection to be TLS, with a publicly-trusted certificate. The connection can be through NAT or reverse proxy.
To confirm that Google Workspace can communicate with the external key service, select [ Test connection ].
To close the card, select [ Continue ].
To connect Google Workspace to your IdP, you can use a .well-known file or the Admin console. After establishing the connection, you need to allowlist your IdP in the Admin console.
This section demonstrates connecting Google Workspace to your IdP by using the Admin console. However, this method should serve as a fallback method for the .well-known file method. Refer to the following Google Workspace documentation instructions on connecting Google Workspace to your IdP using a .well-known file: https://support.google.com/a/answer/10743588#config_wellknown&zippy=%2Coption-to-connectto-your-idp-using-a-well-known-file
Sign in to your Google admin console.
Sign in using an account with super administrator privileges.
In the main menu, select Security > Access and data control > Client-side encryption.
Under Identity provider configuration, select Configure IdP fallback.
Enter the details of your IdP:
- In the Name field, specify a descriptive name to help identify your IdP. It displays in IdP messages for users.
- In the Client ID field, specify the OpenID Connect (OIDC) client ID that the CSE client application uses to acquire a JSON Web Token (JWT). If you use a third party IDP: Generate this ID by using your IdP admin console. If you use Google Identity: Generate this ID by using the Google Cloud Platform (GCP) Admin console. For details, go to Create a client ID for Google identity.
- In the Discovery URI field, specify the OIDC discovery URL, as defined in this OpenID specification. If you use a third-party IdP: Your IdP provides you with this URL, which usually ends with /.wellknown/openid-configuration. If you use Google identity: Use https://accounts.google.com/.well-known/openidconfiguration. Note Configure your discovery URI to enable origin URLs for Cross-Origin Resource Sharing (CORS) calls, as follows:
- Methods: GET
- Allowed origins:
- https://admin.google.com
- https://client-side-encryption.google.com
- https://krahsc.google.com/callback
- https://krahsc.google.com/oidc/cse/callback
- https://krahsc.google.com/oidc/drive/callback
- https://krahsc.google.com/oidc/gmail/callback
- https://krahsc.google.com/oidc/meet/callback
- https://krahsc.google.com/oidc/calendar/callback
- https://krahsc.google.com/oidc/docs/callback
- https://krahsc.google.com/oidc/sheets/callback
- https://krahsc.google.com/oidc/slides/callback
- https://client-side-encryption.google.com/callback
- https://client-side-encryption.google.com/oidc/cse/callback
- https://client-side-encryption.google.com/oidc/drive/callback
- https://client-side-encryption.google.com/oidc/gmail/callback
- https://client-side-encryption.google.com/oidc/meet/callback
- https://client-side-encryption.google.com/oidc/calendar/callback
- https://client-side-encryption.google.com/oidc/docs/callback
- https://client-side-encryption.google.com/oidc/sheets/callback
- https://client-side-encryption.google.com/oidc/slides/callback
- Select [ Test connection ]. If Google Workspace can connect to your IdP, the Connection success message appears.
- Click Add provider to close the card.