provisioning.h

Go to the documentation of this file.

/* Copyright 2019 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
#ifndef _PROVISIONING_H_
#define _PROVISIONING_H_
 
#include <stdint.h>
#include "api.h"
#include "wms_joining.h"
#include "wms_settings.h"
#include "cbor.h"
 
#define PROV_UUID_SIZE_BYTES 16
 
#define PROV_KEY_SIZE_BYTES 16
 
#define PROV_UID_MAX_SIZE_BYTES 79
 
#define PROV_AUTH_UID_SIZE_BYTES 16
 
typedef enum
{
    PROV_RET_OK = 0, 
    PROV_RET_INVALID_STATE = 1, 
    PROV_RET_INVALID_PARAM = 2, 
    PROV_RET_INVALID_DATA = 3, 
    PROV_RET_JOINING_LIB_ERROR = 4, 
    PROV_RET_INTERNAL_ERROR = 5, 
} provisioning_ret_e;
 
typedef enum
{
    PROV_RES_SUCCESS = 0, 
    PROV_RES_TIMEOUT = 1, 
    PROV_RES_NACK = 2, 
    PROV_RES_INVALID_DATA = 3, 
    PROV_RES_INVALID_PACKET = 4, 
    PROV_RES_ERROR_SENDING_DATA = 5, 
    PROV_RES_ERROR_SCANNING_BEACONS = 6, 
    PROV_RES_ERROR_JOINING = 7, 
    PROV_RES_ERROR_NO_ROUTE = 8, 
    PROV_RES_STOPPED = 9, 
    PROV_RES_ERROR_INTERNAL = 10, 
    PROV_RES_ERROR_FAILSAFE = 11
} provisioning_res_e;
 
typedef enum
{
    PROV_METHOD_FLAG_SECURED      = 0b0001,
 
    PROV_METHOD_FLAG_EXTENDED_UID = 0b0010,
 
    PROV_METHOD_FLAG_KEY_MGMT     = 0b0100,
} provisioning_method_flag_e;
 
typedef enum
{
    PROV_METHOD_UNSECURED = 0x0,
 
    PROV_METHOD_SECURED = PROV_METHOD_FLAG_SECURED,
 
    PROV_METHOD_EXTENDED_UID = PROV_METHOD_FLAG_SECURED |
                               PROV_METHOD_FLAG_EXTENDED_UID,
 
    PROV_METHOD_EXTENDED_UID_KEY_MGMT = PROV_METHOD_FLAG_SECURED      |
                                        PROV_METHOD_FLAG_EXTENDED_UID |
                                        PROV_METHOD_FLAG_KEY_MGMT,
} provisioning_method_e;
 
#define PROV_METHOD_IS_UNSECURED(x) ((x) == 0)
 
#define PROV_METHOD_IS_SECURED(x) (((x) & PROV_METHOD_FLAG_SECURED) != 0)
 
#define PROV_METHOD_IS_EXTENDED_UID(x) (((x) & PROV_METHOD_FLAG_EXTENDED_UID) != 0)
 
#define PROV_METHOD_IS_KEY_MGMT(x) (((x) & PROV_METHOD_FLAG_KEY_MGMT) != 0)
 
typedef bool (*provisioning_end_cb_f)(provisioning_res_e result);
 
typedef void (*provisioning_user_data_cb_f)(uint32_t id,
                                            CborType type,
                                            uint8_t * data,
                                            uint8_t len);
 
typedef const app_lib_joining_received_beacon_t *
                    (*provisioning_joining_beacon_cb_f)
                            (const app_lib_joining_received_beacon_t * beacons);
 
typedef struct
{
    uint8_t enc_key[APP_LIB_SETTINGS_AES_KEY_NUM_BYTES];
    uint8_t auth_key[APP_LIB_SETTINGS_AES_KEY_NUM_BYTES];
    app_lib_settings_net_addr_t net_addr;
    app_lib_settings_net_channel_t net_chan;
} provisioning_proxy_net_param_t;
 
typedef bool (*provisioning_proxy_start_cb_f)(
                                const uint8_t * uid,
                                uint8_t uid_len,
                                provisioning_method_e method,
                                provisioning_proxy_net_param_t * net_param);
 
typedef union
{
    uint8_t uid[PROV_UID_MAX_SIZE_BYTES];
    struct
    {
        uint8_t authenticator_uid_type;
        uint8_t authenticator_uid[PROV_AUTH_UID_SIZE_BYTES];
        uint8_t node_uid_type;
        uint8_t node_uid[PROV_UUID_SIZE_BYTES];
    };
} provisioning_uid_t;
 
 
typedef struct
{
    provisioning_method_e method;
    uint8_t nb_retry;
    uint16_t timeout_s;
    provisioning_uid_t prov_uid;
    uint8_t prov_uid_len;
 
    struct
    {
        uint8_t auth_key[PROV_KEY_SIZE_BYTES]; 
        uint8_t enc_key[PROV_KEY_SIZE_BYTES]; 
    } prov_keys;
} provisioning_settings_t;
 
typedef struct
{
    provisioning_settings_t settings;
    provisioning_end_cb_f end_cb;
    provisioning_user_data_cb_f user_data_cb;
    provisioning_joining_beacon_cb_f beacon_joining_cb;
} provisioning_conf_t;
 
typedef struct
{
    uint8_t * payload;
    uint8_t num_bytes;
    int8_t tx_power;
    bool is_local_unsec_allowed;
    bool is_local_sec_allowed;
    const uint8_t * key;
    uint8_t key_len;
    provisioning_proxy_start_cb_f start_cb;
} provisioning_proxy_conf_t;
 
provisioning_ret_e Provisioning_init(provisioning_conf_t * conf);
 
provisioning_ret_e Provisioning_start(void);
 
provisioning_ret_e Provisioning_stop(void);
 
provisioning_ret_e Provisioning_Proxy_init(provisioning_proxy_conf_t * conf);
 
provisioning_ret_e Provisioning_Proxy_start(void);
 
provisioning_ret_e Provisioning_Proxy_stop(void);
 
provisioning_ret_e Provisioning_settings_write(const provisioning_settings_t * settings);
 
provisioning_ret_e Provisioning_settings_read(provisioning_settings_t * settings);
 
provisioning_ret_e Provisioning_init_from_storage(provisioning_conf_t * conf);
 
#endif //_PROVISIONING_H_