le_secStore API Reference
Files | |
| file | le_secStore_common.h |
| file | le_secStore_interface.h |
Macros | |
| #define | LE_SECSTORE_MAX_NAME_SIZE 255 |
| #define | LE_SECSTORE_MAX_NAME_BYTES 256 |
| #define | LE_SECSTORE_MAX_ITEM_SIZE 8192 |
Typedefs | |
| typedef void(* | le_secStore_DisconnectHandler_t) (void *) |
Enumerations | |
| enum | le_secStore_Version_t { LE_SECSTORE_VERSION_SFS = 0, LE_SECSTORE_VERSION_TZ = 1, LE_SECSTORE_VERSION_IKS = 2 } |
Functions | |
| void | le_secStore_ConnectService (void) |
| le_result_t | le_secStore_TryConnectService (void) |
| LE_FULL_API void | le_secStore_SetServerDisconnectHandler (le_secStore_DisconnectHandler_t disconnectHandler, void *contextPtr) |
| void | le_secStore_DisconnectService (void) |
| le_result_t | le_secStore_Write (const char *LE_NONNULL name, const uint8_t *bufPtr, size_t bufSize) |
| le_result_t | le_secStore_Read (const char *LE_NONNULL name, uint8_t *bufPtr, size_t *bufSizePtr) |
| le_result_t | le_secStore_Delete (const char *LE_NONNULL name) |
| le_result_t | le_secStore_GetMinimumBufferSize (const char *LE_NONNULL path, uint32_t *sizePtr) |
| le_result_t | le_secStore_StartBatchWrite (void) |
| le_result_t | le_secStore_EndBatchWrite (void) |
Detailed Description
Macro Definition Documentation
◆ LE_SECSTORE_MAX_ITEM_SIZE
| #define LE_SECSTORE_MAX_ITEM_SIZE 8192 |
Maximum number of bytes for each item in secure storage.
◆ LE_SECSTORE_MAX_NAME_SIZE
| #define LE_SECSTORE_MAX_NAME_SIZE 255 |
Maximum number of characters and byte storage size permitted for a secure storage item name.
Typedef Documentation
◆ le_secStore_DisconnectHandler_t
| typedef void(* le_secStore_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
Enumeration Type Documentation
◆ le_secStore_Version_t
Function Documentation
◆ le_secStore_ConnectService()
| void le_secStore_ConnectService | ( | void | ) |
Connect the current client thread to the service providing this API. Block until the service is available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client Specific Functions.
This function is created automatically.
◆ le_secStore_Delete()
| le_result_t le_secStore_Delete | ( | const char *LE_NONNULL | name | ) |
Deletes an item from secure storage. If the item name is not valid, this function will kill the calling client.
- Returns
- LE_OK if successful. LE_NOT_FOUND if the item doesn't exist. LE_UNAVAILABLE if the secure storage is currently unavailable. LE_FAULT if there was some other error.
- Parameters
-
[in] name Name of the secure storage item.
◆ le_secStore_DisconnectService()
| void le_secStore_DisconnectService | ( | void | ) |
Disconnect the current client thread from the service providing this API.
Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client Specific Functions.
This function is created automatically.
◆ le_secStore_EndBatchWrite()
| le_result_t le_secStore_EndBatchWrite | ( | void | ) |
Ends the "batch write" operation and serializes the data to the persistent storage.
- Note
- - Failure to finish the (previously started) batch write may result in data loss.
- This is not a transactional mechanism, i.e. the possibility to roll back the changes is not provided.
- Returns
- LE_OK if successful. LE_FAULT if there was error.
◆ le_secStore_GetMinimumBufferSize()
| le_result_t le_secStore_GetMinimumBufferSize | ( | const char *LE_NONNULL | path, |
| uint32_t * | sizePtr | ||
| ) |
Gets the size of the buffer required to read an item from the secure storage. It can be actual size of the data, or some slightly greater number.
- Returns
- LE_OK if successful. LE_NOT_FOUND if the path doesn't exist. LE_UNAVAILABLE if the secure storage is currently unavailable. LE_FAULT if there was some other error.
- Parameters
-
[in] path Path of the secure storage item. [out] sizePtr Number that is equal to or greater than the size of the item, in bytes.
◆ le_secStore_Read()
| le_result_t le_secStore_Read | ( | const char *LE_NONNULL | name, |
| uint8_t * | bufPtr, | ||
| size_t * | bufSizePtr | ||
| ) |
Reads an item from secure storage. If the item name is not valid or the buffer is NULL, this function will kill the calling client.
- 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. LE_FAULT if there was some other error.
- Parameters
-
[in] name Name of the secure storage item. [out] bufPtr Buffer to store the data in. [in,out] bufSizePtr
◆ le_secStore_SetServerDisconnectHandler()
| LE_FULL_API void le_secStore_SetServerDisconnectHandler | ( | le_secStore_DisconnectHandler_t | disconnectHandler, |
| void * | contextPtr | ||
| ) |
Set handler called when server disconnection is detected.
When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.
◆ le_secStore_StartBatchWrite()
| le_result_t le_secStore_StartBatchWrite | ( | void | ) |
Start the "batch write" that aggregates multiple write/delete operation into a single batch with the purpose of improving the performance.
The performance is optimized by postponing the data serialization (triggered by write/delete API calls by this particular client) until the function EndBatchWrite is called.
- Returns
- LE_OK if successful. LE_FAULT if there was error.
◆ le_secStore_TryConnectService()
| le_result_t le_secStore_TryConnectService | ( | void | ) |
Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client Specific Functions.
This function is created automatically.
- Returns
- LE_OK if the client connected successfully to the service.
- LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
- LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
- LE_COMM_ERROR if the Service Directory cannot be reached.
◆ le_secStore_Write()
| le_result_t le_secStore_Write | ( | const char *LE_NONNULL | name, |
| const uint8_t * | bufPtr, | ||
| size_t | bufSize | ||
| ) |
Version of the SecStore data storage 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. If the item name is not valid or the buffer is NULL, this function will kill the calling client.
- 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. LE_FAULT if there was some other error.
- Parameters
-
[in] name Name of the secure storage item. [in] bufPtr Buffer containing the data to store. [in] bufSize