File	Doc	Category	Size	Date	Package
JAASMemoryLoginModule.java	API Doc	Apache Tomcat 6.0.14	13705	Fri Jul 20 04:20:36 BST 2007	org.apache.catalina.realm

JAASMemoryLoginModule

• java.lang.Object
  • MemoryRealm

Fields Summary
private static org.apache.juli.logging.Log	log
protected CallbackHandler	callbackHandler The callback handler responsible for answering our requests.
protected boolean	committed Has our own commit() returned successfully?
protected Map	options The configuration information for this LoginModule.
protected String	pathname The absolute or relative pathname to the XML configuration file.
protected Principal	principal The Principal identified by our validation, or null if validation falied.
protected HashMap	principals The set of Principals loaded from our configuration file.
protected static org.apache.catalina.util.StringManager	sm The string manager for this package.
protected Map	sharedState The state information that is shared with other configured LoginModule instances.
protected Subject	subject The subject for which we are performing authentication.

Constructors Summary
public JAASMemoryLoginModule() // --------------------------------------------------------- Public Methods log.debug("MEMORY LOGIN MODULE");

Methods Summary
public boolean	abort() Phase 2 of authenticating a Subject when Phase 1 fails. This method is called if the LoginContext failed somewhere in the overall authentication chain. return true if this method succeeded, or false if this LoginModule should be ignored exception LoginException if the abort fails // If our authentication was not successful, just return false if (principal == null) return (false); // Clean up if overall authentication failed if (committed) logout(); else { committed = false; principal = null; } log.debug("Abort"); return (true);
public boolean	commit() Phase 2 of authenticating a Subject when Phase 1 was successful. This method is called if the LoginContext succeeded in the overall authentication chain. return true if the authentication succeeded, or false if this LoginModule should be ignored exception LoginException if the commit fails log.debug("commit " + principal); // If authentication was not successful, just return false if (principal == null) return (false); // Add our Principal to the Subject if needed if (!subject.getPrincipals().contains(principal)) subject.getPrincipals().add(principal); committed = true; return (true);
public org.apache.catalina.deploy.SecurityConstraint[]	findSecurityConstraints(org.apache.catalina.connector.Request request, org.apache.catalina.Context context) Return the SecurityConstraints configured to guard the request URI for this request, or null if there is no such constraint. param request Request we are processing param context Context the Request is mapped to ArrayList<SecurityConstraint> results = null; // Are there any defined security constraints? SecurityConstraint constraints[] = context.findConstraints(); if ((constraints == null) || (constraints.length == 0)) { if (context.getLogger().isDebugEnabled()) context.getLogger().debug(" No applicable constraints defined"); return (null); } // Check each defined security constraint String uri = request.getDecodedRequestURI(); String contextPath = request.getContextPath(); if (contextPath.length() > 0) uri = uri.substring(contextPath.length()); uri = RequestUtil.URLDecode(uri); // Before checking constraints String method = request.getMethod(); for (int i = 0; i < constraints.length; i++) { if (context.getLogger().isDebugEnabled()) context.getLogger().debug(" Checking constraint '" + constraints[i] + "' against " + method + " " + uri + " --> " + constraints[i].included(uri, method)); if (constraints[i].included(uri, method)) { if(results == null) { results = new ArrayList<SecurityConstraint>(); } results.add(constraints[i]); } } // No applicable security constraint was found if (context.getLogger().isDebugEnabled()) context.getLogger().debug(" No applicable constraint located"); if(results == null) return null; SecurityConstraint [] array = new SecurityConstraint[results.size()]; System.arraycopy(results.toArray(), 0, array, 0, array.length); return array;
public void	initialize(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map sharedState, java.util.Map options) Initialize this LoginModule with the specified configuration information. param subject The Subject to be authenticated param callbackHandler A CallbackHandler for communicating with the end user as necessary param sharedState State information shared with other LoginModule instances param options Configuration information for this specific LoginModule instance log.debug("Init"); // Save configuration values this.subject = subject; this.callbackHandler = callbackHandler; this.sharedState = sharedState; this.options = options; // Perform instance-specific initialization if (options.get("pathname") != null) this.pathname = (String) options.get("pathname"); // Load our defined Principals load();
protected void	load() Load the contents of our configuration file. // Validate the existence of our configuration file File file = new File(pathname); if (!file.isAbsolute()) file = new File(System.getProperty("catalina.base"), pathname); if (!file.exists() || !file.canRead()) { log.warn("Cannot load configuration file " + file.getAbsolutePath()); return; } // Load the contents of our configuration file Digester digester = new Digester(); digester.setValidating(false); digester.addRuleSet(new MemoryRuleSet()); try { digester.push(this); digester.parse(file); } catch (Exception e) { log.warn("Error processing configuration file " + file.getAbsolutePath(), e); return; } finally { digester.reset(); }
public boolean	login() Phase 1 of authenticating a Subject. return true if the authentication succeeded, or false if this LoginModule should be ignored exception LoginException if the authentication fails // Set up our CallbackHandler requests if (callbackHandler == null) throw new LoginException("No CallbackHandler specified"); Callback callbacks[] = new Callback[2]; callbacks[0] = new NameCallback("Username: "); callbacks[1] = new PasswordCallback("Password: ", false); // Interact with the user to retrieve the username and password String username = null; String password = null; try { callbackHandler.handle(callbacks); username = ((NameCallback) callbacks[0]).getName(); password = new String(((PasswordCallback) callbacks[1]).getPassword()); } catch (IOException e) { throw new LoginException(e.toString()); } catch (UnsupportedCallbackException e) { throw new LoginException(e.toString()); } // Validate the username and password we have received principal = super.authenticate(username, password); log.debug("login " + username + " " + principal); // Report results based on success or failure if (principal != null) { return (true); } else { throw new FailedLoginException("Username or password is incorrect"); }
public boolean	logout() Log out this user. return true in all cases because thie LoginModule should not be ignored exception LoginException if logging out failed subject.getPrincipals().remove(principal); committed = false; principal = null; return (true);