Configuring Custom Shared Resource

The custom shared resource is used to define a login module class which implements the authentication mechanism.

The shared resource file consists of the following properties:
  • Property to define the custom login module.
  • User-defined list of properties to pass and use by the custom login module to initialize or configure the custom login module.

TIBCO API Exchange Gateway provides a CelmAsp.properties sample properties file for the shared resource. Use this file as a template and edit the properties, as required.

Use Case

The custom shared resource is useful for the following scenarios:

  • The incoming request contains the user credentials in a non-standard format. The username and password may be embedded within the XML of the message body so the user must extract the credentials specific to application before passing it to TIBCO API Exchange Gateway for authentication.
  • Verification of credentials or information is done through a custom database query.
  • The authentication mechanism requires third-party code.

Properties

The following table describes the properties for the custom shared resource:

Custom Shared Resource Properties
Property Description Example 
com.tibco.asg.security.provider.celm.loginModule
  Name of the login module class that implements the custom authentication. com.example.security.authentication.provider.celm.CelmExampleUsernamePasswordLoginModule 
com.tibco.asg.security.provider.celm.authorizedUsername
An example property defined by the user to pass as an argument to the initialize() method of custom login module. This property can be used to set the value of the username. john 
com.tibco.asg.security.provider.celm.authorizedPassword
An example property defined by the user to pass as an argument to the initialize() method of custom login module. This property can be used to set the value of the password. password 
com.tibco.asg.security.provider.celm.authorizedRole
An example property defined by the user to pass as an argument to the initialize() method of custom login module. This property can be used to set the value of the developer. developer

Sample File

See ASG_CONFIG_HOME/BookQuerySecurity/security/resource/CelmAsp.properties, as follows:

CelmAsp.properties.