System Administration
Create a Custom Authentication Plugin
This topic outlines how to create and register a custom authentication plugin in the Stewardship Tier with the following steps:
- Create Custom Authentication Plugin
- Stop CranSoft Services
- Stop IIS
- Place Plugin in External Assembly Directory
- Enable Custom Authentication within Stewardship Tier
- Update Web.Config File Setting
- Restart CranSoft Service
- 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:
- Open Windows Start Menu.
- Navigate to Services.
- Right click CranSoft Service DSP.
- Select Stop.
Stop IIS
To stop IIS:
- Open Windows Start Menu.
- Open the Command Prompt.
- Type: iisreset /stop.
- 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:
- Select Admin > Configuration > Parameters in the Navigation menu.
- Click the Security Settings tab.
- 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:
-
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" />
-
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:
- Open Windows Start Menu.
- Navigate to Services.
- Right click CranSoft Service DSP.
- Select Restart.
Restart IIS
To restart IIS:
- Open Windows Start Menu.
- Open the Command Prompt.
- Type: iisreset /start.
- Hit Enter.