Package com.sun.enterprise.security.ssl

Class SSLUtils

java.lang.Object

com.sun.enterprise.security.ssl.SSLUtils

All Implemented Interfaces:

org.glassfish.hk2.api.PostConstruct

@Service
@Singleton
public final class SSLUtils
extends Object
implements org.glassfish.hk2.api.PostConstruct

Handy class containing static functions.

Author:

Harpreet Singh, Vivek Nagar, Shing Wai Chan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HTTPS_OUTBOUND_KEY_ALIAS

Constructor Summary

Constructors

Constructor	Description
SSLUtils()

Method Summary

Modifier and Type	Method	Description
static void	checkPermission(String key)
SSLSocketFactory	getAdminSocketFactory(String alias, String protocol)
SSLContext	getAdminSSLContext(String alias, String protocol)
com.sun.enterprise.security.integration.AppClientSSL	getAppclientSsl()
KeyManager[]	getKeyManagers()
KeyManager[]	getKeyManagers(String algorithm)
KeyStore	getKeyStore()
KeyStore[]	getKeyStores()
static String	getKeyStoreType()
KeyStore	getMergedTrustStore()	This API was supposedly for temporary purpose, but it's been in use for some 15 years.
KeyStore.PrivateKeyEntry	getPrivateKeyEntryFromTokenAlias(String certNickname)	Get a PrivateKeyEntry with certNickName is of the form [<TokenName>:]alias where alias is an key entry.
String[]	getSupportedCipherSuites()
TrustManager[]	getTrustManagers()
TrustManager[]	getTrustManagers(String algorithm)
KeyStore	getTrustStore()
KeyStore[]	getTrustStores()
static String	getTrustStoreType()
boolean	isKeyAvailable()	This method checks whether a private key is available or not.
boolean	isTokenKeyAlias(String certNickname)	Check whether given String is of the form [<TokenName>:]alias where alias is an key entry.
void	postConstruct()
void	setAppclientSsl(com.sun.enterprise.security.integration.AppClientSSL ssl)
boolean	verifyMasterPassword(char[] masterPass)

Methods inherited from class java.lang.Object

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

Field Details

HTTPS_OUTBOUND_KEY_ALIAS

public static final String HTTPS_OUTBOUND_KEY_ALIAS

See Also:

• Constant Field Values

Constructor Details

SSLUtils

public SSLUtils()

Method Details

postConstruct

public void postConstruct()

Specified by:

postConstruct in interface org.glassfish.hk2.api.PostConstruct

verifyMasterPassword

public boolean verifyMasterPassword(char[] masterPass)

getKeyStores

public KeyStore[] getKeyStores()
                        throws IOException

Throws:

IOException

getKeyStore

public KeyStore getKeyStore()
                     throws IOException

Throws:

IOException

getTrustStores

public KeyStore[] getTrustStores()
                          throws IOException

Throws:

IOException

getTrustStore

public KeyStore getTrustStore()
                       throws IOException

Throws:

IOException

getMergedTrustStore

public KeyStore getMergedTrustStore()

This API was supposedly for temporary purpose, but it's been in use for some 15 years. Someone once thought it would be removed once Jakarta Authentication is update, but never made clear why or how that would work.

getKeyManagers

public KeyManager[] getKeyManagers()
                            throws Exception

Throws:

Exception

getKeyManagers

public KeyManager[] getKeyManagers(String algorithm)
                            throws IOException,
KeyStoreException,
NoSuchAlgorithmException,
UnrecoverableKeyException

Throws:

IOException

KeyStoreException

NoSuchAlgorithmException

UnrecoverableKeyException

getTrustManagers

public TrustManager[] getTrustManagers()
                                throws Exception

Throws:

Exception

getTrustManagers

public TrustManager[] getTrustManagers(String algorithm)
                                throws IOException,
KeyStoreException,
NoSuchAlgorithmException

Throws:

IOException

KeyStoreException

NoSuchAlgorithmException

setAppclientSsl

public void setAppclientSsl(com.sun.enterprise.security.integration.AppClientSSL ssl)

getAppclientSsl

public com.sun.enterprise.security.integration.AppClientSSL getAppclientSsl()

getKeyStoreType

public static String getKeyStoreType()

getTrustStoreType

public static String getTrustStoreType()

isKeyAvailable

public boolean isKeyAvailable()

This method checks whether a private key is available or not.

isTokenKeyAlias

public boolean isTokenKeyAlias(String certNickname)
                        throws Exception

Check whether given String is of the form [<TokenName>:]alias where alias is an key entry.

Parameters:

certNickname -

Returns:

boolean

Throws:

Exception

getPrivateKeyEntryFromTokenAlias

public KeyStore.PrivateKeyEntry getPrivateKeyEntryFromTokenAlias(String certNickname)
                                                          throws Exception

Get a PrivateKeyEntry with certNickName is of the form [<TokenName>:]alias where alias is an key entry.

Parameters:

certNickname -

Returns:

PrivateKeyEntry

Throws:

Exception

checkPermission

public static void checkPermission(String key)

getSupportedCipherSuites

public String[] getSupportedCipherSuites()

getAdminSocketFactory

public SSLSocketFactory getAdminSocketFactory(String alias,
 String protocol)

Parameters:

alias - the admin key alias

protocol - the protocol or null, uses "TLS" if this argument is null.

Returns:

the SSLSocketFactory from the initialized SSLContext

getAdminSSLContext

public SSLContext getAdminSSLContext(String alias,
 String protocol)