System Administration

Create a Custom Authentication Plugin

A custom authentication plugin is client-specific code that is written to authenticate the credentials entered either on the Stewardship Tier's Login page or the Electronic Signature window against a third-party system.

This topic outlines how to create and register a custom authentication plugin in the Stewardship Tier with the following steps:

  1. Create Custom Authentication Plugin
  2. Stop CranSoft Services
  3. Stop IIS
  4. Place Plugin in External Assembly Directory
  5. Enable Custom Authentication within Stewardship Tier
  6. Update Web.Config File Setting
  7. Restart CranSoft Service
  8. Restart IIS

Create Custom Authentication Plugin

Use the following C# example to create a custom authentication plugin. Refer to Create a Plugin for more information.

 

Stop CranSoft Services

To stop all CranSoft Services:

  1. Open Windows Start Menu.
  2. Navigate to Services.

  1. Right click CranSoft Service DSP.
  2. Select Stop.

Stop IIS

To stop IIS:

  1. Open Windows Start Menu.
  2. Open the Command Prompt.
  3. Type: iisreset /stop.
  4. Hit Enter .

Place Plugin in External Assembly Directory

Place the custom authentication DLL in the {Install Directory}\Web\bin\ExternalAssemblies\ directory.

Enable Custom Authentication within Stewardship Tier

Enabling custom authentication within the Stewardship Tier means the custom authentication DLL is used to authenticate users.

To enable custom authentication within the Stewardship Tier:

  1. Select Admin > Configuration > Parameters in the Navigation menu.
  2. Click the Security Settings tab.
  3. Click the Support Custom Authentication check box to enable custom authentication for the Stewardship Tier.

Update Web.Config File Setting

Update the Web.Config file to utilize the newly created custom authentication plugin.

To update the Web.Config file:

  1. Update the key values. The following example contains key values that relate to the DLL name and class used in Step 1: Create Custom Authentication Plugin.

    <add key="CustomAuthenticationAssembly" value="Custom.Security" />

    <add key="CustomAuthenticationClass" value="Custom.Security.CustomSecurityManager" />

  1. Add any new custom authentication plugin keys and associated values. The following example contains key values that relate to the plugin in Step 1: Create Custom Authentication Plugin.

    <add key="Ldap_Server" value="Enter LDAP Server" />

    <add key="Ldap_User" value="Enter LDAP User" />

    <add key="Ldap_Pwd" value="Enter LDAP User Password"/>

    <add key="Error_User_NotExists" value="UserID does not exist in the CranSoft database"/>

    <add key="Error_InvalidPwd" value="Login failed. "/>

    <add key="Error_Unknown" value="Unknown Error. Please contact the system admin."/>

Restart CranSoft Services

To restart all CranSoft Services:

  1. Open Windows Start Menu.
  2. Navigate to Services.

  1. Right click CranSoft Service DSP.
  2. Select Restart.

Restart IIS

To restart IIS:

  1. Open Windows Start Menu.
  2. Open the Command Prompt.
  3. Type: iisreset /start.
  4. Hit Enter.