Package org.apache.hadoop.security

Class SaslRpcClient

java.lang.Object

org.apache.hadoop.security.SaslRpcClient

@LimitedPrivate({"HDFS","MapReduce"})
@Evolving
public class SaslRpcClient
extends java.lang.Object

A utility class that encapsulates SASL logic for RPC client

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
SaslRpcClient(UserGroupInformation ugi, java.lang.Class<?> protocol, java.net.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

Modifier and Type	Method	Description
void	dispose()	Release resources used by wrapped saslClient.
RpcAuthMethod	getAuthMethod()
java.io.InputStream	getInputStream(java.io.InputStream in)	Get SASL wrapped InputStream if SASL QoP requires unwrapping, otherwise return original stream.
java.lang.Object	getNegotiatedProperty(java.lang.String key)
java.io.OutputStream	getOutputStream(java.io.OutputStream out)	Get SASL wrapped OutputStream if SASL QoP requires wrapping, otherwise return original stream.
RpcAuthMethod	saslConnect(Client.IpcStreams ipcStreams)	Do client side SASL authentication with server via the given IpcStreams.

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.slf4j.Logger LOG

Constructor Detail

SaslRpcClient

public SaslRpcClient(UserGroupInformation ugi,
                     java.lang.Class<?> protocol,
                     java.net.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

@VisibleForTesting
@Private
public java.lang.Object getNegotiatedProperty(java.lang.String key)

getAuthMethod

@Private
public RpcAuthMethod getAuthMethod()

saslConnect

public RpcAuthMethod saslConnect(Client.IpcStreams ipcStreams)
                          throws java.io.IOException

Do client side SASL authentication with server via the given IpcStreams.

Parameters:

ipcStreams - ipcStreams.

Returns:

AuthMethod used to negotiate the connection

Throws:

java.io.IOException - raised on errors performing I/O.

getInputStream

public java.io.InputStream getInputStream(java.io.InputStream in)
                                   throws java.io.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:

java.io.IOException - raised on errors performing I/O.

getOutputStream

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

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

Parameters:

out - - OutputStream used to make the connection

Returns:

OutputStream that may be using wrapping

Throws:

java.io.IOException - raised on errors performing I/O.

dispose

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

Release resources used by wrapped saslClient.

Throws:

javax.security.sasl.SaslException - if authentication or generating response fails, or SASL protocol mixup