Class BasicServerTlsStrategy

java.lang.Object

org.apache.hc.core5.http.nio.ssl.BasicServerTlsStrategy

All Implemented Interfaces:

TlsStrategy

public class BasicServerTlsStrategy
extends Object
implements TlsStrategy

Basic server-side implementation of TlsStrategy that upgrades inbound connection with TLS security but does not make use of TLS ALPN extension to negotiate an application protocol. This strategy will also automatically enforce restrictions on TLS parameters by excluding TLS versions and ciphers considered weak.

This strategy should not be used unless no TLS ALPN support is actually desired. One is advised to use a custom TlsStrategy implementation or an implementation provided by the HTTP/2 module.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
private final SSLSessionInitializer	initializer
private final SecurePortStrategy	securePortStrategy
private final SSLBufferMode	sslBufferMode
private final SSLContext	sslContext
private final SSLSessionVerifier	verifier

Constructor Summary

Constructors

Constructor	Description
BasicServerTlsStrategy()
BasicServerTlsStrategy(SSLContext sslContext)
BasicServerTlsStrategy(SSLContext sslContext, SecurePortStrategy securePortStrategy)	Deprecated. Use BasicServerTlsStrategy(SSLContext)
BasicServerTlsStrategy(SSLContext sslContext, SecurePortStrategy securePortStrategy, SSLBufferMode sslBufferMode, SSLSessionInitializer initializer, SSLSessionVerifier verifier)	Deprecated. Use BasicServerTlsStrategy(SSLContext, SSLBufferMode, SSLSessionInitializer, SSLSessionVerifier)
BasicServerTlsStrategy(SSLContext sslContext, SecurePortStrategy securePortStrategy, SSLSessionInitializer initializer, SSLSessionVerifier verifier)	Deprecated. Use BasicServerTlsStrategy(SSLContext, SSLSessionInitializer, SSLSessionVerifier)
BasicServerTlsStrategy(SSLContext sslContext, SecurePortStrategy securePortStrategy, SSLSessionVerifier verifier)	Deprecated. Use BasicServerTlsStrategy(SSLContext, SSLSessionVerifier)
BasicServerTlsStrategy(SSLContext sslContext, SSLBufferMode sslBufferMode, SSLSessionInitializer initializer, SSLSessionVerifier verifier)
BasicServerTlsStrategy(SSLContext sslContext, SSLSessionInitializer initializer, SSLSessionVerifier verifier)
BasicServerTlsStrategy(SSLContext sslContext, SSLSessionVerifier verifier)
BasicServerTlsStrategy(SecurePortStrategy securePortStrategy)	Deprecated. Use BasicServerTlsStrategy()
BasicServerTlsStrategy(SSLSessionVerifier verifier)	Constructor with the default SSL context based on system properties and custom SSLSessionVerifier verifier.

Method Summary

Modifier and Type	Method	Description
private boolean	isApplicable(SocketAddress localAddress)
boolean	upgrade(TransportSecurityLayer tlsSession, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout)	Deprecated. use upgrade(TransportSecurityLayer, NamedEndpoint, Object, Timeout, FutureCallback)
void	upgrade(TransportSecurityLayer tlsSession, NamedEndpoint endpoint, Object attachment, Timeout handshakeTimeout, FutureCallback<TransportSecurityLayer> callback)	Secures current session layer with TLS.

Methods inherited from class Object

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

Field Details

sslContext

private final SSLContext sslContext

securePortStrategy

private final SecurePortStrategy securePortStrategy

sslBufferMode

private final SSLBufferMode sslBufferMode

initializer

private final SSLSessionInitializer initializer

verifier

private final SSLSessionVerifier verifier

Constructor Details

BasicServerTlsStrategy

@Deprecated
public BasicServerTlsStrategy(SSLContext sslContext,
 SecurePortStrategy securePortStrategy,
 SSLBufferMode sslBufferMode,
 SSLSessionInitializer initializer,
 SSLSessionVerifier verifier)

