From 8f5bcb64a66231561bb4a68a5fd18aa3ae59dafb Mon Sep 17 00:00:00 2001 From: Luke Taylor Date: Tue, 25 Mar 2008 22:32:26 +0000 Subject: [PATCH] SEC-689: Session Fixation protection should be available to all authentication mechanisms. http://jira.springframework.org/browse/SEC-689. Added a general SessionFixationProtectionFilter which can be added to the filter stack to detect when a user has been authenticated and then migrate them to a new session. Also added support to namespace element. --- .../security/ui/AbstractProcessingFilter.java | 51 +- .../ui/SessionFixationProtectionFilter.java | 156 + .../security/util/SessionUtils.java | 75 + .../security/config/spring-security-2.0.rnc | 3 + .../security/config/spring-security-2.0.xsd | 2849 +++++++++++------ 5 files changed, 2123 insertions(+), 1011 deletions(-) create mode 100644 core/src/main/java/org/springframework/security/ui/SessionFixationProtectionFilter.java create mode 100644 core/src/main/java/org/springframework/security/util/SessionUtils.java diff --git a/core/src/main/java/org/springframework/security/ui/AbstractProcessingFilter.java b/core/src/main/java/org/springframework/security/ui/AbstractProcessingFilter.java index 471c0166b2..0cd54de647 100644 --- a/core/src/main/java/org/springframework/security/ui/AbstractProcessingFilter.java +++ b/core/src/main/java/org/springframework/security/ui/AbstractProcessingFilter.java @@ -20,6 +20,7 @@ import org.springframework.security.Authentication; import org.springframework.security.AuthenticationException; import org.springframework.security.AuthenticationManager; import org.springframework.security.util.RedirectUtils; +import org.springframework.security.util.SessionUtils; import org.springframework.security.context.SecurityContextHolder; @@ -353,9 +354,8 @@ public abstract class AbstractProcessingFilter extends SpringSecurityFilter impl logger.debug("Updated SecurityContextHolder to contain the following Authentication: '" + authResult + "'"); } - if (invalidateSessionOnSuccessfulAuthentication) { - startNewSessionIfRequired(request); + SessionUtils.startNewSessionIfRequired(request, migrateInvalidatedSessionAttributes, null); } String targetUrl = determineTargetUrl(request); @@ -376,53 +376,6 @@ public abstract class AbstractProcessingFilter extends SpringSecurityFilter impl sendRedirect(request, response, targetUrl); } - private void startNewSessionIfRequired(HttpServletRequest request) { - HttpSession session = request.getSession(false); - - if (session == null) { - return; - } - - if (!migrateInvalidatedSessionAttributes) { - - if (logger.isDebugEnabled()) { - logger.debug("Invalidating session without migrating attributes."); - } - - session.invalidate(); - session = null; - - // this is probably not necessary, but seems cleaner since - // there already was a session going. - request.getSession(true); - - } else { - - if (logger.isDebugEnabled()) { - logger.debug("Invalidating session and migrating attributes."); - } - - HashMap migratedAttributes = new HashMap(); - - Enumeration enumer = session.getAttributeNames(); - - while (enumer.hasMoreElements()) { - String key = (String) enumer.nextElement(); - migratedAttributes.put(key, session.getAttribute(key)); - } - - session.invalidate(); - session = request.getSession(true); // we now have a new session - - Iterator iter = migratedAttributes.entrySet().iterator(); - - while (iter.hasNext()) { - Map.Entry entry = (Map.Entry) iter.next(); - session.setAttribute((String) entry.getKey(), entry.getValue()); - } - } - } - protected String determineTargetUrl(HttpServletRequest request) { // Don't attempt to obtain the url from the saved request if alwaysUsedefaultTargetUrl is set String targetUrl = alwaysUseDefaultTargetUrl ? null : diff --git a/core/src/main/java/org/springframework/security/ui/SessionFixationProtectionFilter.java b/core/src/main/java/org/springframework/security/ui/SessionFixationProtectionFilter.java new file mode 100644 index 0000000000..12a6c3b0db --- /dev/null +++ b/core/src/main/java/org/springframework/security/ui/SessionFixationProtectionFilter.java @@ -0,0 +1,156 @@ +package org.springframework.security.ui; + +import java.io.IOException; + +import javax.servlet.FilterChain; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.servlet.http.HttpServletResponseWrapper; + +import org.springframework.security.Authentication; +import org.springframework.security.AuthenticationTrustResolver; +import org.springframework.security.AuthenticationTrustResolverImpl; +import org.springframework.security.concurrent.SessionRegistry; +import org.springframework.security.context.SecurityContextHolder; +import org.springframework.security.util.SessionUtils; + +/** + * Detects that a user has been authenticated since the start of the request and starts a new session. + *

