Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Deprecated, pending deletion.

This commit is contained in:
Luke Taylor 2006-04-16 14:12:23 +00:00
parent bbd250e442
commit 7c69668589
2 changed files with 7 additions and 161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
core/src/main/java/org/acegisecurity/providers/ldap/LdapUserSearch.java
View File

@ -15,8 +15,6 @@
package org.acegisecurity.providers.ldap;
import org.acegisecurity.providers.ldap.LdapUserInfo;
/**
* Obtains a user's information from the LDAP directory given a login name.
* <p>
@ -25,19 +23,10 @@ import org.acegisecurity.providers.ldap.LdapUserInfo;
* mapping.
* </p>
*
* @deprecated moved to org.acegisecurity.ldap
* @author Luke Taylor
* @version $Id$
*/
public interface LdapUserSearch {
/**
* Locates a single user in the directory and returns the LDAP information
* for that user.
*
* @param username the login name supplied to the authentication service.
* @return an LdapUserInfo object containing the user's full DN and requested attributes.
* TODO: Need to optionally supply required attributes here for the search.
*/
LdapUserInfo searchForUser(String username);
public interface LdapUserSearch extends org.acegisecurity.ldap.LdapUserSearch {
}

153
core/src/main/java/org/acegisecurity/providers/ldap/search/FilterBasedLdapUserSearch.java
View File

@ -15,163 +15,20 @@
package org.acegisecurity.providers.ldap.search;
import org.acegisecurity.providers.ldap.*;
import org.acegisecurity.userdetails.UsernameNotFoundException;
import org.acegisecurity.BadCredentialsException;
import org.springframework.util.Assert;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.acegisecurity.ldap.InitialDirContextFactory;
import javax.naming.directory.SearchControls;
import javax.naming.directory.SearchResult;
import javax.naming.directory.DirContext;
import javax.naming.NamingException;
import javax.naming.NamingEnumeration;
/**
* LdapUserSearch implementation which uses an Ldap filter to locate the user.
*
* @deprecated Moved to org.acegisecurity.ldap.search
* @author Robert Sanders
* @author Luke Taylor
* @version $Id$
*/
public class FilterBasedLdapUserSearch implements LdapUserSearch {
//~ Static fields/initializers =============================================
private static final Log logger = LogFactory.getLog(FilterBasedLdapUserSearch.class);
//~ Instance fields ========================================================
/**
* Context name to search in, relative to the root DN of the configured
* InitialDirContextFactory.
*/
private String searchBase = "";
/**
* If true then searches the entire subtree as identified by context,
* if false (the default) then only searches the level identified by the context.
*/
// private boolean searchSubtree = false;
private int searchScope = SearchControls.ONELEVEL_SCOPE;
/**
* The filter expression used in the user search. This is an LDAP
* search filter (as defined in 'RFC 2254') with optional arguments. See the documentation
* for the <tt>search</tt> methods in {@link javax.naming.directory.DirContext DirContext}
* for more information.
* <p>
* In this case, the username is the only parameter.
* </p>
* Possible examples are:
* <ul>
* <li>(uid={0}) - this would search for a username match on the uid attribute.</li>
* </ul>
* TODO: more examples.
*
*/
private String searchFilter;
/**
* The time (in milliseconds) which to wait before the search fails;
* the default is zero, meaning forever.
*/
private int searchTimeLimit = 0;
private InitialDirContextFactory initialDirContextFactory;
//~ Methods ================================================================
public FilterBasedLdapUserSearch(String searchBase,
String searchFilter,
InitialDirContextFactory initialDirContextFactory) {
Assert.notNull(initialDirContextFactory, "initialDirContextFactory must not be null");
Assert.notNull(searchFilter, "searchFilter must not be null.");
Assert.notNull(searchBase, "searchBase must not be null (an empty string is acceptable).");
this.searchFilter = searchFilter;
this.initialDirContextFactory = initialDirContextFactory;
this.searchBase = searchBase;
if(searchBase.length() == 0) {
logger.info("SearchBase not set. Searches will be performed from the root: " +
initialDirContextFactory.getRootDn());
}
public class FilterBasedLdapUserSearch extends org.acegisecurity.ldap.search.FilterBasedLdapUserSearch {
public FilterBasedLdapUserSearch(String searchBase, String searchFilter, InitialDirContextFactory initialDirContextFactory) {
super(searchBase, searchFilter, initialDirContextFactory);
}
//~ Methods ================================================================
/**
* Return the LdapUserInfo containing the user's information, or null if
* no SearchResult is found.
*
* @param username the username to search for.
*/
public LdapUserInfo searchForUser(String username) {
DirContext ctx = initialDirContextFactory.newInitialDirContext();
SearchControls ctls = new SearchControls();
ctls.setTimeLimit( searchTimeLimit );
ctls.setSearchScope( searchScope );
if (logger.isDebugEnabled()) {
logger.debug("Searching for user '" + username + "', in context " + ctx +
", with user search " + this.toString());
}
try {
String[] args = new String[] { LdapUtils.escapeNameForFilter(username) };
NamingEnumeration results = ctx.search(searchBase, searchFilter, args, ctls);
if (!results.hasMore()) {
throw new UsernameNotFoundException("User " + username + " not found in directory.");
}
SearchResult searchResult = (SearchResult)results.next();
if (results.hasMore()) {
throw new BadCredentialsException("Expected a single user but search returned multiple results");
}
StringBuffer userDn = new StringBuffer(searchResult.getName());
if (searchBase.length() > 0) {
userDn.append(",");
userDn.append(searchBase);
}
userDn.append(",");
userDn.append(ctx.getNameInNamespace());
return new LdapUserInfo(userDn.toString(), searchResult.getAttributes());
} catch(NamingException ne) {
throw new LdapDataAccessException("User Couldn't be found due to exception", ne);
} finally {
LdapUtils.closeContext(ctx);
}
}
public void setSearchSubtree(boolean searchSubtree) {
// this.searchSubtree = searchSubtree;
this.searchScope = searchSubtree ?
SearchControls.SUBTREE_SCOPE : SearchControls.ONELEVEL_SCOPE;
}
public void setSearchTimeLimit(int searchTimeLimit) {
this.searchTimeLimit = searchTimeLimit;
}
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append("[ searchFilter: '").append(searchFilter).append("', ");
sb.append("searchBase: '").append(searchBase).append("'");
sb.append(", scope: ").append(searchScope ==
SearchControls.SUBTREE_SCOPE ? "subtree" : "single-level, ");
sb.append("searchTimeLimit: ").append(searchTimeLimit).append(" ]");
return sb.toString();
}
}