Package io.netty.handler.ssl

Class SniHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.ssl.SslClientHelloHandler<T>

io.netty.handler.ssl.AbstractSniHandler<SslContext>

io.netty.handler.ssl.SniHandler

All Implemented Interfaces:

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

public class SniHandler
extends AbstractSniHandler<SslContext>

Enables SNI (Server Name Indication) extension for server side SSL. For clients support SNI, the server could have multiple host name bound on a single IP. The client will send host name in the handshake data so server could decide which certificate to choose for the host name.

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.ByteToMessageDecoder.Cumulator

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
protected io.netty.util.AsyncMapping<String,SslContext>	mapping

Fields inherited from class io.netty.handler.ssl.AbstractSniHandler

handshakeTimeoutMillis

Fields inherited from class io.netty.handler.ssl.SslClientHelloHandler

MAX_CLIENT_HELLO_LENGTH

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
SniHandler(io.netty.util.AsyncMapping<? super String,? extends SslContext> mapping)	Creates a SNI detection handler with configured SslContext maintained by AsyncMapping
SniHandler(io.netty.util.AsyncMapping<? super String,? extends SslContext> mapping, int maxClientHelloLength, long handshakeTimeoutMillis)	Creates a SNI detection handler with configured SslContext maintained by AsyncMapping
SniHandler(io.netty.util.AsyncMapping<? super String,? extends SslContext> mapping, long handshakeTimeoutMillis)	Creates a SNI detection handler with configured SslContext maintained by AsyncMapping
SniHandler(io.netty.util.DomainNameMapping<? extends SslContext> mapping)	Creates a SNI detection handler with configured SslContext maintained by DomainNameMapping
SniHandler(io.netty.util.Mapping<? super String,? extends SslContext> mapping)	Creates a SNI detection handler with configured SslContext maintained by Mapping
SniHandler(io.netty.util.Mapping<? super String,? extends SslContext> mapping, int maxClientHelloLength, long handshakeTimeoutMillis)	Creates a SNI detection handler with configured SslContext maintained by Mapping
SniHandler(io.netty.util.Mapping<? super String,? extends SslContext> mapping, long handshakeTimeoutMillis)	Creates a SNI detection handler with configured SslContext maintained by Mapping

Method Summary

Modifier and Type	Method	Description
String	hostname()
protected io.netty.util.concurrent.Future<SslContext>	lookup(io.netty.channel.ChannelHandlerContext ctx, String hostname)	The default implementation will simply call AsyncMapping.map(Object, Promise) but users can override this method to implement custom behavior.
protected SslHandler	newSslHandler(SslContext context, io.netty.buffer.ByteBufAllocator allocator)	Returns a new SslHandler using the given SslContext and ByteBufAllocator.
protected void	onLookupComplete(io.netty.channel.ChannelHandlerContext ctx, String hostname, io.netty.util.concurrent.Future<SslContext> future)	Called upon completion of the AbstractSniHandler.lookup(ChannelHandlerContext, String) Future.
protected void	replaceHandler(io.netty.channel.ChannelHandlerContext ctx, String hostname, SslContext sslContext)	The default implementation of this method will simply replace this SniHandler instance with a SslHandler.
SslContext	sslContext()

Methods inherited from class io.netty.handler.ssl.AbstractSniHandler

channelActive, handlerAdded, lookup, onLookupComplete

Methods inherited from class io.netty.handler.ssl.SslClientHelloHandler

bind, close, connect, decode, deregister, disconnect, flush, handlerRemoved0, read, write

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

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

handlerRemoved

Field Detail

mapping

protected final io.netty.util.AsyncMapping<String,SslContext> mapping

Constructor Detail

SniHandler

public SniHandler(io.netty.util.Mapping<? super String,? extends SslContext> mapping)

Creates a SNI detection handler with configured SslContext maintained by Mapping

Parameters:

mapping - the mapping of domain name to SslContext

