G-Suite Driver 4.2.0.1

Date: 12/18/2019

Updated: 12/18/2019

Driver Documentation: G-Suite Driver Documentation 4.2.0.0

IMPORTANT NOTE: If updating from version 4.2.0.0, no changes are needed to APIs, scopes, or any OAuth area. The only change that is needed is the new ctgmailshim.jar. Otherwise, this version of the G-Suite driver requires changes to the attached G-Suite domain’s list of enabled APIs and authorized API scopes. If updating an existing driver to this version, it is vital that the connected domain(s) be updated or the driver will fail to operate. The changes necessary are detailed in the G-Suite Driver 4.1.3.x OAuth Update guide. For new installations, follow the instructions in the driver documentation.

Please note that some dependencies have been moved to an optional dependencies archive. These dependencies are provided by IDM, however, some versions of IDM may not have the libraries at a sufficient level for the driver to run. If necessary, update the dependencies from the optional dependencies archive. Do not update them if they are already present at the same or higher version level as those in the archive.

G-Suite Driver 4.2.0.1
Created by Michael Weaver
Date: 12/18/2019
Updated: 12/18/2019
Download: G-Suite Driver 4.2.0.1 Release
Release Notes
Concensus Technologies G-Suite Driver 4.2.0.1 Patch
Build 4.2.0.1

Release Notes Updates:

This is a hot fix update for the 4.2.0.0 release. This update corrects a problem found with certain mal-formed response messages from the Google API servers.

If you are patching from version 4.2.0.0, only the ctgmailshim.jar file needs to be updated. There are no other changes to any other files.
Replace the ctgmailshim.jar and restart eDirectory to patch.

PATCHES THIS PATCH SUPERSEDES

All Prior versions including:
4.1.2.2
4.1.3.0
4.1.3.1
4.2.0.0

ABSTRACT

Patch for the Concensus Technologies Identity Manager G-Suite Driver. This will take the G-Suite Driver build version to 4.2.0.1. You must have G-Suite Driver 4.1.x.x or later
DETAILS

IMPORTANT: This update requires changes to the G-Suite enabled APIs and authorized scopes. Please see this guide on how to do the update:
https://concensus.jira.com/wiki/spaces/GADD/pages/601227266/G-Suite+Driver+4.2+OAuth+Update

This G-Suite change is not necessary if upgrading from 4.1.3.0 or later, however, it is necessary for upgrades from any other version.

Version 4.1.3.0 or later will NOT work without this update!

Overview: This is a patch for the Google Apps Driver.

IMPORTANT NOTE: An IDM-provided libarary, Apache commons codec, is too low of a level in some versions of IDM. This connector's dependent libraries require at least commons-codec version 1.6 or later to work. In the IDM DirXML class library path (described below), find the commons-codec jar file. If it is the 1.3 file, please replace it with a version 1.6 file or later. Failure to do so will result in the driver not starting after the update. The file can be found here: https://commons.apache.org/proper/commons-codec/

System Requirements: Novell Identity Manager 4.5 or higher with commons-codec version 1.6 or later.
Files provided with this update (with MD5 sum):
ed448347fc0104034aa14c8189bf37de *commons-logging-1.1.1.jar
1f414a03367888c64bba56cfc0423011 *ctgmailshim.jar
517c607196bebc0adf5cdb26fec27cd2 *gdata-appsforyourdomain-1.0.jar
3f2292058cda93293052c162512b27ed *gdata-appsforyourdomain-meta-1.0.jar
2b5ae2c5542606c442b6c4d729d0b658 *gdata-base-1.0.jar
cd00dc4999d7813f16401582dd93a948 *gdata-client-1.0.jar
bfe3dff20944012d465faa4a28e123d6 *gdata-client-meta-1.0.jar
d07fc71e005171d359440f4a7222f7ad *gdata-contacts-3.0.jar
39197de58161b57bb0b862a4b31fe83f *gdata-contacts-meta-3.0.jar
c51dc9b54e15af5a7de9684cb4516bb1 *gdata-core-1.0.jar
90f1abbbeace9963044767bf1a7adaf3 *google-api-client.jar
3724eb4fd83f192bd7a6738082aaa4b8 *google-api-client-java6.jar
fc39b8362ecb614040385209bffa84e8 *google-api-services-admin-directory.jar
aa60435557b8374fae9fcc148251eb92 *google-api-services-gmail.jar
abfeed1ad975c3e6f08b819c31e323c3 *google-api-services-groupssettings.jar
b3fab879762996affd762315da019a0c *google-api-services-oauth2.jar
feb4d41ef809977d6da6915b76e94099 *google-http-client.jar
1d582258e6a198882a3b9bc21017ef2e *google-http-client-gson.jar
89ad7e003c21f760bec82afef1e214af *google-http-client-jackson2.jar
1dc684593fa1e1af1d812f494081b306 *google-oauth-client.jar
518e414cccc81ab8ffb117059b13b4d0 *google-oauth-client-java6.jar
88a3cd45e727d0c457e9e11e3c506334 *google-oauth-client-jetty.jar
e16b1b8fca0980263f764f633ec91dd6 *gson.jar
eae9048a7177a69881323c08c5122aa4 *guava.jar
1d5a772e400b04bb67a7ef4a0e0996d8 *jsr305-1.3.9.jar
33ec8d237cbaceeffb2c2a7f52afd79a *xercesImpl.jar

Please note that there is a new library needed, the google-api-services-gmail library.

General Instructions for all hosting platforms:

As of this release, the Google API libraries, the gson library, and the guava library have been renamed to remove the version and release strings from their name.
Example: Example: google-api-client-1.25.0.jar has become google-api-client.jar

When doing the file update, keep in mind that, generally speaking, there should only be one java archive (jar) in the classes path for each provided resource. In the earlier example, google-api-client.jar provides the Google API client. There should be no other jar files which provide that same API client.
Prior to copying the new files over, remove files matching the following patterns (the patterns are not valid wildcards for various host platforms, do not use them as written!):

• google-api-client-* (not the java6 files, except as noted below)

• google-api-client-java6-*

• google-api-services-admin-directory_* (also check for hyphen instead of underscore)

• google-api-services-gmail-*

• google-api-services-groupssettings-*

• google-api-services-oauth2-*

• google-http-client-* (not the gson or jackson2 versions, except as noted below)

• google-http-client-gson-*

• google-http-client-jackson2-*

• google-oauth-client-* (not the java6 or jetty versions, except as noted below)

• google-oauth-client-java6-*

• google-oauth-client-jetty-*

• gson-*

• guava-*

A partial list of previous library file versions is at the end of this document. Please note that the v1.25 versions of the libraries, which were part of a previous 4.2 archive should also be removed.

Copy the provided library files. Overwrite/replace ctgmailshim.jar, DirectoryScopes.txt, and this readme file.

Specific host details are below.

Linux:

The connector binary and accessory jar files are located in the eDirectory DirXML class library path. This path
is dependent on your install location. On Linux hosts, it is typically /opt/novell/eDirectory/lib/dirxml/classes

1. Stop all drivers

2. Stop eDirectory

3. Remove old or renamed libraries as detailed above

4. Copy provided libraries as detailed above.

5. Restart eDirectory - rcndsd restart (all drivers will restart)

Windows:

The connector binary and accessory jar files are located in the eDirectory DirXML class library path. This path
is dependent on your install location. On Windows hosts, it is typically [Install_Location]\NDS\lib or c:\netiq\eDirectory

1. Stop all drivers

2. Stop eDirectory

3. Remove old or renamed libraries as detailed above

4. Copy provided libraries as detailed above.

5. Restart the eDirectory instance- (all drivers will restart)

Remote Loader:

Remote loader driver paths are dependent on how the remote loader is installed. Locate the existing gmailshim.jar on the
remote loader host to identify the correct path.

1. Stop the remote loader instance.

2. Remove old or renamed libraries as detailed above

3. Copy provided libraries as detailed above.

4. Restart remote loader instance

TECHNICAL SUPPORT INFORMATION

Fixes made in the Concensus IDM 4.2.0.1 G-Suite Driver:

• Occasional mal-formed JSON errors from the Google API service will no longer crash the driver (GADRIVER-363)

• Corrected a number of null pointer exceptions found during testing

KNOWN ISSUES

Due to apparent propogation delays within the G-Suite API services, it is not possible to set GmailSettings attribute values during use creation. Please set them at least five seconds after user creation to avoid errors from the Gmail API service.

At this time, setting values for GmailSettingsEnableIMAP and GmailSettingsEnablePOP does not appear to work. The driver can query, however modifications do not cause a change on the user object.

Prior Versions of Dependent Libraries

This list is the known prior dependent library filenames which need to be removed for the update:

google-api-client-1.20.0.jar
google-api-client-java6-1.20.0.jar
google-api-services-admin-directory_v1-rev53-1.20.0.jar
google-api-services-groupssettings-v1-rev54-1.20.0.jar
google-api-services-oauth2-v2-rev87-1.19.1.jar
google-http-client-1.20.0.jar
google-http-client-gson-1.20.0.jar
google-http-client-jackson2-1.20.0.jar
google-oauth-client-1.20.0.jar
google-oauth-client-java6-1.20.0.jar
google-oauth-client-jetty-1.20.0.jar
gson-2.3.1.jar
guava-11.0.2.jar

google-api-client-1.22.0.jar
google-api-client-java6-1.22.0.jar
google-api-services-admin-directory_v1-rev68-1.22.0.jar
google-api-services-groupssettings-v1-rev60-1.22.0.jar
google-api-services-oauth2-v1-rev117-1.22.0.jar
google-http-client-1.22.0.jar
google-http-client-gson-1.22.0.jar
google-http-client-jackson2-1.22.0.jar
google-oauth-client-1.22.0.jar
google-oauth-client-java6-1.22.0.jar
google-oauth-client-jetty-1.22.0.jar

google-api-client-1.25.0.jar
google-api-client-java6-1.25.0.jar
google-api-services-admin-directory_v1-rev105-1.25.0.jar
google-api-services-gmail-v1-rev105-1.25.0.jar
google-api-services-groupssettings-v1-rev77-1.25.0.jar
google-api-services-oauth2-v1-rev153-1.25.0.jar
google-http-client-1.25.0.jar
google-http-client-gson-1.25.0.jar
google-http-client-jackson2-1.25.0.jar
google-oauth-client-1.25.0.jar
google-oauth-client-java6-1.25.0.jar
google-oauth-client-jetty-1.25.0.jar
gson-2.3.1.jar
guava-27.1-android.jar