org.apache.nifi.security.util

Class SslContextFactory

java.lang.Object

org.apache.nifi.security.util.SslContextFactory

public final class SslContextFactory
extends Object

A factory for creating SSL contexts using the application's security properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SslContextFactory.ClientAuth

Constructor Summary

Constructors

Constructor and Description
SslContextFactory()

Method Summary

Modifier and Type	Method and Description
static SSLContext	createSslContext(String keystore, char[] keystorePasswd, char[] keyPasswd, String keystoreType, String protocol) Creates a SSLContext instance using the given information.
static SSLContext	createSslContext(String keystore, char[] keystorePasswd, char[] keyPasswd, String keystoreType, String truststore, char[] truststorePasswd, String truststoreType, SslContextFactory.ClientAuth clientAuth, String protocol) Creates a SSLContext instance using the given information.
static SSLContext	createSslContext(String keystore, char[] keystorePasswd, String keystoreType, String protocol) Creates a SSLContext instance using the given information.
static SSLContext	createSslContext(String keystore, char[] keystorePasswd, String keystoreType, String truststore, char[] truststorePasswd, String truststoreType, SslContextFactory.ClientAuth clientAuth, String protocol) Creates a SSLContext instance using the given information.
static SSLContext	createTrustSslContext(String truststore, char[] truststorePasswd, String truststoreType, String protocol) Creates a SSLContext instance using the given information.

Methods inherited from class java.lang.Object

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

Constructor Detail

SslContextFactory

public SslContextFactory()

Method Detail

createSslContext

public static SSLContext createSslContext(String keystore,
                                          char[] keystorePasswd,
                                          String keystoreType,
                                          String truststore,
                                          char[] truststorePasswd,
                                          String truststoreType,
                                          SslContextFactory.ClientAuth clientAuth,
                                          String protocol)
                                   throws KeyStoreException,
                                          IOException,
                                          NoSuchAlgorithmException,
                                          CertificateException,
                                          UnrecoverableKeyException,
                                          KeyManagementException

Creates a SSLContext instance using the given information. The password for the key is assumed to be the same as the password for the keystore. If this is not the case, the #createSslContext(String, char[], chart[], String, String, char[], String, ClientAuth, String) method should be used instead

Parameters:

keystore - the full path to the keystore

keystorePasswd - the keystore password

keystoreType - the type of keystore (e.g., PKCS12, JKS)

truststore - the full path to the truststore

truststorePasswd - the truststore password

truststoreType - the type of truststore (e.g., PKCS12, JKS)

clientAuth - the type of client authentication

protocol - the protocol to use for the SSL connection

Returns:

a SSLContext instance

Throws:

KeyStoreException - if any issues accessing the keystore

IOException - for any problems loading the keystores

NoSuchAlgorithmException - if an algorithm is found to be used but is unknown

CertificateException - if there is an issue with the certificate

UnrecoverableKeyException - if the key is insufficient

KeyManagementException - if unable to manage the key

createSslContext

public static SSLContext createSslContext(String keystore,
                                          char[] keystorePasswd,
                                          char[] keyPasswd,
                                          String keystoreType,
                                          String truststore,
                                          char[] truststorePasswd,
                                          String truststoreType,
                                          SslContextFactory.ClientAuth clientAuth,
                                          String protocol)
                                   throws KeyStoreException,
                                          IOException,
                                          NoSuchAlgorithmException,
                                          CertificateException,
                                          UnrecoverableKeyException,
                                          KeyManagementException

Creates a SSLContext instance using the given information.

Parameters:

keystore - the full path to the keystore

keystorePasswd - the keystore password

keystoreType - the type of keystore (e.g., PKCS12, JKS)

truststore - the full path to the truststore

truststorePasswd - the truststore password

truststoreType - the type of truststore (e.g., PKCS12, JKS)

clientAuth - the type of client authentication

protocol - the protocol to use for the SSL connection

Returns:

a SSLContext instance

Throws:

KeyStoreException - if any issues accessing the keystore

IOException - for any problems loading the keystores

NoSuchAlgorithmException - if an algorithm is found to be used but is unknown

CertificateException - if there is an issue with the certificate

UnrecoverableKeyException - if the key is insufficient

KeyManagementException - if unable to manage the key

createSslContext

public static SSLContext createSslContext(String keystore,
                                          char[] keystorePasswd,
                                          String keystoreType,
                                          String protocol)
                                   throws KeyStoreException,
                                          IOException,
                                          NoSuchAlgorithmException,
                                          CertificateException,
                                          UnrecoverableKeyException,
                                          KeyManagementException

Creates a SSLContext instance using the given information. This method assumes that the key password is the same as the keystore password. If this is not the case, use the createSslContext(String, char[], char[], String, String) method instead.

Parameters:

keystore - the full path to the keystore

keystorePasswd - the keystore password

keystoreType - the type of keystore (e.g., PKCS12, JKS)

protocol - the protocol to use for the SSL connection

Returns:

a SSLContext instance

Throws:

KeyStoreException - if any issues accessing the keystore

IOException - for any problems loading the keystores

NoSuchAlgorithmException - if an algorithm is found to be used but is unknown

CertificateException - if there is an issue with the certificate

UnrecoverableKeyException - if the key is insufficient

KeyManagementException - if unable to manage the key

createSslContext

public static SSLContext createSslContext(String keystore,
                                          char[] keystorePasswd,
                                          char[] keyPasswd,
                                          String keystoreType,
                                          String protocol)
                                   throws KeyStoreException,
                                          IOException,
                                          NoSuchAlgorithmException,
                                          CertificateException,
                                          UnrecoverableKeyException,
                                          KeyManagementException

Creates a SSLContext instance using the given information.

Parameters:

keystore - the full path to the keystore

keystorePasswd - the keystore password

keystoreType - the type of keystore (e.g., PKCS12, JKS)

protocol - the protocol to use for the SSL connection

Returns:

a SSLContext instance

Throws:

KeyStoreException - if any issues accessing the keystore

IOException - for any problems loading the keystores

NoSuchAlgorithmException - if an algorithm is found to be used but is unknown

CertificateException - if there is an issue with the certificate

UnrecoverableKeyException - if the key is insufficient

KeyManagementException - if unable to manage the key

createTrustSslContext

public static SSLContext createTrustSslContext(String truststore,
                                               char[] truststorePasswd,
                                               String truststoreType,
                                               String protocol)
                                        throws KeyStoreException,
                                               IOException,
                                               NoSuchAlgorithmException,
                                               CertificateException,
                                               UnrecoverableKeyException,
                                               KeyManagementException

Creates a SSLContext instance using the given information.

Parameters:

truststore - the full path to the truststore

truststorePasswd - the truststore password

truststoreType - the type of truststore (e.g., PKCS12, JKS)

protocol - the protocol to use for the SSL connection

Returns:

a SSLContext instance

Throws:

KeyStoreException - if any issues accessing the keystore

IOException - for any problems loading the keystores

NoSuchAlgorithmException - if an algorithm is found to be used but is unknown

CertificateException - if there is an issue with the certificate

UnrecoverableKeyException - if the key is insufficient

KeyManagementException - if unable to manage the key