Package org.dogtagpki.jss.tomcat

Class TomcatJSS

java.lang.Object

org.dogtagpki.jss.tomcat.TomcatJSS

All Implemented Interfaces:

EventListener, SSLHandshakeCompletedListener, SSLSocketListener

public class TomcatJSS
extends Object
implements SSLSocketListener

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	boolStrictCiphers
static final String	CATALINA_BASE
(package private) String	certdbDir
(package private) String	clientAuth
(package private) boolean	enableRevocationCheck
(package private) boolean	initialized
static final TomcatJSS	INSTANCE
static final org.slf4j.Logger	logger
(package private) CryptoManager	manager
static final int	MAX_LOGIN_ATTEMPTS
(package private) int	ocspCacheSize
(package private) int	ocspMaxCacheEntryDuration
(package private) int	ocspMinCacheEntryDuration
(package private) String	ocspResponderCertNickname
(package private) String	ocspResponderURL
(package private) int	ocspTimeout
(package private) String	passwordClass
(package private) String	passwordFile
(package private) PasswordStore	passwordStore
(package private) boolean	requireClientAuth
(package private) String	serverCertNick
(package private) String	serverCertNickFile
(package private) Collection<SSLSocketListener>	socketListeners
(package private) String	ssl2Ciphers
(package private) String	ssl3Ciphers
(package private) String	sslOptions
(package private) String	sslRangeCiphers
(package private) String	strictCiphers
(package private) String	tlsCiphers
(package private) boolean	wantClientAuth

Constructor Summary

Constructors

Constructor	Description
TomcatJSS()

Method Summary

Modifier and Type	Method	Description
void	addSocketListener(SSLSocketListener listener)
void	alertReceived(SSLAlertEvent event)
void	alertSent(SSLAlertEvent event)
void	configureRevocationCheck()
String	getCertdbDir()
String	getClientAuth()
boolean	getEnableRevocationCheck()
static TomcatJSS	getInstance()
int	getOcspCacheSize()
int	getOcspMaxCacheEntryDuration()
int	getOcspMinCacheEntryDuration()
String	getOcspResponderCertNickname()
String	getOcspResponderURL()
int	getOcspTimeout()
String	getPasswordClass()
String	getPasswordFile()
PasswordStore	getPasswordStore()
boolean	getRequireClientAuth()
String	getServerCertNick()
String	getServerCertNickFile()
Collection<SSLSocketListener>	getSocketListeners()
CryptoToken	getToken(String tag)
boolean	getWantClientAuth()
void	handshakeCompleted(SSLHandshakeCompletedEvent event)
void	init()
void	loadConfig()	Load configuration from jss.conf (if available) or server.xml.
void	loadJSSConfig(File configFile)
void	loadJSSConfig(String jssConf)
void	loadJSSConfig(Properties config)
void	loadTomcatConfig(File configFile)
void	loadTomcatConfig(String serverXml)
void	loadTomcatConfig(Document document)
void	login()
void	login(String tag)
void	removeSocketListener(SSLSocketListener listener)
void	setCertdbDir(String certdbDir)
void	setClientAuth(String clientAuth)
void	setEnableRevocationCheck(boolean enableRevocationCheck)
void	setOcspCacheSize(int ocspCacheSize)
void	setOcspMaxCacheEntryDuration(int ocspMaxCacheEntryDuration)
void	setOcspMinCacheEntryDuration(int ocspMinCacheEntryDuration)
void	setOcspResponderCertNickname(String ocspResponderCertNickname)
void	setOcspResponderURL(String ocspResponderURL)
void	setOcspTimeout(int ocspTimeout)
void	setPasswordClass(String passwordClass)
void	setPasswordFile(String passwordFile)
void	setPasswordStore(PasswordStore passwordStore)
void	setServerCertNick(String serverCertNick)
void	setServerCertNickFile(String serverCertNickFile)

Methods inherited from class java.lang.Object

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

Field Details

logger

public static final org.slf4j.Logger logger

INSTANCE

public static final TomcatJSS INSTANCE

MAX_LOGIN_ATTEMPTS

public static final int MAX_LOGIN_ATTEMPTS

See Also:

• Constant Field Values

CATALINA_BASE

public static final String CATALINA_BASE

See Also:

• Constant Field Values

socketListeners

Collection<SSLSocketListener> socketListeners

certdbDir

String certdbDir

manager

CryptoManager manager

passwordClass

String passwordClass

passwordFile

String passwordFile

passwordStore

PasswordStore passwordStore

serverCertNickFile

String serverCertNickFile

serverCertNick

String serverCertNick

clientAuth

String clientAuth

requireClientAuth

boolean requireClientAuth

wantClientAuth

boolean wantClientAuth

enableRevocationCheck

boolean enableRevocationCheck

ocspResponderURL

String ocspResponderURL

ocspResponderCertNickname

String ocspResponderCertNickname

ocspCacheSize

int ocspCacheSize

ocspMinCacheEntryDuration

int ocspMinCacheEntryDuration

ocspMaxCacheEntryDuration

int ocspMaxCacheEntryDuration

ocspTimeout

int ocspTimeout

strictCiphers

String strictCiphers

boolStrictCiphers

boolean boolStrictCiphers

sslRangeCiphers

String sslRangeCiphers

sslOptions

String sslOptions

ssl2Ciphers

