com.gemalto.idp.mobile.securestorage

Interface PropertyStorage

public interface PropertyStorage

PropertyStorage represents a storage which can be used to store data in the form of key-value pair. It provides protections on the stored property. PropertyStorage seals the property with a password which is managed by the PasswordManager, as well as the configured device fingerprint.

NOTE: Since the password is managed by the password manager, login is required before using the storage. Default password is supported by Ezio SDK but it is strongly recommended to use a customized password for the SecureStorage.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	close() Close the storage.
void	deleteAllProperties() Delete all the properties from the storage.
void	deleteProperty(byte[] key) Delete a property with given key.
Set<byte[]>	getAllKeys() Get the set of keys for all the properties stored in the storage.
boolean	hasProperty(byte[] key) Check if an entry with the given key exist in the storage.
boolean	isOpen() Check if the storage is open.
void	open() Open the storage.
SecureByteArray	readProperty(byte[] key) Read property from the storage.
void	writeProperty(byte[] key, SecureByteArray value, boolean wipeValue) Store a property into the storage.

Method Detail

open

void open()
   throws PasswordManagerException,
          DeviceFingerprintException,
          IdpSecureStorageException

Open the storage. This has to be called before retrieving or updating the property in the storage.

Throws:

PasswordManagerException - thrown when user has not logged in for SecureStorage domain.

DeviceFingerprintException - thrown when there is an failure in reading or verifying device fingerprint.

IdpSecureStorageException - thrown when storage operation failed.

Since:

4.0

isOpen

boolean isOpen()
        throws IdpSecureStorageException

Check if the storage is open.

Returns:

true if storage is open.

Throws:

IdpSecureStorageException - thrown when storage operation failed.

Since:

4.0

getAllKeys

Set<byte[]> getAllKeys()
                throws IdpSecureStorageException

Get the set of keys for all the properties stored in the storage.

Returns:

Set of existing keys

Throws:

IdpSecureStorageException - thrown when storage operation failed.

Since:

4.0

hasProperty

boolean hasProperty(byte[] key)
             throws IdpSecureStorageException

Check if an entry with the given key exist in the storage.

Parameters:

key - the identifier of a property.

Returns:

true if the property with given key exists.

Throws:

IdpSecureStorageException - thrown when storage operation failed.

Since:

4.0

writeProperty

void writeProperty(byte[] key,
                   SecureByteArray value,
                   boolean wipeValue)
            throws IdpSecureStorageException

Store a property into the storage. If the key already exists, it overwrites the value. Note: It is not recommended to store user PIN/password or other data which are used to provide new factor of authentication.

Parameters:

key - the identifier of a property.

value - in SecureByteArray

wipeValue - if the value is to be wiped after calling the method

Throws:

IdpSecureStorageException - thrown when storage operation failed.

Since:

4.0

readProperty

SecureByteArray readProperty(byte[] key)
                      throws IdpSecureStorageException

Read property from the storage.

Parameters:

key - the identifier of a property.

Returns:

property value in SecureByteArray

Throws:

IdpSecureStorageException - thrown when storage operation failed.

Since:

4.0

deleteProperty

void deleteProperty(byte[] key)
             throws IdpSecureStorageException

Delete a property with given key.

Parameters:

key - the identifier of a property.

Throws:

IdpSecureStorageException - thrown when storage operation failed.

Since:

4.0

deleteAllProperties

void deleteAllProperties()
                  throws IdpSecureStorageException

Delete all the properties from the storage. Resulted in empty storage but the storage table still exists.

Throws:

IdpSecureStorageException - thrown when storage operation failed.

Since:

4.0

close

void close()
    throws IdpSecureStorageException

Close the storage.

Throws:

IdpSecureStorageException - thrown when storage operation failed.

Since:

4.0