org.alfresco.repo.security.authentication.ntlm

Class NTLMAuthenticationComponentImpl

java.lang.Object

org.alfresco.repo.security.authentication.AbstractAuthenticationComponent

org.alfresco.repo.security.authentication.ntlm.NTLMAuthenticationComponentImpl

All Implemented Interfaces:

AuthenticationComponent, AuthenticationContext, NLTMAuthenticator, org.springframework.beans.factory.InitializingBean

public class NTLMAuthenticationComponentImpl
extends AbstractAuthenticationComponent
implements NLTMAuthenticator, org.springframework.beans.factory.InitializingBean

NTLM Authentication Component Class

Provides authentication using passthru to a Windows server(s)/domain controller(s) using the accounts defined on the passthru server to validate users.

Author:

GKSpencer

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.security.authentication.AuthenticationComponent

AuthenticationComponent.UserNameValidationMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	NTLMAuthorityAdministrator
static String	NTLMAuthorityGuest

Constructor Summary

Constructors

Constructor and Description
NTLMAuthenticationComponentImpl() Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
boolean	allowsGuest() Determine if guest logons are allowed
net.sf.acegisecurity.Authentication	authenticate(net.sf.acegisecurity.Authentication auth) Authenticate using a token
protected void	authenticateImpl(String userName, char[] password) Authenticate
boolean	exists(String userName) Check if the user exists
String	getMD4HashedPassword(String userName) Get the MD4 password hash, as required by NTLM based authentication methods.
NTLMMode	getNTLMMode() Get the enum that describes NTLM integration
protected boolean	implementationAllowsGuestLogin()
void	setAllowAuthUserAsGuest(String auth) Allow authenticated users with no alfresco person record to logon with guest access
void	setDomain(String domain) Set the domain to authenticate against
void	setGuestAccess(String guest) Allow guest access
void	setJCEProvider(String providerClass) Set the JCE provider
void	setNullDomainUseAnyServer(String nullDomain) Allow null domain passthru logons to use the first available passthru server
void	setPassthruServers(PassthruServers servers) Directly sets the passthru server list.
void	setProtocolOrder(String protoOrder) Set the protocol order for passthru connections
void	setServers(String servers) Set the server(s) to authenticate against
void	setSessionTimeout(String sessTmo) Set the authentication session timeout, in seconds
void	setUseLocalServer(String useLocal) Use the local server as the authentication server

Methods inherited from class org.alfresco.repo.security.authentication.AbstractAuthenticationComponent

authenticate, clearCurrentSecurityContext, getAllowGuestLogin, getCurrentAuthentication, getCurrentUserName, getDefaultAdministratorUserNames, getDefaultGuestUserNames, getGuestUserName, getGuestUserName, getNodeService, getNumberFailedAuthentications, getNumberSuccessfulAuthentications, getPersonService, getSystemUserName, getSystemUserName, getTransactionService, getUserDetails, getUserDomain, guestUserAuthenticationAllowed, isCurrentUserTheSystemUser, isGuestUserName, isSystemUserName, onAuthenticate, onFail, setAllowGuestLogin, setAuthenticationContext, setCurrentAuthentication, setCurrentUser, setCurrentUser, setDefaultAdministratorUserNameList, setDefaultAdministratorUserNames, setDefaultGuestUserNameList, setDefaultGuestUserNames, setGuestUserAsCurrentUser, setNodeService, setPersonService, setSystemUserAsCurrentUser, setSystemUserAsCurrentUser, setTransactionService, setUserDetails, setUserRegistrySynchronizer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.repo.security.authentication.AuthenticationComponent

authenticate, getDefaultAdministratorUserNames, getDefaultGuestUserNames, guestUserAuthenticationAllowed, setCurrentUser, setCurrentUser, setGuestUserAsCurrentUser

Methods inherited from interface org.alfresco.repo.security.authentication.AuthenticationContext

clearCurrentSecurityContext, getCurrentAuthentication, getCurrentUserName, getGuestUserName, getGuestUserName, getSystemUserName, getSystemUserName, getUserDomain, isCurrentUserTheSystemUser, isGuestUserName, isSystemUserName, setCurrentAuthentication, setSystemUserAsCurrentUser, setSystemUserAsCurrentUser, setUserDetails

Field Detail

NTLMAuthorityGuest

public static final String NTLMAuthorityGuest

See Also:

Constant Field Values

NTLMAuthorityAdministrator

public static final String NTLMAuthorityAdministrator

See Also:

Constant Field Values

Constructor Detail

NTLMAuthenticationComponentImpl

public NTLMAuthenticationComponentImpl()

Class constructor

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

allowsGuest

public final boolean allowsGuest()

Determine if guest logons are allowed

Returns:

boolean

setPassthruServers

public void setPassthruServers(PassthruServers servers)

Directly sets the passthru server list.

Parameters:

servers - a passthru server list, usually created by PassthruServerFactory

setDomain

public void setDomain(String domain)

Set the domain to authenticate against

Parameters:

domain - String

setServers

public void setServers(String servers)

Set the server(s) to authenticate against

Parameters:

servers - String

setUseLocalServer

public void setUseLocalServer(String useLocal)

Use the local server as the authentication server

Parameters:

useLocal - String

setGuestAccess

public void setGuestAccess(String guest)

Allow guest access

Parameters:

guest - String

setAllowAuthUserAsGuest

public void setAllowAuthUserAsGuest(String auth)

Allow authenticated users with no alfresco person record to logon with guest access

Parameters:

auth - String

setNullDomainUseAnyServer

public void setNullDomainUseAnyServer(String nullDomain)

Allow null domain passthru logons to use the first available passthru server

Parameters:

nullDomain - String

setJCEProvider

public void setJCEProvider(String providerClass)

Set the JCE provider

Parameters:

providerClass - String

setSessionTimeout

public void setSessionTimeout(String sessTmo)

Set the authentication session timeout, in seconds

Parameters:

sessTmo - String

setProtocolOrder

public void setProtocolOrder(String protoOrder)

Set the protocol order for passthru connections

Parameters:

protoOrder - String

authenticateImpl

protected void authenticateImpl(String userName,
                    char[] password)
                         throws org.alfresco.repo.security.authentication.AuthenticationException

Authenticate

Overrides:

authenticateImpl in class AbstractAuthenticationComponent

Parameters:

userName - String

password - char[]

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

authenticate

public net.sf.acegisecurity.Authentication authenticate(net.sf.acegisecurity.Authentication auth)
                                                 throws org.alfresco.repo.security.authentication.AuthenticationException

Authenticate using a token

Specified by:

authenticate in interface NLTMAuthenticator

Parameters:

token - Authentication

Returns:

Authentication

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

getNTLMMode

public NTLMMode getNTLMMode()

Get the enum that describes NTLM integration

Specified by:

getNTLMMode in interface NLTMAuthenticator

Returns:

NTLMMode

getMD4HashedPassword

public String getMD4HashedPassword(String userName)

Get the MD4 password hash, as required by NTLM based authentication methods.

Specified by:

getMD4HashedPassword in interface NLTMAuthenticator

Parameters:

userName - String

Returns:

String

exists

public boolean exists(String userName)

Check if the user exists

Parameters:

userName - String

Returns:

boolean

implementationAllowsGuestLogin

protected boolean implementationAllowsGuestLogin()

Specified by:

implementationAllowsGuestLogin in class AbstractAuthenticationComponent