io.r2dbc.mssql.client.ssl

Class TdsSslHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.r2dbc.mssql.client.ssl.TdsSslHandler

All Implemented Interfaces:

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

@ChannelHandler.Sharable
public final class TdsSslHandler
extends io.netty.channel.ChannelDuplexHandler

SSL handling for TDS connections.

This handler wraps or passes thru read and write data depending on the SslState. Because TDS requires header wrapping, we're not mounting the SslHandler directly into the pipeline but delegating read and write events to it.

This ChannelHandler supports also full SSL mode and requires to be reordered once the handshake is done therefor it's marked as @Sharable.

Author:

Mark Paluch

See Also:

SslHandler, ConnectionState

Nested Class Summary

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 boolean	DEBUG_ENABLED

Constructor Summary

Constructors

Constructor and Description
TdsSslHandler(PacketIdProvider packetIdProvider, SslConfiguration sslConfiguration, io.r2dbc.mssql.client.ConnectionContext context) Creates a new TdsSslHandler.

Method Summary

Modifier and Type	Method and Description
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg) Route read events to the SslHandler.
void	channelReadComplete(io.netty.channel.ChannelHandlerContext ctx) SSL quirk: Make sure to flush the output buffer during SSL handshake.
void	flush(io.netty.channel.ChannelHandlerContext ctx) Wrap SSL handshake in prelogin Headers.
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
void	handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
void	userEventTriggered(io.netty.channel.ChannelHandlerContext ctx, Object evt) Lazily register SslHandler if needed.
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise) Write data either directly (SSL disabled), to an intermediate buffer for Header wrapping, or via SslHandler for entire packet encryption without prepending a header.

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, 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

exceptionCaught

Field Detail

DEBUG_ENABLED

public static final boolean DEBUG_ENABLED

Constructor Detail

TdsSslHandler

public TdsSslHandler(PacketIdProvider packetIdProvider,
                     SslConfiguration sslConfiguration,
                     io.r2dbc.mssql.client.ConnectionContext context)

Creates a new TdsSslHandler.

Parameters:

packetIdProvider - the PacketIdProvider to create Headers to wrap the SSL handshake.

sslConfiguration - SSL config.

context - Value object capturing diagnostic connection context.

Method Detail

userEventTriggered

public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
                               Object evt)
                        throws Exception

Lazily register SslHandler if needed.

Specified by:

userEventTriggered in interface io.netty.channel.ChannelInboundHandler

Overrides:

userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the event is made.

evt - the user event.

Throws:

Exception - thrown if an error occurs

handlerAdded

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

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

handlerRemoved

public void handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)

Specified by:

handlerRemoved in interface io.netty.channel.ChannelHandler

Overrides:

handlerRemoved in class io.netty.channel.ChannelHandlerAdapter

channelInactive

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

Specified by:

channelInactive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelInactive 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

Write data either directly (SSL disabled), to an intermediate buffer for Header wrapping, or via SslHandler for entire packet encryption without prepending a header. Note that SslState.LOGIN_ONLY is swapped to SslState.AFTER_LOGIN_ONLY once login payload is written. We don't check actually whether the payload is a login packet but rely on higher level layers to send the appropriate data.

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.channel.ChannelDuplexHandler

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

flush

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

Wrap SSL handshake in prelogin Headers. Delaying write to flush instead of writing each packet in a single header.

Specified by:

flush in interface io.netty.channel.ChannelOutboundHandler

Overrides:

flush in class io.netty.channel.ChannelDuplexHandler

Parameters:

ctx - the ChannelHandlerContext for which the flush operation is made.

Throws:

Exception - thrown if an error occurs.

channelReadComplete

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

SSL quirk: Make sure to flush the output buffer during SSL handshake. The SSL handshake can end in the read underrun that wants to read from the transport. We need to make sure that write requests (that don't get flushed explicitly) are sent so we can expect eventually a read.

Specified by:

channelReadComplete in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelReadComplete in class io.netty.channel.ChannelInboundHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the read complete operation is made.

Throws:

Exception - thrown if an error occurs.

channelRead

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

Route read events to the SslHandler. Strip off Header during handshake.

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the read operation is made.

msg - the message to read.

Throws:

Exception - thrown if an error occurs.