org.apache.flink.runtime.net

Class SSLUtils

java.lang.Object

org.apache.flink.runtime.net.SSLUtils

public class SSLUtils
extends Object

Common utilities to manage SSL transport settings.

Constructor Summary

Constructors

Constructor and Description
SSLUtils()

Method Summary

Modifier and Type	Method and Description
static SSLHandlerFactory	createInternalClientSSLEngineFactory(Configuration config) Creates a SSLEngineFactory to be used by internal communication client endpoints.
static SSLHandlerFactory	createInternalServerSSLEngineFactory(Configuration config) Creates a SSLEngineFactory to be used by internal communication server endpoints.
static SSLHandlerFactory	createRestClientSSLEngineFactory(Configuration config) Creates a SSLHandlerFactory to be used by the REST Clients.
static org.apache.flink.shaded.netty4.io.netty.handler.ssl.SslContext	createRestNettySSLContext(Configuration config, boolean clientMode, org.apache.flink.shaded.netty4.io.netty.handler.ssl.ClientAuth clientAuth, org.apache.flink.shaded.netty4.io.netty.handler.ssl.SslProvider provider) Creates an SSL context for the external REST SSL.
static SSLHandlerFactory	createRestServerSSLEngineFactory(Configuration config) Creates a SSLHandlerFactory to be used by the REST Servers.
static SSLContext	createRestSSLContext(Configuration config, boolean clientMode) Creates an SSL context for clients against the external REST endpoint.
static SocketFactory	createSSLClientSocketFactory(Configuration config) Creates a factory for SSL Client Sockets from the given configuration.
static ServerSocketFactory	createSSLServerSocketFactory(Configuration config) Creates a factory for SSL Server Sockets from the given configuration.
static boolean	isInternalSSLEnabled(Configuration sslConfig) Checks whether SSL for internal communication (rpc, data transport, blob server) is enabled.
static boolean	isRestSSLAuthenticationEnabled(Configuration sslConfig) Checks whether mutual SSL authentication for the external REST endpoint is enabled.
static boolean	isRestSSLEnabled(Configuration sslConfig) Checks whether SSL for the external REST endpoint is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSLUtils

public SSLUtils()

Method Detail

isInternalSSLEnabled

public static boolean isInternalSSLEnabled(Configuration sslConfig)

Checks whether SSL for internal communication (rpc, data transport, blob server) is enabled.

isRestSSLEnabled

public static boolean isRestSSLEnabled(Configuration sslConfig)

Checks whether SSL for the external REST endpoint is enabled.

isRestSSLAuthenticationEnabled

public static boolean isRestSSLAuthenticationEnabled(Configuration sslConfig)

Checks whether mutual SSL authentication for the external REST endpoint is enabled.

createSSLServerSocketFactory

public static ServerSocketFactory createSSLServerSocketFactory(Configuration config)
                                                        throws Exception

Creates a factory for SSL Server Sockets from the given configuration. SSL Server Sockets are always part of internal communication.

Throws:

Exception

createSSLClientSocketFactory

public static SocketFactory createSSLClientSocketFactory(Configuration config)
                                                  throws Exception

Creates a factory for SSL Client Sockets from the given configuration. SSL Client Sockets are always part of internal communication.

Throws:

Exception

createInternalServerSSLEngineFactory

public static SSLHandlerFactory createInternalServerSSLEngineFactory(Configuration config)
                                                              throws Exception

Creates a SSLEngineFactory to be used by internal communication server endpoints.

Throws:

Exception

createInternalClientSSLEngineFactory

public static SSLHandlerFactory createInternalClientSSLEngineFactory(Configuration config)
                                                              throws Exception

Creates a SSLEngineFactory to be used by internal communication client endpoints.

Throws:

Exception

createRestServerSSLEngineFactory

public static SSLHandlerFactory createRestServerSSLEngineFactory(Configuration config)
                                                          throws Exception

Creates a SSLHandlerFactory to be used by the REST Servers.

Parameters:

config - The application configuration.

Throws:

Exception

createRestClientSSLEngineFactory

public static SSLHandlerFactory createRestClientSSLEngineFactory(Configuration config)
                                                          throws Exception

Creates a SSLHandlerFactory to be used by the REST Clients.

Parameters:

config - The application configuration.

Throws:

Exception

createRestSSLContext

@Nullable
 @VisibleForTesting
public static SSLContext createRestSSLContext(Configuration config,
                                                                            boolean clientMode)
                                                                     throws Exception

Creates an SSL context for clients against the external REST endpoint.

Throws:

Exception

createRestNettySSLContext

@Nullable
public static org.apache.flink.shaded.netty4.io.netty.handler.ssl.SslContext createRestNettySSLContext(Configuration config,
                                                                                                                 boolean clientMode,
                                                                                                                 org.apache.flink.shaded.netty4.io.netty.handler.ssl.ClientAuth clientAuth,
                                                                                                                 org.apache.flink.shaded.netty4.io.netty.handler.ssl.SslProvider provider)
                                                                                                          throws Exception

Creates an SSL context for the external REST SSL. If mutual authentication is configured the client and the server side configuration are identical.

Throws:

Exception