Grizzly NIO 5.0.2 · org.glassfish.grizzly.sni.SNIFilter

TLS Server Name Indication (SNI) Filter implementation. This filter supports SNI extension on both client and server sides, however the client side logic works on JDK 7+ only. On the server-side this filter allows developers to set custom SSLEngineConfigurator, based on the host name provided by the client in the SSL CLIENT_HELLO message. An SNIServerConfigResolver registered via setServerSSLConfigResolver(org.glassfish.grizzly.sni.SNIServerConfigResolver) would be responsible for customizing SSLEngineConfigurator. On the other hand for client-side it's not mandatory to register SNIClientConfigResolver, because the host name information could be obtained from the Connection#getPeerAddress(). However SNIClientConfigResolver could be used to customize the host name.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	SNIFilter.SNIAwareTransportFilterWrapper

Field Summary

Modifier and Type	Field and Description
private static final int	CLIENT_HELLO_HST
private SNIClientConfigResolver	clientResolver
private static final byte	HANDSHAKE_TYPE
private static final Logger	LOGGER Hides org.glassfish.grizzly.ssl.SSLFilter.LOGGER.
private static final int	MIN_TLS_VERSION
private SNIServerConfigResolver	serverResolver
private static final int	SSLV3_RECORD_HEADER_SIZE

Inherited from org.glassfish.grizzly.ssl.SSLFilter:: maxPendingBytes

Constructor Summary

Access	Constructor and Description
public	SNIFilter()
public	SNIFilter(final SSLEngineConfigurator serverSSLEngineConfigurator, final SSLEngineConfigurator clientSSLEngineConfigurator) Construct an `SNIFilter` with the given default client and server side `SSLEngineConfigurator`.
public	SNIFilter(final SSLEngineConfigurator SSLEngine configurator for server side connections serverSSLEngineConfigurator, final SSLEngineConfigurator SSLEngine configurator for client side connections clientSSLEngineConfigurator, final boolean renegotiateOnClientAuthWant) Construct an `SNIFilter` with the given default `SSLEngineConfigurator`.

Method Summary

Modifier and Type	Method and Description
pack-priv static boolean	checkTlsVersion(final byte byte0, final byte major, final byte minor)
protected SSLBaseFilter.SSLTransportFilterWrapper	createOptimizedTransportFilter(final TransportFilter childFilter) Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.createOptimizedTransportFilter.
public SNIClientConfigResolver	getClientSSLConfigResolver() Returns: `SNIClientConfigResolver`, which is responsible for customizing `SSLEngineConfigurator` and SNI host name to be sent to a server
private String	getHostName(final Buffer input, final int len)
public SNIServerConfigResolver	getServerSSLConfigResolver() Returns: `SNIServerConfigResolver`, which is responsible for customizing `SSLEngineConfigurator` for newly accepted `Connection`s, based on SNI host name information sent by a client
public NextAction	handleConnect(final FilterChainContext ctx) Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleConnect. Implements org.glassfish.grizzly.filterchain.Filter.handleConnect. Execute a unit of processing work to be performed, when channel gets connected.
public NextAction	handleRead(final FilterChainContext ctx) Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.handleRead. Implements org.glassfish.grizzly.filterchain.Filter.handleRead. Execute a unit of processing work to be performed, when channel will become available for reading.
public void	setClientSSLConfigResolver(final SNIClientConfigResolver resolver) Sets `SNIClientConfigResolver`, which is responsible for customizing `SSLEngineConfigurator` and SNI host name to be sent to a server.
public void	setServerSSLConfigResolver(final SNIServerConfigResolver `SNIServerConfigResolver` resolver) Sets `SNIServerConfigResolver`, which is responsible for customizing `SSLEngineConfigurator` for newly accepted `Connection`s, based on SNI host name information sent by a client.

Inherited from org.glassfish.grizzly.ssl.SSLFilter:: createClientSSLEngine doHandshakeStep getClientSSLEngineConfigurator getMaxPendingBytesPerConnection handleWrite handshake handshake handshake handshake notifyHandshakeComplete notifyHandshakeFailed setMaxPendingBytesPerConnection

Field Detail

CLIENT_HELLO_HST	back to summary
private static final int CLIENT_HELLO_HST

clientResolver	back to summary
private SNIClientConfigResolver clientResolver

HANDSHAKE_TYPE	back to summary
private static final byte HANDSHAKE_TYPE

LOGGER	back to summary
private static final Logger LOGGER Hides org.glassfish.grizzly.ssl.SSLFilter.LOGGER.

MIN_TLS_VERSION	back to summary
private static final int MIN_TLS_VERSION

serverResolver	back to summary
private SNIServerConfigResolver serverResolver

SSLV3_RECORD_HEADER_SIZE	back to summary
private static final int SSLV3_RECORD_HEADER_SIZE

Constructor Detail

SNIFilter	back to summary
public SNIFilter()

