org.apache.tez.http

Class SSLFactory

java.lang.Object

org.apache.tez.http.SSLFactory

All Implemented Interfaces:

org.apache.hadoop.security.authentication.client.ConnectionConfigurator

@InterfaceAudience.Private
@InterfaceStability.Evolving
public class SSLFactory
extends Object
implements org.apache.hadoop.security.authentication.client.ConnectionConfigurator

Factory that creates SSLEngine and SSLSocketFactory instances using Hadoop configuration information.

This SSLFactory uses a ReloadingX509TrustManager instance, which reloads public keys if the truststore file changes.

This factory is used to configure HTTPS in Hadoop HTTP based endpoints, both client and server.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SSL_ENABLED_PROTOCOLS
static String	SSL_ENABLED_PROTOCOLS

Constructor Summary

Constructors

Constructor and Description
SSLFactory(org.apache.hadoop.security.ssl.SSLFactory.Mode mode, org.apache.hadoop.conf.Configuration conf) Creates an SSLFactory.

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(com.ning.http.client.AsyncHttpClientConfig.Builder asyncNingBuilder) Set ssl context for AsyncHttpClientConfig.Builder
HttpURLConnection	configure(HttpURLConnection conn) If the given HttpURLConnection is an HttpsURLConnection configures the connection with the SSLSocketFactory and HostnameVerifier of this SSLFactory, otherwise does nothing.
SSLSocketFactory	createSSLSocketFactory() Returns a configured SSLSocketFactory.
void	destroy() Releases any resources being used.
HostnameVerifier	getHostnameVerifier() Returns the hostname verifier it should be used in HttpsURLConnections.
static HostnameVerifier	getHostnameVerifier(String verifier)
org.apache.hadoop.security.ssl.KeyStoresFactory	getKeystoresFactory() Returns the SSLFactory KeyStoresFactory instance.
void	init() Initializes the factory.

Methods inherited from class java.lang.Object

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

Field Detail

SSL_ENABLED_PROTOCOLS

public static final String SSL_ENABLED_PROTOCOLS

See Also:

Constant Field Values

DEFAULT_SSL_ENABLED_PROTOCOLS

public static final String DEFAULT_SSL_ENABLED_PROTOCOLS

See Also:

Constant Field Values

Constructor Detail

SSLFactory

public SSLFactory(org.apache.hadoop.security.ssl.SSLFactory.Mode mode,
          org.apache.hadoop.conf.Configuration conf)

Creates an SSLFactory.

Parameters:

mode - SSLFactory mode, client or server.

conf - Hadoop configuration from where the SSLFactory configuration will be read.

Method Detail

init

public void init()
          throws GeneralSecurityException,
                 IOException

Initializes the factory.

Throws:

GeneralSecurityException - thrown if an SSL initialization error happened.

IOException - thrown if an IO error happened while reading the SSL configuration.

getHostnameVerifier

public static HostnameVerifier getHostnameVerifier(String verifier)
                                            throws GeneralSecurityException,
                                                   IOException

Throws:

GeneralSecurityException

IOException

destroy

public void destroy()

Releases any resources being used.

getKeystoresFactory

public org.apache.hadoop.security.ssl.KeyStoresFactory getKeystoresFactory()

Returns the SSLFactory KeyStoresFactory instance.

Returns:

the SSLFactory KeyStoresFactory instance.

createSSLSocketFactory

public SSLSocketFactory createSSLSocketFactory()
                                        throws GeneralSecurityException,
                                               IOException

Returns a configured SSLSocketFactory.

Returns:

the configured SSLSocketFactory.

Throws:

GeneralSecurityException - thrown if the SSLSocketFactory could not be initialized.

IOException - thrown if and IO error occurred while loading the server keystore.

getHostnameVerifier

public HostnameVerifier getHostnameVerifier()

Returns the hostname verifier it should be used in HttpsURLConnections.

Returns:

the hostname verifier.

configure

public HttpURLConnection configure(HttpURLConnection conn)
                            throws IOException

If the given HttpURLConnection is an HttpsURLConnection configures the connection with the SSLSocketFactory and HostnameVerifier of this SSLFactory, otherwise does nothing.

Specified by:

configure in interface org.apache.hadoop.security.authentication.client.ConnectionConfigurator

Parameters:

conn - the HttpURLConnection instance to configure.

Returns:

the configured HttpURLConnection instance.

Throws:

IOException - if an IO error occurred.

configure

public void configure(com.ning.http.client.AsyncHttpClientConfig.Builder asyncNingBuilder)
               throws IOException

Set ssl context for AsyncHttpClientConfig.Builder

Parameters:

asyncNingBuilder - AsyncHttpClientConfig.Builder instance to configure.

Throws:

IOException - if an IO error occurred.