net.exogeni.orca.nodeagent

Class MerlinKeyRegister

java.lang.Object

org.apache.ws.security.components.crypto.AbstractCrypto

org.apache.ws.security.components.crypto.Merlin

net.exogeni.orca.nodeagent.MerlinKeyRegister

All Implemented Interfaces:

org.apache.ws.security.components.crypto.Crypto

public class MerlinKeyRegister
extends org.apache.ws.security.components.crypto.Merlin

Author:

ionut, aydan

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AuthorityKeyStoreEntry Admin certificate alias.
static int	CodeInternalError
static int	CodeNoRecovery
static int	CodeRecoverySuccessful
protected static java.lang.String	dataFolder Service data folder.
protected static java.security.KeyStore	keyStore The actual keystore.
protected static org.apache.log4j.Logger	logger Logger.
protected static MerlinKeyRegister	mr The singleton instance.
protected static java.lang.String	root Service root directory.
static java.lang.String	ServerKeySize Size for the server key: 2KB.
protected static java.lang.String	ServerKeyStoreDestination Keystore location.
static java.lang.String	ServerKeyStoreName Service keystore name.
static java.lang.String	ServerKeyValidity Validity interval for the server key: approximately 10 years.
protected static java.lang.String	serverPassword
static java.lang.String	ServiceKeyStoreEntry Service certificat alias.
static java.lang.String	ServicePropertiesFile Properties file.

Fields inherited from class org.apache.ws.security.components.crypto.AbstractCrypto

certFact, keystore, properties

Constructor Summary

Constructors

Constructor and Description
MerlinKeyRegister(java.util.Properties prop)
MerlinKeyRegister(java.util.Properties prop, java.lang.ClassLoader cls)

Method Summary

Modifier and Type	Method and Description
void	addKeyToKeystore(java.lang.String alias, java.security.cert.Certificate cert) Adds a certificate to the keystore.
static int	checkRecovery() Tries recovery for a new instance of the Merlin Provider,
static int	createServiceKeyStore(java.lang.String alias, java.security.cert.Certificate cert) Creates server.jks when registerAuthorityKey is invoked.
static java.security.cert.Certificate	getAuthorityKey() Retrieves the first certificate registered with the node
static MerlinKeyRegister	getInstance() Returns the singleton instance.
static java.security.cert.Certificate	getServiceKey() Retrieves the service key.
void	removeKeyFromKeyStore(java.lang.String alias) Removes a trusted key from the node.
void	setKeyStore(java.security.KeyStore arg0) Sets the keystore to be used by the Merlin Provider.

Methods inherited from class org.apache.ws.security.components.crypto.Merlin

getCertificateData, getX509Certificates, validateCertPath

Methods inherited from class org.apache.ws.security.components.crypto.AbstractCrypto

getAliasesForDN, getAliasForX509Cert, getAliasForX509Cert, getAliasForX509Cert, getAliasForX509Cert, getAliasForX509CertThumb, getCertificateFactory, getCertificates, getDefaultX509Alias, getKeyStore, getPrivateKey, getSKIBytesFromCert, load, loadCertificate

Methods inherited from class java.lang.Object

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

Field Detail

AuthorityKeyStoreEntry

public static final java.lang.String AuthorityKeyStoreEntry

Admin certificate alias.

See Also:

Constant Field Values

ServiceKeyStoreEntry

public static final java.lang.String ServiceKeyStoreEntry

Service certificat alias.

See Also:

Constant Field Values

ServerKeyValidity

public static final java.lang.String ServerKeyValidity

Validity interval for the server key: approximately 10 years.

See Also:

Constant Field Values

ServerKeySize

public static final java.lang.String ServerKeySize

Size for the server key: 2KB.

See Also:

Constant Field Values

ServerKeyStoreName

public static final java.lang.String ServerKeyStoreName

Service keystore name.

See Also:

Constant Field Values

ServicePropertiesFile

public static final java.lang.String ServicePropertiesFile

Properties file.

See Also:

Constant Field Values

CodeInternalError

public static final int CodeInternalError

See Also:

Constant Field Values

CodeRecoverySuccessful

public static final int CodeRecoverySuccessful

See Also:

Constant Field Values

CodeNoRecovery

public static final int CodeNoRecovery

See Also:

Constant Field Values

logger

protected static final org.apache.log4j.Logger logger

Logger.

root

protected static final java.lang.String root

Service root directory.

dataFolder

protected static final java.lang.String dataFolder

Service data folder.

ServerKeyStoreDestination

protected static final java.lang.String ServerKeyStoreDestination

Keystore location.

mr

protected static MerlinKeyRegister mr

The singleton instance.

keyStore

protected static java.security.KeyStore keyStore

The actual keystore.

serverPassword

protected static java.lang.String serverPassword

Constructor Detail

MerlinKeyRegister

public MerlinKeyRegister(java.util.Properties prop)
                  throws java.io.IOException,
                         org.apache.ws.security.components.crypto.CredentialException

Throws:

java.io.IOException

org.apache.ws.security.components.crypto.CredentialException

MerlinKeyRegister

public MerlinKeyRegister(java.util.Properties prop,
                         java.lang.ClassLoader cls)
                  throws java.io.IOException,
                         org.apache.ws.security.components.crypto.CredentialException

Throws:

java.io.IOException

org.apache.ws.security.components.crypto.CredentialException

Method Detail

getInstance

public static MerlinKeyRegister getInstance()

Returns the singleton instance.

Returns:

MerlinKeyRegister

setKeyStore

public void setKeyStore(java.security.KeyStore arg0)

Sets the keystore to be used by the Merlin Provider.

Overrides:

setKeyStore in class org.apache.ws.security.components.crypto.AbstractCrypto

Parameters:

arg0 - arg0

checkRecovery

public static int checkRecovery()

Tries recovery for a new instance of the Merlin Provider,

Returns:

int

createServiceKeyStore

public static int createServiceKeyStore(java.lang.String alias,
                                        java.security.cert.Certificate cert)

Creates server.jks when registerAuthorityKey is invoked. Creates the private key / certificate of the node

Parameters:

alias - this alias should be "authoritykey", we will use "authoritykey"

cert - the first trusted certificate to be added

Returns:

int

getServiceKey

public static java.security.cert.Certificate getServiceKey()

Retrieves the service key.

Returns:

Certificate

getAuthorityKey

public static java.security.cert.Certificate getAuthorityKey()

Retrieves the first certificate registered with the node

Returns:

Certificate

addKeyToKeystore

public void addKeyToKeystore(java.lang.String alias,
                             java.security.cert.Certificate cert)
                      throws java.io.IOException,
                             java.security.KeyStoreException,
                             java.security.cert.CertificateException,
                             java.security.NoSuchAlgorithmException

Adds a certificate to the keystore. Allows multiple clients to use the node. The actor invoking this function has to be trusted.

Parameters:

alias - alias

cert - cert

Throws:

java.io.IOException - in case of error

java.security.KeyStoreException - in case of error

java.security.cert.CertificateException - in case of error

java.security.NoSuchAlgorithmException - in case of error

removeKeyFromKeyStore

public void removeKeyFromKeyStore(java.lang.String alias)
                           throws java.io.IOException,
                                  java.security.KeyStoreException,
                                  java.security.NoSuchAlgorithmException,
                                  java.security.cert.CertificateException

Removes a trusted key from the node. The actor invoking this function has to be trusted.

Parameters:

alias - alias

Throws:

java.io.IOException - in case of error

java.security.KeyStoreException - in case of error

java.security.NoSuchAlgorithmException - in case of error

java.security.cert.CertificateException - in case of error