Package com.floragunn.searchguard.http

Class HTTPBasicAuthenticator

java.lang.Object

com.floragunn.searchguard.http.HTTPBasicAuthenticator

All Implemented Interfaces:

HTTPAuthenticator

public class HTTPBasicAuthenticator
extends Object
implements HTTPAuthenticator

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
HTTPBasicAuthenticator(org.elasticsearch.common.settings.Settings settings, Path configPath)

Method Summary

Modifier and Type	Method	Description
AuthCredentials	extractCredentials(org.elasticsearch.rest.RestRequest request, org.elasticsearch.common.util.concurrent.ThreadContext threadContext)	Extract AuthCredentials from RestRequest
String	getType()	The type (name) of the authenticator.
boolean	reRequestAuthentication(org.elasticsearch.rest.RestChannel channel, AuthCredentials creds)	If the extractCredentials() call was not successful or the authentication flow needs another roundtrip this method will be called.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.logging.log4j.Logger log

Constructor Detail

HTTPBasicAuthenticator

public HTTPBasicAuthenticator(org.elasticsearch.common.settings.Settings settings,
                              Path configPath)

Method Detail

extractCredentials

public AuthCredentials extractCredentials(org.elasticsearch.rest.RestRequest request,
                                          org.elasticsearch.common.util.concurrent.ThreadContext threadContext)

Description copied from interface: HTTPAuthenticator

Extract AuthCredentials from RestRequest

Specified by:

extractCredentials in interface HTTPAuthenticator

Parameters:

request - The rest request

threadContext - The current thread context

Returns:

The authentication credentials (complete or incomplete) or null when no credentials are found in the request

When the credentials could be fully extracted from the request .markComplete() must be called on the AuthCredentials which are returned. If the authentication flow needs another roundtrip with the request originator do not mark it as complete.

reRequestAuthentication

public boolean reRequestAuthentication(org.elasticsearch.rest.RestChannel channel,
                                       AuthCredentials creds)

Description copied from interface: HTTPAuthenticator

If the extractCredentials() call was not successful or the authentication flow needs another roundtrip this method will be called. If the custom HTTP authenticator does not support this method is a no-op and false should be returned. If the custom HTTP authenticator does support re-request authentication or supports authentication flows with multiple roundtrips then the response should be sent (through the channel) and true must be returned.

Specified by:

reRequestAuthentication in interface HTTPAuthenticator

Parameters:

channel - The rest channel to sent back the response via channel.sendResponse()

creds - The credentials from the prior authentication attempt

Returns:

false if re-request is not supported/necessary, true otherwise. If true is returned channel.sendResponse() must be called so that the request completes.

getType

public String getType()

Description copied from interface: HTTPAuthenticator

The type (name) of the authenticator. Only for logging.

Specified by:

getType in interface HTTPAuthenticator

Returns:

the type