Package org.ldaptive.jaas

Class LdapLoginModule

java.lang.Object

org.ldaptive.jaas.AbstractLoginModule

org.ldaptive.jaas.LdapLoginModule

All Implemented Interfaces:

LoginModule

public class LdapLoginModule
extends AbstractLoginModule

Provides a JAAS authentication hook for LDAP authentication.

Field Summary

Fields

Modifier and Type	Field	Description
private Authenticator	auth	Authenticator to use against the LDAP.
private AuthenticatorFactory	authenticatorFactory	Factory for creating authenticators with JAAS options.
private AuthenticationRequest	authRequest	Authentication request to use for authentication.
private String[]	userRoleAttribute	User attribute to add to role data.

Fields inherited from class org.ldaptive.jaas.AbstractLoginModule

callbackHandler, clearPass, commitSuccess, credentials, defaultRole, logger, LOGIN_DN, LOGIN_NAME, LOGIN_PASSWORD, loginSuccess, principalGroupName, principals, roleGroupName, roles, setLdapCredential, setLdapDnPrincipal, setLdapPrincipal, sharedState, storePass, subject, tryFirstPass, useFirstPass

Constructor Summary

Constructors

Constructor	Description
LdapLoginModule()

Method Summary

Modifier and Type	Method	Description
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)
protected boolean	login(NameCallback nameCb, PasswordCallback passCb)	Authenticates a Subject with the supplied callbacks.
static void	main(String[] args)	This provides command line access to this JAAS module.

Methods inherited from class org.ldaptive.jaas.AbstractLoginModule

abort, clearState, commit, getCredentials, login, logout, storeCredentials

Methods inherited from class java.lang.Object

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

Field Details

userRoleAttribute

private String[] userRoleAttribute

User attribute to add to role data.

authenticatorFactory

private AuthenticatorFactory authenticatorFactory

Factory for creating authenticators with JAAS options.

auth

private Authenticator auth

Authenticator to use against the LDAP.

authRequest

private AuthenticationRequest authRequest

Authentication request to use for authentication.

Constructor Details

LdapLoginModule

public LdapLoginModule()

Method Details

initialize

public void initialize(Subject subject,
 CallbackHandler callbackHandler,
 Map<String,?> sharedState,
 Map<String,?> options)

Specified by:

initialize in interface LoginModule

Overrides:

initialize in class AbstractLoginModule

login

protected boolean login(NameCallback nameCb,
 PasswordCallback passCb)
                 throws LoginException

Description copied from class: AbstractLoginModule

Authenticates a Subject with the supplied callbacks.

Specified by:

login in class AbstractLoginModule

Parameters:

nameCb - callback handler for subject's name

passCb - callback handler for subject's password

Returns:

true if authentication succeeded, false to ignore this module

Throws:

LoginException - if the authentication fails

main

public static void main(String[] args)
                 throws Exception

This provides command line access to this JAAS module.

Parameters:

args - command line arguments

Throws:

Exception - if an error occurs