Class OpenSslClientContext

java.lang.Object

io.netty.handler.ssl.SslContext

io.netty.handler.ssl.ReferenceCountedOpenSslContext

io.netty.handler.ssl.OpenSslContext

io.netty.handler.ssl.OpenSslClientContext

All Implemented Interfaces:

ReferenceCounted

public final class OpenSslClientContext
extends OpenSslContext

A client-side SslContext which uses OpenSSL's SSL/TLS implementation.

This class will use a finalizer to ensure native resources are automatically cleaned up. To avoid finalizers and manually release the native memory see ReferenceCountedOpenSslClientContext.

Nested Class Summary

Nested classes/interfaces inherited from class ReferenceCountedOpenSslContext

ReferenceCountedOpenSslContext.AbstractCertificateVerifier

Field Summary

Fields

Modifier and Type	Field	Description
private final OpenSslSessionContext	sessionContext

Fields inherited from class ReferenceCountedOpenSslContext

CLIENT_ENABLE_SESSION_CACHE, CLIENT_ENABLE_SESSION_TICKET, CLIENT_ENABLE_SESSION_TICKET_TLSV13, clientAuth, ctx, ctxLock, enableOcsp, endpointIdentificationAlgorithm, engineMap, hasTLSv13Cipher, hasTmpDhKeys, keyCertChain, NONE_PROTOCOL_NEGOTIATOR, protocols, SERVER_ENABLE_SESSION_CACHE, SERVER_ENABLE_SESSION_TICKET, SERVER_ENABLE_SESSION_TICKET_TLSV13, tlsFalseStart, USE_TASKS, VERIFY_DEPTH

Fields inherited from class SslContext

ALIAS, resumptionController, X509_CERT_FACTORY

Constructor Summary

Constructors

