org.apache.pulsar.common.util

Class SecurityUtility

java.lang.Object

org.apache.pulsar.common.util.SecurityUtility

public class SecurityUtility
extends Object

Helper class for the security domain.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BC
static String	BC_FIPS
static String	BC_FIPS_PROVIDER_CLASS
static String	BC_NON_FIPS_PROVIDER_CLASS
static Provider	BC_PROVIDER

Constructor Summary

Constructors

Constructor and Description
SecurityUtility()

Method Summary

Modifier and Type	Method and Description
static io.netty.handler.ssl.SslContext	createNettySslContextForClient(boolean allowInsecureConnection, InputStream trustCertsStream, Certificate[] certificates, PrivateKey privateKey)
static io.netty.handler.ssl.SslContext	createNettySslContextForClient(boolean allowInsecureConnection, String trustCertsFilePath)
static io.netty.handler.ssl.SslContext	createNettySslContextForClient(boolean allowInsecureConnection, String trustCertsFilePath, Certificate[] certificates, PrivateKey privateKey)
static io.netty.handler.ssl.SslContext	createNettySslContextForClient(boolean allowInsecureConnection, String trustCertsFilePath, String certFilePath, String keyFilePath)
static io.netty.handler.ssl.SslContext	createNettySslContextForServer(boolean allowInsecureConnection, String trustCertsFilePath, String certFilePath, String keyFilePath, Set<String> ciphers, Set<String> protocols, boolean requireTrustedClientCertOnConnect)
static SSLContext	createSslContext(boolean allowInsecureConnection, Certificate[] trustCertificates)
static SSLContext	createSslContext(boolean allowInsecureConnection, Certificate[] trustCertficates, Certificate[] certificates, PrivateKey privateKey)
static SSLContext	createSslContext(boolean allowInsecureConnection, String trustCertsFilePath, String certFilePath, String keyFilePath)
static org.eclipse.jetty.util.ssl.SslContextFactory	createSslContextFactory(boolean tlsAllowInsecureConnection, String tlsTrustCertsFilePath, String tlsCertificateFilePath, String tlsKeyFilePath, boolean tlsRequireTrustedClientCertOnConnect, boolean autoRefresh, long certRefreshInSec)
static Provider	getBCProviderFromClassPath() Get Bouncy Castle provider from classpath, and call Security.addProvider.
static Provider	getProvider() Get Bouncy Castle provider, and call Security.addProvider(provider) if success.
static boolean	isBCFIPS()
static X509Certificate[]	loadCertificatesFromPemFile(String certFilePath)
static X509Certificate[]	loadCertificatesFromPemStream(InputStream inStream)
static PrivateKey	loadPrivateKeyFromPemFile(String keyFilePath)
static PrivateKey	loadPrivateKeyFromPemStream(InputStream inStream)

Methods inherited from class java.lang.Object

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

Field Detail

BC_PROVIDER

public static final Provider BC_PROVIDER

BC_FIPS_PROVIDER_CLASS

public static final String BC_FIPS_PROVIDER_CLASS

See Also:

Constant Field Values

BC_NON_FIPS_PROVIDER_CLASS

public static final String BC_NON_FIPS_PROVIDER_CLASS

See Also:

Constant Field Values

BC_FIPS

public static final String BC_FIPS

See Also:

Constant Field Values

BC

public static final String BC

See Also:

Constant Field Values

Constructor Detail

SecurityUtility

public SecurityUtility()

Method Detail

isBCFIPS

public static boolean isBCFIPS()

getProvider

public static Provider getProvider()

Get Bouncy Castle provider, and call Security.addProvider(provider) if success. 1. try get from classpath. 2. try get from Nar.

getBCProviderFromClassPath

public static Provider getBCProviderFromClassPath()
                                           throws Exception

Get Bouncy Castle provider from classpath, and call Security.addProvider. Throw Exception if failed.

Throws:

Exception

createSslContext

public static SSLContext createSslContext(boolean allowInsecureConnection,
                                          Certificate[] trustCertificates)
                                   throws GeneralSecurityException

