com.captainalm.lib.calmnet.ssl

Class SSLUtilities

java.lang.Object

com.captainalm.lib.calmnet.ssl.SSLUtilities

public class SSLUtilities
extends java.lang.Object

This class provides SSL utilities to create SSLContext and SSLSocket objects using JKS files (Or other supported formats).

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
SSLUtilities()

Method Summary

Modifier and Type	Method and Description
static javax.net.ssl.SSLSocket	getSSLClientSocket(javax.net.ssl.SSLContext sslContext, java.lang.String host, int port) Creates a new SSLSocket using the specified SSLContext, host and port.
static javax.net.ssl.SSLContext	getSSLContext(java.lang.String algorithmName, java.security.KeyStore unifiedKeyStore, char[] keyStorePassword) Gets the SSL context merged with the JRE Trust Store using a unified KeyStore.
static javax.net.ssl.SSLContext	getSSLContext(java.lang.String algorithmName, java.security.KeyStore privateKeyStore, char[] privateKeyStorePassword, java.security.KeyStore trustKeyStore) Gets the SSL context merged with the JRE Trust Store using separate private and trust KeyStores.
static javax.net.ssl.SSLContext	getSSLContextNoJRETrust(java.lang.String algorithmName, java.security.KeyStore unifiedKeyStore, char[] keyStorePassword) Gets the SSL context without the JRE Trust Store using a unified KeyStore.
static javax.net.ssl.SSLContext	getSSLContextNoJRETrust(java.lang.String algorithmName, java.security.KeyStore privateKeyStore, char[] privateKeyStorePassword, java.security.KeyStore trustKeyStore) Gets the SSL context without the JRE Trust Store using separate private and trust KeyStores.
static javax.net.ssl.SSLServerSocket	getSSLServerSocket(javax.net.ssl.SSLContext sslContext, int port, int backlog, java.net.InetAddress ifAddress) Gets the SSL Server socket for the specified SSLContext, port, backlog and InetAddress.
static java.security.KeyStore	loadKeyStore(java.lang.String type, java.io.File file, java.lang.String password) Loads a Keystore of a certain type from a file given the password.
static javax.net.ssl.SSLSocket	upgradeClientSocketToSSL(javax.net.ssl.SSLContext sslContext, java.net.Socket socket, java.lang.String host, int port, boolean autoClose) Upgrades an existing Socket to an SSLSocket using the specified SSLContext, Socket, host, port and if the specified socket should be closed when the returned socket is closed.
static javax.net.ssl.SSLSocket	upgradeClientSocketToSSL(javax.net.ssl.SSLContext sslContext, java.net.Socket socket, java.lang.String host, int port, boolean autoClose, boolean onClient) Upgrades an existing Socket to an SSLSocket using the specified SSLContext, Socket, host, port and if the specified socket should be closed when the returned socket is closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSLUtilities

public SSLUtilities()

Method Detail

loadKeyStore

public static java.security.KeyStore loadKeyStore(java.lang.String type,
                                                  java.io.File file,
                                                  java.lang.String password)
                                           throws SSLUtilityException

Loads a Keystore of a certain type from a file given the password.

Parameters:

type - The type of keystore (pass null for the default type).

file - The file to load the keystore from.

password - The password of the keystore (Can be null).

Returns:

The keystore.

Throws:

java.lang.NullPointerException - file is null.

SSLUtilityException - An Exception has occurred.

getSSLContextNoJRETrust

public static javax.net.ssl.SSLContext getSSLContextNoJRETrust(java.lang.String algorithmName,
                                                               java.security.KeyStore unifiedKeyStore,
                                                               char[] keyStorePassword)
                                                        throws SSLUtilityException

Gets the SSL context without the JRE Trust Store using a unified KeyStore.

Parameters:

algorithmName - The name of the context protocol or null for the JRE Default (TLSv1).

unifiedKeyStore - The keystore for use with the private and trust stores.

keyStorePassword - The password of the key store or null (Use "changeit" for JKS keystore defaults).

Returns:

The SSLContext.

Throws:

SSLUtilityException - An Exception has occurred.

getSSLContextNoJRETrust

public static javax.net.ssl.SSLContext getSSLContextNoJRETrust(java.lang.String algorithmName,
                                                               java.security.KeyStore privateKeyStore,
                                                               char[] privateKeyStorePassword,
                                                               java.security.KeyStore trustKeyStore)
                                                        throws SSLUtilityException

Gets the SSL context without the JRE Trust Store using separate private and trust KeyStores.

Parameters:

algorithmName - The name of the context protocol or null for the JRE Default (TLSv1).

