Module org.elasticsearch.security

Package org.elasticsearch.xpack.security.authc.support

Class SecondaryAuthenticator

java.lang.Object

org.elasticsearch.xpack.security.authc.support.SecondaryAuthenticator

public class SecondaryAuthenticator
extends Object

Performs "secondary user authentication" (that is, a second user, _not_ second factor authentication).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SECONDARY_AUTH_HEADER_NAME	The term "Authorization" in the header value is to mimic the standard HTTP "Authorization" header
static final String	SECONDARY_X_CLIENT_AUTH_HEADER_NAME	Header name for secondary client authentication credentials.

Constructor Summary

Constructors

Constructor	Description
SecondaryAuthenticator(Settings settings, ThreadContext threadContext, AuthenticationService authenticationService, AuditTrailService auditTrailService)
SecondaryAuthenticator(SecurityContext securityContext, AuthenticationService authenticationService, AuditTrailService auditTrailService)

Method Summary

Modifier and Type	Method	Description
void	authenticate(String action, TransportRequest request, ActionListener<SecondaryAuthentication> listener)
void	authenticateAndAttachToContext(RestRequest request, ActionListener<SecondaryAuthentication> listener)

Methods inherited from class java.lang.Object

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

Field Details

SECONDARY_AUTH_HEADER_NAME

public static final String SECONDARY_AUTH_HEADER_NAME

The term "Authorization" in the header value is to mimic the standard HTTP "Authorization" header

See Also:

• Constant Field Values

SECONDARY_X_CLIENT_AUTH_HEADER_NAME

public static final String SECONDARY_X_CLIENT_AUTH_HEADER_NAME

Header name for secondary client authentication credentials. Used by authenticators that require additional [@code X-Client-Authentication} header along with the Authorization header.

See Also:

• Constant Field Values

Constructor Details

SecondaryAuthenticator

public SecondaryAuthenticator(Settings settings,
 ThreadContext threadContext,
 AuthenticationService authenticationService,
 AuditTrailService auditTrailService)

SecondaryAuthenticator

public SecondaryAuthenticator(SecurityContext securityContext,
 AuthenticationService authenticationService,
 AuditTrailService auditTrailService)

Method Details

authenticate

public void authenticate(String action,
 TransportRequest request,
 ActionListener<SecondaryAuthentication> listener)

Parameters:

listener - Handler for the SecondaryAuthentication object. If the secondary authentication credentials do not exist the thread context, the ActionListener.onResponse(Object) method is called with a null authentication value. If the secondary authentication credentials are found in the thread context, but fail to be authenticated, then the failure is returned through ActionListener.onFailure(Exception).

authenticateAndAttachToContext

public void authenticateAndAttachToContext(RestRequest request,
 ActionListener<SecondaryAuthentication> listener)

Parameters:

listener - Handler for the SecondaryAuthentication object. If the secondary authentication credentials do not exist the thread context, the ActionListener.onResponse(Object) method is called with a null authentication value. If the secondary authentication credentials are found in the thread context, but fail to be authenticated, then the failure is returned through ActionListener.onFailure(Exception).