waffle.apache

Class NegotiateAuthenticator

java.lang.Object

org.apache.catalina.util.LifecycleBase

org.apache.catalina.util.LifecycleMBeanBase

org.apache.catalina.valves.ValveBase

org.apache.catalina.authenticator.AuthenticatorBase

waffle.apache.NegotiateAuthenticator

All Implemented Interfaces:

MBeanRegistration, org.apache.catalina.Authenticator, org.apache.catalina.Contained, org.apache.catalina.Lifecycle, org.apache.catalina.Valve

public class NegotiateAuthenticator
extends org.apache.catalina.authenticator.AuthenticatorBase

An Apache Negotiate (NTLM, Kerberos) Authenticator.

Author:

dblock[at]dblock[dot]org

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_allowGuestLogin
protected IWindowsAuthProvider	_auth
protected String	_info
protected org.slf4j.Logger	_log
protected PrincipalFormat	_principalFormat
protected PrincipalFormat	_roleFormat

Fields inherited from class org.apache.catalina.authenticator.AuthenticatorBase

alwaysUseSession, AUTH_HEADER_NAME, cache, changeSessionIdOnAuthentication, context, disableProxyCaching, info, REALM_NAME, securePagesWithPragma, secureRandomAlgorithm, secureRandomClass, secureRandomProvider, sessionIdGenerator, sm, sso

Fields inherited from class org.apache.catalina.valves.ValveBase

asyncSupported, container, containerLog, next

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

mserver

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
NegotiateAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.catalina.deploy.LoginConfig loginConfig)
protected Principal	doLogin(org.apache.catalina.connector.Request request, String username, String password)
IWindowsAuthProvider	getAuth() Windows authentication provider.
protected String	getAuthMethod()
String	getInfo()
PrincipalFormat	getPrincipalFormat() Principal format.
PrincipalFormat	getRoleFormat() Principal format.
boolean	isAllowGuestLogin() True if Guest login permitted.
protected void	sendError(javax.servlet.http.HttpServletResponse response, int code) Send an error code.
protected void	sendUnauthorized(javax.servlet.http.HttpServletResponse response) Send a 401 Unauthorized along with protocol authentication headers.
void	setAllowGuestLogin(boolean value) Set whether Guest login is permitted.
void	setAuth(IWindowsAuthProvider provider) Set Windows auth provider.
void	setPrincipalFormat(String format) Set the principal format.
void	setRoleFormat(String format) Set the principal format.
void	startInternal()
void	stopInternal()

Methods inherited from class org.apache.catalina.authenticator.AuthenticatorBase

associate, authenticate, getAlwaysUseSession, getCache, getChangeSessionIdOnAuthentication, getContainer, getDisableProxyCaching, getSecurePagesWithPragma, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, invoke, login, logout, reauthenticateFromSSO, register, setAlwaysUseSession, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider

Methods inherited from class org.apache.catalina.valves.ValveBase

backgroundProcess, event, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setNext, toString

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase

addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

_info

protected String _info

_log

protected org.slf4j.Logger _log

_principalFormat

protected PrincipalFormat _principalFormat

_roleFormat

protected PrincipalFormat _roleFormat

_allowGuestLogin

protected boolean _allowGuestLogin

_auth

protected IWindowsAuthProvider _auth

Constructor Detail

NegotiateAuthenticator

public NegotiateAuthenticator()

Method Detail

startInternal

public void startInternal()
                   throws org.apache.catalina.LifecycleException

Overrides:

startInternal in class org.apache.catalina.authenticator.AuthenticatorBase

Throws:

org.apache.catalina.LifecycleException

stopInternal

public void stopInternal()
                  throws org.apache.catalina.LifecycleException

Overrides:

stopInternal in class org.apache.catalina.authenticator.AuthenticatorBase

Throws:

org.apache.catalina.LifecycleException

authenticate

public boolean authenticate(org.apache.catalina.connector.Request request,
                   javax.servlet.http.HttpServletResponse response,
                   org.apache.catalina.deploy.LoginConfig loginConfig)

Specified by:

authenticate in interface org.apache.catalina.Authenticator

Specified by:

authenticate in class org.apache.catalina.authenticator.AuthenticatorBase

getAuth

public IWindowsAuthProvider getAuth()

Windows authentication provider.

Returns:

IWindowsAuthProvider.

setAuth

public void setAuth(IWindowsAuthProvider provider)

Set Windows auth provider.

Parameters:

provider - Class implements IWindowsAuthProvider.

getInfo

public String getInfo()

Specified by:

getInfo in interface org.apache.catalina.Valve

Overrides:

getInfo in class org.apache.catalina.authenticator.AuthenticatorBase

setPrincipalFormat

public void setPrincipalFormat(String format)

Set the principal format.

Parameters:

format - Principal format.

getPrincipalFormat

public PrincipalFormat getPrincipalFormat()

Principal format.

Returns:

Principal format.

setRoleFormat

public void setRoleFormat(String format)

Set the principal format.

Parameters:

format - Role format.

getRoleFormat

public PrincipalFormat getRoleFormat()

Principal format.

Returns:

Role format.

isAllowGuestLogin

public boolean isAllowGuestLogin()

True if Guest login permitted.

Returns:

True if Guest login permitted, false otherwise.

setAllowGuestLogin

public void setAllowGuestLogin(boolean value)

Set whether Guest login is permitted. Default is true, if the Guest account is enabled, an invalid username/password results in a Guest login.

Parameters:

value - True or false.

sendUnauthorized

protected void sendUnauthorized(javax.servlet.http.HttpServletResponse response)

Send a 401 Unauthorized along with protocol authentication headers.

Parameters:

response - HTTP Response

sendError

protected void sendError(javax.servlet.http.HttpServletResponse response,
             int code)

Send an error code.

Parameters:

response - HTTP Response

code - Error Code

getAuthMethod

protected String getAuthMethod()

Specified by:

getAuthMethod in class org.apache.catalina.authenticator.AuthenticatorBase

doLogin

protected Principal doLogin(org.apache.catalina.connector.Request request,
                String username,
                String password)
                     throws javax.servlet.ServletException

Overrides:

doLogin in class org.apache.catalina.authenticator.AuthenticatorBase

Throws:

javax.servlet.ServletException