Custom Authentication Plug-ins

Last updated
Save as PDF

This page outlines the general principles for integrating a custom authentication plug-in with TeamConnect security. While specific coding details are not covered, it provides guidance on how to develop and implement a custom authentication solution.

Write your own Java class, implementing one of these two interfaces:

CustomSSOAuthenticator
CustomUserPwdAuthenticator

Write an authenticationDescriptor.properties file. The file needs to have at least the following lines (sample data shown in italics):

tc.displayName=My Authenticator
tc.uniqueId=MYAUTH
tc.isSSO=true
tc.authenticatorClassName=com.mitratech.teamconnect.authentication.provider.TestMySSOAut henticator

It's a good idea to override some default error-message HTML files, too:

page.badCredentials=loginFailed.html
page.logout=logout.html
page.sessionExpired=timeout.html

Put your new class in Document folder System/Authentication/MYAUTH/classes (the folder path must incorporate the value of tc.uniqueId). Put the properties file in there too.

As a sibling of folder classes, create folder pages. Put in HTML files to be used for overriding the default error-condition pages. This is especially important if you're writing an SSO authenticator.

Customizing Message Screens

If you enable an authentication plug-in mechanism in TeamConnect, you can customize the screens that you encounter while accessing and logging out of TeamConnect. You must write, test, and deploy your own Java class to display the customized screens. You should do this step only if you plan to provide extra information for users during their sessions.

Your custom Java class must implement interface javax.servlet.Filter. It should be deployed in the same Documents folder as the configuration files.

Enabling a Default Authentication Method

After you install one or more authentication plug‑ins (including the built‑in Standard authentication, the LDAP plug‑in, or any custom plug‑in), you can select which method TeamConnect uses by default.

To set the default authentication method:

Steps to follow	Screenshot for reference
In TeamConnect, click the Admin tab. Click Admin Settings, and then click Security. In the Authentication Plug-in section, click Reload to make sure that all installed plug‑ins are loaded. In Default Authentication Method, select the plug‑in that you want TeamConnect to use as the system default (for example, Standard Authentication, LDAP TeamConnect Authenticator, or a custom plug‑in). Click Update to save your changes.

Steps to follow

Screenshot for reference

In TeamConnect, click the Admin tab.
Click Admin Settings, and then click Security.
In the Authentication Plug-in section, click Reload to make sure that all installed plug‑ins are loaded.
In Default Authentication Method, select the plug‑in that you want TeamConnect to use as the system default (for example, Standard Authentication, LDAP TeamConnect Authenticator, or a custom plug‑in).
Click Update to save your changes.

Enabling a Default Authentication Method.png

Note: When you select LDAP TeamConnect Authenticator as the default method, TeamConnect uses the LDAP login flow that is described in LDAP Authentication Plug-in, including the requirements that the LDAP username match the TeamConnect username and that the TeamConnect user must be active.