SimpleServerLoginModule

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.security.auth.spi
Class SimpleServerLoginModule

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

All Implemented Interfaces:: javax.security.auth.spi.LoginModule

public class SimpleServerLoginModule
extends UsernamePasswordLoginModule (src)

A simple server login module useful to quick setup of security for testing purposes. It implements the following simple algorithm:

if password is null, authenticate the user and assign an identity of "guest" and a role of "guest".
else if password is equal to the user name, assign an identity equal to the username and both "user" and "guest" roles
else authentication fails.

Field Summary

Fields inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule (src)

callbackHandler, log, loginOk, options, principalClassName, sharedState, subject, unauthenticatedIdentity, useFirstPass

Constructor Summary
`SimpleServerLoginModule()`

Method Summary
`protected java.security.Principal`	`getIdentity()` Overriden by subclasses to return the Principal that corresponds to the user primary identity.
`protected java.security.acl.Group[]`	`getRoleSets()` Overriden by subclasses to return the Groups that correspond to the to the role sets assigned to the user.
`protected java.lang.String`	`getUsersPassword()` Get the expected password for the current username available via the getUsername() method.
`protected boolean`	`validatePassword(java.lang.String inputPassword, java.lang.String expectedPassword)` A hook that allows subclasses to change the validation of the input password against the expected password.

Methods inherited from class org.jboss.security.auth.spi.UsernamePasswordLoginModule (src)

createPasswordHash, getCredentials, getUnauthenticatedIdentity, getUsername, getUsernameAndPassword, initialize, login

Methods inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule (src)

abort, commit, createGroup, createIdentity, getUseFirstPass, logout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleServerLoginModule

public SimpleServerLoginModule()

Method Detail

getIdentity

protected java.security.Principal getIdentity()

Description copied from class: AbstractServerLoginModule (src)

Overriden by subclasses to return the Principal that corresponds to the user primary identity.

Overrides:: getIdentity in class UsernamePasswordLoginModule (src)

validatePassword

protected boolean validatePassword(java.lang.String inputPassword,
                                   java.lang.String expectedPassword)

Description copied from class: UsernamePasswordLoginModule (src)

A hook that allows subclasses to change the validation of the input password against the expected password. This version checks that neither inputPassword or expectedPassword are null that that inputPassword.equals(expectedPassword) is true;

Overrides:: validatePassword in class UsernamePasswordLoginModule (src)

Returns:: true if the inputPassword is valid, false otherwise.

getRoleSets

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

Description copied from class: AbstractServerLoginModule (src)

Overriden by subclasses to return the Groups that correspond to the to the role sets assigned to the user. Subclasses should create at least a Group named "Roles" that contains the roles assigned to the user. A second common group is "CallerPrincipal" that provides the application identity of the user rather than the security domain identity.

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()
                                     throws javax.security.auth.login.LoginException

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.