#include <SecureStore.h>

Inheritance diagram for SecureStore:

Public Types
typedef struct mbed::KVStore::info	info_t
	Holds key information. More...

Public Member Functions
	SecureStore (KVStore underlying_kv, KVStore rbp_kv=0)
	Class constructor. More...

virtual	~SecureStore ()
	Class destructor. More...

virtual int	init ()
	Initialize SecureStore class. More...

virtual int	deinit ()
	Deinitialize SecureStore class, free handles and memory allocations. More...

virtual int	reset ()
	Reset KVStore contents (clear all keys) Warning: This function is not thread safe. More...

virtual int	set (const char key, const void buffer, size_t size, uint32_t create_flags)
	Set one KVStore item, given key and value. More...

virtual int	get (const char key, void buffer, size_t buffer_size, size_t *actual_size=NULL, size_t offset=0)
	Get one KVStore item, given key. More...

virtual int	get_info (const char key, info_t info)
	Get information of a given key. More...

virtual int	remove (const char *key)
	Remove a KVStore item, given key. More...

virtual int	set_start (set_handle_t handle, const char key, size_t final_data_size, uint32_t create_flags)
	Start an incremental KVStore set sequence. More...

virtual int	set_add_data (set_handle_t handle, const void *value_data, size_t data_size)
	Add data to incremental KVStore set sequence. More...

virtual int	set_finalize (set_handle_t handle)
	Finalize an incremental KVStore set sequence. More...

virtual int	iterator_open (iterator_t it, const char prefix=NULL)
	Start an iteration over KVStore keys. More...

virtual int	iterator_next (iterator_t it, char *key, size_t key_size)
	Get next key in iteration. More...

virtual int	iterator_close (iterator_t it)
	Close iteration. More...

bool	is_valid_key (const char *key) const
	Convenience function for checking key validity. More...

Detailed Description

SecureStore class.

SecureStore is a KVStore-based storage solution, providing security features on the stored data, such as encryption, authentication, rollback protection and write once, over an underlying KVStore class. It references an additional KVStore class for storing the rollback protection keys.

Only available if your device has Flash IAP and a hardware entropy source (TRNG).

Definition at line 60 of file SecureStore.h.

Member Typedef Documentation

◆ info_t

typedef struct mbed::KVStore::info info_t

inherited

Holds key information.

Constructor & Destructor Documentation

◆ SecureStore()

SecureStore	(	KVStore *	underlying_kv,
		KVStore *	rbp_kv = `0`
	)

Class constructor.

Parameters

[in]	underlying_kv	KVStore that will hold the data.
[in]	rbp_kv	Additional KVStore used for rollback protection.

◆ ~SecureStore()

virtual ~SecureStore ( )

virtual

Class destructor.

Member Function Documentation

◆ init()

virtual int init ( )

virtual

Initialize SecureStore class.

It will also initialize the underlying KVStore and the rollback protection KVStore.

Returns: MBED_SUCCESS Success. or any other error from underlying KVStore instances.

Implements KVStore.

◆ deinit()

virtual int deinit ( )

virtual

Deinitialize SecureStore class, free handles and memory allocations.

Returns: MBED_SUCCESS Success. or any other error from underlying KVStore instances.

Implements KVStore.

◆ reset()

virtual int reset ( )

virtual

Reset KVStore contents (clear all keys) Warning: This function is not thread safe.

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. or any other error from underlying KVStore instances.

Implements KVStore.

◆ set()

virtual int set	(	const char *	key,
		const void *	buffer,
		size_t	size,
		uint32_t	create_flags
	)

virtual

Set one KVStore item, given key and value.

Parameters

[in]	key	Key - must not include '*' '/' '?' ':' ';' '\' '"' '\|' ' ' '<' '>' '\'.
[in]	buffer	Value data buffer.
[in]	size	Value data size.
[in]	create_flags	Flag mask - WRITE_ONCE_FLAG\|REQUIRE_CONFIDENTIALITY_FLAG\| REQUIRE_INTEGRITY_FLAG\|REQUIRE_REPLAY_PROTECTION_FLAG

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_READ_FAILED Unable to read from media. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. MBED_ERROR_INVALID_SIZE Invalid size given in function arguments. MBED_ERROR_WRITE_PROTECTED Already stored with "write once" flag. MBED_ERROR_FAILED_OPERATION Internal error. or any other error from underlying KVStore instances.

Implements KVStore.

◆ get()

virtual int get	(	const char *	key,
		void *	buffer,
		size_t	buffer_size,
		size_t *	actual_size = `NULL`,
		size_t	offset = `0`
	)

virtual

Get one KVStore item, given key.

Parameters

[in]	key	Key - must not include '*' '/' '?' ':' ';' '\' '"' '\|' ' ' '<' '>' '\'.
[in]	buffer	Value data buffer.
[in]	buffer_size	Value data buffer size.
[out]	actual_size	Actual read size.
[in]	offset	Offset to read from in data.

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_READ_FAILED Unable to read from media. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. MBED_ERROR_INVALID_SIZE Invalid size given in function arguments. MBED_ERROR_FAILED_OPERATION Internal error. MBED_ERROR_ITEM_NOT_FOUND No such key. MBED_ERROR_AUTHENTICATION_FAILED Data authentication failed. MBED_ERROR_AUTHENTICATION_RBP_FAILED Rollback protection data authentication failed. or any other error from underlying KVStore instances.

