org.apache.hadoop.hbase.http.ssl

Class KeyStoreTestUtil

java.lang.Object

org.apache.hadoop.hbase.http.ssl.KeyStoreTestUtil

public class KeyStoreTestUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
KeyStoreTestUtil()

Method Summary

Modifier and Type	Method and Description
static void	cleanupSSLConfig(java.lang.String keystoresDir, java.lang.String sslConfDir)
static Configuration	createClientSSLConfig(java.lang.String clientKS, java.lang.String password, java.lang.String keyPassword, java.lang.String trustKS) Creates SSL configuration for a client.
static void	createKeyStore(java.lang.String filename, java.lang.String password, java.lang.String alias, java.security.Key privateKey, java.security.cert.Certificate cert)
static void	createKeyStore(java.lang.String filename, java.lang.String password, java.lang.String keyPassword, java.lang.String alias, java.security.Key privateKey, java.security.cert.Certificate cert) Creates a keystore with a single key and saves it to a file.
static Configuration	createServerSSLConfig(java.lang.String serverKS, java.lang.String password, java.lang.String keyPassword, java.lang.String trustKS) Creates SSL configuration for a server.
static <T extends java.security.cert.Certificate> void	createTrustStore(java.lang.String filename, java.lang.String password, java.util.Map<java.lang.String,T> certs)
static void	createTrustStore(java.lang.String filename, java.lang.String password, java.lang.String alias, java.security.cert.Certificate cert)
static java.security.cert.X509Certificate	generateCertificate(java.lang.String dn, java.security.KeyPair pair, int days, java.lang.String algorithm) Create a self-signed X.509 Certificate.
static java.security.KeyPair	generateKeyPair(java.lang.String algorithm)
static java.lang.String	getClasspathDir(java.lang.Class<?> klass)
static void	saveConfig(java.io.File file, Configuration conf) Saves configuration to a file.
static void	setupSSLConfig(java.lang.String keystoresDir, java.lang.String sslConfDir, Configuration conf, boolean useClientCert) Performs complete setup of SSL configuration in preparation for testing an SSLFactory.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyStoreTestUtil

public KeyStoreTestUtil()

Method Detail

getClasspathDir

public static java.lang.String getClasspathDir(java.lang.Class<?> klass)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

generateCertificate

public static java.security.cert.X509Certificate generateCertificate(java.lang.String dn,
                                                                     java.security.KeyPair pair,
                                                                     int days,
                                                                     java.lang.String algorithm)
                                                              throws java.security.cert.CertificateEncodingException,
                                                                     java.security.InvalidKeyException,
                                                                     java.lang.IllegalStateException,
                                                                     java.security.NoSuchProviderException,
                                                                     java.security.NoSuchAlgorithmException,
                                                                     java.security.SignatureException

Create a self-signed X.509 Certificate.

Parameters:

dn - the X.509 Distinguished Name, eg "CN=Test, L=London, C=GB"

pair - the KeyPair

days - how many days from now the Certificate is valid for

algorithm - the signing algorithm, eg "SHA1withRSA"

Returns:

the self-signed certificate

Throws:

java.security.cert.CertificateEncodingException

java.security.InvalidKeyException

java.lang.IllegalStateException

java.security.NoSuchProviderException

java.security.NoSuchAlgorithmException

java.security.SignatureException

generateKeyPair

public static java.security.KeyPair generateKeyPair(java.lang.String algorithm)
                                             throws java.security.NoSuchAlgorithmException

Throws:

java.security.NoSuchAlgorithmException

createKeyStore

public static void createKeyStore(java.lang.String filename,
                                  java.lang.String password,
                                  java.lang.String alias,
                                  java.security.Key privateKey,
                                  java.security.cert.Certificate cert)
                           throws java.security.GeneralSecurityException,
                                  java.io.IOException

Throws:

java.security.GeneralSecurityException

java.io.IOException

createKeyStore

public static void createKeyStore(java.lang.String filename,
                                  java.lang.String password,
                                  java.lang.String keyPassword,
                                  java.lang.String alias,
                                  java.security.Key privateKey,
                                  java.security.cert.Certificate cert)
                           throws java.security.GeneralSecurityException,
                                  java.io.IOException

Creates a keystore with a single key and saves it to a file.

Parameters:

filename - String file to save

password - String store password to set on keystore

keyPassword - String key password to set on key

alias - String alias to use for the key

privateKey - Key to save in keystore

cert - Certificate to use as certificate chain associated to key

Throws:

java.security.GeneralSecurityException - for any error with the security APIs

java.io.IOException - if there is an I/O error saving the file

createTrustStore

public static void createTrustStore(java.lang.String filename,
                                    java.lang.String password,
                                    java.lang.String alias,
                                    java.security.cert.Certificate cert)
                             throws java.security.GeneralSecurityException,
                                    java.io.IOException

Throws:

java.security.GeneralSecurityException

java.io.IOException

createTrustStore

public static <T extends java.security.cert.Certificate> void createTrustStore(java.lang.String filename,
                                                                               java.lang.String password,
                                                                               java.util.Map<java.lang.String,T> certs)
                                                                        throws java.security.GeneralSecurityException,
                                                                               java.io.IOException

Throws:

java.security.GeneralSecurityException

java.io.IOException

cleanupSSLConfig

public static void cleanupSSLConfig(java.lang.String keystoresDir,
                                    java.lang.String sslConfDir)
                             throws java.lang.Exception

Throws:

java.lang.Exception

setupSSLConfig

public static void setupSSLConfig(java.lang.String keystoresDir,
                                  java.lang.String sslConfDir,
                                  Configuration conf,
                                  boolean useClientCert)
                           throws java.lang.Exception

Performs complete setup of SSL configuration in preparation for testing an SSLFactory. This includes keys, certs, keystores, truststores, the server SSL configuration file, the client SSL configuration file, and the master configuration file read by the SSLFactory.

Parameters:

keystoresDir - String directory to save keystores

sslConfDir - String directory to save SSL configuration files

conf - Configuration master configuration to be used by an SSLFactory, which will be mutated by this method

useClientCert - boolean true to make the client present a cert in the SSL handshake

Throws:

java.lang.Exception

createClientSSLConfig

public static Configuration createClientSSLConfig(java.lang.String clientKS,
                                                  java.lang.String password,
                                                  java.lang.String keyPassword,
                                                  java.lang.String trustKS)

Creates SSL configuration for a client.

Parameters:

clientKS - String client keystore file

password - String store password, or null to avoid setting store password

keyPassword - String key password, or null to avoid setting key password

trustKS - String truststore file

Returns:

Configuration for client SSL

createServerSSLConfig

public static Configuration createServerSSLConfig(java.lang.String serverKS,
                                                  java.lang.String password,
                                                  java.lang.String keyPassword,
                                                  java.lang.String trustKS)
                                           throws java.io.IOException

Creates SSL configuration for a server.

Parameters:

serverKS - String server keystore file

password - String store password, or null to avoid setting store password

keyPassword - String key password, or null to avoid setting key password

trustKS - String truststore file

Returns:

Configuration for server SSL

Throws:

java.io.IOException

saveConfig

public static void saveConfig(java.io.File file,
                              Configuration conf)
                       throws java.io.IOException

Saves configuration to a file.

Parameters:

file - File to save

conf - Configuration contents to write to file

Throws:

java.io.IOException - if there is an I/O error saving the file