Difference between revisions of "G Suite Integration"

Jump to: navigation, search
[pending revision][pending revision]
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Synchronizing User Accounts with G Suite}}
 
{{DISPLAYTITLE:Synchronizing User Accounts with G Suite}}
 
{{Directory Services Preamble|G Suite account}}
 
{{Directory Services Preamble|G Suite account}}
 +
 +
<p class=msnote>Please note that on December 16th 2019 [https://go.mailstore.com/?lang=en&target=gsuite-lsa-restriction Google announced] to limit access to G Suite for less secure apps in the future.  This includes any MailStore Server version prior to 13, which therefore will no longer be able to authenticate users against G Suite when trying to log into MailStore Server.
 +
 +
In MailStore Server 13, support for modern authentication methods via OAuth 2.0 & OpenID Connect as per Google's recommendation was introduced. Although MailStore Server 13 still comes with support for IMAP-based authentication, this document only covers the setup using modern authentication methods as required by Google in the future.</p>
 +
 +
== Prerequisites and Recommendations ==
 +
* To comply with Google's requirements for ''Authorized redirect URIs'' of  OAuth 2.0 clients, MailStore Server must be accessible via an URI that ends with a public top-level domain. Google uses the list from https://publicsuffix.org for validation.
 +
* For best user experience, the certificate used by MailStore Server should be trusted by all client and the used Web Browsers. Using a certificate that is signed by an trusted certificate authority or [[Using_Lets_Encrypt_Certificates|using Let's Encrypt certificates]] is highly recommended.
  
 
== Register Project with Google ==
 
== Register Project with Google ==
Irregardless of whether own or third-party applications such as MailStore are supposed to interact with a G Suite account through Google APIs, they must be registered as a project with Google first. This is necessary to ensure that access by external applications is limited to a minimum and that each application uses its own set of credentials to authenticate itself.
+
Irregardless of whether own or third-party applications such as MailStore are supposed to interact with a G Suite account through Google APIs, they must be registered as a project with Google first. This is necessary to ensure that access by external applications is limited to a minimum and that each application uses its own set of credentials to authenticate with Google.
  
 
=== Create New Project ===
 
=== Create New Project ===
To register a project for MailStore with Google, and prepare the next steps, proceed as follows:
+
To register a project for MailStore Server with Google, proceed as follows:
  
* Go to the [https://console.developers.google.com/ Google Developers Console].
+
* Go to the [https://console.developers.google.com Google Developers Console].
* If prompted, login using a Google Account of you G Suite organization. A user with administrative privileges is highly recommend.  
+
* If prompted, login using a Google account of you G Suite organization. Logging in with a user that has admin privileges is highly recommend.  
* If no project exists, click ''Create'' on the dashboard. Otherwise open the ''Project'' drop-down list in the header bar and click ''New Project''.
+
* If no project exists, click ''Create Project'' on the dashboard. Otherwise open the project list by clicking on the project drop-down in the header bar and click ''New project''.
* Name the project, e.g. ''MailStore Server''. By default a random Project ID is assigned, which can be changed if desired.  
+
* Type in a meaningful name into the ''Project name'' field, e.g. "MailStore Server".
 +
* Verify that ''Organization'' matches the desired organization and adjust the ''Location'' if needed.
 
* Click on ''Create''.
 
* Click on ''Create''.
* Once the project has been created, ''APIs & Services'' is shown.
+
 
* Make sure that you have selected the newly created project. You can change the project by using the drop-down list.
+
Once the project has been created, make sure that it is selected in the project drop-down list before proceeding.  
  
 
==== Add API Libraries ====
 
==== Add API Libraries ====
* Select ''Library'' from the left navigation pane.
+
* Open the ''Navigation menu'' and select ''APIs & Services'' > ''Library''.
* In the ''API Library'', enable ''Admin SDK'' and ''Gmail API''.
+
* In the ''API Library'', search and enable the following APIs and services:
* Return to the project's dashboard by clicking on ''Google APIs'' in the top navigation bar.
+
*: <tt>Admin SDK</tt>
 +
*: <tt>Gmail API</tt>
  
 
==== Customize Consent Screen ====
 
==== Customize Consent Screen ====
* Select ''OAuth consent screen'' from the left navigation pane.
+
* Open the ''Navigation menu'' and select ''APIs & Services'' > ''OAuth consent screen''.
* Under ''User Type'' select ''Internal''.
+
* Under ''User Type'' select ''Internal''.
 
* Click ''Create''
 
* Click ''Create''
* Fill in the an '''Application name''', e.g. "MailStore Server"
+
* Type in a meaningful name into the ''Application name'' field, e.g. "MailStore Server"
 
* Click ''Save''.
 
* Click ''Save''.
  
 
=== Create Service Account ===
 
=== Create Service Account ===
A service account is needed for MailStore Server to authenticate with Google and request authorization to use certain Google APIs. The following steps describe the creation of such a service account.
+
A service account is required for MailStore Server to authenticate with Google and request authorization to use certain Google APIs to synchronize users and group, and to access user mailboxes. The following steps describe the creation of such a service account.
  
* Go to the [https://console.developers.google.com/ Google Developers Console].
+
* Open the ''Navigation menu'' and select ''APIs & Services'' > '''Credentials''.
* Click on ''Credentials''' in the left navigation pane.
 
 
* Click ''+ Create Credentials'' and select ''Service account'' from the drop-down list.
 
* Click ''+ Create Credentials'' and select ''Service account'' from the drop-down list.
* On the ''Create service account'' screen, enter a name for the service account. The ''Service account ID'' gets updated automatically based on the service account name, but can be changed if desired.
+
* On the ''Create service account'' page, enter a name for the service account, e.g. "MailStore Server Service".
* Click on ''Continue''.
+
* Enter a description such as "Service account for MailStore Server to synchronize users and access mailboxes"
 +
* Click ''Create''.
 
* The service account does not require permissions on project level, therefore do not select a role.
 
* The service account does not require permissions on project level, therefore do not select a role.
 
* Click on ''Continue''.
 
* Click on ''Continue''.
* Only grant other users access to this service account if absolutely necessary, which is typically not the case.
+
* Under ''Keys'' click on ''+ Create Key''.
* Click on ''Create Key'' in the ''Keys'' section.
+
* Select ''JSON'' as key type and click ''Create''.
* Select the ''JSON'' as key type and click on ''Create''.
+
* The JSON file will be downloaded automatically. Save the JSON file in a secure location as it allows access to cloud resources of your organization.
* The JSON file will be downloaded automatically. Save the JSON file (e.g. <tt>MailStore API Access-e035d2ad4f35.json</tt>) in a secure location as it allows access to cloud resources of your organization.
+
* Click ''Close'' and then ''Done''.
* Click on ''Close'' and then on ''Done'' to finish the creation of credentials.
+
* Edit the details of the newly created service account by clicking on the corresponding pencil icon.  
 
+
* Click ''Show Domain-wide Delegation''.
=== Perform Domain-Wide Delegation of Authority ===
+
* Tick the ''Enable G Suite Domain-wide Delegation'' box.
To grant the service account domain-wide access to your G Suite account, so called domain-wide delegation must be enabled as described in these steps:
+
* Click ''Save''.
  
* Click on the newly created service account to access its details.
+
On the ''Credentials'' page, there should be a service account listed under ''Service Accounts'' with a corresponding client listed under ''OAuth 2.0 Client IDs''.
* Click on ''Show Domain-wide Delegation''.
 
* Check the ''Enable G Suite Domain-wide Delegation'' box.
 
* Click on ''Save''.
 
  
As a result, a new ''OAuth 2.0 Client'' was created for the service account that has been created in the previous step.
+
=== Create OAuth 2.0 Client for User Authentication ===
 +
To allow users to log in to MailStore by authenticating with Google using the OpenID Connect mechanism, an OAuth 2.0 Client must be created as described below.
  
=== Creating OAuth 2.0 Client for User Authentication ===
+
* Open the ''Navigation menu'' and select ''APIs & Services'' > '''Credentials''.
To allow users to log into MailStore by authenticating with Google, another OAuth 2.0 Client must be created that is suitable for OpenID Connect.
 
 
 
* Click on ''Credentials''' in the left navigation pane.
 
 
* Click ''+ Create Credentials'' and select ''OAuth client ID'' from the drop-down list.
 
* Click ''+ Create Credentials'' and select ''OAuth client ID'' from the drop-down list.
 
* Select ''Web application'' as ''Application type''.
 
* Select ''Web application'' as ''Application type''.
* Enter a ''Name'', e.g. MailStore Server OpenID Connect.
+
* Enter a ''Name'', e.g. "MailStore Server OpenID Connect".
* In the ''Authorized redirect URIs'' section, click on ''+ Add URI''.
+
* Click ''+ Add URI'' under ''Authorized redirect URIs''.
* Enter the URI that is reachable by clients in the ''URIs'' field in the following scheme:
+
* Enter the URI that is reachable by clients in the ''URIs'' field using the the following scheme:
 
*:<tt>https://<host>.<domain.tld>[:<port>]/oidc/signin</tt>
 
*:<tt>https://<host>.<domain.tld>[:<port>]/oidc/signin</tt>
 +
* Click ''Create'' to finish.
 +
* Copy the client ID and client secret from the ''Your Client ID'' and ''Your Client Secret'' fields to a safe place and click ''OK''.
  
== Granting Access on G Suite Account to Project ==
+
== Grant Access on G Suite Account to Project ==
Once created, grant the newly created project fine-grained access to your G Suite account by defining the Google APIs it is allowed to use.
+
Once created, grant the new project fine-grained access to your G Suite account by defining the Google APIs it is allowed to use.
  
 
* Open the [https://admin.google.com/ Google Admin console] and log in with a G Suite domain admin.
 
* Open the [https://admin.google.com/ Google Admin console] and log in with a G Suite domain admin.
Line 77: Line 84:
 
* Click ''Authorize''.
 
* Click ''Authorize''.
  
== Accessing Directory Service Integration ==
+
== Configure MailStore Server ==
 +
After the project has been successfully set up on the Google side, MailStore Server can now be configured to synchronize and authenticate users with G Suite.
 +
 
 
{{Directory Services Accessing Configuration|G Suite|gapps_sync_01.png}}
 
{{Directory Services Accessing Configuration|G Suite|gapps_sync_01.png}}
  
== Connection to G Suite ==
+
==== Connection ====
For synchronization MailStore Server requires information on how to connect to the G Suite.  
+
For synchronization MailStore Server requires information on how to connect to the G Suite.
  
*'''Key ID'''<br/>To import the private key, select the JSON file (e.g. <tt>MailStore API Access-e035d2ad4f35.json</tt>) that has been generated by Google for the service account.
+
* '''Key ID'''<br/>To import the private key, select the JSON file hat has been generated by Google for the service account in the [[#Create_Service_Account|Create Service Account]] step.
*'''Service Account'''<br/>The service account is determined automatically from the JSON file.
+
* '''Service Account'''<br/>The service account is determined automatically from the JSON file.
*'''User Name'''<br/>The ''email address'' of a G Suite Administrator (e.g. ''admin@example.com'').
+
* '''User Name'''<br/>The email address of a G Suite Administrator (e.g. admin@example.com).
  
 
=== User Database Synchronization ===
 
=== User Database Synchronization ===
 
After configuring the connection settings as described above, you can specify filter criteria for the G Suite synchronization in this section.
 
After configuring the connection settings as described above, you can specify filter criteria for the G Suite synchronization in this section.
  
*'''Sync only these groups'''<br/>Choose one or several G Suite groups if you only want their members to be created as MailStore Server users. That way it's possible to exclude certain users from being synchronized to MailStore Server.
+
* '''Sync only these groups'''<br/>Choose one or several G Suite groups if you only want their members to be created as MailStore Server users. That way it's possible to exclude certain users from being synchronized to MailStore Server.
 +
 
 +
=== Authentication ===
 +
The authentication settings define how MailStore Server should authenticate users at login, that have been synchronized from G Suite.
 +
 
 +
* '''Method'''<br/>Ensure that ''OpenID Connect'' is selected. As mentioned in the introduction, the ''IMAP'' option is only available for backward compatibility.
 +
* '''Client ID'''<br/>Enter the client ID from the [[#Create_OAuth_2.0_Client_for_User_Authentication|Create_OAuth_2.0 Client…]] step.
 +
* '''Client Secret'''<br/>Enter the client secret from the [[#Create_OAuth_2.0_Client_for_User_Authentication|Create_OAuth_2.0 Client…]] step.
 +
* '''Redirect Url'''<br/>Enter the same redirect URI as defined in the [[#Create_OAuth_2.0_Client_for_User_Authentication|Create_OAuth_2.0 Client…]] step .
 +
 
 
{{Directory Services Options|G Suite Account}}
 
{{Directory Services Options|G Suite Account}}
 
{{Directory Services Assign Default Privileges|G Suite Account}}
 
{{Directory Services Assign Default Privileges|G Suite Account}}
Line 98: Line 116:
  
 
{{Directory Services Test Authentication}}
 
{{Directory Services Test Authentication}}
<p class="msnote">'''Important Notice:''' For authentication with G Suite to work, the setting ''Allow less secure apps'' of the respective G&nbsp;Suite user has to turned on if it has not been enforced for all users (see above).</p>
 
 
{{Directory Services Login with Directory Services Credentials|G Suite Account|mads_ldapauth_01.png}}
 
{{Directory Services Login with Directory Services Credentials|G Suite Account|mads_ldapauth_01.png}}
 
[[de:G Suite-Integration]]
 
[[de:G Suite-Integration]]
 
[[en:G Suite Integration]]
 
[[en:G Suite Integration]]

Revision as of 11:28, 3 June 2020

In addition to adding users manually as described in chapter User Management, MailStore Server can synchronize its internal user database with the G Suite account of your organization.

During synchronization, user information, such as user names and email addresses, is copied from the G Suite account into MailStore Server's user database. That way, users can use their G Suite account credentials to also log on to MailStore Server and emails can be assigned to their corresponding user archives automatically, for example. No changes are made to the G Suite account itself by MailStore Server. The scope of the synchronization can be limited through filters.


Please note that on December 16th 2019 Google announced to limit access to G Suite for less secure apps in the future. This includes any MailStore Server version prior to 13, which therefore will no longer be able to authenticate users against G Suite when trying to log into MailStore Server. In MailStore Server 13, support for modern authentication methods via OAuth 2.0 & OpenID Connect as per Google's recommendation was introduced. Although MailStore Server 13 still comes with support for IMAP-based authentication, this document only covers the setup using modern authentication methods as required by Google in the future.

Prerequisites and Recommendations

  • To comply with Google's requirements for Authorized redirect URIs of OAuth 2.0 clients, MailStore Server must be accessible via an URI that ends with a public top-level domain. Google uses the list from https://publicsuffix.org for validation.
  • For best user experience, the certificate used by MailStore Server should be trusted by all client and the used Web Browsers. Using a certificate that is signed by an trusted certificate authority or using Let's Encrypt certificates is highly recommended.

Register Project with Google

Irregardless of whether own or third-party applications such as MailStore are supposed to interact with a G Suite account through Google APIs, they must be registered as a project with Google first. This is necessary to ensure that access by external applications is limited to a minimum and that each application uses its own set of credentials to authenticate with Google.

Create New Project

To register a project for MailStore Server with Google, proceed as follows:

  • Go to the Google Developers Console.
  • If prompted, login using a Google account of you G Suite organization. Logging in with a user that has admin privileges is highly recommend.
  • If no project exists, click Create Project on the dashboard. Otherwise open the project list by clicking on the project drop-down in the header bar and click New project.
  • Type in a meaningful name into the Project name field, e.g. "MailStore Server".
  • Verify that Organization matches the desired organization and adjust the Location if needed.
  • Click on Create.

Once the project has been created, make sure that it is selected in the project drop-down list before proceeding.

Add API Libraries

  • Open the Navigation menu and select APIs & Services > Library.
  • In the API Library, search and enable the following APIs and services:
    Admin SDK
    Gmail API

Customize Consent Screen

  • Open the Navigation menu and select APIs & Services > OAuth consent screen.
  • Under User Type select Internal.
  • Click Create
  • Type in a meaningful name into the Application name field, e.g. "MailStore Server"
  • Click Save.

Create Service Account

A service account is required for MailStore Server to authenticate with Google and request authorization to use certain Google APIs to synchronize users and group, and to access user mailboxes. The following steps describe the creation of such a service account.

  • Open the Navigation menu and select APIs & Services > 'Credentials.
  • Click + Create Credentials and select Service account from the drop-down list.
  • On the Create service account page, enter a name for the service account, e.g. "MailStore Server Service".
  • Enter a description such as "Service account for MailStore Server to synchronize users and access mailboxes"
  • Click Create.
  • The service account does not require permissions on project level, therefore do not select a role.
  • Click on Continue.
  • Under Keys click on + Create Key.
  • Select JSON as key type and click Create.
  • The JSON file will be downloaded automatically. Save the JSON file in a secure location as it allows access to cloud resources of your organization.
  • Click Close and then Done.
  • Edit the details of the newly created service account by clicking on the corresponding pencil icon.
  • Click Show Domain-wide Delegation.
  • Tick the Enable G Suite Domain-wide Delegation box.
  • Click Save.

On the Credentials page, there should be a service account listed under Service Accounts with a corresponding client listed under OAuth 2.0 Client IDs.

Create OAuth 2.0 Client for User Authentication

To allow users to log in to MailStore by authenticating with Google using the OpenID Connect mechanism, an OAuth 2.0 Client must be created as described below.

  • Open the Navigation menu and select APIs & Services > 'Credentials.
  • Click + Create Credentials and select OAuth client ID from the drop-down list.
  • Select Web application as Application type.
  • Enter a Name, e.g. "MailStore Server OpenID Connect".
  • Click + Add URI under Authorized redirect URIs.
  • Enter the URI that is reachable by clients in the URIs field using the the following scheme:
    https://<host>.<domain.tld>[:<port>]/oidc/signin
  • Click Create to finish.
  • Copy the client ID and client secret from the Your Client ID and Your Client Secret fields to a safe place and click OK.

Grant Access on G Suite Account to Project

Once created, grant the new project fine-grained access to your G Suite account by defining the Google APIs it is allowed to use.

  • Open the Google Admin console and log in with a G Suite domain admin.
  • Select Security > API controls from the menu.
  • Unter Domain wide delegation, click Manage domain wide delegation.
  • On the Domain-wide delegation page, click Add new.
  • Enter the Client ID of the OAuth 2.0 Client that is linked with the service account.
  • Under OAuth Scope, add the following scopes:
    https://mail.google.com/, https://www.googleapis.com/auth/admin.directory.group.readonly, https://www.googleapis.com/auth/admin.directory.user.readonly
  • Click Authorize.

Configure MailStore Server

After the project has been successfully set up on the Google side, MailStore Server can now be configured to synchronize and authenticate users with G Suite.

  • Log on to MailStore Client as a MailStore Server administrator.
  • Click on Administrative Tools > Users and Privileges and then on Directory Services.
  • In the Integration section, change the directory service type to G Suite.
Gapps sync 01.png


Connection

For synchronization MailStore Server requires information on how to connect to the G Suite.

  • Key ID
    To import the private key, select the JSON file hat has been generated by Google for the service account in the Create Service Account step.
  • Service Account
    The service account is determined automatically from the JSON file.
  • User Name
    The email address of a G Suite Administrator (e.g. admin@example.com).

User Database Synchronization

After configuring the connection settings as described above, you can specify filter criteria for the G Suite synchronization in this section.

  • Sync only these groups
    Choose one or several G Suite groups if you only want their members to be created as MailStore Server users. That way it's possible to exclude certain users from being synchronized to MailStore Server.

Authentication

The authentication settings define how MailStore Server should authenticate users at login, that have been synchronized from G Suite.

Options

  • Automatically delete users in MailStore Server
    Here you can choose whether users that have been deleted in the G Suite Account will also be deleted in the MailStore user database by the synchronization. If the archive folder of such a user already contains archived emails, only the user entry but not its archive folder will be deleted in MailStore. Additionally, only MailStore users that have their authentication method set to Directory Services will be deleted.

Assigning Default Privileges

By default, users that have been synchronized to MailStore Server from G Suite Account have the privilege to log on to MailStore Server as well as read access to their own user archive.
You can configure those default privileges before synchronization, for example, to assign the privilege Archive E-mail to all new users. To do this, click on Default Privileges...
More information on managing user privileges and their effects is available in the chapter Users, Folders and Settings which also has details on editing existing privileges.

Running Directory Services Synchronization

Click on Test Settings to check synchronization configuration and the results returned by the G Suite Account without any changes to the MailStore Server user database being actually committed.

To finally run the synchronization, click on Synchronize now. The results are shown with any changes committed to the MailStore Server user database.

ApplicationIntegration sync 02.png


You can test the authentication for a user by first selecting him from the list and then clicking on the button on the lower left. You will now be asked for that user's password. Upon clicking OK you'll receive a message whether the authentication has been successful.

Login with G Suite Account Credentials

After synchronization MailStore users can log on to MailStore Server with their G Suite Account username and G Suite Account password.

Navigation
Tools
Print/export
About MailStore

  • MailStore Server is one of the leading email archiving solutions for SMB.
  • For private use there is a free tool for email archiving furthermore: MailStore Home.