Throws:

GeneralSecurityException

createNettySslContextForClient

public static io.netty.handler.ssl.SslContext createNettySslContextForClient(boolean allowInsecureConnection,
                                                                             String trustCertsFilePath)
                                                                      throws GeneralSecurityException,
                                                                             SSLException,
                                                                             FileNotFoundException,
                                                                             IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createSslContext

public static SSLContext createSslContext(boolean allowInsecureConnection,
                                          String trustCertsFilePath,
                                          String certFilePath,
                                          String keyFilePath)
                                   throws GeneralSecurityException

Throws:

GeneralSecurityException

createNettySslContextForClient

public static io.netty.handler.ssl.SslContext createNettySslContextForClient(boolean allowInsecureConnection,
                                                                             String trustCertsFilePath,
                                                                             String certFilePath,
                                                                             String keyFilePath)
                                                                      throws GeneralSecurityException,
                                                                             SSLException,
                                                                             FileNotFoundException,
                                                                             IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createNettySslContextForClient

public static io.netty.handler.ssl.SslContext createNettySslContextForClient(boolean allowInsecureConnection,
                                                                             String trustCertsFilePath,
                                                                             Certificate[] certificates,
                                                                             PrivateKey privateKey)
                                                                      throws GeneralSecurityException,
                                                                             SSLException,
                                                                             FileNotFoundException,
                                                                             IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createNettySslContextForClient

public static io.netty.handler.ssl.SslContext createNettySslContextForClient(boolean allowInsecureConnection,
                                                                             InputStream trustCertsStream,
                                                                             Certificate[] certificates,
                                                                             PrivateKey privateKey)
                                                                      throws GeneralSecurityException,
                                                                             SSLException,
                                                                             FileNotFoundException,
                                                                             IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createNettySslContextForServer

public static io.netty.handler.ssl.SslContext createNettySslContextForServer(boolean allowInsecureConnection,
                                                                             String trustCertsFilePath,
                                                                             String certFilePath,
                                                                             String keyFilePath,
                                                                             Set<String> ciphers,
                                                                             Set<String> protocols,
                                                                             boolean requireTrustedClientCertOnConnect)
                                                                      throws GeneralSecurityException,
                                                                             SSLException,
                                                                             FileNotFoundException,
                                                                             IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createSslContext

public static SSLContext createSslContext(boolean allowInsecureConnection,
                                          Certificate[] trustCertficates,
                                          Certificate[] certificates,
                                          PrivateKey privateKey)
                                   throws GeneralSecurityException

Throws:

GeneralSecurityException

loadCertificatesFromPemFile

public static X509Certificate[] loadCertificatesFromPemFile(String certFilePath)
                                                     throws KeyManagementException

Throws:

KeyManagementException

loadCertificatesFromPemStream

public static X509Certificate[] loadCertificatesFromPemStream(InputStream inStream)
                                                       throws KeyManagementException

Throws:

KeyManagementException

loadPrivateKeyFromPemFile

public static PrivateKey loadPrivateKeyFromPemFile(String keyFilePath)
                                            throws KeyManagementException

Throws:

KeyManagementException

loadPrivateKeyFromPemStream

public static PrivateKey loadPrivateKeyFromPemStream(InputStream inStream)
                                              throws KeyManagementException

Throws:

KeyManagementException

createSslContextFactory

public static org.eclipse.jetty.util.ssl.SslContextFactory createSslContextFactory(boolean tlsAllowInsecureConnection,
                                                                                   String tlsTrustCertsFilePath,
                                                                                   String tlsCertificateFilePath,
                                                                                   String tlsKeyFilePath,
                                                                                   boolean tlsRequireTrustedClientCertOnConnect,
                                                                                   boolean autoRefresh,
                                                                                   long certRefreshInSec)
                                                                            throws GeneralSecurityException,
                                                                                   SSLException,
                                                                                   FileNotFoundException,
                                                                                   IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException