io.netty.handler.ssl

Class JdkSslContext

java.lang.Object

io.netty.handler.ssl.SslContext

io.netty.handler.ssl.JdkSslContext

Direct Known Subclasses:

JdkSslClientContext, JdkSslServerContext

public class JdkSslContext
extends SslContext

An SslContext which uses JDK's SSL/TLS implementation.

Constructor Summary

Constructors

Constructor and Description
JdkSslContext(javax.net.ssl.SSLContext sslContext, boolean isClient, ClientAuth clientAuth) Creates a new JdkSslContext from a pre-configured SSLContext.
JdkSslContext(javax.net.ssl.SSLContext sslContext, boolean isClient, java.lang.Iterable<java.lang.String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, ClientAuth clientAuth) Creates a new JdkSslContext from a pre-configured SSLContext.

Method Summary

Modifier and Type	Method and Description
JdkApplicationProtocolNegotiator	applicationProtocolNegotiator() Returns the object responsible for negotiating application layer protocols for the TLS NPN/ALPN extensions.
protected static javax.net.ssl.KeyManagerFactory	buildKeyManagerFactory(java.io.File certChainFile, java.io.File keyFile, java.lang.String keyPassword, javax.net.ssl.KeyManagerFactory kmf) Deprecated. will be removed.
protected static javax.net.ssl.KeyManagerFactory	buildKeyManagerFactory(java.io.File certChainFile, java.lang.String keyAlgorithm, java.io.File keyFile, java.lang.String keyPassword, javax.net.ssl.KeyManagerFactory kmf) Deprecated. will be removed.
java.util.List<java.lang.String>	cipherSuites() Returns the list of enabled cipher suites, in the order of preference.
javax.net.ssl.SSLContext	context() Returns the JDK SSLContext object held by this context.
boolean	isClient() Returns the true if and only if this context is for client-side.
javax.net.ssl.SSLEngine	newEngine(ByteBufAllocator alloc) Creates a new SSLEngine.
javax.net.ssl.SSLEngine	newEngine(ByteBufAllocator alloc, java.lang.String peerHost, int peerPort) Creates a new SSLEngine using advisory peer information.
long	sessionCacheSize() Returns the size of the cache used for storing SSL session objects.
javax.net.ssl.SSLSessionContext	sessionContext() Returns the JDK SSLSessionContext object held by this context.
long	sessionTimeout() Returns the timeout for the cached SSL session objects, in seconds.

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

buildTrustManagerFactory, defaultClientProvider, defaultServerProvider, generateKeySpec, isServer, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newHandler, newHandler, newHandler, newHandler, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, nextProtocols

Methods inherited from class java.lang.Object

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

Constructor Detail

JdkSslContext

public JdkSslContext(javax.net.ssl.SSLContext sslContext,
                     boolean isClient,
                     ClientAuth clientAuth)

Creates a new JdkSslContext from a pre-configured SSLContext.

Parameters:

sslContext - the SSLContext to use.

isClient - true if this context should create SSLEngines for client-side usage.

clientAuth - the ClientAuth to use. This will only be used when is false.

JdkSslContext

public JdkSslContext(javax.net.ssl.SSLContext sslContext,
                     boolean isClient,
                     java.lang.Iterable<java.lang.String> ciphers,
                     CipherSuiteFilter cipherFilter,
                     ApplicationProtocolConfig apn,
                     ClientAuth clientAuth)

Creates a new JdkSslContext from a pre-configured SSLContext.

Parameters:

sslContext - the SSLContext to use.

isClient - true if this context should create SSLEngines for client-side usage.

ciphers - the ciphers to use or null if the standard should be used.

cipherFilter - the filter to use.

apn - the ApplicationProtocolConfig to use.

clientAuth - the ClientAuth to use. This will only be used when is false.

Method Detail

context

public final javax.net.ssl.SSLContext context()

Returns the JDK SSLContext object held by this context.

isClient

public final boolean isClient()

Description copied from class: SslContext

Returns the true if and only if this context is for client-side.

Specified by:

isClient in class SslContext

sessionContext

public final javax.net.ssl.SSLSessionContext sessionContext()

Returns the JDK SSLSessionContext object held by this context.

Specified by:

sessionContext in class SslContext

cipherSuites

public final java.util.List<java.lang.String> cipherSuites()

Description copied from class: SslContext

Returns the list of enabled cipher suites, in the order of preference.

Specified by:

cipherSuites in class SslContext

sessionCacheSize

public final long sessionCacheSize()

Description copied from class: SslContext

Returns the size of the cache used for storing SSL session objects.

Specified by:

sessionCacheSize in class SslContext

sessionTimeout

public final long sessionTimeout()

Description copied from class: SslContext

Returns the timeout for the cached SSL session objects, in seconds.

Specified by:

sessionTimeout in class SslContext

newEngine

public final javax.net.ssl.SSLEngine newEngine(ByteBufAllocator alloc)

Description copied from class: SslContext

Creates a new SSLEngine.

If SslProvider.OPENSSL_REFCNT is used then the object must be released. One way to do this is to wrap in a SslHandler and insert it into a pipeline. See SslContext.newHandler(ByteBufAllocator).

Specified by:

newEngine in class SslContext

Returns:

a new SSLEngine

newEngine

public final javax.net.ssl.SSLEngine newEngine(ByteBufAllocator alloc,
                                               java.lang.String peerHost,
                                               int peerPort)

Description copied from class: SslContext

Creates a new SSLEngine using advisory peer information.

If SslProvider.OPENSSL_REFCNT is used then the object must be released. One way to do this is to wrap in a SslHandler and insert it into a pipeline. See SslContext.newHandler(ByteBufAllocator, String, int).

Specified by:

newEngine in class SslContext

peerHost - the non-authoritative name of the host

peerPort - the non-authoritative port

Returns:

a new SSLEngine

applicationProtocolNegotiator

public final JdkApplicationProtocolNegotiator applicationProtocolNegotiator()

Description copied from class: SslContext

Returns the object responsible for negotiating application layer protocols for the TLS NPN/ALPN extensions.

Specified by:

applicationProtocolNegotiator in class SslContext

buildKeyManagerFactory

@Deprecated
protected static javax.net.ssl.KeyManagerFactory buildKeyManagerFactory(java.io.File certChainFile,
                                                                                    java.io.File keyFile,
                                                                                    java.lang.String keyPassword,
                                                                                    javax.net.ssl.KeyManagerFactory kmf)
                                                                             throws java.security.UnrecoverableKeyException,
                                                                                    java.security.KeyStoreException,
                                                                                    java.security.NoSuchAlgorithmException,
                                                                                    javax.crypto.NoSuchPaddingException,
                                                                                    java.security.spec.InvalidKeySpecException,
                                                                                    java.security.InvalidAlgorithmParameterException,
                                                                                    java.security.cert.CertificateException,
                                                                                    java.security.KeyException,
                                                                                    java.io.IOException

Deprecated. will be removed.

Build a KeyManagerFactory based upon a key file, key file password, and a certificate chain.

Parameters:

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

keyFile - a PKCS#8 private key file in PEM format

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

kmf - The existing KeyManagerFactory that will be used if not null

Returns:

A KeyManagerFactory based upon a key file, key file password, and a certificate chain.

Throws:

java.security.UnrecoverableKeyException

java.security.KeyStoreException

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

java.security.spec.InvalidKeySpecException

java.security.InvalidAlgorithmParameterException

java.security.cert.CertificateException

java.security.KeyException

java.io.IOException

buildKeyManagerFactory

@Deprecated
protected static javax.net.ssl.KeyManagerFactory buildKeyManagerFactory(java.io.File certChainFile,
                                                                                    java.lang.String keyAlgorithm,
                                                                                    java.io.File keyFile,
                                                                                    java.lang.String keyPassword,
                                                                                    javax.net.ssl.KeyManagerFactory kmf)
                                                                             throws java.security.KeyStoreException,
                                                                                    java.security.NoSuchAlgorithmException,
                                                                                    javax.crypto.NoSuchPaddingException,
                                                                                    java.security.spec.InvalidKeySpecException,
                                                                                    java.security.InvalidAlgorithmParameterException,
                                                                                    java.io.IOException,
                                                                                    java.security.cert.CertificateException,
                                                                                    java.security.KeyException,
                                                                                    java.security.UnrecoverableKeyException

Deprecated. will be removed.

Build a KeyManagerFactory based upon a key algorithm, key file, key file password, and a certificate chain.

Parameters:

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

keyAlgorithm - the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.

keyFile - a PKCS#8 private key file in PEM format

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

kmf - The existing KeyManagerFactory that will be used if not null

Returns:

A KeyManagerFactory based upon a key algorithm, key file, key file password, and a certificate chain.

Throws:

java.security.KeyStoreException

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

java.security.spec.InvalidKeySpecException

java.security.InvalidAlgorithmParameterException

java.io.IOException

java.security.cert.CertificateException

java.security.KeyException

java.security.UnrecoverableKeyException