Go to the source code of this file.
Macros | |
| #define | SECSTOREADMIN_MAX_PATH_SIZE 511 |
| #define | SECSTOREADMIN_MAX_PATH_BYTES 512 |
Typedefs | |
| typedef void(* | secStoreAdmin_DisconnectHandler_t) (void *) |
| typedef struct secStoreAdmin_Iter * | secStoreAdmin_IterRef_t |
Detailed Description
Legato Secure Storage Admin API
Copyright (C) Sierra Wireless Inc.
Macro Definition Documentation
| #define SECSTOREADMIN_MAX_PATH_SIZE 511 |
Maximum number of characters and byte storage size permitted for a path.
Typedef Documentation
| typedef void(* secStoreAdmin_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
| typedef struct secStoreAdmin_Iter* secStoreAdmin_IterRef_t |
Iterator to list entries in secure storage.
Function Documentation
| void secStoreAdmin_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_result_t secStoreAdmin_CopyMetaTo | ( | const char *LE_NONNULL | path | ) |
Copy the meta file to the specified path.
- Returns
- LE_OK if successful. LE_NOT_FOUND if the meta file does not exist. LE_UNAVAILABLE if the sfs is currently unavailable. LE_FAULT if there was some other error.
- Parameters
-
[in] path Destination path of meta file copy.
| secStoreAdmin_IterRef_t secStoreAdmin_CreateIter | ( | const char *LE_NONNULL | path | ) |
Create an iterator for listing entries in secure storage under the specified path.
- Returns
- An iterator reference if successful. NULL if the secure storage is currently unavailable.
- Parameters
-
[in] path Path to iterate over.
| le_result_t secStoreAdmin_Delete | ( | const char *LE_NONNULL | path | ) |
Recursively deletes all items under the specified path and the specified path from secure storage.
- Note
- The specified path must be an absolute path.
- 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.
| void secStoreAdmin_DeleteIter | ( | secStoreAdmin_IterRef_t | iterRef | ) |
Deletes an iterator.
- Parameters
-
[in] iterRef Iterator reference.
| void secStoreAdmin_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_result_t secStoreAdmin_GetEntry | ( | secStoreAdmin_IterRef_t | iterRef, |
| char * | name, | ||
| size_t | nameSize, | ||
| bool * | isDirPtr | ||
| ) |
Get the current entry's name.
- Returns
- LE_OK if successful. LE_OVERFLOW if the buffer is too small to hold the entry name. LE_UNAVAILABLE if the secure storage is currently unavailable.
- Parameters
-
[in] iterRef Iterator reference. [out] name Buffer to store the entry name. [in] nameSize [out] isDirPtr True if the entry is a directory, false otherwise.
| le_result_t secStoreAdmin_GetSize | ( | const char *LE_NONNULL | path, |
| uint64_t * | sizePtr | ||
| ) |
Gets the size, in bytes, of all items under the specified path.
- Note
- The specified path must be an absolute path.
- 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 Size in bytes of all items in the path.
| le_result_t secStoreAdmin_GetTotalSpace | ( | uint64_t * | totalSizePtr, |
| uint64_t * | freeSizePtr | ||
| ) |
Gets the total space and the available free space in secure storage.
- Returns
- LE_OK if successful. LE_UNAVAILABLE if the secure storage is currently unavailable. LE_FAULT if there was some other error.
- Parameters
-
[out] totalSizePtr Total size, in bytes, of secure storage. [out] freeSizePtr Free space, in bytes, in secure storage.
| le_result_t secStoreAdmin_Next | ( | secStoreAdmin_IterRef_t | iterRef | ) |
Go to the next entry in the iterator. This should be called at least once before accessing the entry. After the first time this function is called successfully on an iterator the first entry will be available.
- Returns
- LE_OK if successful. LE_NOT_FOUND if there are no more entries available.
- Parameters
-
[in] iterRef Iterator reference.
| le_result_t secStoreAdmin_Read | ( | const char *LE_NONNULL | path, |
| uint8_t * | bufPtr, | ||
| size_t * | bufSizePtr | ||
| ) |
Reads an item from secure storage.
- Note
- The specified path must be an absolute path.
- 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] path Path of the secure storage item. [out] bufPtr Buffer to store the data in. [in,out] bufSizePtr
| void secStoreAdmin_SetServerDisconnectHandler | ( | secStoreAdmin_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_result_t secStoreAdmin_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_result_t secStoreAdmin_Write | ( | const char *LE_NONNULL | path, |
| const uint8_t * | bufPtr, | ||
| size_t | bufSize | ||
| ) |
Writes a buffer of data into the specified path in 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.
- Note
- The specified path must be an absolute path.
- 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] path Path of the secure storage item. [in] bufPtr Buffer containing the data to store. [in] bufSize