org.intellimate.izou.security.storage

Class SecureStorage

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.security.storage.SecureStorage

All Implemented Interfaces:

Identifiable, MainProvider

public final class SecureStorage
extends IzouModule

The SecureStorage class offers a way for addOns to store data so that other addOns cannot access it. For example if addOn A wants to store the users username and password to some service, it can do so using this class without any other addOn having access to that information.

While the stored information is encrypted, it is not safe from the user. In theory and with a lot of effort, the user could extract the keys and decrypt the stored information since the keys are not hidden from the user (only from addOns).

Field Summary

Fields inherited from class org.intellimate.izou.util.IzouModule

log, main

Constructor Summary

Constructors

Constructor and Description
SecureStorage(Main main) Creates a new SecureStorage instance if and only if none has been created yet

Method Summary

Modifier and Type	Method and Description
static SecureStorage	createSecureStorage(Main main) Creates an SecureStorage.
static SecureStorage	getInstance() Gets the instance of the secure storage object or null if it has not been created yet
SecureContainer	retrieve(ro.fortsoft.pf4j.PluginDescriptor descriptor) Retrieves a SecureContainer with the given secure ID of the plugin descriptor
void	store(ro.fortsoft.pf4j.PluginDescriptor descriptor, SecureContainer container) Stores a SecureContainer with the given secure ID of the plugin descriptor.

Methods inherited from class org.intellimate.izou.util.IzouModule

debug, debug, error, error, fatal, fatal, getID, getMain

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Constructor Detail

SecureStorage

public SecureStorage(Main main)
              throws IllegalAccessException,
                     NullPointerException

Creates a new SecureStorage instance if and only if none has been created yet

Parameters:

main - the main instance of izou

Throws:

IllegalAccessException - thrown if this method is called more than once

NullPointerException

Method Detail

createSecureStorage

public static SecureStorage createSecureStorage(Main main)
                                         throws IllegalAccessException

Creates an SecureStorage. There can only be one single SecureStorage, so calling this method twice will cause an illegal access exception.

Parameters:

main - the main instance of izou

Returns:

a SecureAccess object

Throws:

IllegalAccessException - thrown if this method is called more than once

getInstance

public static SecureStorage getInstance()

Gets the instance of the secure storage object or null if it has not been created yet

Returns:

the instance of the secure storage object or null if it has not been created yet

store

public void store(ro.fortsoft.pf4j.PluginDescriptor descriptor,
                  SecureContainer container)

Stores a SecureContainer with the given secure ID of the plugin descriptor. Each addOn can only have 1 secure container, so in order to update it, retrieve it and store it again.

Parameters:

descriptor - The plugin descriptor belonging to an addOn

container - The secure container to be stored with an addOn

retrieve

public SecureContainer retrieve(ro.fortsoft.pf4j.PluginDescriptor descriptor)

Retrieves a SecureContainer with the given secure ID of the plugin descriptor

Parameters:

descriptor - The plugin descriptor belonging to an addOn

Returns:

container The secure container that was retrieved