SniHandler

public SniHandler(io.netty.util.Mapping<? super String,? extends SslContext> mapping,
                  int maxClientHelloLength,
                  long handshakeTimeoutMillis)

Creates a SNI detection handler with configured SslContext maintained by Mapping

Parameters:

mapping - the mapping of domain name to SslContext

maxClientHelloLength - the maximum length of the client hello message

handshakeTimeoutMillis - the handshake timeout in milliseconds

SniHandler

public SniHandler(io.netty.util.DomainNameMapping<? extends SslContext> mapping)

Creates a SNI detection handler with configured SslContext maintained by DomainNameMapping

Parameters:

mapping - the mapping of domain name to SslContext

SniHandler

public SniHandler(io.netty.util.AsyncMapping<? super String,? extends SslContext> mapping)

Creates a SNI detection handler with configured SslContext maintained by AsyncMapping

Parameters:

mapping - the mapping of domain name to SslContext

SniHandler

public SniHandler(io.netty.util.AsyncMapping<? super String,? extends SslContext> mapping,
                  int maxClientHelloLength,
                  long handshakeTimeoutMillis)

Creates a SNI detection handler with configured SslContext maintained by AsyncMapping

Parameters:

mapping - the mapping of domain name to SslContext

maxClientHelloLength - the maximum length of the client hello message

handshakeTimeoutMillis - the handshake timeout in milliseconds

SniHandler

public SniHandler(io.netty.util.Mapping<? super String,? extends SslContext> mapping,
                  long handshakeTimeoutMillis)

Creates a SNI detection handler with configured SslContext maintained by Mapping

Parameters:

mapping - the mapping of domain name to SslContext

handshakeTimeoutMillis - the handshake timeout in milliseconds

SniHandler

public SniHandler(io.netty.util.AsyncMapping<? super String,? extends SslContext> mapping,
                  long handshakeTimeoutMillis)

Creates a SNI detection handler with configured SslContext maintained by AsyncMapping

Parameters:

mapping - the mapping of domain name to SslContext

handshakeTimeoutMillis - the handshake timeout in milliseconds

Method Detail

hostname

public String hostname()

Returns:

the selected hostname

sslContext

public SslContext sslContext()

Returns:

the selected SslContext

lookup

protected io.netty.util.concurrent.Future<SslContext> lookup(io.netty.channel.ChannelHandlerContext ctx,
                                                             String hostname)
                                                      throws Exception

The default implementation will simply call AsyncMapping.map(Object, Promise) but users can override this method to implement custom behavior.

Specified by:

lookup in class AbstractSniHandler<SslContext>

Throws:

Exception

See Also:

AsyncMapping.map(Object, Promise)

onLookupComplete

protected final void onLookupComplete(io.netty.channel.ChannelHandlerContext ctx,
                                      String hostname,
                                      io.netty.util.concurrent.Future<SslContext> future)
                               throws Exception

Description copied from class: AbstractSniHandler

Called upon completion of the AbstractSniHandler.lookup(ChannelHandlerContext, String) Future.

Specified by:

onLookupComplete in class AbstractSniHandler<SslContext>

Throws:

Exception

See Also:

AbstractSniHandler.lookup(ChannelHandlerContext, String)

replaceHandler

protected void replaceHandler(io.netty.channel.ChannelHandlerContext ctx,
                              String hostname,
                              SslContext sslContext)
                       throws Exception

The default implementation of this method will simply replace this SniHandler instance with a SslHandler. Users may override this method to implement custom behavior. Please be aware that this method may get called after a client has already disconnected and custom implementations must take it into consideration when overriding this method. It's also possible for the hostname argument to be null.

Throws:

Exception

newSslHandler

protected SslHandler newSslHandler(SslContext context,
                                   io.netty.buffer.ByteBufAllocator allocator)

Returns a new SslHandler using the given SslContext and ByteBufAllocator. Users may override this method to implement custom behavior.