org.apache.hadoop.hbase.security

Class HBaseSaslRpcClient

java.lang.Object

org.apache.hadoop.hbase.security.HBaseSaslRpcClient

@InterfaceAudience.Private
public class HBaseSaslRpcClient
extends java.lang.Object

A utility class that encapsulates SASL logic for RPC client. Copied from org.apache.hadoop.security

Field Summary

Fields

Modifier and Type	Field and Description
static Log	LOG

Constructor Summary

Constructors

Constructor and Description
HBaseSaslRpcClient(AuthMethod method, <any> token, java.lang.String serverPrincipal, boolean fallbackAllowed) Create a HBaseSaslRpcClient for an authentication method
HBaseSaslRpcClient(AuthMethod method, <any> token, java.lang.String serverPrincipal, boolean fallbackAllowed, java.lang.String rpcProtection) Create a HBaseSaslRpcClient for an authentication method

Method Summary

Modifier and Type	Method and Description
protected javax.security.sasl.SaslClient	createDigestSaslClient(java.lang.String[] mechanismNames, java.lang.String saslDefaultRealm, javax.security.auth.callback.CallbackHandler saslClientCallbackHandler)
protected javax.security.sasl.SaslClient	createKerberosSaslClient(java.lang.String[] mechanismNames, java.lang.String userFirstPart, java.lang.String userSecondPart)
void	dispose() Release resources used by wrapped saslClient
java.io.InputStream	getInputStream(java.io.InputStream in) Get a SASL wrapped InputStream.
java.io.OutputStream	getOutputStream(java.io.OutputStream out) Get a SASL wrapped OutputStream.
boolean	saslConnect(java.io.InputStream inS, java.io.OutputStream outS) Do client side SASL authentication with server via the given InputStream and OutputStream

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final Log LOG

Constructor Detail

HBaseSaslRpcClient

public HBaseSaslRpcClient(AuthMethod method,
                          <any> token,
                          java.lang.String serverPrincipal,
                          boolean fallbackAllowed)
                   throws java.io.IOException

Create a HBaseSaslRpcClient for an authentication method

Parameters:

method - the requested authentication method

token - token to use if needed by the authentication method

serverPrincipal - the server principal that we are trying to set the connection up to

fallbackAllowed - does the client allow fallback to simple authentication

Throws:

java.io.IOException

HBaseSaslRpcClient

public HBaseSaslRpcClient(AuthMethod method,
                          <any> token,
                          java.lang.String serverPrincipal,
                          boolean fallbackAllowed,
                          java.lang.String rpcProtection)
                   throws java.io.IOException

Create a HBaseSaslRpcClient for an authentication method

Parameters:

method - the requested authentication method

token - token to use if needed by the authentication method

serverPrincipal - the server principal that we are trying to set the connection up to

fallbackAllowed - does the client allow fallback to simple authentication

rpcProtection - the protection level ("authentication", "integrity" or "privacy")

Throws:

java.io.IOException

Method Detail

createDigestSaslClient

protected javax.security.sasl.SaslClient createDigestSaslClient(java.lang.String[] mechanismNames,
                                                                java.lang.String saslDefaultRealm,
                                                                javax.security.auth.callback.CallbackHandler saslClientCallbackHandler)
                                                         throws java.io.IOException

Throws:

java.io.IOException

createKerberosSaslClient

protected javax.security.sasl.SaslClient createKerberosSaslClient(java.lang.String[] mechanismNames,
                                                                  java.lang.String userFirstPart,
                                                                  java.lang.String userSecondPart)
                                                           throws java.io.IOException

Throws:

java.io.IOException

saslConnect

public boolean saslConnect(java.io.InputStream inS,
                           java.io.OutputStream outS)
                    throws java.io.IOException

Do client side SASL authentication with server via the given InputStream and OutputStream

Parameters:

inS - InputStream to use

outS - OutputStream to use

Returns:

true if connection is set up, or false if needs to switch to simple Auth.

Throws:

java.io.IOException

getInputStream

public java.io.InputStream getInputStream(java.io.InputStream in)
                                   throws java.io.IOException

Get a SASL wrapped InputStream. Can be called only after saslConnect() has been called.

Parameters:

in - the InputStream to wrap

Returns:

a SASL wrapped InputStream

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream(java.io.OutputStream out)
                                     throws java.io.IOException

Get a SASL wrapped OutputStream. Can be called only after saslConnect() has been called.

Parameters:

out - the OutputStream to wrap

Returns:

a SASL wrapped OutputStream

Throws:

java.io.IOException

dispose

public void dispose()
             throws javax.security.sasl.SaslException

Release resources used by wrapped saslClient

Throws:

javax.security.sasl.SaslException