org.apache.hadoop.hbase.security

Class SaslClientHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

org.apache.hadoop.hbase.security.SaslClientHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler

@InterfaceAudience.Private
public class SaslClientHandler
extends io.netty.channel.ChannelDuplexHandler

Handles Sasl connections

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SaslClientHandler.SaslExceptionHandler Handler for exceptions during Sasl connection
static interface	SaslClientHandler.SaslSuccessfulConnectHandler Handler for successful connects

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description

SaslClientHandler(org.apache.hadoop.security.UserGroupInformation ticket, AuthMethod method, org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier> token, String serverPrincipal, boolean fallbackAllowed, String rpcProtection, SaslClientHandler.SaslExceptionHandler exceptionHandler, SaslClientHandler.SaslSuccessfulConnectHandler successfulConnectHandler) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)
void	channelUnregistered(io.netty.channel.ChannelHandlerContext ctx)
protected SaslClient	createDigestSaslClient(String[] mechanismNames, String saslDefaultRealm, CallbackHandler saslClientCallbackHandler) Create a Digest Sasl client
protected SaslClient	createKerberosSaslClient(String[] mechanismNames, String userFirstPart, String userSecondPart) Create Kerberos client
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerRemoved

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

Constructor Detail

SaslClientHandler

public SaslClientHandler(org.apache.hadoop.security.UserGroupInformation ticket,
                 AuthMethod method,
                 org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier> token,
                 String serverPrincipal,
                 boolean fallbackAllowed,
                 String rpcProtection,
                 SaslClientHandler.SaslExceptionHandler exceptionHandler,
                 SaslClientHandler.SaslSuccessfulConnectHandler successfulConnectHandler)
                  throws IOException

Constructor

Parameters:

ticket - the ugi

method - auth method

token - for Sasl

serverPrincipal - Server's Kerberos principal name

fallbackAllowed - True if server may also fall back to less secure connection

rpcProtection - Quality of protection. Can be 'authentication', 'integrity' or 'privacy'.

exceptionHandler - handler for exceptions

successfulConnectHandler - handler for succesful connects

Throws:

IOException - if handler could not be created

Method Detail

createDigestSaslClient

protected SaslClient createDigestSaslClient(String[] mechanismNames,
                                String saslDefaultRealm,
                                CallbackHandler saslClientCallbackHandler)
                                     throws IOException

Create a Digest Sasl client

Parameters:

mechanismNames - names of mechanisms

saslDefaultRealm - default realm for sasl

saslClientCallbackHandler - handler for the client

Returns:

new SaslClient

Throws:

IOException - if creation went wrong

createKerberosSaslClient

protected SaslClient createKerberosSaslClient(String[] mechanismNames,
                                  String userFirstPart,
                                  String userSecondPart)
                                       throws IOException

Create Kerberos client

Parameters:

mechanismNames - names of mechanisms

userFirstPart - first part of username

userSecondPart - second part of username

Returns:

new SaslClient

Throws:

IOException - if fails

channelUnregistered

public void channelUnregistered(io.netty.channel.ChannelHandlerContext ctx)
                         throws Exception

Specified by:

channelUnregistered in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelUnregistered in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

handlerAdded

public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
                  throws Exception

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
               Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                   Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
         Object msg,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception