Configuring authentication filters
The portal authentication filters are a set of plug-in points. You can use them to intercept or extend the portal login, logout, session timeout, and request processing by custom code, for example to redirect users to a specific URL.
- The authentication filter chain concept
- Available authentication filter chains
- Configuring the filter chains
- Example of a custom authentication filter
The authentication filter chain concept
Trigger of filter chain, | |
for example explicit | CustomFilter1 |
login or logout ---> next(..., chain){ | |
| // do something #1a | CustomFilter2 |
| chain.next(...) ---> next(..., chain){ |
| | // do something #2a | DefaultFilter
| | chain.next(...) ---> next(..., chain){
| | | // Execute the
| | | default logic
| | // do something #2b <--- }
| // do something #1b <--- } |
Redirect, exception, <--- } |
or continue |
A default filter performs
the default logic for a particular use case, for example, login. You
can chain a set of custom filters to be executed before that default
filter. When the filter chain is invoked, it calls the first element
in the chain (in the example CustomFilter1) and passes
a chain object as an argument to the call. The filter implementation
can then perform some operations before calling the appropriate method
on the chain object to trigger the next element in the chain (CustomFilter2).
This filter again can implement some individual logic that is executed
before calling the next element. The last element of the chain is
the predefined DefaultFilter that makes sure that
the default logic for the respective use case is executed.After a filter has been executed or if an exception is thrown, each filter returns to the one that has called it, so it is possible to implement a customized exception handling or perform additional operations after having called the successor. This way you can chain a custom set of filters. Each custom filter can perform operations before and after the following element(s) in the chain. You can specify the order and the fully qualified class names of the custom filters by portal configuration properties. For details see the topic about the portal WP Authentication Service. The portal provides only the DefaultFilter implementations and enforces that they are always the last element in the chains; if there are no custom login filters defined, the default filters are the only element.
Available authentication filter chains
- Explicit login: This is a login by user name and password as represented by the interface com.ibm.portal.auth.ExplicitLoginFilter. For example, this can be a login by using the login portlet or the login URL.
- Implicit login: For example, this can be when a user is already authenticated by WAS, but not yet to Portal. This is represented by the interface com.ibm.portal.auth.ImplicitLoginFilter.
- Explicit logout: This means that the user triggers a logout action directly, for example by clicking the Logout button in the user interface, interface com.ibm.portal.auth.ExplicitLogoutFilter.
- Implicit logout: For example, this can be after a session timeout, or if an authenticated user accesses a public page, or if the user navigates to a virtual portal without being member of the associated user realm. This is represented by the interface com.ibm.portal.auth.ImplicitLogoutFilter.
- Session Timeout: This is called immediately after an idle timeout of the user session occurred. This is represented by the interface com.ibm.portal.auth.SessionTimeoutFilter.
- Session Validation: This is called for every request before actions are triggered and the page is rendered. This is represented by the interface com.ibm.portal.auth.SessionValidationFilter.
Configuring the filter chains
login.explicit.filterchain = colon or semicolon-separated list of fully qualified class names
login.implicit.filterchain = colon or semicolon-separated list of fully qualified class names
logout.explicit.filterchain = colon or semicolon-separated list of fully qualified class names
logout.implicit.filterchain = colon or semicolon-separated list of fully qualified class names
sessiontimeout.filterchain = colon or semicolon-separated list of fully qualified class names
sessionvalidation.filterchain = colon or semicolon-separated list of fully qualified class names
filterchain.properties.fully qualified class name of the filter implementation.property name
This
makes the value of this property available in the filter configuration
object of the specified class by using the key property name .For details about setting portal configuration properties see the topic about Setting service configuration properties.
Example of a custom authentication filter
- Implement the com.ibm.portal.auth.ExplicitLoginFilter interface
and make your class available to the portal class path by adding the
JAR file to the extended classpath directory of the WebSphere Portal application: PortalServer_root/shared/app .
For an example for how to implement the methods of the interface refer
to the following code sample:
package com.ibm.portal.example; public class UserRedirectLoginFilter implements ExplicitLoginFilter { // hash map to store the mappings from user id to redirect URL private java.util.Map userToRedirectURLs = new java.util.HashMap(); public void init(SecurityFilterConfig filterConfig) throws SecurityFilterInitException { // iterate the list of init parameters and store the mappings of user to redirect urls for (java.util.Iterator it = filterConfig.getInitParameterNames(); it.hasNext(); ) { String currentParameter = (String)it.next(); userToRedirectURLs.put(currentParameter, filterConfig.getInitParameter(currentParameter)); } } public void login(HttpServletRequest req, HttpServletResponse resp, String userID, char[] password, FilterChainContext portalLoginContext, Subject subject, String realm, ExplicitLoginFilterChain chain) throws LoginException, WSSecurityException, PasswordInvalidException, UserIDInvalidException, AuthenticationFailedException, AuthenticationException, SystemLoginException, com.ibm.portal.auth.exceptions.LoginException { // call the next element in the filter chain to trigger the default login chain.login(req, resp, userID, password, portalLoginContext, subject, realm); // if no exception occured, the login was successful if (userToRedirectURLs.containsKey(userID)) { // set the redirect url for the user if we have an entry portalLoginContext.setRedirectURL((String)userToRedirectURLs.get(userID)); } } public void destroy() { // nothing to do here } }
- Specify the class name of the custom filter in the WP Authentication
Service properties:
login.explicit.filterchain=com.ibm.portal.example.UserRedirectLoginFilter
- To define the redirect URLs for individual user IDs, specify your
custom set of properties for this class accordingly. Example:
filterchain.properties.com.ibm.portal.example.UserRedirectLoginFilter.alice=/wps/myportal/pageA filterchain.properties.com.ibm.portal.example.UserRedirectLoginFilter.bob=/wps/myportal/pageB
- Restart the portal.