org.jboss.security.auth.spi
Class UsersRolesLoginModule

java.lang.Object
  org.jboss.security.auth.spi.AbstractServerLoginModule (src) 
      org.jboss.security.auth.spi.UsernamePasswordLoginModule (src) 
          org.jboss.security.auth.spi.UsersRolesLoginModule

All Implemented Interfaces:

javax.security.auth.spi.LoginModule

Direct Known Subclasses:

UsersRoles2LoginModule (src)

public class UsersRolesLoginModule

extends UsernamePasswordLoginModule (src)

A simple properties file based login module that consults two Java Properties formatted text files for username to password("users.properties") and username to roles("roles.properties") mapping. The names of the properties files may be overriden by the usersProperties and rolesProperties options. The properties files are loaded during initialization using the thread context class loader. This means that these files can be placed into the J2EE deployment jar or the JBoss config directory. The users.properties file uses a format: username1=password1 username2=password2 ... to define all valid usernames and their corresponding passwords. The roles.properties file uses a format: username1=role1,role2,... username1.RoleGroup1=role3,role4,... username2=role1,role3,... to define the sets of roles for valid usernames. The "username.XXX" form of property name is used to assign the username roles to a particular named group of roles where the XXX portion of the property name is the group name. The "username=..." form is an abbreviation for "username.Roles=...". The following are therefore equivalent: jduke=TheDuke,AnimatedCharacter jduke.Roles=TheDuke,AnimatedCharacter

UsersRolesLoginModule

public UsersRolesLoginModule()

initialize

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.

Specified by:

initialize in interface javax.security.auth.spi.LoginModule

Overrides:

initialize in class UsernamePasswordLoginModule (src)

Parameters:

options - - the login module option map. Supported options include: usersProperties: The name of the properties resource containing user/passwords. The default is "users.properties" rolesProperties: The name of the properties resource containing user/roles The default is "roles.properties". roleGroupSeperator: The character used to seperate the role group name from the username e.g., '.' in jduke.CallerPrincipal=... . The default = '.'. defaultUsersProperties=string: The name of the properties resource containing the username to password mappings that will be used as the defaults Properties passed to the usersProperties Properties. This defaults to defaultUsers.properties. defaultRolesProperties=string: The name of the properties resource containing the username to roles mappings that will be used as the defaults Properties passed to the usersProperties Properties. This defaults to defaultRoles.properties.

login

public boolean login()
              throws javax.security.auth.login.LoginException

Method to authenticate a Subject (phase 1). This validates that the users and roles properties files were loaded and then calls super.login to perform the validation of the password.

Specified by:

login in interface javax.security.auth.spi.LoginModule

Overrides:

login in class UsernamePasswordLoginModule (src)

Throws:

javax.security.auth.login.LoginException - thrown if the users or roles properties files were not found or the super.login method fails.

getRoleSets

protected java.security.acl.Group[] getRoleSets()
                                         throws javax.security.auth.login.LoginException

Create the set of roles the user belongs to by parsing the roles.properties data for username=role1,role2,... and username.XXX=role1,role2,... patterns.

Specified by:

getRoleSets in class AbstractServerLoginModule (src)

Returns:

Group[] containing the sets of roles

Throws:

javax.security.auth.login.LoginException

getUsersPassword

protected java.lang.String getUsersPassword()

Description copied from class: UsernamePasswordLoginModule (src)

Get the expected password for the current username available via the getUsername() method. This is called from within the login() method after the CallbackHandler has returned the username and candidate password.

Specified by:

getUsersPassword in class UsernamePasswordLoginModule (src)

Returns:

the valid password String

loadUsers

protected void loadUsers()
                  throws java.io.IOException

Throws:

java.io.IOException

loadRoles

protected void loadRoles()
                  throws java.io.IOException

Throws:

java.io.IOException

parseGroupMembers

protected void parseGroupMembers(java.security.acl.Group group,
                                 java.lang.String roles)

Parse the comma delimited roles names given by value and add them to group. The type of Principal created for each name is determined by the createIdentity method.

Parameters:

group - - the Group to add the roles to.

roles - - the comma delimited role names.

See Also:

AbstractServerLoginModule.createIdentity(String)