Constructor	Description
OpenSslClientContext()	Deprecated. use SslContextBuilder
OpenSslClientContext(File certChainFile)	Deprecated. use SslContextBuilder
OpenSslClientContext(File certChainFile, TrustManagerFactory trustManagerFactory)	Deprecated. use SslContextBuilder
OpenSslClientContext(File trustCertCollectionFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslClientContext(File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslClientContext(File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslClientContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, String[] protocols, long sessionCacheSize, long sessionTimeout, boolean startTls, boolean enableOcsp, String keyStore, String endpointIdentificationAlgorithm, ResumptionController resumptionController, Map.Entry<SslContextOption<?>, Object>... options)
OpenSslClientContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, String[] protocols, long sessionCacheSize, long sessionTimeout, boolean enableOcsp, String keyStore, String endpointIdentificationAlgorithm, ResumptionController resumptionController, Map.Entry<SslContextOption<?>, Object>... options)
OpenSslClientContext(TrustManagerFactory trustManagerFactory)	Deprecated. use SslContextBuilder

Method Summary

Modifier and Type	Method	Description
OpenSslSessionContext	sessionContext()	Returns the SSLSessionContext object held by this context.

Methods inherited from class OpenSslContext

finalize, newEngine0

Methods inherited from class ReferenceCountedOpenSslContext

applicationProtocolNegotiator, certificates, chooseTrustManager, chooseTrustManager, chooseX509KeyManager, cipherSuites, context, freeBio, getBioNonApplicationBufferSize, getRejectRemoteInitiatedRenegotiation, isClient, newEngine, newEngine, newHandler, newHandler, newHandler, newHandler, providerFor, refCnt, release, release, retain, retain, setBioNonApplicationBufferSize, setKeyMaterial, setPrivateKeyMethod, setRejectRemoteInitiatedRenegotiation, setTicketKeys, setUseTasks, sslCtxPointer, stats, toBIO, toBIO, toBIO, toNegotiator, touch, touch, useExtendedTrustManager

Methods inherited from class SslContext

attributes, buildKeyManagerFactory, buildKeyManagerFactory, buildKeyStore, buildTrustManagerFactory, buildTrustManagerFactory, buildTrustManagerFactory, defaultClientProvider, defaultServerProvider, generateKeySpec, isServer, keyStorePassword, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContextInternal, newClientContextInternal, newHandler, newHandler, newHandler, newHandler, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContextInternal, nextProtocols, sessionCacheSize, sessionTimeout, toApplicationProtocolConfig, toPrivateKey, toPrivateKey, toPrivateKey, toPrivateKeyInternal, toX509Certificates, toX509Certificates, toX509CertificatesInternal

Methods inherited from class Object

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

Field Details

sessionContext

private final OpenSslSessionContext sessionContext

Constructor Details

OpenSslClientContext

@Deprecated
public OpenSslClientContext()
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Throws:

SSLException

OpenSslClientContext

@Deprecated
public OpenSslClientContext(File certChainFile)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format. null to use the system default

Throws:

SSLException

OpenSslClientContext

@Deprecated
public OpenSslClientContext(TrustManagerFactory trustManagerFactory)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.

Throws:

SSLException

OpenSslClientContext

@Deprecated
public OpenSslClientContext(File certChainFile,
 TrustManagerFactory trustManagerFactory)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format. null to use the system default

trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.

Throws:

SSLException

OpenSslClientContext

@Deprecated
public OpenSslClientContext(File certChainFile,
 TrustManagerFactory trustManagerFactory,
 Iterable<String> ciphers,
 ApplicationProtocolConfig apn,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default..

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

apn - Provides a means to configure parameters related to application protocol negotiation.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslClientContext

@Deprecated
public OpenSslClientContext(File certChainFile,
 TrustManagerFactory trustManagerFactory,
 Iterable<String> ciphers,
 CipherSuiteFilter cipherFilter,
 ApplicationProtocolConfig apn,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default..

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

cipherFilter - a filter to apply over the supplied list of ciphers

apn - Provides a means to configure parameters related to application protocol negotiation.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslClientContext

@Deprecated
public OpenSslClientContext(File trustCertCollectionFile,
 TrustManagerFactory trustManagerFactory,
 File keyCertChainFile,
 File keyFile,
 String keyPassword,
 KeyManagerFactory keyManagerFactory,
 Iterable<String> ciphers,
 CipherSuiteFilter cipherFilter,
 ApplicationProtocolConfig apn,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

trustCertCollectionFile - an X.509 certificate collection file in PEM format. null to use the system default

trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default or the results of parsing trustCertCollectionFile

keyCertChainFile - an X.509 certificate chain file in PEM format. This provides the public key for mutual authentication. null to use the system default

keyFile - a PKCS#8 private key file in PEM format. This provides the private key for mutual authentication. null for no mutual authentication.

keyPassword - the password of the keyFile. null if it's not password-protected. Ignored if keyFile is null.

keyManagerFactory - the KeyManagerFactory that provides the KeyManagers that is used to encrypt data being sent to servers. null to use the default or the results of parsing keyCertChainFile and keyFile.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

cipherFilter - a filter to apply over the supplied list of ciphers

apn - Application Protocol Negotiator object.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslClientContext

OpenSslClientContext(X509Certificate[] trustCertCollection,
 TrustManagerFactory trustManagerFactory,
 X509Certificate[] keyCertChain,
 PrivateKey key,
 String keyPassword,
 KeyManagerFactory keyManagerFactory,
 Iterable<String> ciphers,
 CipherSuiteFilter cipherFilter,
 ApplicationProtocolConfig apn,
 String[] protocols,
 long sessionCacheSize,
 long sessionTimeout,
 boolean enableOcsp,
 String keyStore,
 String endpointIdentificationAlgorithm,
 ResumptionController resumptionController,
 Map.Entry<SslContextOption<?>, Object>... options)
              throws SSLException

Throws:

SSLException

OpenSslClientContext

OpenSslClientContext(X509Certificate[] trustCertCollection,
 TrustManagerFactory trustManagerFactory,
 X509Certificate[] keyCertChain,
 PrivateKey key,
 String keyPassword,
 KeyManagerFactory keyManagerFactory,
 Iterable<String> ciphers,
 CipherSuiteFilter cipherFilter,
 ApplicationProtocolConfig apn,
 String[] protocols,
 long sessionCacheSize,
 long sessionTimeout,
 boolean startTls,
 boolean enableOcsp,
 String keyStore,
 String endpointIdentificationAlgorithm,
 ResumptionController resumptionController,
 Map.Entry<SslContextOption<?>, Object>... options)
              throws SSLException

Throws:

SSLException

Method Details

sessionContext

public OpenSslSessionContext sessionContext()

Description copied from class: SslContext

Returns the SSLSessionContext object held by this context.

Specified by:

sessionContext in class ReferenceCountedOpenSslContext