eu.h2020.helios_social.core.security

Interface HeliosKeyStore

All Known Implementing Classes:

HeliosKeyStoreManager

public interface HeliosKeyStore

Interface class for HELIOS key storage operations

Method Summary

Modifier and Type	Method and Description
void	deleteAlias(java.lang.String alias) Delete an item in the key store.
java.lang.String[]	getAliases() Get the aliases (names) of all items in the key store.
java.security.cert.Certificate	retrieveCertificate(java.lang.String alias, java.lang.String passPhrase) Retrieves a certificate from the key store.
java.security.PrivateKey	retrievePrivateKey(java.lang.String alias, java.lang.String passPhrase) Retrieves a private RSA key from the key store.
javax.crypto.SecretKey	retrieveSecretKey(java.lang.String alias, java.lang.String passPhrase) Retrieves an AES key from the key store.
void	storeCertificate(java.security.cert.Certificate cert, java.lang.String alias, java.lang.String passPhrase) Stores a certificate to the key store.
void	storePrivateKey(java.security.PrivateKey rsaKey, java.lang.String alias, java.lang.String passPhrase) Stores a private RSA key (and a self signed certificate) to the key store.
void	storeSecretKey(javax.crypto.SecretKey aesKey, java.lang.String alias, java.lang.String passPhrase) Stores an AES key to the key store.

Method Detail

storeSecretKey

void storeSecretKey(javax.crypto.SecretKey aesKey,
                    java.lang.String alias,
                    java.lang.String passPhrase)
             throws HeliosKeyStoreException

Stores an AES key to the key store. The key is issued a name and a password that are required when retrieving the key.

Parameters:

aesKey - The key to be stored SecretKey

alias - The name assigned for the key

passPhrase - The password for the key

Throws:

HeliosKeyStoreException - if the operation fails.

retrieveSecretKey

javax.crypto.SecretKey retrieveSecretKey(java.lang.String alias,
                                         java.lang.String passPhrase)
                                  throws HeliosKeyStoreException

Retrieves an AES key from the key store.

Parameters:

alias - The name of the key

passPhrase - The password of the key

Returns:

The AES key SecretKey

Throws:

HeliosKeyStoreException - if the operation fails.

storePrivateKey

void storePrivateKey(java.security.PrivateKey rsaKey,
                     java.lang.String alias,
                     java.lang.String passPhrase)
              throws HeliosKeyStoreException

Stores a private RSA key (and a self signed certificate) to the key store. The key is issued a name and a password that are required when retrieving the key.

Parameters:

rsaKey - The RSA key that is to be stored PrivateKey

alias - The name assigned for the key

passPhrase - The password for the key

Throws:

HeliosKeyStoreException - if the operation fails.

retrievePrivateKey

java.security.PrivateKey retrievePrivateKey(java.lang.String alias,
                                            java.lang.String passPhrase)
                                     throws HeliosKeyStoreException

Retrieves a private RSA key from the key store.

Parameters:

alias - The name of the key

passPhrase - The password of the key

Returns:

The private RSA key PrivateKey

Throws:

HeliosKeyStoreException - if the operation fails.

storeCertificate

void storeCertificate(java.security.cert.Certificate cert,
                      java.lang.String alias,
                      java.lang.String passPhrase)
               throws HeliosKeyStoreException

Stores a certificate to the key store. The certificate is issued a name and a password that are required when retrieving the certificate.

Parameters:

cert - The certificate to be stored Certificate

alias - The name assigned for the certificate

passPhrase - The password for the certificate

Throws:

HeliosKeyStoreException - if the operation fails.

retrieveCertificate

java.security.cert.Certificate retrieveCertificate(java.lang.String alias,
                                                   java.lang.String passPhrase)
                                            throws HeliosKeyStoreException

Retrieves a certificate from the key store.

Parameters:

alias - The name of the certificate

passPhrase - The password of the certificate

Returns:

The certificate Certificate

Throws:

HeliosKeyStoreException - if the operation fails.

getAliases

java.lang.String[] getAliases()
                       throws HeliosKeyStoreException

Get the aliases (names) of all items in the key store.

Returns:

The aliases of all items in the key store

Throws:

HeliosKeyStoreException - if the operation fails.

deleteAlias

void deleteAlias(java.lang.String alias)
          throws HeliosKeyStoreException

Delete an item in the key store.

Parameters:

alias - The name of the item to be deleted from the key store

Throws:

HeliosKeyStoreException