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 SSLEngineFactory	createClientSSLEngineFactory(org.apache.flink.configuration.Configuration config) Creates a SSLEngineFactory to be used by the Client.
static SSLEngineFactory	createServerSSLEngineFactory(org.apache.flink.configuration.Configuration config) Creates a SSLEngineFactory to be used by the Server.
static SSLContext	createSSLClientContext(org.apache.flink.configuration.Configuration sslConfig) Creates the SSL Context for the client if SSL is configured.
static SSLContext	createSSLServerContext(org.apache.flink.configuration.Configuration sslConfig) Creates the SSL Context for the server if SSL is configured.
static boolean	getSSLEnabled(org.apache.flink.configuration.Configuration sslConfig) Retrieves the global ssl flag from configuration.
static void	setSSLVerAndCipherSuites(ServerSocket socket, org.apache.flink.configuration.Configuration config) Sets SSl version and cipher suites for SSLServerSocket.
static void	setSSLVerAndCipherSuites(SSLEngine engine, org.apache.flink.configuration.Configuration config) Deprecated. Use createClientSSLEngineFactory(Configuration) or createServerSSLEngineFactory(Configuration).
static void	setSSLVerifyHostname(org.apache.flink.configuration.Configuration sslConfig, SSLParameters sslParams) Sets SSL options to verify peer's hostname in the certificate.

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

getSSLEnabled

public static boolean getSSLEnabled(org.apache.flink.configuration.Configuration sslConfig)

Retrieves the global ssl flag from configuration.

Parameters:

sslConfig - The application configuration

Returns:

true if global ssl flag is set

setSSLVerAndCipherSuites

public static void setSSLVerAndCipherSuites(ServerSocket socket,
                                            org.apache.flink.configuration.Configuration config)

Sets SSl version and cipher suites for SSLServerSocket.

Parameters:

socket - Socket to be handled

config - The application configuration

createServerSSLEngineFactory

public static SSLEngineFactory createServerSSLEngineFactory(org.apache.flink.configuration.Configuration config)
                                                     throws Exception

Creates a SSLEngineFactory to be used by the Server.

Parameters:

config - The application configuration.

Throws:

Exception

createClientSSLEngineFactory

public static SSLEngineFactory createClientSSLEngineFactory(org.apache.flink.configuration.Configuration config)
                                                     throws Exception

Creates a SSLEngineFactory to be used by the Client.

Parameters:

config - The application configuration.

Throws:

Exception

setSSLVerAndCipherSuites

@Deprecated
public static void setSSLVerAndCipherSuites(SSLEngine engine,
                                                        org.apache.flink.configuration.Configuration config)

Deprecated. Use createClientSSLEngineFactory(Configuration) or createServerSSLEngineFactory(Configuration).

Sets SSL version and cipher suites for SSLEngine.

Parameters:

engine - SSLEngine to be handled

config - The application configuration

setSSLVerifyHostname

public static void setSSLVerifyHostname(org.apache.flink.configuration.Configuration sslConfig,
                                        SSLParameters sslParams)

Sets SSL options to verify peer's hostname in the certificate.

Parameters:

sslConfig - The application configuration

sslParams - The SSL parameters that need to be updated

createSSLClientContext

@Nullable
public static SSLContext createSSLClientContext(org.apache.flink.configuration.Configuration sslConfig)
                                                   throws Exception

Creates the SSL Context for the client if SSL is configured.

Parameters:

sslConfig - The application configuration

Returns:

The SSLContext object which can be used by the ssl transport client Returns null if SSL is disabled

Throws:

Exception - Thrown if there is any misconfiguration

createSSLServerContext

@Nullable
public static SSLContext createSSLServerContext(org.apache.flink.configuration.Configuration sslConfig)
                                                   throws Exception

Creates the SSL Context for the server if SSL is configured.

Parameters:

sslConfig - The application configuration

Returns:

The SSLContext object which can be used by the ssl transport server Returns null if SSL is disabled

Throws:

Exception - Thrown if there is any misconfiguration