info.pppc.base.security

Interface IKeyStore

All Known Implementing Classes:

GAMBASKeyStore

public interface IKeyStore

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addCertificate(ICertificate cert) Adds a certificate to the store.
void	addKey(SystemID system, ISymmetricKey hmacSymmetricKey, ISymmetricKey aesSymmetricKey, long time) Adds a session key to the key store.
boolean	createKey(SystemID system) Creates a new session key for the specified system.
boolean	existCertificate(ICertificate cert) Checks if the certificate already is contained in the key store.
ICertificate	getCertificate(java.lang.String subject) Returns the certificate that has been issued to the specified subject or null if there is none.
ICertificate	getCertificate(SystemID id) Returns the certificate that has the specified system id.
ISymmetricKey	getEncryptionKey(SystemID system) Returns the encryption key for the specified system or null if there is none.
ICertificate	getOwnCertificate()
ISymmetricKey	getSignatureKey(SystemID system) Returns the signature key for the specified system or null if there is none.
boolean	removeCertificate(ICertificate cert) Removes the specified certificate from the store.
boolean	removeKey(SystemID system) Removes the session key for the specified system from the store.

Method Detail

getOwnCertificate

ICertificate getOwnCertificate()

existCertificate

boolean existCertificate(ICertificate cert)

Checks if the certificate already is contained in the key store.

Parameters:

cert - The certificate to check for.

Returns:

True, if the certificate is contained and would be used for communication, false otherwise.

addCertificate

boolean addCertificate(ICertificate cert)

Adds a certificate to the store. The add operation will not validate the certificate but it will simply add it. Make sure to call the validate method before adding it to ensure that the certificate can be trusted.

Parameters:

certificate - The certificate to add.

Throws:

java.lang.IllegalArgumentException - Thrown if the key store contains already a different certificate for the same subject.

removeCertificate

boolean removeCertificate(ICertificate cert)

Removes the specified certificate from the store.

Parameters:

certificate - The certificate that shall be removed.

Returns:

True if the certificate has been removed, false if the certificate was not installed at the key store.

getCertificate

ICertificate getCertificate(SystemID id)

Returns the certificate that has the specified system id.

Parameters:

systemID - The system id of the certificate.

Returns:

The certificate with the specified system id or null if there is no such certificate.

getCertificate

ICertificate getCertificate(java.lang.String subject)

Returns the certificate that has been issued to the specified subject or null if there is none.

Parameters:

subject - The subject to lookup.

Returns:

The certificate for the subject or null if the key store does not contain a certificate for the specified subject.

addKey

void addKey(SystemID system,
          ISymmetricKey hmacSymmetricKey,
          ISymmetricKey aesSymmetricKey,
          long time)

Adds a session key to the key store.

Parameters:

system - The system id of the system that shares the key.

signature - The signature key.

encryption - The encryption key.

timestamp - The time stamp of the key, use ISymmetricKey.TIMESTAMP_MANUAL for manual created, long persistence keys.

getSignatureKey

ISymmetricKey getSignatureKey(SystemID system)

Returns the signature key for the specified system or null if there is none.

Parameters:

system - The system to search for.

Returns:

The signature key or null if there is none.

getEncryptionKey

ISymmetricKey getEncryptionKey(SystemID system)

Returns the encryption key for the specified system or null if there is none.

Parameters:

system - The system to search for.

Returns:

The encryption key or null if there is none.

createKey

boolean createKey(SystemID system)

Creates a new session key for the specified system. Note that a key will not be established if a manually configured key is available.

Parameters:

system - The system with which a key should be established.

Returns:

True if successful (i.e. checks for the encryption key), false otherwise.

removeKey

boolean removeKey(SystemID system)

Removes the session key for the specified system from the store.

Parameters:

system - The system to remove.

Returns:

True if a key has been removed, false otherwise.