Package org.certificateservices.messages

Class DummyMessageSecurityProvider

java.lang.Object

org.certificateservices.messages.DummyMessageSecurityProvider

All Implemented Interfaces:

ContextMessageSecurityProvider, MessageSecurityProvider

public class DummyMessageSecurityProvider
extends java.lang.Object
implements ContextMessageSecurityProvider

Dummy PKI Message Security Provider returning a self-signed certificate used for testing.

Nested Class Summary

Nested classes/interfaces inherited from interface org.certificateservices.messages.ContextMessageSecurityProvider

ContextMessageSecurityProvider.Context

Field Summary

Fields inherited from interface org.certificateservices.messages.ContextMessageSecurityProvider

DEFAULT_CONTEXT

Fields inherited from interface org.certificateservices.messages.MessageSecurityProvider

DEFAULT_DECRYPTIONKEY

Constructor Summary

Constructors

Constructor	Description
DummyMessageSecurityProvider()

Method Summary

Modifier and Type	Method	Description
java.security.cert.X509Certificate	getDecryptionCertificate(java.lang.String keyId)	Fetches the decryption certificate of related key id.
java.security.cert.X509Certificate	getDecryptionCertificate(ContextMessageSecurityProvider.Context context, java.lang.String keyId)	Fetches the decryption certificate of related key id.
java.security.cert.X509Certificate[]	getDecryptionCertificateChain(java.lang.String keyId)	Fetches the decryption certificate chain of related key id can be one or more in size..
java.security.cert.X509Certificate[]	getDecryptionCertificateChain(ContextMessageSecurityProvider.Context context, java.lang.String keyId)	Fetches the decryption certificate chain of related key id can be one or more in size.
java.security.PrivateKey	getDecryptionKey(java.lang.String keyId)	Fetches a private key given it's unique identifier.
java.security.PrivateKey	getDecryptionKey(ContextMessageSecurityProvider.Context context, java.lang.String keyId)	Fetches a private key given it's unique identifier.
java.util.Set<java.lang.String>	getDecryptionKeyIds()	Returns key identifiers of all available decryption keys.
java.util.Set<java.lang.String>	getDecryptionKeyIds(ContextMessageSecurityProvider.Context context)	Returns key identifiers of all available decryption keys.
EncryptionAlgorithmScheme	getEncryptionAlgorithmScheme()	Method to fetch the EncryptionAlgorithmScheme to use when encrypting messages.
EncryptionAlgorithmScheme	getEncryptionAlgorithmScheme(ContextMessageSecurityProvider.Context context)	Method to fetch the EncryptionAlgorithmScheme to use when encrypting messages.
java.lang.String	getOrganisationCalled()
java.lang.String	getProvider()	Method to retrieve JCE provider that should be used with keys provided by this provider.
java.lang.String	getProvider(ContextMessageSecurityProvider.Context context)	Method to retrieve JCE provider that should be used with keys provided by this provider.
SigningAlgorithmScheme	getSigningAlgorithmScheme()	Method to fetch the SigningAlgorithmScheme to use when signing messages.
SigningAlgorithmScheme	getSigningAlgorithmScheme(ContextMessageSecurityProvider.Context context)	Method to fetch the SigningAlgorithmScheme to use when signing messages.
java.security.cert.X509Certificate	getSigningCertificate()	Fetches the signing certificate used to create the digital signatures of the XML file.
java.security.cert.X509Certificate	getSigningCertificate(ContextMessageSecurityProvider.Context context)	Fetches the signing certificate used to create the digital signatures of the XML file.
java.security.PrivateKey	getSigningKey()	Method fetching the signing key from the dummy keystore.
java.security.PrivateKey	getSigningKey(ContextMessageSecurityProvider.Context context)	Fetches the signing key used to create the digital signatures of the XML file.
boolean	getValidCallDone()
boolean	isValidAndAuthorized(java.security.cert.X509Certificate signCertificate, java.lang.String organisation)	Method in charge of validating a certificate used to sign a PKI message and also check if the certificate is authorized to generate messages.
boolean	isValidAndAuthorized(ContextMessageSecurityProvider.Context context, java.security.cert.X509Certificate signCertificate, java.lang.String organisation)	Method in charge of validating a certificate used to sign a PKI message and also check if the certificate is authorized to generate messages.
void	resetCounters()

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyMessageSecurityProvider

public DummyMessageSecurityProvider()

Method Detail

getSigningKey

public java.security.PrivateKey getSigningKey()
                                       throws MessageProcessingException

Method fetching the signing key from the dummy keystore.

Specified by:

getSigningKey in interface MessageSecurityProvider

Returns:

the signing key used.

Throws:

MessageProcessingException - if key isn't accessible or activated.

See Also:

MessageSecurityProvider.getSigningKey()

getSigningKey

public java.security.PrivateKey getSigningKey(ContextMessageSecurityProvider.Context context)
                                       throws MessageProcessingException

Description copied from interface: ContextMessageSecurityProvider

Fetches the signing key used to create the digital signatures of the XML file.

Specified by:

getSigningKey in interface ContextMessageSecurityProvider

