Package org.omegazero.net.util

Class SSLUtil

java.lang.Object

org.omegazero.net.util.SSLUtil

public final class SSLUtil
extends Object

Contains utility methods for managing SSL/TLS objects and keys/certificates.

Method Summary

Modifier and Type	Method	Description
static SSLServerSocketFactory	getSecureServerSocketFactory(String keyFile, String certFile)	Deprecated. Use getSSLContextFromPEM(String, String) and SSLContext.getServerSocketFactory()
static ServerSocketFactory	getServerSocketFactory()	Deprecated. Use ServerSocketFactory.getDefault()
static SSLContext	getSSLContextFromKeyStore(String filename, String password, String keypassword)	Creates a SSLContext with the "TLS" protocol from a Java key store stored in a file identified by filename.
static SSLContext	getSSLContextFromKeyStore(String protocol, String filename, String password, String keypassword)	Creates a SSLContext from a Java key store stored in a file identified by filename.
static SSLContext	getSSLContextFromPEM(String keyFile, String certFile)	Creates a SSLContext with the "TLS" protocol from PEM-encoded key and certificate files.
static SSLContext	getSSLContextFromPEM(String protocol, String keyFile, String certFile)	Creates a SSLContext from PEM-encoded key and certificate files.
static SSLEngine	getSSLEngineWithPEM(String keyFile, String certFile)	Deprecated. Use getSSLContextFromPEM(String, String) and SSLContext.createSSLEngine()
static X509Certificate	loadCertificateFromPEM(String certFile)	Reads a single X509Certificate from the given certFile.
static X509Certificate[]	loadCertificatesFromPEM(String certFile)	Reads one or more X509Certificate from the given certFile.
static PrivateKey	loadPrivateKeyFromPEM(String keyFile)	Reads a PrivateKey from the given keyFile.
static List<byte[]>	readCertificatePEM(String data)	Reads one or more encoded certificates from the given string data and returns the decoded bytes.

Methods inherited from class java.lang.Object

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

Method Details

getServerSocketFactory

public static ServerSocketFactory getServerSocketFactory()

Deprecated.

Use ServerSocketFactory.getDefault()

Returns the default server socket factory.

Returns:

The default server socket factory

getSSLContextFromKeyStore

public static SSLContext getSSLContextFromKeyStore(String filename,
 String password,
 String keypassword)
                                            throws GeneralSecurityException,
IOException

Creates a SSLContext with the "TLS" protocol from a Java key store stored in a file identified by filename.

Parameters:

filename - The key store file

password - The file password

keypassword - The key password

Returns:

The SSLContext

Throws:

GeneralSecurityException - If an SSL error occurs

IOException - If an IO error occurs while reading the file

See Also:

• getSSLContextFromKeyStore(String, String, String, String)
• SSLContext.getInstance(String)

getSSLContextFromKeyStore

public static SSLContext getSSLContextFromKeyStore(String protocol,
 String filename,
 String password,
 String keypassword)
                                            throws GeneralSecurityException,
IOException

Creates a SSLContext from a Java key store stored in a file identified by filename.

Parameters:

protocol - The name of the protocol the SSLContext will be used for

filename - The key store file

password - The file password

keypassword - The key password

Returns:

The SSLContext

Throws:

GeneralSecurityException - If an SSL error occurs

IOException - If an IO error occurs while reading the file

See Also:

• getSSLContextFromKeyStore(String, String, String)
• SSLContext.getInstance(String)

getSSLContextFromPEM

public static SSLContext getSSLContextFromPEM(String keyFile,
 String certFile)
                                       throws GeneralSecurityException,
IOException

Creates a SSLContext with the "TLS" protocol from PEM-encoded key and certificate files.

Parameters:

keyFile - The key file

certFile - The certificate file

Returns:

The SSLContext

Throws:

GeneralSecurityException - If an SSL error occurs

IOException - If an IO error occurs while reading the file

See Also:

• getSSLContextFromPEM(String, String, String)
• SSLContext.getInstance(String)

getSSLContextFromPEM

public static SSLContext getSSLContextFromPEM(String protocol,
 String keyFile,
 String certFile)
                                       throws GeneralSecurityException,
IOException

Creates a SSLContext from PEM-encoded key and certificate files.

Parameters:

protocol - The name of the protocol the SSLContext will be used for

keyFile - The key file

certFile - The certificate file

Returns:

The SSLContext

Throws:

GeneralSecurityException - If an SSL error occurs

IOException - If an IO error occurs while reading the file

See Also:

• getSSLContextFromPEM(String, String)
• SSLContext.getInstance(String)

getSecureServerSocketFactory

@Deprecated
public static SSLServerSocketFactory getSecureServerSocketFactory(String keyFile,
 String certFile)
                                                           throws GeneralSecurityException,
IOException

Deprecated.

Use getSSLContextFromPEM(String, String) and SSLContext.getServerSocketFactory()

Creates a SSLServerSocketFactory from PEM-encoded key and certificate files.

Parameters:

keyFile - The key file

certFile - The certificate file

Returns:

The SSLServerSocketFactory

Throws:

GeneralSecurityException - If an SSL error occurs

IOException - If an IO error occurs while reading the file

getSSLEngineWithPEM

@Deprecated
public static SSLEngine getSSLEngineWithPEM(String keyFile,
 String certFile)
                                     throws GeneralSecurityException,
IOException

Deprecated.

Use getSSLContextFromPEM(String, String) and SSLContext.createSSLEngine()

Creates a SSLEngine from PEM-encoded key and certificate files.

Parameters:

keyFile - The key file

certFile - The certificate file

Returns:

The SSLEngine

Throws:

GeneralSecurityException - If an SSL error occurs

IOException - If an IO error occurs while reading the file

readCertificatePEM

public static List<byte[]> readCertificatePEM(String data)
                                       throws IOException

Reads one or more encoded certificates from the given string data and returns the decoded bytes.

The given data is expected to contain one or more blocks of the following format:

 
 -----BEGIN CERTIFICATE-----
 <base64-encoded certificate data>
 -----END CERTIFICATE-----
 
 

Parameters:

data - The string data

Returns:

The list of decoded certificate blocks

Throws:

IOException - If the format is invalid

loadPrivateKeyFromPEM

public static PrivateKey loadPrivateKeyFromPEM(String keyFile)
                                        throws GeneralSecurityException,
IOException

Reads a PrivateKey from the given keyFile.

Parameters:

keyFile - The key file

Returns:

The PrivateKey

Throws:

GeneralSecurityException - If an SSL error occurs

IOException - If an IO error occurs while reading the file

See Also:

• PrivateKeyReader.read(String)

loadCertificateFromPEM

public static X509Certificate loadCertificateFromPEM(String certFile)
                                              throws GeneralSecurityException,
IOException

Reads a single X509Certificate from the given certFile.

Parameters:

certFile - The certificate file

Returns:

The X509Certificate

Throws:

GeneralSecurityException - If an SSL error occurs

IOException - If an IO error occurs while reading the file

loadCertificatesFromPEM

public static X509Certificate[] loadCertificatesFromPEM(String certFile)
                                                 throws GeneralSecurityException,
IOException

Reads one or more X509Certificate from the given certFile.

Parameters:

certFile - The certificate file

Returns:

The X509Certificates

Throws:

GeneralSecurityException - If an SSL error occurs

IOException - If an IO error occurs while reading the file