le_secStore_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	LE_SECSTORE_MAX_NAME_SIZE   255
#define	LE_SECSTORE_MAX_ITEM_SIZE   8192

Functions
void	le_secStore_ConnectService (void)
void	le_secStore_DisconnectService (void)
le_result_t	le_secStore_Write (const char *name, const uint8_t *bufPtr, size_t bufNumElements)
le_result_t	le_secStore_Read (const char *name, uint8_t *bufPtr, size_t *bufNumElementsPtr)
le_result_t	le_secStore_Delete (const char *name)

Detailed Description

Legato Secure Storage API

Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.

Macro Definition Documentation

#define LE_SECSTORE_MAX_ITEM_SIZE   8192

Maximum number of bytes for each item in secure storage.

#define LE_SECSTORE_MAX_NAME_SIZE   255

Maximum number of characters permited for a secure storage item name.

Function Documentation

void le_secStore_ConnectService

(

void

)

Connect the client to the service

le_result_t le_secStore_Delete

(

const char *

name

)

Deletes an item from secure storage.

Returns

LE_OK if successful. LE_NOT_FOUND if the item doesn't exist. LE_UNAVAILABLE if the secure storage is currently unavailable.

Parameters

[in]

name

Name of the secure storage item.

void le_secStore_DisconnectService

(

void

)

Disconnect the client from the service

le_result_t le_secStore_Read	(	const char *	name,
		uint8_t *	bufPtr,
		size_t *	bufNumElementsPtr
	)

Reads an item from secure storage.

Returns

LE_OK if successful. LE_OVERFLOW if the buffer is too small to hold the entire item. No data will be written to the buffer in this case. LE_NOT_FOUND if the item doesn't exist. LE_UNAVAILABLE if the secure storage is currently unavailable.

Parameters

[in]	name	Name of the secure storage item.
[out]	bufPtr	Buffer to store the data in.
[in,out]	bufNumElementsPtr

le_result_t le_secStore_Write	(	const char *	name,
		const uint8_t *	bufPtr,
		size_t	bufNumElements
	)

Writes an item to secure storage. If the item already exists, it'll be overwritten with the new value. If the item doesn't already exist, it'll be created.

Returns

LE_OK if successful. LE_NO_MEMORY if there isn't enough memory to store the item. LE_UNAVAILABLE if the secure storage is currently unavailable.

Parameters

[in]	name	Name of the secure storage item.
[in]	bufPtr	Buffer contain the data to store.
[in]	bufNumElements