eu.h2020.helios_social.core.security

Class HeliosKeyStoreManager

java.lang.Object

eu.h2020.helios_social.core.security.HeliosKeyStoreManager

All Implemented Interfaces:

HeliosKeyStore

public class HeliosKeyStoreManager
extends java.lang.Object
implements HeliosKeyStore

HELIOS key storage class implementation for HeliosKeyStore.

Constructor Summary

Constructors

Constructor and Description
HeliosKeyStoreManager(android.content.Context context) Constructor.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeliosKeyStoreManager

public HeliosKeyStoreManager(android.content.Context context)

Constructor.

Parameters:

context - Context to be used in operations.

Method Detail

storeSecretKey

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

Description copied from interface: HeliosKeyStore

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

Specified by:

storeSecretKey in interface HeliosKeyStore

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

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

Description copied from interface: HeliosKeyStore

Retrieves an AES key from the key store.

Specified by:

retrieveSecretKey in interface HeliosKeyStore

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

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

Description copied from interface: HeliosKeyStore

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.

Specified by:

storePrivateKey in interface HeliosKeyStore

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

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

Description copied from interface: HeliosKeyStore

Retrieves a private RSA key from the key store.

Specified by:

retrievePrivateKey in interface HeliosKeyStore

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

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

Description copied from interface: HeliosKeyStore

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

Specified by:

storeCertificate in interface HeliosKeyStore

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

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

Description copied from interface: HeliosKeyStore

Retrieves a certificate from the key store.

Specified by:

retrieveCertificate in interface HeliosKeyStore

Parameters:

alias - The name of the certificate

passPhrase - The password of the certificate

Returns:

The certificate Certificate

Throws:

HeliosKeyStoreException - if the operation fails.

getAliases

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

Description copied from interface: HeliosKeyStore

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

Specified by:

getAliases in interface HeliosKeyStore

Returns:

The aliases of all items in the key store

Throws:

HeliosKeyStoreException - if the operation fails.

deleteAlias

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

Description copied from interface: HeliosKeyStore

Delete an item in the key store.

Specified by:

deleteAlias in interface HeliosKeyStore

Parameters:

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

Throws:

HeliosKeyStoreException