SslContext (Netty API Reference (4.1.0.CR7))

java.lang.Object
- io.netty.handler.ssl.SslContext

Direct Known Subclasses:: JdkSslContext, OpenSslContext

public abstract class SslContext
extends Object

A secure socket protocol implementation which acts as a factory for SSLEngine and SslHandler. Internally, it is implemented via JDK's SSLContext or OpenSSL's SSL_CTX.

Making your server support SSL/TLS

 // In your ChannelInitializer:
 ChannelPipeline p = channel.pipeline();
 SslContext sslCtx = SslContextBuilder.forServer(...).build();
 p.addLast("ssl", sslCtx.newHandler(channel.alloc()));
 ...

Making your client support SSL/TLS

 // In your ChannelInitializer:
 ChannelPipeline p = channel.pipeline();
 SslContext sslCtx = SslContextBuilder.forClient().build();
 p.addLast("ssl", sslCtx.newHandler(channel.alloc(), host, port));
 ...

Constructor Summary

Constructors
Modifier Constructor and Description

protected SslContext()
Creates a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`SslContext()` Creates a new instance.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract ApplicationProtocolNegotiator`	`applicationProtocolNegotiator()` Returns the object responsible for negotiating application layer protocols for the TLS NPN/ALPN extensions.
`protected static TrustManagerFactory`	`buildTrustManagerFactory(File certChainFile, TrustManagerFactory trustManagerFactory)` Deprecated.
`abstract List<String>`	`cipherSuites()` Returns the list of enabled cipher suites, in the order of preference.
`static SslProvider`	`defaultClientProvider()` Returns the default client-side implementation provider currently in use.
`static SslProvider`	`defaultServerProvider()` Returns the default server-side implementation provider currently in use.
`protected static PKCS8EncodedKeySpec`	`generateKeySpec(char[] password, byte[] key)` Generates a key specification for an (encrypted) private key.
`abstract boolean`	`isClient()` Returns the `true` if and only if this context is for client-side.
`boolean`	`isServer()` Returns `true` if and only if this context is for server-side.
`static SslContext`	`newClientContext()` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(File certChainFile)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(File certChainFile, TrustManagerFactory trustManagerFactory)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(SslProvider provider)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(SslProvider provider, File certChainFile)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(SslProvider provider, File certChainFile, TrustManagerFactory trustManagerFactory)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(SslProvider provider, File trustCertCollectionFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(SslProvider provider, File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(SslProvider provider, File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(SslProvider provider, TrustManagerFactory trustManagerFactory)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newClientContext(TrustManagerFactory trustManagerFactory)` Deprecated. Replaced by `SslContextBuilder`
`abstract SSLEngine`	`newEngine(ByteBufAllocator alloc)` Creates a new `SSLEngine`.
`abstract SSLEngine`	`newEngine(ByteBufAllocator alloc, String peerHost, int peerPort)` Creates a new `SSLEngine` using advisory peer information.
`SslHandler`	`newHandler(ByteBufAllocator alloc)` Creates a new `SslHandler`.
`SslHandler`	`newHandler(ByteBufAllocator alloc, String peerHost, int peerPort)` Creates a new `SslHandler` with advisory peer information.
`static SslContext`	`newServerContext(File certChainFile, File keyFile)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newServerContext(File certChainFile, File keyFile, String keyPassword)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newServerContext(File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newServerContext(File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newServerContext(SslProvider provider, File certChainFile, File keyFile)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newServerContext(SslProvider provider, File certChainFile, File keyFile, String keyPassword)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newServerContext(SslProvider provider, File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newServerContext(SslProvider provider, File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newServerContext(SslProvider provider, File certChainFile, File keyFile, String keyPassword, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`static SslContext`	`newServerContext(SslProvider provider, File trustCertCollectionFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)` Deprecated. Replaced by `SslContextBuilder`
`List<String>`	`nextProtocols()` Deprecated. Use `applicationProtocolNegotiator()` instead.
`abstract long`	`sessionCacheSize()` Returns the size of the cache used for storing SSL session objects.
`abstract SSLSessionContext`	`sessionContext()` Returns the `SSLSessionContext` object held by this context.
`abstract long`	`sessionTimeout()` Returns the timeout for the cached SSL session objects, in seconds.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SslContext
```
protected SslContext()
```
    Creates a new instance.
- Method Detail
  - defaultServerProvider
```
public static SslProvider defaultServerProvider()
```
    Returns the default server-side implementation provider currently in use.
    
    Returns:
    SslProvider.OPENSSL if OpenSSL is available. SslProvider.JDK otherwise.
  - defaultClientProvider
```
public static SslProvider defaultClientProvider()
```
    Returns the default client-side implementation provider currently in use.
    
    Returns:
    SslProvider.OPENSSL if OpenSSL is available. SslProvider.JDK otherwise.
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(File certChainFile,
                                     File keyFile)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    certChainFile - an X.509 certificate chain file in PEM format
    keyFile - a PKCS#8 private key file in PEM format
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(File certChainFile,
                                     File keyFile,
                                     String keyPassword)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    certChainFile - an 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.
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(File certChainFile,
                                     File keyFile,
                                     String keyPassword,
                                     Iterable<String> ciphers,
                                     Iterable<String> nextProtocols,
                                     long sessionCacheSize,
                                     long sessionTimeout)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    certChainFile - an 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.
    ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.
    nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.
    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.
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(File certChainFile,
                                     File keyFile,
                                     String keyPassword,
                                     Iterable<String> ciphers,
                                     CipherSuiteFilter cipherFilter,
                                     ApplicationProtocolConfig apn,
                                     long sessionCacheSize,
                                     long sessionTimeout)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    certChainFile - an 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.
    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.
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(SslProvider provider,
                                     File certChainFile,
                                     File keyFile)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - an X.509 certificate chain file in PEM format
    keyFile - a PKCS#8 private key file in PEM format
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(SslProvider provider,
                                     File certChainFile,
                                     File keyFile,
                                     String keyPassword)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - an 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.
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(SslProvider provider,
                                     File certChainFile,
                                     File keyFile,
                                     String keyPassword,
                                     Iterable<String> ciphers,
                                     Iterable<String> nextProtocols,
                                     long sessionCacheSize,
                                     long sessionTimeout)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - an 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.
    ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.
    nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.
    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.
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(SslProvider provider,
                                     File certChainFile,
                                     File keyFile,
                                     String keyPassword,
                                     TrustManagerFactory trustManagerFactory,
                                     Iterable<String> ciphers,
                                     Iterable<String> nextProtocols,
                                     long sessionCacheSize,
                                     long sessionTimeout)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - an 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.
    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.
    nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.
    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.
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(SslProvider provider,
                                     File certChainFile,
                                     File keyFile,
                                     String keyPassword,
                                     Iterable<String> ciphers,
                                     CipherSuiteFilter cipherFilter,
                                     ApplicationProtocolConfig apn,
                                     long sessionCacheSize,
                                     long sessionTimeout)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - an 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.
    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 Only required if provider is SslProvider.JDK
    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.
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newServerContext
```
@Deprecated
public static SslContext newServerContext(SslProvider provider,
                                     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. Replaced by SslContextBuilder
    
    Creates a new server-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    trustCertCollectionFile - an X.509 certificate collection file in PEM format. This provides the certificate collection used for mutual authentication. null to use the system default
    trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from clients. null to use the default or the results of parsing trustCertCollectionFile. This parameter is ignored if provider is not SslProvider.JDK.
    keyCertChainFile - an 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.
    keyManagerFactory - the KeyManagerFactory that provides the KeyManagers that is used to encrypt data being sent to clients. null to use the default or the results of parsing keyCertChainFile and keyFile. This parameter is ignored if provider is not SslProvider.JDK.
    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 Only required if provider is SslProvider.JDK
    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.
    
    Returns:
    a new server-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext()
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(File certChainFile)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Parameters:
    certChainFile - an X.509 certificate chain file in PEM format
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(TrustManagerFactory trustManagerFactory)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Parameters:
    trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(File certChainFile,
                                     TrustManagerFactory trustManagerFactory)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    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.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(File certChainFile,
                                     TrustManagerFactory trustManagerFactory,
                                     Iterable<String> ciphers,
                                     Iterable<String> nextProtocols,
                                     long sessionCacheSize,
                                     long sessionTimeout)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    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.
    ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.
    nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.
    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.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(File certChainFile,
                                     TrustManagerFactory trustManagerFactory,
                                     Iterable<String> ciphers,
                                     CipherSuiteFilter cipherFilter,
                                     ApplicationProtocolConfig apn,
                                     long sessionCacheSize,
                                     long sessionTimeout)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    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.
    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.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(SslProvider provider)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(SslProvider provider,
                                     File certChainFile)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - an X.509 certificate chain file in PEM format. null to use the system default
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(SslProvider provider,
                                     TrustManagerFactory trustManagerFactory)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(SslProvider provider,
                                     File certChainFile,
                                     TrustManagerFactory trustManagerFactory)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    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.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(SslProvider provider,
                                     File certChainFile,
                                     TrustManagerFactory trustManagerFactory,
                                     Iterable<String> ciphers,
                                     Iterable<String> nextProtocols,
                                     long sessionCacheSize,
                                     long sessionTimeout)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    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.
    ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.
    nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.
    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.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(SslProvider provider,
                                     File certChainFile,
                                     TrustManagerFactory trustManagerFactory,
                                     Iterable<String> ciphers,
                                     CipherSuiteFilter cipherFilter,
                                     ApplicationProtocolConfig apn,
                                     long sessionCacheSize,
                                     long sessionTimeout)
                                   throws SSLException
```
    Deprecated. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    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.
    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.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - newClientContext
```
@Deprecated
public static SslContext newClientContext(SslProvider provider,
                                     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. Replaced by SslContextBuilder
    
    Creates a new client-side SslContext.
    
    Parameters:
    provider - the SslContext implementation to use. null to use the current default one.
    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. This parameter is ignored if provider is not SslProvider.JDK.
    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. This parameter is ignored if provider is not SslProvider.JDK.
    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.
    
    Returns:
    a new client-side SslContext
    
    Throws:
    
    SSLException
  - isServer
```
public final boolean isServer()
```
    Returns true if and only if this context is for server-side.
  - isClient
```
public abstract boolean isClient()
```
    Returns the true if and only if this context is for client-side.
  - cipherSuites
```
public abstract List<String> cipherSuites()
```
    Returns the list of enabled cipher suites, in the order of preference.
  - sessionCacheSize
```
public abstract long sessionCacheSize()
```
    Returns the size of the cache used for storing SSL session objects.
  - sessionTimeout
```
public abstract long sessionTimeout()
```
    Returns the timeout for the cached SSL session objects, in seconds.
  - nextProtocols
```
@Deprecated
public final List<String> nextProtocols()
```
    Deprecated. Use applicationProtocolNegotiator() instead.
  - applicationProtocolNegotiator
```
public abstract ApplicationProtocolNegotiator applicationProtocolNegotiator()
```
    Returns the object responsible for negotiating application layer protocols for the TLS NPN/ALPN extensions.
  - newEngine
```
public abstract SSLEngine newEngine(ByteBufAllocator alloc)
```
    Creates a new SSLEngine.
    
    Returns:
    a new SSLEngine
  - newEngine
```
public abstract SSLEngine newEngine(ByteBufAllocator alloc,
                  String peerHost,
                  int peerPort)
```
    Creates a new SSLEngine using advisory peer information.
    
    Parameters:
    peerHost - the non-authoritative name of the host
    peerPort - the non-authoritative port
    
    Returns:
    a new SSLEngine
  - sessionContext
```
public abstract SSLSessionContext sessionContext()
```
    Returns the SSLSessionContext object held by this context.
  - newHandler
```
public final SslHandler newHandler(ByteBufAllocator alloc)
```
    Creates a new SslHandler.
    
    Returns:
    a new SslHandler
  - newHandler
```
public final SslHandler newHandler(ByteBufAllocator alloc,
                    String peerHost,
                    int peerPort)
```
    Creates a new SslHandler with advisory peer information.
    
    Parameters:
    peerHost - the non-authoritative name of the host
    peerPort - the non-authoritative port
    
    Returns:
    a new SslHandler
  - generateKeySpec
```
protected static PKCS8EncodedKeySpec generateKeySpec(char[] password,
                                  byte[] key)
                                              throws IOException,
                                                     NoSuchAlgorithmException,
                                                     NoSuchPaddingException,
                                                     InvalidKeySpecException,
                                                     InvalidKeyException,
                                                     InvalidAlgorithmParameterException
```
    Generates a key specification for an (encrypted) private key.
    
    Parameters:
    password - characters, if null an unencrypted key is assumed
    key - bytes of the DER encoded private key
    
    Returns:
    a key specification
    
    Throws:
    
    IOException - if parsing key fails
    
    NoSuchAlgorithmException - if the algorithm used to encrypt key is unkown
    
    NoSuchPaddingException - if the padding scheme specified in the decryption algorithm is unkown
    
    InvalidKeySpecException - if the decryption key based on password cannot be generated
    
    InvalidKeyException - if the decryption key based on password cannot be used to decrypt key
    
    InvalidAlgorithmParameterException - if decryption algorithm parameters are somehow faulty
  - buildTrustManagerFactory
```
@Deprecated
protected static TrustManagerFactory buildTrustManagerFactory(File certChainFile,
                                                      TrustManagerFactory trustManagerFactory)
                                                       throws NoSuchAlgorithmException,
                                                              CertificateException,
                                                              KeyStoreException,
                                                              IOException
```
    Deprecated.
    
    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

Class SslContext

Making your server support SSL/TLS

Making your client support SSL/TLS

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SslContext

Method Detail

defaultServerProvider

defaultClientProvider

newServerContext

newServerContext

newServerContext

newServerContext

newServerContext

newServerContext

newServerContext

newServerContext

newServerContext

newServerContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

isServer

isClient

cipherSuites

sessionCacheSize

sessionTimeout

nextProtocols

applicationProtocolNegotiator

newEngine

newEngine

sessionContext

newHandler

newHandler

generateKeySpec

buildTrustManagerFactory