org.apache.solr.servlet.authentication

Class LdapAuthenticationHandler

java.lang.Object

org.apache.solr.servlet.authentication.LdapAuthenticationHandler

All Implemented Interfaces:

org.apache.hadoop.security.authentication.server.AuthenticationHandler

public class LdapAuthenticationHandler
extends Object
implements org.apache.hadoop.security.authentication.server.AuthenticationHandler

The LdapAuthenticationHandler implements the BASIC authentication mechanism for HTTP using LDAP back-end.

The supported configuration properties are:

• ldap.providerurl: The url of the LDAP server. It does not have a default value.
• ldap.basedn: the base distinguished name (DN) to be used with the LDAP server. This value is appended to the provided user id for authentication purpose. It does not have a default value.
• ldap.binddomain: the LDAP bind domain value to be used with the LDAP server. This property is optional and useful only in case of Active Directory server.
• ldap.enablestarttls: A boolean value used to define if the LDAP server supports 'StartTLS' extension.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_DN Constant for the configuration property that indicates the base distinguished name (DN) to be used with the LDAP server.
static String	BASIC_AUTH_SCHEME Constant that identifies the HTTP authentication scheme.
static String	ENABLE_START_TLS Constant for the configuration property that indicates the base distinguished name (DN) to be used with the LDAP server.
static String	LDAP_BIND_DOMAIN Constant for the configuration property that indicates the LDAP bind domain value to be used with the LDAP server.
static String	PROVIDER_URL Constant for the configuration property that indicates the url of the LDAP server.
static String	SECURITY_AUTHENTICATION Constant that identifies the authentication mechanism to be used with the LDAP server.
static String	TYPE Constant that identifies the authentication mechanism.

Fields inherited from interface org.apache.hadoop.security.authentication.server.AuthenticationHandler

WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor and Description
LdapAuthenticationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.hadoop.security.authentication.server.AuthenticationToken	authenticate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	destroy()
String	getType()
Collection<String>	getTypes()
void	init(Properties config)
boolean	managementOperation(org.apache.hadoop.security.authentication.server.AuthenticationToken token, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setDisableHostNameVerification(Boolean disableHostNameVerification) Configure the Host name verification for this handler.
void	setEnableStartTls(Boolean enableStartTls) Configure StartTLS LDAP extension for this handler.

Methods inherited from class java.lang.Object

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

Field Detail

BASIC_AUTH_SCHEME

public static final String BASIC_AUTH_SCHEME

Constant that identifies the HTTP authentication scheme.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Constant that identifies the authentication mechanism.

See Also:

Constant Field Values

SECURITY_AUTHENTICATION

public static final String SECURITY_AUTHENTICATION

Constant that identifies the authentication mechanism to be used with the LDAP server.

See Also:

Constant Field Values

PROVIDER_URL

public static final String PROVIDER_URL

Constant for the configuration property that indicates the url of the LDAP server.

See Also:

Constant Field Values

BASE_DN

public static final String BASE_DN

Constant for the configuration property that indicates the base distinguished name (DN) to be used with the LDAP server. This value is appended to the provided user id for authentication purpose.

See Also:

Constant Field Values

LDAP_BIND_DOMAIN

public static final String LDAP_BIND_DOMAIN

Constant for the configuration property that indicates the LDAP bind domain value to be used with the LDAP server.

See Also:

Constant Field Values

ENABLE_START_TLS

public static final String ENABLE_START_TLS

Constant for the configuration property that indicates the base distinguished name (DN) to be used with the LDAP server. This value is appended to the provided user id for authentication purpose.

See Also:

Constant Field Values

Constructor Detail

LdapAuthenticationHandler

public LdapAuthenticationHandler()

Method Detail

setEnableStartTls

public void setEnableStartTls(Boolean enableStartTls)

Configure StartTLS LDAP extension for this handler.

Parameters:

enableStartTls - true If the StartTLS LDAP extension is to be enabled false otherwise

setDisableHostNameVerification

public void setDisableHostNameVerification(Boolean disableHostNameVerification)

Configure the Host name verification for this handler. This method is introduced only for unit testing and should never be used in production.

Parameters:

disableHostNameVerification - true to disable host-name verification false otherwise

getType

public String getType()

Specified by:

getType in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler

getTypes

public Collection<String> getTypes()

init

public void init(Properties config)
          throws javax.servlet.ServletException

Specified by:

init in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler

managementOperation

public boolean managementOperation(org.apache.hadoop.security.authentication.server.AuthenticationToken token,
                          javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                            throws IOException,
                                   org.apache.hadoop.security.authentication.client.AuthenticationException

Specified by:

managementOperation in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler

Throws:

IOException

org.apache.hadoop.security.authentication.client.AuthenticationException

authenticate

public org.apache.hadoop.security.authentication.server.AuthenticationToken authenticate(javax.servlet.http.HttpServletRequest request,
                                                                                javax.servlet.http.HttpServletResponse response)
                                                                                  throws IOException,
                                                                                         org.apache.hadoop.security.authentication.client.AuthenticationException

Specified by:

authenticate in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler

Throws:

IOException

org.apache.hadoop.security.authentication.client.AuthenticationException