org.rundeck.jaas.pam

Class AbstractPamLoginModule

java.lang.Object

org.rundeck.jaas.AbstractBaseLoginModule

org.rundeck.jaas.AbstractSharedLoginModule

org.rundeck.jaas.pam.AbstractPamLoginModule

All Implemented Interfaces:

javax.security.auth.spi.LoginModule

Direct Known Subclasses:

JettyPamLoginModule

public abstract class AbstractPamLoginModule
extends AbstractSharedLoginModule

Abstract base login module for using libpam4j to authenticate.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractPamLoginModule()

Method Summary

Modifier and Type	Method and Description
boolean	abort()
protected boolean	authenticate(java.lang.String name, char[] password) Authenticates using PAM
boolean	commit()
protected abstract java.security.Principal	createRolePrincipal(java.lang.String role) Create a role Principal
protected java.util.List<java.security.Principal>	createRolePrincipals() Create the list of Principals for roles
protected java.util.List<java.security.Principal>	createRolePrincipals(org.jvnet.libpam.UnixUser username) Create Principals for any roles
protected java.security.Principal	createUserPrincipal() Create the use Principal
protected abstract java.security.Principal	createUserPrincipal(org.jvnet.libpam.UnixUser user) Create a Principal for the user
protected void	debug(java.lang.String message) Emit Debug message via System.err by default
void	initialize(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map shared, java.util.Map options)
boolean	isUseUnixGroups()
boolean	logout()

Methods inherited from class org.rundeck.jaas.AbstractSharedLoginModule

getCallBackAuth, getSharedLoginCreds, login, wasAuthenticated

Methods inherited from class org.rundeck.jaas.AbstractBaseLoginModule

getCallbackHandler, isAuthenticated, isCommitted, isDebug, setAuthenticated, setCommitted, wasAuthenticated

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

Constructor Detail

AbstractPamLoginModule

public AbstractPamLoginModule()

Method Detail

initialize

public void initialize(javax.security.auth.Subject subject,
                       javax.security.auth.callback.CallbackHandler callbackHandler,
                       java.util.Map shared,
                       java.util.Map options)

Specified by:

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

Overrides:

initialize in class AbstractSharedLoginModule

authenticate

protected boolean authenticate(java.lang.String name,
                               char[] password)
                        throws javax.security.auth.login.LoginException

Authenticates using PAM

Specified by:

authenticate in class AbstractSharedLoginModule

Parameters:

name -

password -

Returns:

Throws:

javax.security.auth.login.LoginException

debug

protected void debug(java.lang.String message)

Emit Debug message via System.err by default

Overrides:

debug in class AbstractBaseLoginModule

Parameters:

message -

createRolePrincipals

protected java.util.List<java.security.Principal> createRolePrincipals()

Description copied from class: AbstractBaseLoginModule

Create the list of Principals for roles

Specified by:

createRolePrincipals in class AbstractBaseLoginModule

Returns:

createUserPrincipal

protected java.security.Principal createUserPrincipal()

Description copied from class: AbstractBaseLoginModule

Create the use Principal

Specified by:

createUserPrincipal in class AbstractBaseLoginModule

Returns:

createUserPrincipal

protected abstract java.security.Principal createUserPrincipal(org.jvnet.libpam.UnixUser user)

Create a Principal for the user

Parameters:

user -

Returns:

createRolePrincipal

protected abstract java.security.Principal createRolePrincipal(java.lang.String role)

Create a role Principal

Parameters:

role -

Returns:

createRolePrincipals

protected java.util.List<java.security.Principal> createRolePrincipals(org.jvnet.libpam.UnixUser username)

Create Principals for any roles

Parameters:

username -

Returns:

commit

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

Specified by:

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

Overrides:

commit in class AbstractSharedLoginModule

Throws:

javax.security.auth.login.LoginException

abort

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

Specified by:

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

Overrides:

abort in class AbstractBaseLoginModule

Throws:

javax.security.auth.login.LoginException

logout

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

Specified by:

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

Overrides:

logout in class AbstractBaseLoginModule

Throws:

javax.security.auth.login.LoginException

isUseUnixGroups

public boolean isUseUnixGroups()