provisioning_int.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_INT_H_
#define _PROVISIONING_INT_H_
 
#include <stdint.h>
#include "api.h"
#include "aessw.h"
 
 
#if defined(MAC_PROFILE_ISM24) || defined(MAC_PROFILE_SUBG)
 
/* Wirepas Provisioning Protocol endpoints for 2.4G and SubGHz
 *  - Downlink: Source: 255 ; Destination: 246
 *  - Uplink: Source: 246 ; Destination: 255
 */
 
#define PROV_DOWNLINK_SRC_EP    255
#define PROV_DOWNLINK_DST_EP    246
 
#define PROV_UPLINK_SRC_EP      246
#define PROV_UPLINK_DST_EP      255
 
#endif
 
 
#define PROV_PDU_SIZE 135
 
#define PROV_CTR_SIZE 2
 
#define PROV_MIC_SIZE 5
 
#define ENC_KEY_OFFSET 16
 
#define PROV_DATA_OFFSET (sizeof(pdu_prov_hdr_t) + 1 + PROV_CTR_SIZE)
 
#define PROV_DATA_MIN_USER_ID 128
 
#define PROV_DATA_MAX_USER_ID 255
 
#define JOINING_NETWORK_ADDRESS 0x9E4ADC // "JBTX"
 
#if defined(MAC_PROFILE_ISM24)
// For 2.4G MAC profiles, joining network channel is 36
#define JOINING_NETWORK_CHANNEL 36
#endif
 
 
#if defined(MAC_PROFILE_ISM24)
 
#define JOINING_RX_TIMEOUT      600
#endif
 
#if defined(MAC_PROFILE_ISM24)
 
#define JOINING_TX_INTERVAL     500
#endif
 
#if defined(MAC_PROFILE_ISM24) || defined(MAC_PROFILE_SUBG)
// SubG and 2.4G
#define JOINING_BEACON_TYPE 0x647650fb // "PROVIS"
 
#endif
 
#define PROV_START_FLAGS_NONE               0
 
#define PROV_START_FLAGS_NW_PARAM_EQUAL_CHECK 1
 
typedef enum {
    PROV_DATA_ID_ENC_KEY = 0,
    PROV_DATA_ID_AUTH_KEY = 1,
    PROV_DATA_ID_NET_ADDR = 2,
    PROV_DATA_ID_NET_CHAN = 3,
    PROV_DATA_ID_NODE_ADDR = 4,
    PROV_DATA_ID_NODE_ROLE = 5,
    PROV_DATA_ID_NET_KEY_SEQ = 6,
    PROV_DATA_ID_MGMT_ENC_KEY = 7,
    PROV_DATA_ID_MGMT_AUTH_KEY = 8,
    PROV_DATA_ID_MGMT_KEY_SEQ = 9
} provisioning_data_ids_e;
 
typedef enum
{
    PROV_PACKET_TYPE_START = 1,
    PROV_PACKET_TYPE_DATA = 2,
    PROV_PACKET_TYPE_DATA_ACK = 3,
    PROV_PACKET_TYPE_NACK = 4
} prov_packet_type_e;
 
typedef enum
{
    PROV_NACK_TYPE_NOT_AUTHORIZED = 0,
    PROV_NACK_TYPE_METHOD_NOT_SUPPORTED = 1,
    PROV_NACK_TYPE_INVALID_DATA = 2,
    PROV_NACK_TYPE_INVALID_KEY_IDX = 3
} prov_nack_type_e;
 
typedef struct __attribute__((__packed__))
{
    uint8_t  type;
    app_addr_t address;
    uint8_t  session_id;
}pdu_prov_hdr_t;
 
typedef struct __attribute__((__packed__))
{
    pdu_prov_hdr_t  pdu_header;
    uint8_t         method;
    uint8_t         iv[AES_128_KEY_BLOCK_SIZE];
    uint8_t         uid[PROV_PDU_SIZE -
                        sizeof(pdu_prov_hdr_t) - 1 - AES_128_KEY_BLOCK_SIZE];
}pdu_prov_start_t;
 
 
typedef struct __attribute__((__packed__))
{
    pdu_prov_hdr_t  pdu_header;
    uint8_t         key_index;
    uint16_t        counter;
    uint8_t         data[PROV_PDU_SIZE - PROV_DATA_OFFSET - PROV_MIC_SIZE];
    /* Mic is added at the end of the data packet.
     * uint8_t         mic[PROV_MIC_SIZE];
     */
}pdu_prov_data_t;
 
typedef struct __attribute__((__packed__))
{
    pdu_prov_hdr_t  pdu_header;
}pdu_prov_data_ack_t;
 
typedef struct __attribute__((__packed__))
{
    pdu_prov_hdr_t  pdu_header;
    uint8_t         nack_type;
}pdu_prov_nack_t;
 
typedef union __attribute__((__packed__))
{
    union __attribute__((__packed__))
    {
        pdu_prov_hdr_t  pdu_header;
        uint8_t         pld[PROV_PDU_SIZE - sizeof(pdu_prov_hdr_t)];
    };
    pdu_prov_start_t start;
    pdu_prov_data_t data;
    pdu_prov_data_ack_t data_ack;
    pdu_prov_nack_t nack;
} pdu_prov_t;
 
typedef struct
{
    provisioning_end_cb_f end_cb;
    provisioning_user_data_cb_f user_data_cb;
    uint8_t * buffer;
    uint8_t length;
    uint8_t method;
} provisioning_data_conf_t;
 
typedef void (*provisioning_joining_end_cb_f)(provisioning_res_e result);
 
typedef struct
{
    provisioning_joining_beacon_cb_f joining_cb;
    provisioning_joining_end_cb_f end_cb;
    uint8_t nb_retry;
    uint8_t flags;
} provisioning_joining_conf_t;
 
typedef provisioning_ret_e (*provisioning_start_cb_f)(void);
 
typedef struct
{
    provisioning_start_cb_f start_cb;
    uint16_t timeout_sec;
} provisioning_failsafe_conf_t;
 
provisioning_ret_e Provisioning_Data_decode(provisioning_data_conf_t * conf,
                                            bool dry_run);
 
provisioning_ret_e Provisioning_Joining_init(
                                        provisioning_joining_conf_t * conf);
 
provisioning_ret_e Provisioning_Joining_start(void);
 
provisioning_ret_e Provisioning_Joining_stop(void);
 
provisioning_ret_e Provisioning_Failsafe_init(
    const provisioning_failsafe_conf_t * conf);
 
provisioning_ret_e Provisioning_Failsafe_start(void);
 
provisioning_ret_e Provisioning_Failsafe_stop(void);
 
bool Provisioning_Failsafe_callback_end(provisioning_res_e result);
 
const app_lib_joining_received_beacon_t *
Provisioning_Failsafe_callback_beacons(
    const app_lib_joining_received_beacon_t * beacons);
 
#endif //_PROVISIONING_INT_H_