diff --git a/src/docbkx/jaas-auth-provider.xml b/src/docbkx/jaas-auth-provider.xml index c7a8cb0009..844948c62d 100644 --- a/src/docbkx/jaas-auth-provider.xml +++ b/src/docbkx/jaas-auth-provider.xml @@ -1,10 +1,8 @@ -Java Authentication and Authorization Service (JAAS) - Provider - - -
Overview - - + + Java Authentication and Authorization Service (JAAS) Provider + +
+ Overview Spring Security provides a package able to delegate authentication requests to the Java Authentication and Authorization Service (JAAS). This package is discussed in detail below. @@ -16,9 +14,8 @@ syntax in order to understand this section.
-
Configuration - - +
+ Configuration The JaasAuthenticationProvider attempts to authenticate a user’s principal and credentials through JAAS. @@ -36,34 +33,31 @@ above JAAS login configuration file: - <bean id="jaasAuthenticationProvider" - class="org.springframework.security.providers.jaas.JaasAuthenticationProvider"> - <property name="loginConfig"> - <value>/WEB-INF/login.conf</value> - </property> - <property name="loginContextName"> - <value>JAASTest</value> - </property> - <property name="callbackHandlers"> - <list> - <bean class="org.springframework.security.providers.jaas.JaasNameCallbackHandler"/> - <bean class="org.springframework.security.providers.jaas.JaasPasswordCallbackHandler"/> - </list> - </property> - <property name="authorityGranters"> - <list> - <bean class="org.springframework.security.providers.jaas.TestAuthorityGranter"/> - </list> - </property> -</bean> - + + + + + + + + + + + + + + + +]]> The CallbackHandlers and AuthorityGranters are discussed below. -
JAAS CallbackHandler - +
+ JAAS CallbackHandler Most JAAS LoginModules require a callback of some sort. These callbacks are usually used to obtain the @@ -102,7 +96,8 @@ being wrapped.
-
JAAS AuthorityGranter +
+ JAAS AuthorityGranter JAAS works with principals. Even "roles" are represented as diff --git a/src/docbkx/ldap-auth-provider.xml b/src/docbkx/ldap-auth-provider.xml index 5630ad7290..afcbc33f60 100644 --- a/src/docbkx/ldap-auth-provider.xml +++ b/src/docbkx/ldap-auth-provider.xml @@ -1,7 +1,11 @@ -LDAP Authentication - -
Overview - + + + LDAP Authentication + +
+ + Overview + LDAP is often used by organizations as a central repository for user information and as an authentication service. It can also be used to store the role information for application users. @@ -11,143 +15,205 @@ configured to handle a wide range of situations. You should be familiar with LDAP before trying to use it with Spring Security. The following link provides a good introduction to the concepts involved and a guide to - setting up a directory using the free LDAP server OpenLDAP: http://www.zytrax.com/books/ldap/. Some familiarity with the JNDI APIs used - to access LDAP from Java may also be useful. We don't use any third-party LDAP libraries + setting up a directory using the free LDAP server OpenLDAP: + http://www.zytrax.com/books/ldap/. + Some familiarity with the JNDI APIs used to access LDAP from Java may also be useful. We don't use any third-party LDAP libraries (Mozilla, JLDAP etc.) in the LDAP provider, but extensive use is made of Spring LDAP, so some familiarity with that project may be useful if you plan on adding your own customizations.
-
Using LDAP with Spring Security - - LDAP authentication in Spring Security can be roughly divided into the following - stages. +
+ + Using LDAP with Spring Security + + + LDAP authentication in Spring Security can be roughly divided into the following stages. + - Obtaining the unique LDAP Distinguished Name, or DN, from - the login name. This will often mean performing a search in the directory, - unless the exact mapping of usernames to DNs is known in advance. + Obtaining the unique LDAP + Distinguished Name, or DN, from the login name. This will + often mean performing a search in the directory, unless the exact mapping of + usernames to DNs is known in advance. Authenticating the user, either by binding as that user or by performing a - remote compare operation of the user's password against the - password attribute in the directory entry for the DN. + remote + compare + operation of the user's password against the password attribute in the + directory entry for the DN. Loading the list of authorities for the user. - The exception is when the LDAP directory is just being used to retrieve - user information and authenticate against it locally. This may not be possible as - directories are often set up with limited read access for attributes such as user - passwords. - We will look at some configuration scenarios below. For full information on available + + The exception is when the LDAP directory is just being used to retrieve user information + and authenticate against it locally. This may not be possible as directories are often + set up with limited read access for attributes such as user passwords. + + + We will look at some configuration scenarios below. For full information on available configuration options, please consult the security namespace schema (information from - which should be available in your XML editor). + which should be available in your XML editor). +
-
Configuring an LDAP Server - - The first thing you need to do is configure the server against which authentication - should take place. This is done using the <ldap-server> element - from the security namespace. This can be configured to point at an external LDAP server, - using the url attribute: - <ldap-server url="ldap://springframework.org:389/dc=springframework,dc=org" /> - -
Using an Embedded Test Server - - The <ldap-server> element can also be used to create an - embedded server, which can be very useful for testing and demonstrations. In this - case you use it without the url attribute: - <ldap-server root="dc=springframework,dc=org"/> - Here we've specified that the root DIT of the directory should be - dc=springframework,dc=org, which is the default. Used this way, - the namespace parser will create an embedded Apache Directory server and scan the +
+ + Configuring an LDAP Server + + + The first thing you need to do is configure the server against which authentication + should take place. This is done using the + <ldap-server> + element from the security namespace. This can be configured to point at an external LDAP + server, using the + url + attribute: + + ]]> + + +
+ + Using an Embedded Test Server + + + The + <ldap-server> + element can also be used to create an embedded server, which can be very useful for + testing and demonstrations. In this case you use it without the + url + attribute: + + ]]> + + Here we've specified that the root DIT of the directory should be + dc=springframework,dc=org, which is the default. Used this way, the + namespace parser will create an embedded Apache Directory server and scan the classpath for any LDIF files, which it will attempt to load into the server. You can - customize this behaviour using the ldif attribute, which defines - an LDIF resource to be loaded: - <ldap-server ldif="classpath:users.ldif" /> - This makes it a lot easier to get up and running with LDAP, since it can be + customize this behaviour using the + ldif + attribute, which defines an LDIF resource to be loaded: + + ]]> + This makes it a lot easier to get up and running with LDAP, since it can be inconvenient to work all the time with an external server. It also insulates the user from the complex bean configuration needed to wire up an Apache Directory server. Using plain Spring Beans the configuration would be much more cluttered. You must have the necessary Apache Directory dependency jars available for your - application to use. These can be obtained from the LDAP sample application. + application to use. These can be obtained from the LDAP sample application. +
-
Using Bind Authentication - - This is the most common LDAP authentication scenario. - - <ldap-authentication-provider user-dn-pattern="uid={0},ou=people"/> - This simple example would obtain the DN for the user by - substituting the user login name in the supplied pattern and attempting to bind as - that user with the login password. This is OK if all your users are stored under a - single node in the directory. If instead you wished to configure an LDAP search - filter to locate the user, you could use the following: - - <ldap-authentication-provider user-search-filter="(uid={0})" user-search-base="ou=people"/> - If used with the server definition above, this would - perform a search under the DN ou=people,dc=springframework,dc=org - using the value of the user-search-filter attribute as a filter. - Again the user login name is substituted for the parameter in the filter name. If - user-search-base isn't supplied, the search will be performed - from the root. +
+ + Using Bind Authentication + + + This is the most common LDAP authentication scenario. + + + ]]> + This simple example would obtain the DN for the user by substituting the user login + name in the supplied pattern and attempting to bind as that user with the login + password. This is OK if all your users are stored under a single node in the + directory. If instead you wished to configure an LDAP search filter to locate the + user, you could use the following: + + ]]> + If used with the server definition above, this would perform a search under the DN + ou=people,dc=springframework,dc=org + using the value of the + user-search-filter + attribute as a filter. Again the user login name is substituted for the parameter in + the filter name. If + user-search-base + isn't supplied, the search will be performed from the root. +
-
Loading Authorities - - How authorities are loaded from groups in the LDAP directory is controlled by the - following attributes. +
+ + Loading Authorities + + + How authorities are loaded from groups in the LDAP directory is controlled by the + following attributes. + - group-search-base. Defines the part of the - directory tree under which group searches should be performed. + + group-search-base. Defines the part of the directory + tree under which group searches should be performed. - group-role-attribute. The attribute which contains + + group-role-attribute. The attribute which contains the name of the authority defined by the group entry. Defaults to - cn + cn + - group-search-filter. The filter which is used to - search for group membership. The default is uniqueMember={0}, corresponding to the groupOfUniqueMembers LDAP class. In this case, the - substituted parameter is the full distinguished name of the user. The - parameter {1} can be used if you want to filter on - the login name. + + group-search-filter. The filter which is used to + search for group membership. The default is + uniqueMember={0}, corresponding to the + groupOfUniqueMembers + LDAP class. In this case, the substituted parameter is the full + distinguished name of the user. The parameter + {1} + can be used if you want to filter on the login name. - So if we used the following configuration - - <ldap-authentication-provider user-dn-pattern="uid={0},ou=people group-search-base="ou=groups" /> - and authenticated successfully as user ben, - the subsequent loading of authorities would perform a search under the directory - entry ou=groups,dc=springframework,dc=org, looking for entries - which contain the attribute uniqueMember with value uid=ben,ou=people,dc=springframework,dc=org. For more information on - loading authorities, see the Javadoc for the - DefaultLdapAuthoritiesPopulator class. + + So if we used the following configuration + + ]]> + and authenticated successfully as user + ben, the subsequent loading of authorities would perform a search + under the directory entry + ou=groups,dc=springframework,dc=org, looking for entries which + contain the attribute + uniqueMember + with value + uid=ben,ou=people,dc=springframework,dc=org. For more information + on loading authorities, see the Javadoc for the + DefaultLdapAuthoritiesPopulator + class. +
-
Implementation Classes - +
+ + Implementation Classes + The namespace configuration options we've used above are simple to use and much more concise than using Spring beans explicitly. There are situations when you may need to know how to configure Spring Security LDAP directly in your application context. You may - wish to customize the behaviour of some of the classes, for example. If you're happy using - namespace configuration then you can skip this section and the next one. + wish to customize the behaviour of some of the classes, for example. If you're happy + using namespace configuration then you can skip this section and the next one. - - The main LDAP - provider class is - org.springframework.security.providers.ldap.LdapAuthenticationProvider. + The main LDAP provider class is + org.springframework.security.providers.ldap.LdapAuthenticationProvider. This bean doesn't actually do much itself but delegates the work to two other beans, an - LdapAuthenticator and an - LdapAuthoritiesPopulator which are responsible for - authenticating the user and retrieving the user's set of + LdapAuthenticator + and an + LdapAuthoritiesPopulator + which are responsible for authenticating the user and retrieving the user's set of GrantedAuthoritys respectively. -
LdapAuthenticator Implementations - +
+ + LdapAuthenticator Implementations + The authenticator is also responsible for retrieving any required user attributes. This is because the permissions on the attributes may depend on the type of authentication being used. For example, if binding as the user, it may be necessary to read them with the user's own permissions. - There are currently two authentication strategies supplied with Spring Security: + There are currently two authentication strategies supplied with Spring Security: + - Authentication directly to the LDAP server ("bind" - authentication). + Authentication directly to the LDAP server ("bind" authentication). Password comparison, where the password supplied by the user is @@ -157,127 +223,167 @@ password is passed to the server for comparison and the real password value is never retrieved. - -
Common Functionality - + + +
+ + Common Functionality + Before it is possible to authenticate a user (by either strategy), the distinguished name (DN) has to be obtained from the login name supplied to the application. This can be done either by simple pattern-matching (by setting the - setUserDnPatterns array property) or by setting the - userSearch property. For the DN pattern-matching - approach, a standard Java pattern format is used, and the login name will be - substituted for the parameter {0}. The pattern should be - relative to the DN that the configured - InitialDirContextFactory will bind to (see the - section on connecting to the LDAP - server for more information on this). For example, if you are using an - LDAP server with the URL ldap://monkeymachine.co.uk/dc=springframework,dc=org, and have a - pattern uid={0},ou=greatapes, then a login name of "gorilla" - will map to a DN uid=gorilla,ou=greatapes,dc=springframework,dc=org. Each configured - DN pattern will be tried in turn until a match is found. For information on - using a search, see the section on search - objects below. A combination of the two approaches can also be used - - the patterns will be checked first and if no matching DN is found, the search - will be used. + setUserDnPatterns + array property) or by setting the + userSearch + property. For the DN pattern-matching approach, a standard Java pattern format + is used, and the login name will be substituted for the parameter + {0}. The pattern should be relative to the DN that the + configured + InitialDirContextFactory + will bind to (see the section on + connecting to the LDAP server + for more information on this). For example, if you are using an LDAP server with + the URL + ldap://monkeymachine.co.uk/dc=springframework,dc=org, and + have a pattern + uid={0},ou=greatapes, then a login name of "gorilla" will map + to a DN + uid=gorilla,ou=greatapes,dc=springframework,dc=org. Each + configured DN pattern will be tried in turn until a match is found. For + information on using a search, see the section on + search objects + below. A combination of the two approaches can also be used - the patterns will + be checked first and if no matching DN is found, the search will be used.
-
BindAuthenticator - +
+ + BindAuthenticator + The class - org.springframework.security.providers.ldap.authenticator.BindAuthenticator + org.springframework.security.providers.ldap.authenticator.BindAuthenticator implements the bind authentication strategy. It simply attempts to bind as the user.
-
PasswordComparisonAuthenticator - +
+ + PasswordComparisonAuthenticator + The class - org.springframework.security.providers.ldap.authenticator.PasswordComparisonAuthenticator + org.springframework.security.providers.ldap.authenticator.PasswordComparisonAuthenticator implements the password comparison authentication strategy.
-
Active Directory Authentication - +
+ + Active Directory Authentication + In addition to standard LDAP authentication (binding with a DN), Active Directory has its own non-standard syntax for user authentication.
-
Connecting to the LDAP Server - +
+ + Connecting to the LDAP Server + The beans discussed above have to be able to connect to the server. They both have - to be supplied with a SpringSecurityContextSource - which is an extension of Spring LDAP's ContextSource. - Unless you have special requirements, you will usually - configure a DefaultSpringSecurityContextSource bean, which can be - configured with the URL of your LDAP server and optionally with the username and - password of a "manager" user which will be used by default when binding to the - server (instead of binding anonymously). For more information read the Javadoc for - this class and for Spring LDAP's AbstractContextSource. + to be supplied with a + SpringSecurityContextSource + which is an extension of Spring LDAP's + ContextSource. Unless you have special requirements, + you will usually configure a + DefaultSpringSecurityContextSource + bean, which can be configured with the URL of your LDAP server and optionally with + the username and password of a "manager" user which will be used by default when + binding to the server (instead of binding anonymously). For more information read + the Javadoc for this class and for Spring LDAP's + AbstractContextSource.
-
LDAP Search Objects - +
+ + LDAP Search Objects + Often more a more complicated strategy than simple DN-matching is required to locate a user entry in the directory. This can be encapsulated in an - LdapUserSearch instance which can be supplied to - the authenticator implementations, for example, to allow them to locate a user. The - supplied implementation is FilterBasedLdapUserSearch. -
<classname>FilterBasedLdapUserSearch</classname> - + LdapUserSearch + instance which can be supplied to the authenticator implementations, for example, to + allow them to locate a user. The supplied implementation is + FilterBasedLdapUserSearch. +
+ + + <classname>FilterBasedLdapUserSearch</classname> + + This bean uses an LDAP filter to match the user object in the directory. The process is explained in the Javadoc for the corresponding search method on the - JDK DirContext class. As explained there, the search filter can be - supplied with parameters. For this class, the only valid parameter is {0} which will be replaced with the user's login name. + JDK + DirContext class. + As explained there, the search filter can be supplied with parameters. For this class, the only valid parameter is + {0} + which will be replaced with the user's login name.
-
Spring Bean Configuration - +
+ + Spring Bean Configuration + A typical configuration, using some of the beans we've discussed here, might look - like this: - -<bean id="contextSource" - class="org.springframework.security.ldap.DefaultSpringSecurityContextSource"> - <constructor-arg value="ldap://monkeymachine:389/dc=springframework,dc=org"/> - <property name="userDn" value="cn=manager,dc=springframework,dc=org"/> - <property name="password" value="password"/> -</bean> + like this: + + + + + + -<bean id="ldapAuthProvider" - class="org.springframework.security.providers.ldap.LdapAuthenticationProvider"> - <constructor-arg> - <bean class="org.springframework.security.providers.ldap.authenticator.BindAuthenticator"> - <constructor-arg ref="contextSource"/> - <property name="userDnPatterns"><list><value>uid={0},ou=people</value></list></property> - </bean> - </constructor-arg> - <constructor-arg> - <bean class="org.springframework.security.ldap.populator.DefaultLdapAuthoritiesPopulator"> - <constructor-arg ref="contextSource"/> - <constructor-arg value="ou=groups"/> - <property name="groupRoleAttribute" value="ou"/> - </bean> - </constructor-arg> -</bean> - - This would set up the provider to access an LDAP server with URL + + + + + uid={0},ou=people + + + + + + + + + +]]> + + This would set up the provider to access an LDAP server with URL ldap://monkeymachine:389/dc=springframework,dc=org. - Authentication will be performed by attempting to bind with the DN uid=<user-login-name>,ou=people,dc=springframework,dc=org. After - successful authentication, roles will be assigned to the user by searching under the DN - ou=groups,dc=springframework,dc=org with the default filter + Authentication will be performed by attempting to bind with the DN + uid=<user-login-name>,ou=people,dc=springframework,dc=org. + After successful authentication, roles will be assigned to the user by searching + under the DN + ou=groups,dc=springframework,dc=org + with the default filter (member=<user's-DN>). The role name will be taken from the - ou attribute of each match. + ou + attribute of each match. To configurae a user search object, which uses the filter - (uid=<user-login-name>) for use instead of the - DN-pattern (or in addition to it), you would configure the following bean + (uid=<user-login-name>) + for use instead of the DN-pattern (or in addition to it), you would configure the + following bean -<bean id="userSearch" - class="org.springframework.security.ldap.search.FilterBasedLdapUserSearch"> - <constructor-arg index="0" value=""/> - <constructor-arg index="1" value="(uid={0})"/> - <constructor-arg index="2" ref="contextSource" /> - <property name="searchSubtree" value="true"/> -</bean> - - and use it by setting the authenticator's userSearch property. The authenticator - would then call the search object to obtain the correct user's DN before attempting to bind as this user. + + + + + + ]]> + + and use it by setting the authenticator's + userSearch + property. The authenticator would then call the search object to obtain the correct + user's DN before attempting to bind as this user.
- \ No newline at end of file