org.apache.hadoop.security.authentication.server

类 KerberosAuthenticationHandler

java.lang.Object

org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler

所有已实现的接口:

AuthenticationHandler

public class KerberosAuthenticationHandler
extends Object
implements AuthenticationHandler

The KerberosAuthenticationHandler implements the Kerberos SPNEGO authentication mechanism for HTTP.

The supported configuration properties are:

• kerberos.principal: the Kerberos principal to used by the server. As stated by the Kerberos SPNEGO specification, it should be HTTP/${HOSTNAME}@{REALM}. The realm can be omitted from the principal as the JDK GSS libraries will use the realm name of the configured default realm. It does not have a default value.
• kerberos.keytab: the keytab file containing the credentials for the Kerberos principal. It does not have a default value.

字段概要

字段

限定符和类型	字段和说明
static String	KEYTAB Constant for the configuration property that indicates the keytab file path.
static String	NAME_RULES Constant for the configuration property that indicates the Kerberos name rules for the Kerberos principals.
static String	PRINCIPAL Constant for the configuration property that indicates the kerberos principal.
static String	TYPE Constant that identifies the authentication mechanism.

构造器概要

构造器

构造器和说明
KerberosAuthenticationHandler()

方法概要

方法

限定符和类型	方法和说明
AuthenticationToken	authenticate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) It enforces the the Kerberos SPNEGO authentication sequence returning an AuthenticationToken only after the Kerberos SPNEGO sequence has completed successfully.
void	destroy() Releases any resources initialized by the authentication handler.
protected String	getKeytab() Returns the keytab used by the authentication handler.
protected String	getPrincipal() Returns the Kerberos principal used by the authentication handler.
String	getType() Returns the authentication type of the authentication handler, 'kerberos'.
void	init(Properties config) Initializes the authentication handler instance.

从类继承的方法 java.lang.Object

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

字段详细资料

TYPE

public static final String TYPE

Constant that identifies the authentication mechanism.

另请参阅:

常量字段值

PRINCIPAL

public static final String PRINCIPAL

Constant for the configuration property that indicates the kerberos principal.

另请参阅:

常量字段值

KEYTAB

public static final String KEYTAB

Constant for the configuration property that indicates the keytab file path.

另请参阅:

常量字段值

NAME_RULES

public static final String NAME_RULES

Constant for the configuration property that indicates the Kerberos name rules for the Kerberos principals.

另请参阅:

常量字段值

构造器详细资料

KerberosAuthenticationHandler

public KerberosAuthenticationHandler()

方法详细资料

init

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

Initializes the authentication handler instance.

It creates a Kerberos context using the principal and keytab specified in the configuration.

This method is invoked by the AuthenticationFilter.init(javax.servlet.FilterConfig) method.

指定者:

init 在接口中 AuthenticationHandler

参数:

config - configuration properties to initialize the handler.

抛出:

javax.servlet.ServletException - thrown if the handler could not be initialized.

destroy

public void destroy()

Releases any resources initialized by the authentication handler.

It destroys the Kerberos context.

指定者:

destroy 在接口中 AuthenticationHandler

getType

public String getType()

Returns the authentication type of the authentication handler, 'kerberos'.

指定者:

getType 在接口中 AuthenticationHandler

返回:

the authentication type of the authentication handler, 'kerberos'.

getPrincipal

protected String getPrincipal()

Returns the Kerberos principal used by the authentication handler.

返回:

the Kerberos principal used by the authentication handler.

getKeytab

protected String getKeytab()

Returns the keytab used by the authentication handler.

返回:

the keytab used by the authentication handler.

authenticate

public AuthenticationToken authenticate(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                                 throws IOException,
                                        AuthenticationException

It enforces the the Kerberos SPNEGO authentication sequence returning an AuthenticationToken only after the Kerberos SPNEGO sequence has completed successfully.

指定者:

authenticate 在接口中 AuthenticationHandler

参数:

request - the HTTP client request.

response - the HTTP client response.

返回:

an authentication token if the Kerberos SPNEGO sequence is complete and valid, null if it is in progress (in this case the handler handles the response to the client).

抛出:

IOException - thrown if an IO error occurred.

AuthenticationException - thrown if Kerberos SPNEGO sequence failed.