privateKeyStore - The keystore for use with the private store.

privateKeyStorePassword - The password of the private key store or null (Use "changeit" for JKS keystore defaults).

trustKeyStore - The keystore for use with the trust store.

Returns:

The SSLContext.

Throws:

SSLUtilityException - An Exception has occurred.

getSSLContext

public static javax.net.ssl.SSLContext getSSLContext(java.lang.String algorithmName,
                                                     java.security.KeyStore unifiedKeyStore,
                                                     char[] keyStorePassword)
                                              throws SSLUtilityException

Gets the SSL context merged with the JRE Trust Store using a unified KeyStore.

Parameters:

algorithmName - The name of the context protocol or null for the JRE Default (TLSv1).

unifiedKeyStore - The keystore for use with the private and trust stores.

keyStorePassword - The password of the key store or null (Use "changeit" for JKS keystore defaults).

Returns:

The SSLContext.

Throws:

SSLUtilityException - An Exception has occurred.

getSSLContext

public static javax.net.ssl.SSLContext getSSLContext(java.lang.String algorithmName,
                                                     java.security.KeyStore privateKeyStore,
                                                     char[] privateKeyStorePassword,
                                                     java.security.KeyStore trustKeyStore)
                                              throws SSLUtilityException

Gets the SSL context merged with the JRE Trust Store using separate private and trust KeyStores.

Parameters:

algorithmName - The name of the context protocol or null for the JRE Default (TLSv1).

privateKeyStore - The keystore for use with the private store.

privateKeyStorePassword - The password of the private key store or null (Use "changeit" for JKS keystore defaults).

trustKeyStore - The keystore for use with the trust store.

Returns:

The SSLContext.

Throws:

SSLUtilityException - An Exception has occurred.

getSSLClientSocket

public static javax.net.ssl.SSLSocket getSSLClientSocket(javax.net.ssl.SSLContext sslContext,
                                                         java.lang.String host,
                                                         int port)
                                                  throws SSLUtilityException

Creates a new SSLSocket using the specified SSLContext, host and port.

Parameters:

sslContext - The SSL Context to create the socket from.

host - The host to connect to.

port - The port to connect to.

Returns:

The SSLSocket.

Throws:

SSLUtilityException - An Exception has occurred.

upgradeClientSocketToSSL

public static javax.net.ssl.SSLSocket upgradeClientSocketToSSL(javax.net.ssl.SSLContext sslContext,
                                                               java.net.Socket socket,
                                                               java.lang.String host,
                                                               int port,
                                                               boolean autoClose)
                                                        throws SSLUtilityException

Upgrades an existing Socket to an SSLSocket using the specified SSLContext, Socket, host, port and if the specified socket should be closed when the returned socket is closed. This socket is in client mode (Upgrade for client side).

Parameters:

sslContext - The SSL Context to create the socket from.

socket - The socket to wrap.

host - The host to "connect" to.

port - The port to "connect" to.

autoClose - If the underlying socket should be closed when the returned socket is closed.

Returns:

The SSLSocket.

Throws:

SSLUtilityException - An Exception has occurred.

upgradeClientSocketToSSL

public static javax.net.ssl.SSLSocket upgradeClientSocketToSSL(javax.net.ssl.SSLContext sslContext,
                                                               java.net.Socket socket,
                                                               java.lang.String host,
                                                               int port,
                                                               boolean autoClose,
                                                               boolean onClient)
                                                        throws SSLUtilityException

Upgrades an existing Socket to an SSLSocket using the specified SSLContext, Socket, host, port and if the specified socket should be closed when the returned socket is closed.

Parameters:

sslContext - The SSL Context to create the socket from.

socket - The socket to wrap.

host - The host to "connect" to.

port - The port to "connect" to.

autoClose - If the underlying socket should be closed when the returned socket is closed.

onClient - Is this being called on the client side.

Returns:

The SSLSocket.

Throws:

SSLUtilityException - An Exception has occurred.

getSSLServerSocket

public static javax.net.ssl.SSLServerSocket getSSLServerSocket(javax.net.ssl.SSLContext sslContext,
                                                               int port,
                                                               int backlog,
                                                               java.net.InetAddress ifAddress)
                                                        throws SSLUtilityException

Gets the SSL Server socket for the specified SSLContext, port, backlog and InetAddress.

Parameters:

sslContext - The SSL Context to create the socket from.

port - The port to listen on.

backlog - The number of connections that can be queued.

ifAddress - The network interface to listen on (null means listen on all network interfaces).

Returns:

The SSLServerSocket.

Throws:

SSLUtilityException - An Exception has occurred.