Parameters:

context - the related context, null for default context.

Returns:

the signing key used.

Throws:

MessageProcessingException - if key isn't accessible or activated.

getSigningCertificate

public java.security.cert.X509Certificate getSigningCertificate()
                                                         throws java.lang.IllegalArgumentException,
                                                                MessageProcessingException

Description copied from interface: MessageSecurityProvider

Fetches the signing certificate used to create the digital signatures of the XML file.

Specified by:

getSigningCertificate in interface MessageSecurityProvider

Returns:

the signing certificate used.

Throws:

MessageProcessingException - if certificate isn't accessible.

java.lang.IllegalArgumentException

See Also:

MessageSecurityProvider.getSigningCertificate()

getSigningCertificate

public java.security.cert.X509Certificate getSigningCertificate(ContextMessageSecurityProvider.Context context)
                                                         throws MessageProcessingException

Description copied from interface: ContextMessageSecurityProvider

Fetches the signing certificate used to create the digital signatures of the XML file.

Specified by:

getSigningCertificate in interface ContextMessageSecurityProvider

Parameters:

context - the related context, null for default context.

Returns:

the signing certificate used.

Throws:

MessageProcessingException - if certificate isn't accessible.

isValidAndAuthorized

public boolean isValidAndAuthorized(java.security.cert.X509Certificate signCertificate,
                                    java.lang.String organisation)
                             throws java.lang.IllegalArgumentException,
                                    MessageProcessingException

Description copied from interface: MessageSecurityProvider

Method in charge of validating a certificate used to sign a PKI message and also check if the certificate is authorized to generate messages.

Specified by:

isValidAndAuthorized in interface MessageSecurityProvider

Parameters:

signCertificate - the certificate used to sign the message.

organisation - the related organisation to the message, null if no organisation lookup should be done.

Returns:

true if the sign certificate is valid and authorized to sign messages.

Throws:

java.lang.IllegalArgumentException - if arguments were invalid.

MessageProcessingException - if internal error occurred validating the certificate.

See Also:

MessageSecurityProvider.isValidAndAuthorized(X509Certificate, String)

isValidAndAuthorized

public boolean isValidAndAuthorized(ContextMessageSecurityProvider.Context context,
                                    java.security.cert.X509Certificate signCertificate,
                                    java.lang.String organisation)
                             throws java.lang.IllegalArgumentException,
                                    MessageProcessingException

Description copied from interface: ContextMessageSecurityProvider

Method in charge of validating a certificate used to sign a PKI message and also check if the certificate is authorized to generate messages.

Specified by:

isValidAndAuthorized in interface ContextMessageSecurityProvider

Parameters:

context - the related context, null for default context.

signCertificate - the certificate used to sign the message.

organisation - the related organisation to the message, null if no organisation lookup should be done.

Returns:

true if the sign certificate is valid and authorized to sign messages.

Throws:

java.lang.IllegalArgumentException - if arguments were invalid.

MessageProcessingException - if internal error occurred validating the certificate.

resetCounters

public void resetCounters()

getValidCallDone

public boolean getValidCallDone()

getOrganisationCalled

public java.lang.String getOrganisationCalled()

getDecryptionKey

public java.security.PrivateKey getDecryptionKey(java.lang.String keyId)
                                          throws MessageProcessingException

Description copied from interface: MessageSecurityProvider

Fetches a private key given it's unique identifier.

Specified by:

getDecryptionKey in interface MessageSecurityProvider

Parameters:

keyId - unique identifier of the key, if null should a default key be retrieved

Returns:

the related decryption key.

Throws:

MessageProcessingException

getDecryptionKey

public java.security.PrivateKey getDecryptionKey(ContextMessageSecurityProvider.Context context,
                                                 java.lang.String keyId)
                                          throws MessageProcessingException

Description copied from interface: ContextMessageSecurityProvider

Fetches a private key given it's unique identifier.

Specified by:

getDecryptionKey in interface ContextMessageSecurityProvider

Parameters:

context - the related context, null for default context.

keyId - unique identifier of the key, if null should a default key be retrieved

Returns:

the related decryption key.

Throws:

MessageProcessingException

getDecryptionCertificate

public java.security.cert.X509Certificate getDecryptionCertificate(java.lang.String keyId)
                                                            throws MessageProcessingException

Description copied from interface: MessageSecurityProvider

Fetches the decryption certificate of related key id.

Specified by:

getDecryptionCertificate in interface MessageSecurityProvider

Parameters:

keyId - unique identifier of the key, if null should a default key certificate be retrieved

Returns:

the related decryption certificate.

Throws:

MessageProcessingException - if certificate isn't accessible.

getDecryptionCertificate

public java.security.cert.X509Certificate getDecryptionCertificate(ContextMessageSecurityProvider.Context context,
                                                                   java.lang.String keyId)
                                                            throws MessageProcessingException

Description copied from interface: ContextMessageSecurityProvider

Fetches the decryption certificate of related key id.

Specified by:

getDecryptionCertificate in interface ContextMessageSecurityProvider

Parameters:

context - the related context, null for default context.