Deprecated.

Use BasicServerTlsStrategy(SSLContext, SSLBufferMode, SSLSessionInitializer, SSLSessionVerifier)

BasicServerTlsStrategy

@Deprecated
public BasicServerTlsStrategy(SSLContext sslContext,
 SecurePortStrategy securePortStrategy,
 SSLSessionInitializer initializer,
 SSLSessionVerifier verifier)

Deprecated.

Use BasicServerTlsStrategy(SSLContext, SSLSessionInitializer, SSLSessionVerifier)

BasicServerTlsStrategy

@Deprecated
public BasicServerTlsStrategy(SSLContext sslContext,
 SecurePortStrategy securePortStrategy,
 SSLSessionVerifier verifier)

Deprecated.

Use BasicServerTlsStrategy(SSLContext, SSLSessionVerifier)

BasicServerTlsStrategy

@Deprecated
public BasicServerTlsStrategy(SSLContext sslContext,
 SecurePortStrategy securePortStrategy)

Deprecated.

Use BasicServerTlsStrategy(SSLContext)

BasicServerTlsStrategy

@Deprecated
public BasicServerTlsStrategy(SecurePortStrategy securePortStrategy)

Deprecated.

Use BasicServerTlsStrategy()

BasicServerTlsStrategy

public BasicServerTlsStrategy(SSLSessionVerifier verifier)

Constructor with the default SSL context based on system properties and custom SSLSessionVerifier verifier.

Parameters:

verifier - the custom SSLSessionVerifier.

Since:

5.2

BasicServerTlsStrategy

public BasicServerTlsStrategy(SSLContext sslContext,
 SSLBufferMode sslBufferMode,
 SSLSessionInitializer initializer,
 SSLSessionVerifier verifier)

BasicServerTlsStrategy

public BasicServerTlsStrategy(SSLContext sslContext,
 SSLSessionInitializer initializer,
 SSLSessionVerifier verifier)

BasicServerTlsStrategy

public BasicServerTlsStrategy(SSLContext sslContext,
 SSLSessionVerifier verifier)

BasicServerTlsStrategy

public BasicServerTlsStrategy(SSLContext sslContext)

BasicServerTlsStrategy

public BasicServerTlsStrategy()

Method Details

isApplicable

private boolean isApplicable(SocketAddress localAddress)

upgrade

public void upgrade(TransportSecurityLayer tlsSession,
 NamedEndpoint endpoint,
 Object attachment,
 Timeout handshakeTimeout,
 FutureCallback<TransportSecurityLayer> callback)

Description copied from interface: TlsStrategy

Secures current session layer with TLS.

Specified by:

upgrade in interface TlsStrategy

Parameters:

tlsSession - the session layer

endpoint - the name of the opposite endpoint when applicable or null otherwise.

attachment - arbitrary object passes to the TLS session initialization code.

handshakeTimeout - the timeout to use while performing the TLS handshake; may be null.

callback - Operation result callback.

upgrade

@Deprecated
public boolean upgrade(TransportSecurityLayer tlsSession,
 HttpHost host,
 SocketAddress localAddress,
 SocketAddress remoteAddress,
 Object attachment,
 Timeout handshakeTimeout)

Deprecated.

use upgrade(TransportSecurityLayer, NamedEndpoint, Object, Timeout, FutureCallback)

Description copied from interface: TlsStrategy

Secures current session layer with TLS.

Specified by:

upgrade in interface TlsStrategy

Parameters:

tlsSession - the session layer

host - the name of the opposite endpoint when given or null otherwise.

localAddress - the address of the local endpoint.

remoteAddress - the address of the remote endpoint.

attachment - arbitrary object passes to the TLS session initialization code.

handshakeTimeout - the timeout to use while performing the TLS handshake; may be null.

Returns:

true if the session has been upgraded, false otherwise.