SslContext (Netty API Reference (4.1.116.Final))

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

Direct Known Subclasses:: DelegatingSslContext, JdkSslContext, ReferenceCountedOpenSslContext

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 (startTls set to false).

protected SslContext(boolean startTls)
Creates a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`SslContext()` Creates a new instance (startTls set to `false`).
`protected`	`SslContext(boolean startTls)` Creates a new instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated 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.
`AttributeMap`	`attributes()` Returns the `AttributeMap` that belongs to this `SslContext` .
`protected static KeyManagerFactory`	`buildKeyManagerFactory(X509Certificate[] certChainFile, String keyAlgorithm, PrivateKey key, String keyPassword, KeyManagerFactory kmf, String keyStore)`
`protected static KeyStore`	`buildKeyStore(X509Certificate[] certChain, PrivateKey key, char[] keyPasswordChars, String keyStoreType)` Generates a new `KeyStore`.
`protected static TrustManagerFactory`	`buildTrustManagerFactory(File certChainFile, TrustManagerFactory trustManagerFactory)` Deprecated.
`protected static TrustManagerFactory`	`buildTrustManagerFactory(File certChainFile, TrustManagerFactory trustManagerFactory, String keyType)` Build a `TrustManagerFactory` from a certificate chain file.
`protected static TrustManagerFactory`	`buildTrustManagerFactory(X509Certificate[] certCollection, TrustManagerFactory trustManagerFactory, String keyStoreType)`
`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)` Deprecated.
`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)` Create a new SslHandler.
`protected SslHandler`	`newHandler(ByteBufAllocator alloc, boolean startTls)` Create a new SslHandler.
`protected SslHandler`	`newHandler(ByteBufAllocator alloc, boolean startTls, Executor executor)` Create a new SslHandler.
`SslHandler`	`newHandler(ByteBufAllocator alloc, Executor delegatedTaskExecutor)` Creates a new `SslHandler`.
`SslHandler`	`newHandler(ByteBufAllocator alloc, String peerHost, int peerPort)` Creates a new `SslHandler`
`protected SslHandler`	`newHandler(ByteBufAllocator alloc, String peerHost, int peerPort, boolean startTls)` Create a new SslHandler.
`protected SslHandler`	`newHandler(ByteBufAllocator alloc, String peerHost, int peerPort, boolean startTls, Executor delegatedTaskExecutor)`
`SslHandler`	`newHandler(ByteBufAllocator alloc, String peerHost, int peerPort, Executor delegatedTaskExecutor)` 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.
`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.
`long`	`sessionTimeout()` Returns the timeout for the cached SSL session objects, in seconds.
`protected static PrivateKey`	`toPrivateKey(File keyFile, String keyPassword)`
`protected static PrivateKey`	`toPrivateKey(InputStream keyInputStream, String keyPassword)`
`protected static X509Certificate[]`	`toX509Certificates(File file)`
`protected static X509Certificate[]`	`toX509Certificates(InputStream in)`

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 (startTls set to false).
- SslContext
```
protected SslContext(boolean startTls)
```
  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.