org.apache.hadoop.security

Class SaslRpcClient

java.lang.Object

org.apache.hadoop.security.SaslRpcClient

@InterfaceAudience.LimitedPrivate(value={"HDFS","MapReduce"})
@InterfaceStability.Evolving
public class SaslRpcClient
extends Object

A utility class that encapsulates SASL logic for RPC client

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	LOG

Constructor Summary

Constructors

Constructor and Description
SaslRpcClient(UserGroupInformation ugi, Class<?> protocol, InetSocketAddress serverAddr, Configuration conf) Create a SaslRpcClient that can be used by a RPC client to negotiate SASL authentication with a RPC server

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Release resources used by wrapped saslClient
SaslRpcServer.AuthMethod	getAuthMethod()
InputStream	getInputStream(InputStream in) Get SASL wrapped InputStream if SASL QoP requires unwrapping, otherwise return original stream.
Object	getNegotiatedProperty(String key)
OutputStream	getOutputStream(OutputStream out) Get SASL wrapped OutputStream if SASL QoP requires wrapping, otherwise return original stream.
SaslRpcServer.AuthMethod	saslConnect(InputStream inS, 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 org.apache.commons.logging.Log LOG

Constructor Detail

SaslRpcClient

public SaslRpcClient(UserGroupInformation ugi,
             Class<?> protocol,
             InetSocketAddress serverAddr,
             Configuration conf)

Create a SaslRpcClient that can be used by a RPC client to negotiate SASL authentication with a RPC server

Parameters:

ugi - - connecting user

protocol - - RPC protocol

serverAddr - - InetSocketAddress of remote server

conf - - Configuration

Method Detail

getNegotiatedProperty

@InterfaceAudience.Private
public Object getNegotiatedProperty(String key)

getAuthMethod

@InterfaceAudience.Private
public SaslRpcServer.AuthMethod getAuthMethod()

saslConnect

public SaslRpcServer.AuthMethod saslConnect(InputStream inS,
                                   OutputStream outS)
                                     throws IOException

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

Parameters:

inS - InputStream to use

outS - OutputStream to use

Returns:

AuthMethod used to negotiate the connection

Throws:

IOException

getInputStream

public InputStream getInputStream(InputStream in)
                           throws IOException

Get SASL wrapped InputStream if SASL QoP requires unwrapping, otherwise return original stream. Can be called only after saslConnect() has been called.

Parameters:

in - - InputStream used to make the connection

Returns:

InputStream that may be using SASL unwrap

Throws:

IOException

getOutputStream

public OutputStream getOutputStream(OutputStream out)
                             throws IOException

Get SASL wrapped OutputStream if SASL QoP requires wrapping, otherwise return original stream. Can be called only after saslConnect() has been called.

Parameters:

in - - InputStream used to make the connection

Returns:

InputStream that may be using SASL unwrap

Throws:

IOException

dispose

public void dispose()
             throws SaslException

Release resources used by wrapped saslClient

Throws:

SaslException