String ssl2Ciphers

ssl3Ciphers

String ssl3Ciphers

tlsCiphers

String tlsCiphers

initialized

boolean initialized

Constructor Details

TomcatJSS

public TomcatJSS()

Method Details

getInstance

public static TomcatJSS getInstance()

addSocketListener

public void addSocketListener(SSLSocketListener listener)

removeSocketListener

public void removeSocketListener(SSLSocketListener listener)

getSocketListeners

public Collection<SSLSocketListener> getSocketListeners()

getCertdbDir

public String getCertdbDir()

setCertdbDir

public void setCertdbDir(String certdbDir)

getPasswordClass

public String getPasswordClass()

setPasswordClass

public void setPasswordClass(String passwordClass)

getPasswordFile

public String getPasswordFile()

setPasswordFile

public void setPasswordFile(String passwordFile)

getServerCertNickFile

public String getServerCertNickFile()

getPasswordStore

public PasswordStore getPasswordStore()

setPasswordStore

public void setPasswordStore(PasswordStore passwordStore)

setServerCertNickFile

public void setServerCertNickFile(String serverCertNickFile)

getServerCertNick

public String getServerCertNick()

setServerCertNick

public void setServerCertNick(String serverCertNick)

getClientAuth

public String getClientAuth()

setClientAuth

public void setClientAuth(String clientAuth)

getRequireClientAuth

public boolean getRequireClientAuth()

getWantClientAuth

public boolean getWantClientAuth()

getEnableRevocationCheck

public boolean getEnableRevocationCheck()

setEnableRevocationCheck

public void setEnableRevocationCheck(boolean enableRevocationCheck)

getOcspResponderURL

public String getOcspResponderURL()

setOcspResponderURL

public void setOcspResponderURL(String ocspResponderURL)

getOcspResponderCertNickname

public String getOcspResponderCertNickname()

setOcspResponderCertNickname

public void setOcspResponderCertNickname(String ocspResponderCertNickname)

getOcspCacheSize

public int getOcspCacheSize()

setOcspCacheSize

public void setOcspCacheSize(int ocspCacheSize)

getOcspMinCacheEntryDuration

public int getOcspMinCacheEntryDuration()

setOcspMinCacheEntryDuration

public void setOcspMinCacheEntryDuration(int ocspMinCacheEntryDuration)

getOcspMaxCacheEntryDuration

public int getOcspMaxCacheEntryDuration()

setOcspMaxCacheEntryDuration

public void setOcspMaxCacheEntryDuration(int ocspMaxCacheEntryDuration)

getOcspTimeout

public int getOcspTimeout()

setOcspTimeout

public void setOcspTimeout(int ocspTimeout)

loadJSSConfig

public void loadJSSConfig(String jssConf)
                   throws IOException

Throws:

IOException

loadJSSConfig

public void loadJSSConfig(File configFile)
                   throws IOException

Throws:

IOException

loadJSSConfig

public void loadJSSConfig(Properties config)

loadTomcatConfig

public void loadTomcatConfig(String serverXml)
                      throws ParserConfigurationException,
SAXException,
IOException,
XPathExpressionException

Throws:

ParserConfigurationException

SAXException

IOException

XPathExpressionException

loadTomcatConfig

public void loadTomcatConfig(File configFile)
                      throws ParserConfigurationException,
SAXException,
IOException,
XPathExpressionException

Throws:

ParserConfigurationException

SAXException

IOException

XPathExpressionException

loadTomcatConfig

public void loadTomcatConfig(Document document)
                      throws XPathExpressionException

Throws:

XPathExpressionException

loadConfig

public void loadConfig()
                throws IOException,
XPathExpressionException,
ParserConfigurationException,
SAXException

Load configuration from jss.conf (if available) or server.xml.

Throws:

IOException

SAXException

ParserConfigurationException

XPathExpressionException

init

public void init()
          throws KeyDatabaseException,
CertDatabaseException,
GeneralSecurityException,
NotInitializedException,
InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
NoSuchMethodException,
SecurityException,
ClassNotFoundException,
IOException,
NoSuchTokenException,
TokenException,
ConfigurationException

Throws:

KeyDatabaseException

CertDatabaseException

GeneralSecurityException

NotInitializedException

InstantiationException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

NoSuchMethodException

SecurityException

ClassNotFoundException

IOException

NoSuchTokenException

TokenException

ConfigurationException

login

public void login()
           throws NoSuchTokenException,
TokenException

Throws:

NoSuchTokenException

TokenException

login

public void login(String tag)
           throws NoSuchTokenException,
TokenException

Throws:

NoSuchTokenException

TokenException

getToken

public CryptoToken getToken(String tag)
                     throws NoSuchTokenException

Throws:

NoSuchTokenException

configureRevocationCheck

public void configureRevocationCheck()
                              throws GeneralSecurityException,
ConfigurationException

Throws:

GeneralSecurityException

ConfigurationException

alertReceived

public void alertReceived(SSLAlertEvent event)

Specified by:

alertReceived in interface SSLSocketListener

alertSent

public void alertSent(SSLAlertEvent event)

Specified by:

alertSent in interface SSLSocketListener

handshakeCompleted

public void handshakeCompleted(SSLHandshakeCompletedEvent event)

Specified by:

handshakeCompleted in interface SSLHandshakeCompletedListener