Skip to main content
This section describes how to configure the KMES Series 3 as an external key service for Google Workspace Client-side encryption (CSE). You complete some configuration in the KMES Series 3 application interface and some in the Google Admin Console.

​
Configure settings in the KMES Series 3 application interface

Complete the following tasks in the KMES interface:
  1. Define the Key Access Control List (KACL) URL.
  2. Enable the Host API commands.
The following sections describe how to perform these tasks.

​
Define the KACL URL

Perform the following steps to define the KACL URL for Google client-side encryption:
1
Log in to the KMES Series 3 application interface with the default Admin identities.
2
Go to the Administration > Configuration menu and select Google API options
3
In KACL URL, enter the URL for your key service (for example, https://<server ip>:<port>/kmes/v7/key-encrypt/client).
Google requires this connection to be TLS with a publicly trusted certificate. The connection can be through NAT or reverse proxy.
4
Select [ Save ] to finish.

​
Enable the commands

Perform the following steps to enable the required Host API commands:
1
Go to the Administration> Configuration menu and select Host API Options.
2
Select the KACL command, which enables Google client-side key wrap and unwrap.
3
Select [ Save ] to finish.

​
Configure settings in the Google Admin console

The Key Access Control List Service (KACLS) is your external key service (such as KMES Series 3) that uses an API to control access to encryption keys stored in an external system. The (Identity Provider) IdP, discussed in previous sections of this guide, authenticates users before they can encrypt files or access encrypted files. This integration uses VirtuCrypt as the IdP, but you can use any IdP that supports OAuth. Complete the following tasks in the Google Admin console for client-side encryption:
  1. Configure the KACLS.
  2. Configure the IdP.
The following sections describe how to perform these tasks.

​
Configure the KACLS

Perform the following steps to configure the KACLS:
1
Sign in to your Google admin console by using an account with super administrator privileges.
2
In the main menu, select Security> Access and data control> Client-side encryption.
3
Select the External key service card to open it.
4
Select [ Add external key service ].
5
Enter a name for your key service.
6
Enter the URL for your key service (such as https://<server ip>:<port>/kmes/v7/key-encrypt/client).
Google requires this connection to be TLS with a publicly trusted certificate. The connection can be through NAT or a reverse proxy.
7
To confirm that Google Workspace can communicate with the external key service, select [ Test connection ].
8
To close the card, select [ Continue ].

​
Configure the IdP

To connect Google Workspace to your IdP, you can use a .well-known file or the Admin console. After establishing the connection, you must allowlist your IdP in the Admin console. This section shows how to connect Google Workspace to your IdP by using the Admin console. However, this method serves as a fallback method for the .well-known file method. See 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-connect-to-your-idp-using-a-well-known-file
1
Sign in (admin.google.com/) to your Google admin console (support.google.com/a/answer/182076) by using an account with super administrator privileges (support.google.com/a/answer/2405986#super_admin).
2
In the main menu, select Security> Access and data control > Client-side encryption.
3
Under Identity provider configuration, select [ Configure IdP fallback ].
4
Enter the details of your IdP.
5
In Name, specify a descriptive name to help identify your IdP. This name displays in IdP messages for users.
6
In Client ID, specify the OpenID Connect (OIDC) client ID that the CSE client application uses to acquire a JSON Web Token (JWT) based on the following scenarios:
  • If you’re using a third-party IdP: Generate this ID by using your IdP admin console.
  • If you’re using Google identity: Generate this ID by using the Google Cloud Platform (GCP) Admin console. For instructions, go to the following link: Create a client ID for Google identity.
7
In Discovery URI, specify the OIDC discovery URL, as defined in this OpenID specification (openid.net/specs/openid-connect-discovery-1_0.html), based on the following scenarios:-If you’re using a third-party IdP: Your IdP provides you with this URL, which usually ends with /.wellknown/openid-configuration. -If you’re using Google identity: Use https://accounts.google.com/.well-known/openidconfiguration.Configure your discovery URI to allow 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
8
In the Grant type field, select the OAuth flow you want to use for OIDC based on the following scenarios:
  • If you’re using a third-party IdP: Use either the Implicit or Authorization code with PKCE grant type.
  • If you’re using Google identity: Use only the Implicit grant type.
9
Select [ Test Connection ].
If Google Workspace can connect to your IdP, the Connection success message displays.
10
Select [ Add Provider ] to close the card.