waffle.apache

Class NegotiateAuthenticator

java.lang.Object

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 The allow guest login.
protected IWindowsAuthProvider	auth The auth.
protected String	info The info.
protected org.slf4j.Logger	log The log.
protected PrincipalFormat	principalFormat The principal format.
protected Set<String>	protocols The protocols.
protected PrincipalFormat	roleFormat The role format.

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

algorithm, cache, changeSessionIdOnAuthentication, context, DEFAULT_ALGORITHM, digest, disableProxyCaching, entropy, lifecycle, random, randomClass, REALM_NAME, securePagesWithPragma, SESSION_ID_BYTES, sm, sso, started

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

container, containerLog, controller, domain, mserver, next, oname

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
NegotiateAuthenticator() Instantiates a new negotiate authenticator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response, org.apache.catalina.deploy.LoginConfig loginConfig)
IWindowsAuthProvider	getAuth() Windows authentication provider.
String	getInfo()
PrincipalFormat	getPrincipalFormat() Principal format.
PrincipalFormat	getRoleFormat() Principal format.
boolean	isAllowGuestLogin() True if Guest login permitted.
protected void	sendError(org.apache.catalina.connector.Response response, int code) Send an error code.
protected void	sendUnauthorized(org.apache.catalina.connector.Response 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	setProtocols(String value) Set the authentication protocols.
void	setRoleFormat(String format) Set the principal format.
void	start()
void	stop()

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

addLifecycleListener, associate, findLifecycleListeners, generateSessionId, getAlgorithm, getCache, getChangeSessionIdOnAuthentication, getContainer, getDigest, getDisableProxyCaching, getEntropy, getRandom, getRandomClass, getSecurePagesWithPragma, invoke, reauthenticateFromSSO, register, removeLifecycleListener, setAlgorithm, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setEntropy, setRandomClass, setSecurePagesWithPragma

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

backgroundProcess, createObjectName, event, getContainerName, getController, getDomain, getNext, getObjectName, getParentName, postDeregister, postRegister, preDeregister, preRegister, setController, setNext, setObjectName, toString

Methods inherited from class java.lang.Object

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

Field Detail

info

protected String info

The info.

log

protected org.slf4j.Logger log

The log.

principalFormat

protected PrincipalFormat principalFormat

The principal format.

roleFormat

protected PrincipalFormat roleFormat

The role format.

allowGuestLogin

protected boolean allowGuestLogin

The allow guest login.

protocols

protected Set<String> protocols

The protocols.

auth

protected IWindowsAuthProvider auth

The auth.

Constructor Detail

NegotiateAuthenticator

public NegotiateAuthenticator()

Instantiates a new negotiate authenticator.

Method Detail

start

public void start()

Specified by:

start in interface org.apache.catalina.Lifecycle

Overrides:

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

stop

public void stop()

Specified by:

stop in interface org.apache.catalina.Lifecycle

Overrides:

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

authenticate

public boolean authenticate(org.apache.catalina.connector.Request request,
                   org.apache.catalina.connector.Response response,
                   org.apache.catalina.deploy.LoginConfig loginConfig)

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.

setProtocols

public void setProtocols(String value)

Set the authentication protocols. Default is "Negotiate, NTLM".

Parameters:

value - Authentication protocols

sendUnauthorized

protected void sendUnauthorized(org.apache.catalina.connector.Response response)

Send a 401 Unauthorized along with protocol authentication headers.

Parameters:

response - HTTP Response

sendError

protected void sendError(org.apache.catalina.connector.Response response,
             int code)

Send an error code.

Parameters:

response - HTTP Response

code - Error Code