wms_secure_storage.h

Go to the documentation of this file.

/* Copyright 2024 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef APP_LIB_SECURE_STORAGE_H_
#define APP_LIB_SECURE_STORAGE_H_
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "wms_app.h"
#include "wms_memory_area.h"
 
#define APP_LIB_SECURE_STORAGE_NAME 0x74be4415  
 
 
#define APP_LIB_SECURE_STORAGE_VERSION 0x200
 
typedef enum
{
    APP_LIB_SECURE_STORAGE_CMD_INIT = 0,
    APP_LIB_SECURE_STORAGE_CMD_NO_INIT = 1,
    APP_LIB_SECURE_STORAGE_CMD_ERASE = 2,
} app_lib_secure_storage_command_e;
 
typedef uint32_t app_lib_secure_storage_record_tag_t;
 
typedef enum
{
    APP_LIB_SECURE_STORAGE_RECORD_FLAG_NO_ENCRYPT = (1 << 0),
    APP_LIB_SECURE_STORAGE_RECORD_FLAG_NO_AUTH = (1 << 1),
} app_lib_secure_storage_record_flags_e;
 
typedef app_lib_mem_area_res_e (*app_lib_secure_storage_init_area_f)(
    app_lib_mem_area_id_t id, app_lib_secure_storage_command_e cmd,
    uint32_t flags);
 
typedef app_lib_mem_area_res_e (*app_lib_secure_storage_read_record_f)(
    app_lib_mem_area_id_t id, app_lib_secure_storage_record_tag_t tag,
    void * to, size_t * max_amount);
 
typedef app_lib_mem_area_res_e (*app_lib_secure_storage_write_record_f)(
    app_lib_mem_area_id_t               id,
    app_lib_secure_storage_record_tag_t tag,
    const void *                        from,
    size_t                              amount,
    uint32_t                            flags);
 
typedef app_lib_mem_area_res_e (*app_lib_secure_storage_delete_record_f)(
    app_lib_mem_area_id_t id, app_lib_secure_storage_record_tag_t tag);
 
typedef struct
{
    app_lib_secure_storage_init_area_f     initArea;
    app_lib_secure_storage_read_record_f   readRecord;
    app_lib_secure_storage_write_record_f  writeRecord;
    app_lib_secure_storage_delete_record_f deleteRecord;
} app_lib_secure_storage_t;
 
#endif /* APP_LIB_SECURE_STORAGE_H_ */