Implements KVStore.

◆ get_info()

virtual int get_info	(	const char *	key,
		info_t *	info
	)

virtual

Get information of a given key.

Parameters

[in]	key	Key - must not include '*' '/' '?' ':' ';' '\' '"' '\|' ' ' '<' '>' '\'.
[out]	info	Returned information structure containing size and flags.

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_READ_FAILED Unable to read from media. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. MBED_ERROR_FAILED_OPERATION Internal error. MBED_ERROR_ITEM_NOT_FOUND No such key. MBED_ERROR_AUTHENTICATION_FAILED Data authentication failed. MBED_ERROR_AUTHENTICATION_RBP_FAILED Rollback protection data authentication failed. or any other error from underlying KVStore instances.

Implements KVStore.

◆ remove()

virtual int remove ( const char * key )

virtual

Remove a KVStore item, given key.

Parameters

[in] key Key - must not include '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'.

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_READ_FAILED Unable to read from media. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. MBED_ERROR_WRITE_PROTECTED Already stored with "write once" flag. MBED_ERROR_FAILED_OPERATION Internal error. or any other error from underlying KVStore instances.

Implements KVStore.

◆ set_start()

virtual int set_start	(	set_handle_t *	handle,
		const char *	key,
		size_t	final_data_size,
		uint32_t	create_flags
	)

virtual

Start an incremental KVStore set sequence.

This operation is blocking other operations. Any get/set/remove/iterator operation will be blocked until set_finalize is called.

Parameters

[out]	handle	Returned incremental set handle.
[in]	key	Key - must not include '*' '/' '?' ':' ';' '\' '"' '\|' ' ' '<' '>' '\'.
[in]	final_data_size	Final value data size.
[in]	create_flags	Flag mask - WRITE_ONCE_FLAG\|REQUIRE_CONFIDENTIALITY_FLAG\| REQUIRE_INTEGRITY_FLAG\|REQUIRE_REPLAY_PROTECTION_FLAG

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_READ_FAILED Unable to read from media. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. MBED_ERROR_INVALID_SIZE Invalid size given in function arguments. MBED_ERROR_WRITE_PROTECTED Already stored with "write once" flag. MBED_ERROR_FAILED_OPERATION Internal error. or any other error from underlying KVStore instances.

Implements KVStore.

◆ set_add_data()

virtual int set_add_data	(	set_handle_t	handle,
		const void *	value_data,
		size_t	data_size
	)

virtual

Add data to incremental KVStore set sequence.

This operation is blocking other operations. Any get/set/remove operation will be blocked until set_finalize is called.

Parameters

[in]	handle	Incremental set handle.
[in]	value_data	value data to add.
[in]	data_size	value data size.

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. MBED_ERROR_INVALID_SIZE Invalid size given in function arguments. MBED_ERROR_FAILED_OPERATION Internal error. or any other error from underlying KVStore instances.

Implements KVStore.

◆ set_finalize()

virtual int set_finalize ( set_handle_t handle )

virtual

Finalize an incremental KVStore set sequence.

Parameters

[in] handle Incremental set handle.

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. MBED_ERROR_INVALID_SIZE Invalid size given in function arguments. MBED_ERROR_FAILED_OPERATION Internal error. or any other error from underlying KVStore instances.

Implements KVStore.

◆ iterator_open()

virtual int iterator_open	(	iterator_t *	it,
		const char *	prefix = `NULL`
	)

virtual

Start an iteration over KVStore keys.

There are no issue with any other operation while iterator is open.

Parameters

[out]	it	Returned iterator handle.
[in]	prefix	Key prefix (null for all keys).

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. or any other error from underlying KVStore instances.

Implements KVStore.

◆ iterator_next()

virtual int iterator_next	(	iterator_t	it,
		char *	key,
		size_t	key_size
	)

virtual

Get next key in iteration.

There are no issue with any other operation while iterator is open.

Parameters

[in]	it	Iterator handle.
[in]	key	Buffer for returned key.
[in]	key_size	Key buffer size.

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. or any other error from underlying KVStore instances.

Implements KVStore.

◆ iterator_close()

virtual int iterator_close ( iterator_t it )

virtual

Close iteration.

Returns: MBED_SUCCESS Success. MBED_ERROR_NOT_READY Not initialized. MBED_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments. or any other error from underlying KVStore instances.; 0 on success or a negative error code on failure

Implements KVStore.

◆ is_valid_key()

bool is_valid_key ( const char * key ) const

inherited

Convenience function for checking key validity.

Key must not include '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'.

Parameters

[in] key Key buffer.

Returns: MBED_SUCCESS on success or an error code on failure

Definition at line 208 of file KVStore.h.

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ info_t

Constructor & Destructor Documentation

◆ SecureStore()

◆ ~SecureStore()

Member Function Documentation

◆ init()

◆ deinit()

◆ reset()

◆ set()

◆ get()

◆ get_info()

◆ remove()

◆ set_start()

◆ set_add_data()

◆ set_finalize()

◆ iterator_open()

◆ iterator_next()

◆ iterator_close()

◆ is_valid_key()