keyId - unique identifier of the key, if null should a default key certificate be retrieved

Returns:

the related decryption certificate.

Throws:

MessageProcessingException - if certificate isn't accessible.

getDecryptionCertificateChain

public java.security.cert.X509Certificate[] getDecryptionCertificateChain(java.lang.String keyId)
                                                                   throws MessageProcessingException

Description copied from interface: MessageSecurityProvider

Fetches the decryption certificate chain of related key id can be one or more in size..

Specified by:

getDecryptionCertificateChain in interface MessageSecurityProvider

Parameters:

keyId - unique identifier of the key, if null should a default key certificate be retrieved

Returns:

the related decryption certificate chain

Throws:

MessageProcessingException - if certificate isn't accessible.

getDecryptionCertificateChain

public java.security.cert.X509Certificate[] getDecryptionCertificateChain(ContextMessageSecurityProvider.Context context,
                                                                          java.lang.String keyId)
                                                                   throws MessageProcessingException

Description copied from interface: ContextMessageSecurityProvider

Fetches the decryption certificate chain of related key id can be one or more in size.

Specified by:

getDecryptionCertificateChain in interface ContextMessageSecurityProvider

Parameters:

context - the related context, null for default context.

keyId - unique identifier of the key, if null should a default key certificate be retrieved

Returns:

the related decryption certificate chain

Throws:

MessageProcessingException - if certificate isn't accessible.

getDecryptionKeyIds

public java.util.Set<java.lang.String> getDecryptionKeyIds()
                                                    throws MessageProcessingException

Description copied from interface: MessageSecurityProvider

Returns key identifiers of all available decryption keys.

Specified by:

getDecryptionKeyIds in interface MessageSecurityProvider

Returns:

key identifiers of all available decryption keys.

Throws:

MessageProcessingException

getDecryptionKeyIds

public java.util.Set<java.lang.String> getDecryptionKeyIds(ContextMessageSecurityProvider.Context context)
                                                    throws MessageProcessingException

Description copied from interface: ContextMessageSecurityProvider

Returns key identifiers of all available decryption keys.

Specified by:

getDecryptionKeyIds in interface ContextMessageSecurityProvider

Parameters:

context - the related context, null for default context.

Returns:

key identifiers of all available decryption keys.

Throws:

MessageProcessingException

getEncryptionAlgorithmScheme

public EncryptionAlgorithmScheme getEncryptionAlgorithmScheme()
                                                       throws MessageProcessingException

Description copied from interface: MessageSecurityProvider

Method to fetch the EncryptionAlgorithmScheme to use when encrypting messages.

Specified by:

getEncryptionAlgorithmScheme in interface MessageSecurityProvider

Returns:

Configured EncryptionAlgorithmScheme to use.

Throws:

MessageProcessingException - if internal error determining algorithm scheme to use

getEncryptionAlgorithmScheme

public EncryptionAlgorithmScheme getEncryptionAlgorithmScheme(ContextMessageSecurityProvider.Context context)
                                                       throws MessageProcessingException

Description copied from interface: ContextMessageSecurityProvider

Method to fetch the EncryptionAlgorithmScheme to use when encrypting messages.

Specified by:

getEncryptionAlgorithmScheme in interface ContextMessageSecurityProvider

Returns:

Configured EncryptionAlgorithmScheme to use.

Throws:

MessageProcessingException - if internal error determining algorithm scheme to use

getSigningAlgorithmScheme

public SigningAlgorithmScheme getSigningAlgorithmScheme()
                                                 throws MessageProcessingException

Description copied from interface: MessageSecurityProvider

Method to fetch the SigningAlgorithmScheme to use when signing messages.

Specified by:

getSigningAlgorithmScheme in interface MessageSecurityProvider

Returns:

Configured SigningAlgorithmScheme to use.

Throws:

MessageProcessingException - if internal error determining algorithm scheme to use

getProvider

public java.lang.String getProvider()

Method to retrieve JCE provider that should be used with keys provided by this provider.

Specified by:

getProvider in interface MessageSecurityProvider

Returns:

name of an JCE Provider that should be installed prior to usage of this MessageSecurityProvider if null should the JRE configured list of security providers be used.

getSigningAlgorithmScheme

public SigningAlgorithmScheme getSigningAlgorithmScheme(ContextMessageSecurityProvider.Context context)
                                                 throws MessageProcessingException

Description copied from interface: ContextMessageSecurityProvider

Method to fetch the SigningAlgorithmScheme to use when signing messages.

Specified by:

getSigningAlgorithmScheme in interface ContextMessageSecurityProvider

Parameters:

context - the related context, null for default context.

Returns:

Configured SigningAlgorithmScheme to use.

Throws:

MessageProcessingException - if internal error determining algorithm scheme to use

getProvider

public java.lang.String getProvider(ContextMessageSecurityProvider.Context context)

Method to retrieve JCE provider that should be used with keys provided by this provider.

Specified by:

getProvider in interface ContextMessageSecurityProvider

Returns:

name of an JCE Provider that should be installed prior to usage of this MessageSecurityProvider if null should the JRE configured list of security providers be used.