+ * This is essentially a generalization of the functionality that was implemented for SEC-399. Additionally, it will + * update the configured SessionRegistry if one is in use, thus preventing problems when used with Spring Security's + * concurrent session control. + * + * @author Martin Algesten + * @author Luke Taylor + * @since 2.0 + */ +public class SessionFixationProtectionFilter extends SpringSecurityFilter { + //~ Static fields/initializers ===================================================================================== + + static final String FILTER_APPLIED = "__spring_security_session_fixation_filter_applied"; + + //~ Instance fields ================================================================================================ + + private SessionRegistry sessionRegistry; + + /** + * Indicates that the session attributes of the session to be invalidated + * should be migrated to the new session. Defaults to true. + */ + private boolean migrateSessionAttributes = true; + + private AuthenticationTrustResolver authenticationTrustResolver = new AuthenticationTrustResolverImpl(); + + protected void doFilterHttp(HttpServletRequest request, HttpServletResponse response, FilterChain chain) + throws IOException, ServletException { + // Session fixation isn't a problem if there's no session + if(request.getSession(false) == null || request.getAttribute(FILTER_APPLIED) != null) { + chain.doFilter(request, response); + return; + } + + request.setAttribute(FILTER_APPLIED, Boolean.TRUE); + + if (isAuthenticated()) { + // We don't have to worry about session fixation attack if already authenticated + chain.doFilter(request, response); + return; + } + + SessionFixationProtectionResponseWrapper wrapper = + new SessionFixationProtectionResponseWrapper(response, request); + try { + chain.doFilter(request, wrapper); + } finally { + if (!wrapper.isNewSessionStarted()) { + startNewSessionIfRequired(request); + } + } + } + + private boolean isAuthenticated() { + Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); + + return authentication != null && !authenticationTrustResolver.isAnonymous(authentication); + } + + public void setMigrateSessionAttributes(boolean migrateSessionAttributes) { + this.migrateSessionAttributes = migrateSessionAttributes; + } + + public int getOrder() { + return FilterChainOrder.SESSION_FIXATION_FILTER; + } + + /** + * Called when the an initially unauthenticated request completes or a redirect or sendError occurs. + *

+ * If the user is now authenticated, a new session will be created, the session attributes copied to it (if + * migrateSessionAttributes is set and the sessionRegistry updated with the new session information. + */ + protected void startNewSessionIfRequired(HttpServletRequest request) { + if (isAuthenticated()) { + SessionUtils.startNewSessionIfRequired(request, migrateSessionAttributes, sessionRegistry); + } + } + + /** + * Response wrapper to handle the situation where we need to migrate the session after a redirect or sendError. + * Similar in function to Martin Algesten's OnRedirectUpdateSessionResponseWrapper used in + * HttpSessionContextIntegrationFilter. + */ + private class SessionFixationProtectionResponseWrapper extends HttpServletResponseWrapper { + private HttpServletRequest request; + private boolean newSessionStarted; + + public SessionFixationProtectionResponseWrapper(HttpServletResponse response, HttpServletRequest request) { + super(response); + this.request = request; + } + + /** + * Makes sure a new session is created before calling the + * superclass sendError() + */ + public void sendError(int sc) throws IOException { + startNewSession(); + super.sendError(sc); + } + + /** + * Makes sure a new session is created before calling the + * superclass sendError() + */ + public void sendError(int sc, String msg) throws IOException { + startNewSession(); + super.sendError(sc, msg); + } + + /** + * Makes sure a new session is created before calling the + * superclass sendRedirect() + */ + public void sendRedirect(String location) throws IOException { + startNewSession(); + super.sendRedirect(location); + } + + /** + * Calls startNewSessionIfRequired() + */ + private void startNewSession() { + if (newSessionStarted) { + return; + } + startNewSessionIfRequired(request); + newSessionStarted = true; + } + + private boolean isNewSessionStarted() { + return newSessionStarted; + } + } + +} diff --git a/core/src/main/java/org/springframework/security/util/SessionUtils.java b/core/src/main/java/org/springframework/security/util/SessionUtils.java new file mode 100644 index 0000000000..7c42f0914a --- /dev/null +++ b/core/src/main/java/org/springframework/security/util/SessionUtils.java @@ -0,0 +1,75 @@ +package org.springframework.security.util; + +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Iterator; +import java.util.Map; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpSession; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.security.concurrent.SessionRegistry; +import org.springframework.security.concurrent.SessionRegistryUtils; +import org.springframework.security.context.SecurityContextHolder; + +/** + * @author Luke Taylor + * @version $Id$ + * @since 2.0 + */ +public final class SessionUtils { + private final static Log logger = LogFactory.getLog(SessionUtils.class); + + SessionUtils() {} + + public static void startNewSessionIfRequired(HttpServletRequest request, boolean migrateAttributes, + SessionRegistry sessionRegistry) { + + HttpSession session = request.getSession(false); + + if (session == null) { + return; + } + + String originalSessionId = session.getId(); + + if (logger.isDebugEnabled()) { + logger.debug("Invalidating session " + (migrateAttributes ? "and" : "without") + " migrating attributes."); + } + + HashMap attributesToMigrate = null; + + if (migrateAttributes) { + attributesToMigrate = new HashMap(); + + Enumeration enumer = session.getAttributeNames(); + + while (enumer.hasMoreElements()) { + String key = (String) enumer.nextElement(); + attributesToMigrate.put(key, session.getAttribute(key)); + } + } + + session.invalidate(); + session = request.getSession(true); // we now have a new session + + if (attributesToMigrate != null) { + Iterator iter = attributesToMigrate.entrySet().iterator(); + + while (iter.hasNext()) { + Map.Entry entry = (Map.Entry) iter.next(); + session.setAttribute((String) entry.getKey(), entry.getValue()); + } + } + + if (sessionRegistry != null) { + sessionRegistry.removeSessionInformation(originalSessionId); + Object principal = SessionRegistryUtils.obtainPrincipalFromAuthentication( + SecurityContextHolder.getContext().getAuthentication()); + + sessionRegistry.registerNewSession(session.getId(), principal); + } + } +} diff --git a/core/src/main/resources/org/springframework/security/config/spring-security-2.0.rnc b/core/src/main/resources/org/springframework/security/config/spring-security-2.0.rnc index f8a7b6f7ad..cedd0826f1 100644 --- a/core/src/main/resources/org/springframework/security/config/spring-security-2.0.rnc +++ b/core/src/main/resources/org/springframework/security/config/spring-security-2.0.rnc @@ -202,6 +202,9 @@ http.attlist &= http.attlist &= ## Optional attribute specifying the realm name that will be used for all authentication features that require a realm name (eg BASIC and Digest authentication). If unspecified, defaults to "Spring Security Application". attribute realm {xsd:string}? +http.attlist &= + ## Indicates whether an existing session should be invalidated when a user authenticates and a new session started. If set to "none" no change will be made. "newSession" will create a new empty session. "migrateSession" will create a new session and copy the session attributes to the new session. Defaults to "migrateSession". + attribute session-fixation-protection {"none" | "newSession" | "migrateSession" }? intercept-url = diff --git a/core/src/main/resources/org/springframework/security/config/spring-security-2.0.xsd b/core/src/main/resources/org/springframework/security/config/spring-security-2.0.xsd index 80a8e93e77..7a9a7a654c 100644 --- a/core/src/main/resources/org/springframework/security/config/spring-security-2.0.xsd +++ b/core/src/main/resources/org/springframework/security/config/spring-security-2.0.xsd @@ -1,995 +1,1920 @@ - - - - - - Defines the hashing algorithm used on user passwords. We recommend strongly against using MD4, as it is a very weak hashing algorithm. - - - - - - - - - - - - - - - - - Whether a string should be base64 encoded - - - - - - - - - - - - - Defines the type of pattern used to specify URL paths (either JDK 1.4-compatible regular expressions, or Apache Ant expressions). Defaults to "ant" if unspecified. - - - - - - - - - - - - - Specifies an IP port number. Used to configure an embedded LDAP server, for example. - - - - - - - Specifies a URL. - - - - - - - A bean identifier, used for referring to the bean elsewhere in the context. - - - - - - - Defines a reference to a Spring bean Id. - - - - - - - A reference to a user-service (or UserDetailsService bean) Id - - - - - - element which defines a password encoding strategy. Used by an authentication provider to convert submitted passwords to hashed versions, for example. - - - - - - - - - - - - Defines a reference to a Spring bean Id. - - - - - Defines the hashing algorithm used on user passwords. We recommend strongly against using MD4, as it is a very weak hashing algorithm. - - - - - - - - - - - - - - - Whether a string should be base64 encoded - - - - - - - - - - - - - - A property of the UserDetails object which will be used as salt by a password encoder. Typically something like "username" might be used. - + + + + + + + + + + Defines the hashing algorithm used on user passwords. We recommend strongly against using MD4, as it is a very weak hashing algorithm. + + + + + + + + + + + + + + + + + + + + + + + - - - A single value that will be used as the salt for a password encoder. - + + + + + + + + + + Whether a string should be base64 encoded + + + + + + + + + + + + + + + - - - - + + + + + + + + + + Defines the type of pattern used to specify URL paths (either JDK 1.4-compatible regular expressions, or Apache Ant expressions). Defaults to "ant" if unspecified. + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies an IP port number. Used to configure an embedded LDAP server, for example. + + + + + + + + + + + + + + Specifies a URL. + + + + + + + + + + + + + + A bean identifier, used for referring to the bean elsewhere in the context. + + + + + + + + + + + + + + Defines a reference to a Spring bean Id. + + + + + + + + + + + + + + A reference to a user-service (or UserDetailsService bean) Id + + + + + + + + - A property of the UserDetails object which will be used as salt by a password encoder. Typically something like "username" might be used. + + element which defines a password encoding strategy. Used by an authentication provider to convert submitted passwords to hashed versions, for example. + - - - - + + + + + + + + + + + + A property of the UserDetails object which will be used as salt by a password encoder. Typically something like "username" might be used. + + + + + + + + + + A single value that will be used as the salt for a password encoder. + + + + + + + + + + + + + + + + + + + + + + Defines a reference to a Spring bean Id. + + + + + + + + + + Defines the hashing algorithm used on user passwords. We recommend strongly against using MD4, as it is a very weak hashing algorithm. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Whether a string should be base64 encoded + + + + + + + + + + + + + + + + + + + + + + + + + + + A property of the UserDetails object which will be used as salt by a password encoder. Typically something like "username" might be used. + + + + + + + + + + + + + + A single value that will be used as the salt for a password encoder. + + + + + + + + - A single value that will be used as the salt for a password encoder. + + Defines an LDAP server location or starts an embedded server. The url indicates the location of a remote server. If no url is given, an embedded server will be started, listening on the supplied port number. The port is optional and defaults to 33389. A Spring LDAP ContextSource bean will be registered for the server with the id supplied. + - - - - - Defines an LDAP server location or starts an embedded server. The url indicates the location of a remote server. If no url is given, an embedded server will be started, listening on the supplied port number. The port is optional and defaults to 33389. A Spring LDAP ContextSource bean will be registered for the server with the id supplied. - - - - - - - + + + + + + + + + + + + + + A bean identifier, used for referring to the bean elsewhere in the context. + + + + + + + + + + Specifies a URL. + + + + + + + + + + Specifies an IP port number. Used to configure an embedded LDAP server, for example. + + + + + + + + + + Username (DN) of the "manager" user identity which will be used to authenticate to a (non-embedded) LDAP server. If omitted, anonymous access will be used. + + + + + + + + + + + + Explicitly specifies an ldif file resource to load into an embedded LDAP server + + + + + + + + + + Optional root suffix for the embedded LDAP server. Default is "dc=springframework,dc=org" + + + + + + + + + + + + + + The optional server to use. If omitted, and a default LDAP server is registered (using <ldap-server> with no Id), that server will be used. + + + + + + + + + + + + + + Group search filter. Defaults to (uniqueMember={0}). The substituted parameter is the DN of the user. + + + + + + + + + + + + + + Search base for group membership searches. Defaults to "ou=groups". + + + + + + + + + + + + + + + + + + + + Search base for user searches. Defaults to "". + + + + + + + + + + + + + + The LDAP attribute name which contains the role name which will be used within Spring Security. Defaults to "cn". + + + + + + + + + + + + + + + + + + + + + + A bean identifier, used for referring to the bean elsewhere in the context. + + + + + + + + + + The optional server to use. If omitted, and a default LDAP server is registered (using <ldap-server> with no Id), that server will be used. + + + + + + + + + + + + + + Group search filter. Defaults to (uniqueMember={0}). The substituted parameter is the DN of the user. + + + + + + + + + + Search base for group membership searches. Defaults to "ou=groups". + + + + + + + + + + The LDAP attribute name which contains the role name which will be used within Spring Security. Defaults to "cn". + + + + + + + + - A bean identifier, used for referring to the bean elsewhere in the context. + + Sets up an ldap authentication provider + - - + + + + + + + + + + + + + + + + + + + + The optional server to use. If omitted, and a default LDAP server is registered (using <ldap-server> with no Id), that server will be used. + + + + + + + + + + + + + + Search base for group membership searches. Defaults to "ou=groups". + + + + + + + + + + Group search filter. Defaults to (uniqueMember={0}). The substituted parameter is the DN of the user. + + + + + + + + + + The LDAP attribute name which contains the role name which will be used within Spring Security. Defaults to "cn". + + + + + + + + + + A specific pattern used to build the user's DN, for example "uid={0},ou=people". The key "{0}" must be present and will be substituted with the username. + + + + + + + + - Specifies a URL. + + Specifies that an LDAP provider should use an LDAP compare operation of the user's password to authenticate the user + - - + + + + + + + + + + + + + + + + + + + + The attribute in the directory which contains the user password. Defaults to "userPassword". + + + + + + + + + + Defines the hashing algorithm used on user passwords. We recommend strongly against using MD4, as it is a very weak hashing algorithm. + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Specifies an IP port number. Used to configure an embedded LDAP server, for example. + + Can be used inside a bean definition to add a security interceptor to the bean and set up access configuration attributes for the bean's methods + - - + + + + + + + + + + + + + + + + + + + + Optional AccessDecisionManager bean ID to be used by the created method security interceptor. + + + + + + + + - Username (DN) of the "manager" user identity which will be used to authenticate to a (non-embedded) LDAP server. If omitted, anonymous access will be used. + + Defines a protected method and the access control configuration attributes that apply to it. We strongly advise you NOT to mix "protect" declarations with any services provided "global-method-security". + - - - + + + + + + + + + + + + + + A method name + + + + + + + + + + Access configuration attributes list that applies to the method, e.g. "ROLE_A,ROLE_B". + + + + + + + + - Explicitly specifies an ldif file resource to load into an embedded LDAP server + + Provides method security for all beans registered in the Spring application context. Specifically, beans will be scanned for Spring Security annotations and/or matches with the ordered list of "protect-pointcut" sub-elements. Where there is a match, the beans will automatically be proxied and security authorization applied to the methods accordingly. If you use and enable all three sources of method security metadata (ie "protect-pointcut" declarations, @Secured and also JSR 250 security annotations), the metadata sources will be queried in that order. In practical terms, this enables you to use XML to override method security metadata expressed by way of @Secured annotations, with @Secured annotations overriding method security metadata expressed by JSR 250 annotations. It is perfectly acceptable to mix and match, with a given Java type using a combination of XML, @Secured and JSR 250 to express method security metadata (albeit on different methods). + - - + + + + + + + + Defines a protected pointcut and the access control configuration attributes that apply to it. Every bean registered in the Spring application context that provides a method that matches the pointcut will receive security authorization. + + + + + + + + + + + + + + + + + + + + + + + Specifies that Spring Security's @Secured annotation should be used. Please ensure you have the spring-security-tiger-xxx.jar on the classpath. Defaults to false. + + + + + + + + + + + + + + + + + + + + + + Specifies that JSR-250 style attributes are to be used (for example "RolesAllowed"). This will require the javax.annotation.security classes on the classpath. Defaults to false. + + + + + + + + + + + + + + + + + + + + + + Optional AccessDecisionManager bean ID to override the default. + + + + + + + + + + + + + + + An AspectJ expression, including the 'execution' keyword. For example, 'execution(int com.foo.TargetObject.countLength(String))' (without the quotes). + + + + + + + + + + Access configuration attributes list that applies to all methods matching the pointcut, e.g. "ROLE_A,ROLE_B" + + + + + + + + - Optional root suffix for the embedded LDAP server. Default is "dc=springframework,dc=org" + + Container element for HTTP security configuration + - - - - + + + + + + + + Specifies the access attributes and/or filter list for a particular set of URLs. + + + + + + + + + + + + + Sets up a form login configuration for authentication with a username and password + + + + + + + + + + + + + + + Adds support for X.509 client authentication. + + + + + + + + + + + + + Adds support for basic authentication (this is an element to permit future expansion, such as supporting an "ignoreFailure" attribute) + + + + + + + + + Incorporates a logout processing filter. Most web applications require a logout filter, although you may not require one if you write a controller to provider similar logic. + + + + + + + + + + + + + Adds support for concurrent session control, allowing limits to be placed on the number of sessions a user can have. + + + + + + + + + + + + + + + + + + + + + Adds support for automatically granting all anonymous web requests a particular principal identity and a corresponding granted authority. + + + + + + + + + + + + + Defines the list of mappings between http and https ports for use in redirects + + + + + + + + + + + + + + + + + + + + + + + + + + + Automatically registers a login form, BASIC authentication, anonymous authentication, logout services, remember-me and servlet-api-integration. If set to "true", all of these capabilities are added (although you can still customize the configuration of each by providing the respective element). If unspecified, defaults to "false". + + + + + + + + + + + + + + + + + + + + + + Controls the eagerness with which an HTTP session is created. If not set, defaults to "ifRequired". + + + + + + + + + + + + + + + + + + + + + + + + Defines the type of pattern used to specify URL paths (either JDK 1.4-compatible regular expressions, or Apache Ant expressions). Defaults to "ant" if unspecified. + + + + + + + + + + + + + + + + + + + + + + Whether test URLs should be converted to lower case prior to comparing with defined path patterns. If unspecified, defaults to "true". + + + + + + + + + + + + + + + + + + + + + + Provides versions of HttpServletRequest security methods such as isUserInRole() and getPrincipal() which are implemented by accessing the Spring SecurityContext. Defaults to "true". + + + + + + + + + + + + + + + + + + + + + + Optional attribute specifying the ID of the AccessDecisionManager implementation which should be used for authorizing HTTP requests. + + + + + + + + + + Optional attribute specifying the realm name that will be used for all authentication features that require a realm name (eg BASIC and Digest authentication). If unspecified, defaults to "Spring Security Application". + + + + + + + + + + Indicates whether an existing session should be invalidated when a user authenticates and a new session started. If set to "none" no change will be made. "newSession" will create a new empty session. "migrateSession" will create a new session and copy the session attributes to the new session. Defaults to "migrateSession". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The pattern which defines the URL path. The content will depend on the type set in the containing http element, so will default to ant path syntax. + + + + + + + + + + The access configuration attributes that apply for the configured path. + + + + + + + + + + The HTTP Method for which the access configuration attributes should apply. If not specified, the attributes will apply to any method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The filter list for the path. Currently can be set to "none" to remove a path from having any filters applied. The full filter stack (consisting of all defined filters, will be applied to any other paths). + + + + + + + + + + + + + + + + + + + + Used to specify that a URL must be accessed over http or https + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the URL that will cause a logout. Spring Security will initialize a filter that responds to this particular URL. Defaults to /j_spring_security_logout if unspecified. + + + + + + + + + + Specifies the URL to display once the user has logged out. If not specified, defaults to /. + + + + + + + + + + Specifies whether a logout also causes HttpSession invalidation, which is generally desirable. If unspecified, defaults to true. + + + + + + + + + + + + + + + + + + + + + + + + + + + The URL that the login form is posted to. If unspecified, it defaults to /j_spring_security_check. + + + + + + + + + + The URL that will be redirected to after successful authentication, if the user's previous action could not be resumed. This generally happens if the user visits a login page without having first requested a secured operation that triggers authentication. If unspecified, defaults to the root of the application. + + + + + + + + + + The URL for the login page. If no login URL is specified, Spring Security will automatically create a login URL at /spring_security_login and a corresponding filter to render that login URL when requested. + + + + + + + + + + The URL for the login failure page. If no login failure URL is specified, Spring Security will automatically create a failure login URL at /spring_security_login?login_error and a corresponding filter to render that login failure URL when requested. + + + + + + + + - The optional server to use. If omitted, and a default LDAP server is registered (using <ldap-server> with no Id), that server will be used. + + Sets up form login for authentication with an Open ID identity + - - - - + + + + + + + + + A reference to a user-service (or UserDetailsService bean) Id + + + + + + + + + - Group search filter. Defaults to (uniqueMember={0}). The substituted parameter is the DN of the user. + + Used to explicitly configure a FilterChainProxy instance with a FilterChainMap + - - - - + + + + + + + + Used within filter-chain-map to define a specific URL pattern and the list of filters which apply to the URLs matching that pattern. When multiple filter-chain elements are used within a filter-chain-map element, the most specific patterns must be placed at the top of the list, with most general ones at the bottom. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Search base for group membership searches. Defaults to "ou=groups". + + Used to explicitly configure a FilterInvocationDefinitionSource bean for use with a FilterSecurityInterceptor. Usually only needed if you are configuring a FilterChainProxy explicitly, rather than using the <http> element. The intercept-url elements used should only contain pattern, method and access attributes. Any others will result in a configuration error. + - - - - - - - - - Search base for user searches. Defaults to "". - - - - - - - The LDAP attribute name which contains the role name which will be used within Spring Security. Defaults to "cn". - - - - - - - - - - - - A bean identifier, used for referring to the bean elsewhere in the context. - - - - - The optional server to use. If omitted, and a default LDAP server is registered (using <ldap-server> with no Id), that server will be used. - - - - - - - Group search filter. Defaults to (uniqueMember={0}). The substituted parameter is the DN of the user. - - - - - Search base for group membership searches. Defaults to "ou=groups". - - - - - The LDAP attribute name which contains the role name which will be used within Spring Security. Defaults to "cn". - - - - - - Sets up an ldap authentication provider - - - - - - - - - - - - The optional server to use. If omitted, and a default LDAP server is registered (using <ldap-server> with no Id), that server will be used. - - - - - - - Search base for group membership searches. Defaults to "ou=groups". - - - - - Group search filter. Defaults to (uniqueMember={0}). The substituted parameter is the DN of the user. - - - - - The LDAP attribute name which contains the role name which will be used within Spring Security. Defaults to "cn". - - - - - A specific pattern used to build the user's DN, for example "uid={0},ou=people". The key "{0}" must be present and will be substituted with the username. - - - - - - Specifies that an LDAP provider should use an LDAP compare operation of the user's password to authenticate the user - - - - - - - - - - - - The attribute in the directory which contains the user password. Defaults to "userPassword". - - - - - Defines the hashing algorithm used on user passwords. We recommend strongly against using MD4, as it is a very weak hashing algorithm. - - - - - - - - - - - - - - - - Can be used inside a bean definition to add a security interceptor to the bean and set up access configuration attributes for the bean's methods - - - - - - - - - - - - Optional AccessDecisionManager bean ID to be used by the created method security interceptor. - - - - - - Defines a protected method and the access control configuration attributes that apply to it. We strongly advise you NOT to mix "protect" declarations with any services provided "global-method-security". - - - - - - - - - A method name - - - - - Access configuration attributes list that applies to the method, e.g. "ROLE_A,ROLE_B". - - - - - - Provides method security for all beans registered in the Spring application context. Specifically, beans will be scanned for Spring Security annotations and/or matches with the ordered list of "protect-pointcut" sub-elements. Where there is a match, the beans will automatically be proxied and security authorization applied to the methods accordingly. If you use and enable all three sources of method security metadata (ie "protect-pointcut" declarations, @Secured and also JSR 250 security annotations), the metadata sources will be queried in that order. In practical terms, this enables you to use XML to override method security metadata expressed by way of @Secured annotations, with @Secured annotations overriding method security metadata expressed by JSR 250 annotations. It is perfectly acceptable to mix and match, with a given Java type using a combination of XML, @Secured and JSR 250 to express method security metadata (albeit on different methods). - - - - - - - - - - - - Specifies that Spring Security's @Secured annotation should be used. Please ensure you have the spring-security-tiger-xxx.jar on the classpath. Defaults to false. - - - - - - - - - - - Specifies that JSR-250 style attributes are to be used (for example "RolesAllowed"). This will require the javax.annotation.security classes on the classpath. Defaults to false. - - - - - - - - - - - Optional AccessDecisionManager bean ID to override the default. - - - - - - Defines a protected pointcut and the access control configuration attributes that apply to it. Every bean registered in the Spring application context that provides a method that matches the pointcut will receive security authorization. - - - - - - - - - An AspectJ expression, including the 'execution' keyword. For example, 'execution(int com.foo.TargetObject.countLength(String))' (without the quotes). - - - - - Access configuration attributes list that applies to all methods matching the pointcut, e.g. "ROLE_A,ROLE_B" - - - - - - Container element for HTTP security configuration - - - - - - - - - - - - - - - - - - - - - Automatically registers a login form, BASIC authentication, anonymous authentication, logout services, remember-me and servlet-api-integration. If set to "true", all of these capabilities are added (although you can still customize the configuration of each by providing the respective element). If unspecified, defaults to "false". - - - - - - - - - - - Controls the eagerness with which an HTTP session is created. If not set, defaults to "ifRequired". - - - - - - - - - - - - Defines the type of pattern used to specify URL paths (either JDK 1.4-compatible regular expressions, or Apache Ant expressions). Defaults to "ant" if unspecified. - - - - - - - - - - - Whether test URLs should be converted to lower case prior to comparing with defined path patterns. If unspecified, defaults to "true". - - - - - - - - - - - Provides versions of HttpServletRequest security methods such as isUserInRole() and getPrincipal() which are implemented by accessing the Spring SecurityContext. Defaults to "true". - - - - - - - - - - - Optional attribute specifying the ID of the AccessDecisionManager implementation which should be used for authorizing HTTP requests. - - - - - Optional attribute specifying the realm name that will be used for all authentication features that require a realm name (eg BASIC and Digest authentication). If unspecified, defaults to "Spring Security Application". - - - - - - Specifies the access attributes and/or filter list for a particular set of URLs. - - - - - - - - - The pattern which defines the URL path. The content will depend on the type set in the containing http element, so will default to ant path syntax. - - - - - The access configuration attributes that apply for the configured path. - - - - - The HTTP Method for which the access configuration attributes should apply. If not specified, the attributes will apply to any method. - - - - - - - - - - - - - - - - The filter list for the path. Currently can be set to "none" to remove a path from having any filters applied. The full filter stack (consisting of all defined filters, will be applied to any other paths). - - - - - - - - - - Used to specify that a URL must be accessed over http or https - - - - - - - - - - - - - Incorporates a logout processing filter. Most web applications require a logout filter, although you may not require one if you write a controller to provider similar logic. - - - - - - - - - Specifies the URL that will cause a logout. Spring Security will initialize a filter that responds to this particular URL. Defaults to /j_spring_security_logout if unspecified. - - - - - Specifies the URL to display once the user has logged out. If not specified, defaults to /. - - - - - Specifies whether a logout also causes HttpSession invalidation, which is generally desirable. If unspecified, defaults to true. - - - - - - - - - - - - Sets up a form login configuration for authentication with a username and password - - - - - - - - - The URL that the login form is posted to. If unspecified, it defaults to /j_spring_security_check. - - - - - The URL that will be redirected to after successful authentication, if the user's previous action could not be resumed. This generally happens if the user visits a login page without having first requested a secured operation that triggers authentication. If unspecified, defaults to the root of the application. - - - - - The URL for the login page. If no login URL is specified, Spring Security will automatically create a login URL at /spring_security_login and a corresponding filter to render that login URL when requested. - - - - - The URL for the login failure page. If no login failure URL is specified, Spring Security will automatically create a failure login URL at /spring_security_login?login_error and a corresponding filter to render that login failure URL when requested. - - - - - - Sets up form login for authentication with an Open ID identity - - - + + + + + + + + Specifies the access attributes and/or filter list for a particular set of URLs. + + + + + + + + + + + + + + + + + + + + + + + A bean identifier, used for referring to the bean elsewhere in the context. + + + + + + + + + + as for http element + + + + + + + + + + + + + + + + + + + + + + Defines the type of pattern used to specify URL paths (either JDK 1.4-compatible regular expressions, or Apache Ant expressions). Defaults to "ant" if unspecified. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The key used between the provider and filter. This generally does not need to be set. If unset, it will default to "doesNotMatter". + + + + + + + + + + The username that should be assigned to the anonymous request. This allows the principal to be identified, which may be important for logging and auditing. if unset, defaults to "anonymousUser". + + + + + + + + + + The granted authority that should be assigned to the anonymous request. Commonly this is used to assign the anonymous request particular roles, which can subsequently be used in authorization decisions. If unset, defaults to "ROLE_ANONYMOUS". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The regular expression used to obtain the username from the certificate's subject. Defaults to matching on the common name using the pattern "CN=(.*?),". + + + + + - - A reference to a user-service (or UserDetailsService bean) Id - + + + + A reference to a user-service (or UserDetailsService bean) Id + + + - - - - - Used to explicitly configure a FilterChainProxy instance with a FilterChainMap - - + + + + + + + If you are using namespace configuration with Spring Security, an AuthenticationManager will automatically be registered. This element simple allows you to define an alias to allow you to reference the authentication-manager in your own beans. + + + + + + + + + + + + + + The alias you wish to use for the AuthenticationManager bean + + + + + + + + + + + Indicates that the contained user-service should be used as an authentication source. + + + + + + + + + + + + + + + + + + + + + + + + A reference to a user-service (or UserDetailsService bean) Id + + + + + + + + + + + + + + + Creates an in-memory UserDetailsService from a properties file or a list of "user" child elements. + + + + + + + + + + + + + + + A bean identifier, used for referring to the bean elsewhere in the context. + + + + + + + + + + + + + + + + + + + + Represents a user in the application. + + + + + + + + + + + + + + + + The username assigned to the user. + + + + + + + + + + The password assigned to the user. This may be hashed if the corresponding authentication provider supports hashing (remember to set the "hash" attribute of the "user-service" element). + + + + + + + + + + One of more authorities granted to the user. Separate authorities with a comma (but no space). For example, "ROLE_USER,ROLE_ADMINISTRATOR" + + + + + + + + + + Can be set to "true" to mark an account as locked and unusable. + + + + + + + + + + + + + + + + + + + + + + + Causes creation of a JDBC-based UserDetailsService. + + + + + + + + + A bean identifier, used for referring to the bean elsewhere in the context. + + + + + + + + + + + + + + + + + The bean ID of the DataSource which provides the required tables. + + + + + + + + + + + - + + + - - - - - - - - - Used within filter-chain-map to define a specific URL pattern and the list of filters which apply to the URLs matching that pattern. When multiple filter-chain elements are used within a filter-chain-map element, the most specific patterns must be placed at the top of the list, with most general ones at the bottom. - - - - - - - - - - - - Used to explicitly configure a FilterInvocationDefinitionSource bean for use with a FilterSecurityInterceptor. Usually only needed if you are configuring a FilterChainProxy explicitly, rather than using the <http> element. The intercept-url elements used should only contain pattern, method and access attributes. Any others will result in a configuration error. - - - - - - - - - - + + + + - A bean identifier, used for referring to the bean elsewhere in the context. + + Used to indicate that a filter bean declaration should be incorporated into the security filter chain. If neither the 'after' or 'before' options are supplied, then the filter must implement the Ordered interface directly. + - - - - as for http element - - - - - - - - - - - Defines the type of pattern used to specify URL paths (either JDK 1.4-compatible regular expressions, or Apache Ant expressions). Defaults to "ant" if unspecified. - - - - - - - - - - - - Adds support for basic authentication (this is an element to permit future expansion, such as supporting an "ignoreFailure" attribute) - - - - - - Adds support for concurrent session control, allowing limits to be placed on the number of sessions a user can have. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Adds support for automatically granting all anonymous web requests a particular principal identity and a corresponding granted authority. - - - - - - - - - The key used between the provider and filter. This generally does not need to be set. If unset, it will default to "doesNotMatter". - - - - - The username that should be assigned to the anonymous request. This allows the principal to be identified, which may be important for logging and auditing. if unset, defaults to "anonymousUser". - - - - - The granted authority that should be assigned to the anonymous request. Commonly this is used to assign the anonymous request particular roles, which can subsequently be used in authorization decisions. If unset, defaults to "ROLE_ANONYMOUS". - - - - - - Defines the list of mappings between http and https ports for use in redirects - - - - - - - - - - - - - - - - - - - - - - Adds support for X.509 client authentication. - - - - - - - - - The regular expression used to obtain the username from the certificate's subject. Defaults to matching on the common name using the pattern "CN=(.*?),". - - - - - A reference to a user-service (or UserDetailsService bean) Id - - - - - - If you are using namespace configuration with Spring Security, an AuthenticationManager will automatically be registered. This element simple allows you to define an alias to allow you to reference the authentication-manager in your own beans. - - - - - - - - The alias you wish to use for the AuthenticationManager bean - - - - - - Indicates that the contained user-service should be used as an authentication source. - - - - - - - - - - - - - A reference to a user-service (or UserDetailsService bean) Id - - - - - - - - - Creates an in-memory UserDetailsService from a properties file or a list of "user" child elements. - - - - - - - - A bean identifier, used for referring to the bean elsewhere in the context. - + + + + + + + The filter immediately after which the custom-filter should be placed in the chain. This feature will only be needed by advanced users who wish to mix their own filters into the security filter chain and have some knowledge of the standard Spring Security filters. The filter names map to specific Spring Security implementation filters. + + + + + + + + + + The filter immediately before which the custom-filter should be placed in the chain + + + + + + + + + + + + + + + The filter immediately after which the custom-filter should be placed in the chain. This feature will only be needed by advanced users who wish to mix their own filters into the security filter chain and have some knowledge of the standard Spring Security filters. The filter names map to specific Spring Security implementation filters. + + + - - - - - - - - - Represents a user in the application. - - - - - - - - - The username assigned to the user. - - - - - The password assigned to the user. This may be hashed if the corresponding authentication provider supports hashing (remember to set the "hash" attribute of the "user-service" element). - - - - - One of more authorities granted to the user. Separate authorities with a comma (but no space). For example, "ROLE_USER,ROLE_ADMINISTRATOR" - - - - - Can be set to "true" to mark an account as locked and unusable. - - - - - - - - - - - - Causes creation of a JDBC-based UserDetailsService. - - - - - A bean identifier, used for referring to the bean elsewhere in the context. - + + + + + + + + + + The filter immediately before which the custom-filter should be placed in the chain + + + - - - - - - - The bean ID of the DataSource which provides the required tables. - - - - - - - - - - - - Used to indicate that a filter bean declaration should be incorporated into the security filter chain. If neither the 'after' or 'before' options are supplied, then the filter must implement the Ordered interface directly. - - - - - The filter immediately after which the custom-filter should be placed in the chain. This feature will only be needed by advanced users who wish to mix their own filters into the security filter chain and have some knowledge of the standard Spring Security filters. The filter names map to specific Spring Security implementation filters. - - - - - The filter immediately before which the custom-filter should be placed in the chain - - - - - - - - The filter immediately after which the custom-filter should be placed in the chain. This feature will only be needed by advanced users who wish to mix their own filters into the security filter chain and have some knowledge of the standard Spring Security filters. The filter names map to specific Spring Security implementation filters. - - - - - - - The filter immediately before which the custom-filter should be placed in the chain - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +