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 abstract class JdkSslContext
extends SslContext

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

Method Summary

Methods

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 KeyManagerFactory	buildKeyManagerFactory(File certChainFile, File keyFile, String keyPassword, KeyManagerFactory kmf) Build a KeyManagerFactory based upon a key file, key file password, and a certificate chain.
protected static KeyManagerFactory	buildKeyManagerFactory(File certChainFile, String keyAlgorithm, File keyFile, String keyPassword, KeyManagerFactory kmf) Build a KeyManagerFactory based upon a key algorithm, key file, key file password, and a certificate chain.
protected static TrustManagerFactory	buildTrustManagerFactory(File certChainFile, TrustManagerFactory trustManagerFactory) Build a TrustManagerFactory from a certificate chain file.
List<String>	cipherSuites() Returns the list of enabled cipher suites, in the order of preference.
abstract SSLContext	context() Returns the JDK SSLContext object held by this context.
SSLEngine	newEngine(ByteBufAllocator alloc) Creates a new SSLEngine.
SSLEngine	newEngine(ByteBufAllocator alloc, 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.
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

defaultClientProvider, defaultServerProvider, generateKeySpec, isClient, isServer, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newHandler, newHandler, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext

Methods inherited from class java.lang.Object

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

Method Detail

context

public abstract SSLContext context()

Returns the JDK SSLContext object held by this context.

sessionContext

public final SSLSessionContext sessionContext()

Returns the JDK SSLSessionContext object held by this context.

Specified by:

sessionContext in class SslContext

cipherSuites

public final List<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 SSLEngine newEngine(ByteBufAllocator alloc)

Description copied from class: SslContext

Creates a new SSLEngine.

Specified by:

newEngine in class SslContext

Returns:

a new SSLEngine

newEngine

public final SSLEngine newEngine(ByteBufAllocator alloc,
                  String peerHost,
                  int peerPort)

Description copied from class: SslContext

Creates a new SSLEngine using advisory peer information.

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 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

protected static KeyManagerFactory buildKeyManagerFactory(File certChainFile,
                                       File keyFile,
                                       String keyPassword,
                                       KeyManagerFactory kmf)
                                                   throws UnrecoverableKeyException,
                                                          KeyStoreException,
                                                          NoSuchAlgorithmException,
                                                          NoSuchPaddingException,
                                                          InvalidKeySpecException,
                                                          InvalidAlgorithmParameterException,
                                                          CertificateException,
                                                          KeyException,
                                                          IOException

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:

UnrecoverableKeyException

KeyStoreException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeySpecException

InvalidAlgorithmParameterException

CertificateException

KeyException

IOException

buildKeyManagerFactory

protected static KeyManagerFactory buildKeyManagerFactory(File certChainFile,
                                       String keyAlgorithm,
                                       File keyFile,
                                       String keyPassword,
                                       KeyManagerFactory kmf)
                                                   throws KeyStoreException,
                                                          NoSuchAlgorithmException,
                                                          NoSuchPaddingException,
                                                          InvalidKeySpecException,
                                                          InvalidAlgorithmParameterException,
                                                          IOException,
                                                          CertificateException,
                                                          KeyException,
                                                          UnrecoverableKeyException

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:

KeyStoreException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeySpecException

InvalidAlgorithmParameterException

IOException

CertificateException

KeyException

UnrecoverableKeyException

buildTrustManagerFactory

protected static TrustManagerFactory buildTrustManagerFactory(File certChainFile,
                                           TrustManagerFactory trustManagerFactory)
                                                       throws NoSuchAlgorithmException,
                                                              CertificateException,
                                                              KeyStoreException,
                                                              IOException

Build a TrustManagerFactory from a certificate chain file.

Parameters:

certChainFile - The certificate file to build from.

trustManagerFactory - The existing TrustManagerFactory that will be used if not null.

Returns:

A TrustManagerFactory which contains the certificates in certChainFile

Throws:

NoSuchAlgorithmException

CertificateException

KeyStoreException

IOException