SNIFilter	back to summary
public SNIFilter(final SSLEngineConfigurator serverSSLEngineConfigurator, final SSLEngineConfigurator clientSSLEngineConfigurator) Construct an `SNIFilter` with the given default client and server side `SSLEngineConfigurator`.

SNIFilter back to summary

SNIFilter	back to summary
public SNIFilter(final SSLEngineConfigurator serverSSLEngineConfigurator, final SSLEngineConfigurator clientSSLEngineConfigurator, final boolean renegotiateOnClientAuthWant) Construct an `SNIFilter` with the given default `SSLEngineConfigurator`. Parameters serverSSLEngineConfigurator:SSLEngineConfigurator SSLEngine configurator for server side connections clientSSLEngineConfigurator:SSLEngineConfigurator SSLEngine configurator for client side connections

public SNIFilter(final SSLEngineConfigurator serverSSLEngineConfigurator, final SSLEngineConfigurator clientSSLEngineConfigurator, final boolean renegotiateOnClientAuthWant)

Construct an SNIFilter with the given default SSLEngineConfigurator.

Parameters

serverSSLEngineConfigurator:SSLEngineConfigurator: SSLEngine configurator for server side connections
clientSSLEngineConfigurator:SSLEngineConfigurator: SSLEngine configurator for client side connections

Method Detail

checkTlsVersion	back to summary
pack-priv static boolean checkTlsVersion(final byte byte0, final byte major, final byte minor)

createOptimizedTransportFilter	back to summary
protected SSLBaseFilter.SSLTransportFilterWrapper createOptimizedTransportFilter(final TransportFilter childFilter) Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.createOptimizedTransportFilter. Annotations @Override

createOptimizedTransportFilter

back to summary

protected SSLBaseFilter.SSLTransportFilterWrapper createOptimizedTransportFilter(final TransportFilter childFilter)

Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.createOptimizedTransportFilter.

Annotations

@Override

getClientSSLConfigResolver	back to summary
public SNIClientConfigResolver getClientSSLConfigResolver() Returns:SNIClientConfigResolver `SNIClientConfigResolver`, which is responsible for customizing `SSLEngineConfigurator` and SNI host name to be sent to a server

getHostName	back to summary
private String getHostName(final Buffer input, final int len)

getServerSSLConfigResolver	back to summary
public SNIServerConfigResolver getServerSSLConfigResolver() Returns:SNIServerConfigResolver `SNIServerConfigResolver`, which is responsible for customizing `SSLEngineConfigurator` for newly accepted `Connection`s, based on SNI host name information sent by a client

handleConnect back to summary

handleConnect	back to summary
public NextAction handleConnect(final FilterChainContext ctx) throws IOException Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleConnect. Implements org.glassfish.grizzly.filterchain.Filter.handleConnect. Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleConnect. Execute a unit of processing work to be performed, when channel gets connected. This `Filter` may either complete the required processing and return false, or delegate remaining processing to the next `Filter` in a `FilterChain` containing this `Filter` by returning true. Annotations @Override

public NextAction handleConnect(final FilterChainContext ctx) throws IOException

Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleConnect.

Implements org.glassfish.grizzly.filterchain.Filter.handleConnect.

Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleConnect.

Execute a unit of processing work to be performed, when channel gets connected. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Annotations

@Override

handleRead back to summary

handleRead	back to summary
public NextAction handleRead(final FilterChainContext ctx) throws IOException Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.handleRead. Implements org.glassfish.grizzly.filterchain.Filter.handleRead. Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleRead. Execute a unit of processing work to be performed, when channel will become available for reading. This `Filter` may either complete the required processing and return false, or delegate remaining processing to the next `Filter` in a `FilterChain` containing this `Filter` by returning true. Annotations @Override

public NextAction handleRead(final FilterChainContext ctx) throws IOException

Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.handleRead.

Implements org.glassfish.grizzly.filterchain.Filter.handleRead.

Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleRead.

Execute a unit of processing work to be performed, when channel will become available for reading. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Annotations

@Override

setClientSSLConfigResolver	back to summary
public void setClientSSLConfigResolver(final SNIClientConfigResolver resolver) Sets `SNIClientConfigResolver`, which is responsible for customizing `SSLEngineConfigurator` and SNI host name to be sent to a server.

setServerSSLConfigResolver back to summary

setServerSSLConfigResolver	back to summary
public void setServerSSLConfigResolver(final SNIServerConfigResolver resolver) Sets `SNIServerConfigResolver`, which is responsible for customizing `SSLEngineConfigurator` for newly accepted `Connection`s, based on SNI host name information sent by a client. Parameters resolver:SNIServerConfigResolver `SNIServerConfigResolver`

public void setServerSSLConfigResolver(final SNIServerConfigResolver resolver)

Sets SNIServerConfigResolver, which is responsible for customizing SSLEngineConfigurator for newly accepted Connections, based on SNI host name information sent by a client.

Parameters

resolver:SNIServerConfigResolver: SNIServerConfigResolver

public Class SNIFilter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SNIFilter.SNIAwareTransportFilterWrapper

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail