You.i Engine
Public Member Functions | List of all members
CYISecureStorageBridge Class Referenceabstract
Platform

Detailed Description

This class is used to securely store a specific key-value pair.

The mechanism for securely storing data is platform-specific. The default platform implementation of this bridge internally uses the CYIPersistentStore to store the data after it has been encrypted. Most implementations use AES256 encryption and requires an encryption key, which should be stored off the device. This bridge is intended to be used by applications which receive a key externally, for example, from a web service.

Note
The value stored must be at least as large as the block size of 16 bytes.
See also
CYIPersistentStore
Note
The key Yi_Reserved_Key is reserved by the implementation for internal use.

#include <platform/YiSecureStorageBridge.h>

Public Member Functions

virtual ~CYISecureStorageBridge ()
 
virtual void StoreValue (const CYIString &rKey, const CYIString &rValue)=0
 
virtual CYIString RetrieveValue (const CYIString &rKey)=0
 
virtual void RemoveValue (const CYIString &rKey)=0
 
virtual void SetEncryptionKey (const CYIString &rEncryptionKey)=0
 

Constructor & Destructor Documentation

virtual CYISecureStorageBridge::~CYISecureStorageBridge ( )
inlinevirtual

Member Function Documentation

virtual void CYISecureStorageBridge::RemoveValue ( const CYIString &  rKey)
pure virtual

Remove the value and its associated rKey from secure storage.

virtual CYIString CYISecureStorageBridge::RetrieveValue ( const CYIString &  rKey)
pure virtual

Retrieve any previously stored value associated with this rKey from secure storage. An empty string will be returned if the key is not found in secure storage.

virtual void CYISecureStorageBridge::SetEncryptionKey ( const CYIString &  rEncryptionKey)
pure virtual

Set the rEncryptionKey used for the secure storage encryption.

Note
This key is cached in memory to be saved between app startup but not when app is deleted
If you want to clear the key, send in a null string
virtual void CYISecureStorageBridge::StoreValue ( const CYIString &  rKey,
const CYIString &  rValue 
)
pure virtual

Store a single rValue associated with the rKey in secure storage.

The documentation for this class was generated from the following file: