1 /* 2 * Copyright (C) 2018 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 #ifndef __MESH_NETWORK 39 #define __MESH_NETWORK 40 41 #include "btstack_linked_list.h" 42 #include "btstack_run_loop.h" 43 44 #include "mesh/provisioning.h" 45 #include "mesh/mesh_keys.h" 46 47 #if defined __cplusplus 48 extern "C" { 49 #endif 50 51 #define MESH_DEVICE_KEY_INDEX 0xffff 52 53 #define MESH_NETWORK_PAYLOAD_MAX 29 54 #define MESH_ACCESS_PAYLOAD_MAX 384 55 56 #define MESH_ADDRESS_UNSASSIGNED 0x0000u 57 #define MESH_ADDRESS_ALL_PROXIES 0xFFFCu 58 #define MESH_ADDRESS_ALL_FRIENDS 0xFFFDu 59 #define MESH_ADDRESS_ALL_RELAYS 0xFFFEu 60 #define MESH_ADDRESS_ALL_NODES 0xFFFFu 61 62 typedef enum { 63 MESH_NETWORK_PDU_RECEIVED, 64 MESH_NETWORK_PDU_SENT, 65 MESH_NETWORK_PDU_ENCRYPTED, 66 MESH_NETWORK_CAN_SEND_NOW, 67 } mesh_network_callback_type_t; 68 69 typedef enum { 70 MESH_PDU_TYPE_NETWORK = 0, 71 MESH_PDU_TYPE_TRANSPORT, 72 MESH_PDU_TYPE_MESSAGE, 73 MESH_PDU_TYPE_UNSEGMENTED_INCOMING, 74 } mesh_pdu_type_t; 75 76 typedef struct mesh_pdu { 77 // allow for linked lists 78 btstack_linked_item_t item; 79 // type 80 mesh_pdu_type_t pdu_type; 81 82 } mesh_pdu_t; 83 84 // 85 #define MESH_NETWORK_PDU_FLAGS_PROXY_CONFIGURATION 1 86 #define MESH_NETWORK_PDU_FLAGS_GATT_BEARER 2 87 #define MESH_NETWORK_PDU_FLAGS_RELAY 4 88 89 typedef struct mesh_network_pdu { 90 mesh_pdu_t pdu_header; 91 92 // meta data network layer 93 uint16_t netkey_index; 94 // MESH_NETWORK_PDU_FLAGS 95 uint16_t flags; 96 97 // pdu 98 uint16_t len; 99 uint8_t data[MESH_NETWORK_PAYLOAD_MAX]; 100 } mesh_network_pdu_t; 101 102 #define MESH_TRANSPORT_FLAG_SEQ_RESERVED 1 103 #define MESH_TRANSPORT_FLAG_SEGMENTED 2 104 105 typedef struct { 106 mesh_pdu_t pdu_header; 107 108 // access acknowledged message 109 uint16_t retransmit_count; 110 uint32_t retransmit_timeout_ms; 111 uint32_t ack_opcode; 112 113 // rx/tx: acknowledgement timer / segment transmission timer 114 btstack_timer_source_t acknowledgement_timer; 115 // rx: incomplete timer / tx: resend timer 116 btstack_timer_source_t incomplete_timer; 117 // block access 118 uint32_t block_ack; 119 // meta data network layer 120 uint16_t netkey_index; 121 // meta data transport layer 122 uint16_t appkey_index; 123 // transmic size 124 uint8_t transmic_len; 125 // akf - aid for access, opcode for control 126 uint8_t akf_aid_control; 127 // network pdu header 128 uint8_t network_header[9]; 129 // MESH_TRANSPORT_FLAG 130 uint16_t flags; 131 // acknowledgement timer active 132 uint8_t acknowledgement_timer_active; 133 // incomplete timer active 134 uint8_t incomplete_timer_active; 135 // message complete 136 uint8_t message_complete; 137 // seq_zero for segmented messages 138 uint16_t seq_zero; 139 // pdu 140 uint16_t len; 141 uint8_t data[MESH_ACCESS_PAYLOAD_MAX]; 142 } mesh_transport_pdu_t; 143 144 typedef struct { 145 mesh_pdu_t pdu_header; 146 147 // access acknowledged message 148 uint16_t retransmit_count; 149 uint32_t retransmit_timeout_ms; 150 uint32_t ack_opcode; 151 152 // rx/tx: acknowledgement timer / segment transmission timer 153 btstack_timer_source_t acknowledgement_timer; 154 // rx: incomplete timer / tx: resend timer 155 btstack_timer_source_t incomplete_timer; 156 // block access 157 uint32_t block_ack; 158 // meta data network layer 159 uint16_t netkey_index; 160 // meta data transport layer 161 uint16_t appkey_index; 162 // transmic size 163 uint8_t transmic_len; 164 // akf - aid for access, opcode for control 165 uint8_t akf_aid_control; 166 // network pdu header 167 uint8_t network_header[9]; 168 // MESH_TRANSPORT_FLAG 169 uint16_t flags; 170 // acknowledgement timer active 171 uint8_t acknowledgement_timer_active; 172 // incomplete timer active 173 uint8_t incomplete_timer_active; 174 // message complete 175 uint8_t message_complete; 176 // seq_zero for segmented messages 177 uint16_t seq_zero; 178 // pdu segments 179 uint16_t len; 180 btstack_linked_list_t segments; 181 } mesh_message_pdu_t; 182 183 typedef struct { 184 // generic pdu header 185 mesh_pdu_t pdu_header; 186 // meta data transport layer 187 uint16_t appkey_index; 188 // MESH_TRANSPORT_FLAG 189 uint16_t flags; 190 // pdu segment 191 mesh_network_pdu_t * segment; 192 } mesh_unsegmented_incoming_pdu_t; 193 194 typedef enum { 195 MESH_KEY_REFRESH_NOT_ACTIVE = 0, 196 MESH_KEY_REFRESH_FIRST_PHASE, 197 MESH_KEY_REFRESH_SECOND_PHASE 198 } mesh_key_refresh_state_t; 199 200 typedef enum { 201 MESH_SECURE_NETWORK_BEACON_W2_AUTH_VALUE, 202 MESH_SECURE_NETWORK_BEACON_W4_AUTH_VALUE, 203 MESH_SECURE_NETWORK_BEACON_AUTH_VALUE, 204 MESH_SECURE_NETWORK_BEACON_W2_SEND_ADV, 205 MESH_SECURE_NETWORK_BEACON_ADV_SENT, 206 MESH_SECURE_NETWORK_BEACON_W2_SEND_GATT, 207 MESH_SECURE_NETWORK_BEACON_GATT_SENT, 208 MESH_SECURE_NETWORK_BEACON_W4_INTERVAL 209 } mesh_secure_network_beacon_state_t; 210 211 typedef struct { 212 btstack_linked_item_t item; 213 214 // netkey index 215 uint16_t netkey_index; 216 217 // current / old key 218 mesh_network_key_t * old_key; 219 220 // new key (only set during key refresh) 221 mesh_network_key_t * new_key; 222 223 // key refresh state 224 mesh_key_refresh_state_t key_refresh; 225 226 // advertisement using node id active 227 uint8_t node_id_advertisement_running; 228 229 230 // advertisement using network id (used by proxy) 231 adv_bearer_connectable_advertisement_data_item_t advertisement_with_network_id; 232 233 // advertising using node id (used by proxy) 234 adv_bearer_connectable_advertisement_data_item_t advertisement_with_node_id; 235 236 // secure network beacons 237 mesh_secure_network_beacon_state_t beacon_state; 238 uint32_t beacon_interval_ms; 239 uint32_t beacon_observation_start_ms; 240 uint16_t beacon_observation_counter; 241 242 } mesh_subnet_t; 243 244 typedef struct { 245 btstack_linked_list_iterator_t it; 246 } mesh_subnet_iterator_t; 247 248 /** 249 * @brief Init Mesh Network Layer 250 */ 251 void mesh_network_init(void); 252 253 /** 254 * @brief Set higher layer Network PDU handler 255 * @param packet_handler 256 */ 257 void mesh_network_set_higher_layer_handler(void (*packet_handler)(mesh_network_callback_type_t callback_type, mesh_network_pdu_t * network_pdu)); 258 259 /** 260 * @brief Set higher layer Proxy PDU handler 261 * @param packet_handler 262 */ 263 void mesh_network_set_proxy_message_handler(void (*packet_handler)(mesh_network_callback_type_t callback_type, mesh_network_pdu_t * network_pdu)); 264 265 /** 266 * @brief Mark packet as processed 267 * @param newtork_pdu received via call packet_handler 268 */ 269 void mesh_network_message_processed_by_higher_layer(mesh_network_pdu_t * network_pdu); 270 271 /** 272 * @brief Send network_pdu after encryption 273 * @param network_pdu 274 */ 275 void mesh_network_send_pdu(mesh_network_pdu_t * network_pdu); 276 277 /* 278 * @brief Setup network pdu header 279 * @param netkey_index 280 * @param nid 281 * @param ctl 282 * @param ttl 283 * @param seq 284 * @param dst 285 * @param transport_pdu_data 286 * @param transport_pdu_len 287 */ 288 void mesh_network_setup_pdu(mesh_network_pdu_t * network_pdu, uint16_t netkey_index, uint8_t nid, uint8_t ctl, uint8_t ttl, uint32_t seq, uint16_t src, uint16_t dst, const uint8_t * transport_pdu_data, uint8_t transport_pdu_len); 289 290 /** 291 * Setup network pdu header without modifying len or payload 292 * @param network_pdu 293 * @param netkey_index 294 * @param nid 295 * @param ctl 296 * @param ttl 297 * @param seq 298 * @param src 299 * @param dest 300 */ 301 void mesh_network_setup_pdu_header(mesh_network_pdu_t * network_pdu, uint16_t netkey_index, uint8_t nid, uint8_t ctl, uint8_t ttl, uint32_t seq, uint16_t src, uint16_t dest); 302 303 /** 304 * @brief Validate network addresses 305 * @param ctl 306 * @param src 307 * @param dst 308 * @returns 1 if valid, 309 */ 310 int mesh_network_addresses_valid(uint8_t ctl, uint16_t src, uint16_t dst); 311 312 /** 313 * @brief Check if Unicast address 314 * @param addr 315 * @returns 1 if unicast 316 */ 317 int mesh_network_address_unicast(uint16_t addr); 318 319 /** 320 * @brief Check if Unicast address 321 * @param addr 322 * @returns 1 if unicast 323 */ 324 int mesh_network_address_group(uint16_t addr); 325 326 /** 327 * @brief Check if All Proxies address 328 * @param addr 329 * @returns 1 if all proxies 330 */ 331 int mesh_network_address_all_proxies(uint16_t addr); 332 333 /** 334 * @brief Check if All Nodes address 335 * @param addr 336 * @returns 1 if all nodes 337 */ 338 int mesh_network_address_all_nodes(uint16_t addr); 339 340 /** 341 * @brief Check if All Friends address 342 * @param addr 343 * @returns 1 if all friends 344 */ 345 int mesh_network_address_all_friends(uint16_t addr); 346 347 /** 348 * @brief Check if All Relays address 349 * @param addr 350 * @returns 1 if all relays 351 */ 352 int mesh_network_address_all_relays(uint16_t addr); 353 354 355 /** 356 * @brief Check if Virtual address 357 * @param addr 358 * @returns 1 if virtual 359 */ 360 int mesh_network_address_virtual(uint16_t addr); 361 362 363 /** 364 * @brief Add subnet to list 365 * @param subnet 366 */ 367 void mesh_subnet_add(mesh_subnet_t * subnet); 368 369 /** 370 * @brief Remove subnet from list 371 * @param subnet 372 */ 373 void mesh_subnet_remove(mesh_subnet_t * subnet); 374 375 /** 376 * @brief Get subnet for netkey_index 377 * @param netkey_index 378 * @returns mesh_subnet_t or NULL 379 */ 380 mesh_subnet_t * mesh_subnet_get_by_netkey_index(uint16_t netkey_index); 381 382 /** 383 * @brief Get number of stored subnets 384 * @returns count 385 */ 386 int mesh_subnet_list_count(void); 387 388 /** 389 * @brief Iterate over all subnets 390 * @param it 391 */ 392 void mesh_subnet_iterator_init(mesh_subnet_iterator_t *it); 393 394 /** 395 * @brief Check if another subnet is available 396 * @param it 397 * @return 398 */ 399 int mesh_subnet_iterator_has_more(mesh_subnet_iterator_t *it); 400 401 /** 402 * @brief Get next subnet 403 * @param it 404 * @return 405 */ 406 mesh_subnet_t * mesh_subnet_iterator_get_next(mesh_subnet_iterator_t *it); 407 408 /** 409 * @brief Setup subnet for given netkey index 410 */ 411 void mesh_subnet_setup_for_netkey_index(uint16_t netkey_index); 412 413 414 /** 415 * @brief Get outgoing network key for subnet based on key refresh phase 416 */ 417 mesh_network_key_t * mesh_subnet_get_outgoing_network_key(mesh_subnet_t * subnet); 418 419 // buffer pool 420 mesh_network_pdu_t * mesh_network_pdu_get(void); 421 void mesh_network_pdu_free(mesh_network_pdu_t * network_pdu); 422 423 // Mesh Network PDU Getter 424 uint16_t mesh_network_control(mesh_network_pdu_t * network_pdu); 425 uint8_t mesh_network_nid(mesh_network_pdu_t * network_pdu); 426 uint8_t mesh_network_ttl(mesh_network_pdu_t * network_pdu); 427 uint32_t mesh_network_seq(mesh_network_pdu_t * network_pdu); 428 uint16_t mesh_network_src(mesh_network_pdu_t * network_pdu); 429 uint16_t mesh_network_dst(mesh_network_pdu_t * network_pdu); 430 int mesh_network_segmented(mesh_network_pdu_t * network_pdu); 431 uint8_t mesh_network_control_opcode(mesh_network_pdu_t * network_pdu); 432 uint8_t * mesh_network_pdu_data(mesh_network_pdu_t * network_pdu); 433 uint8_t mesh_network_pdu_len(mesh_network_pdu_t * network_pdu); 434 435 // Mesh Network PDU Setter 436 void mesh_network_pdu_set_seq(mesh_network_pdu_t * network_pdu, uint32_t seq); 437 438 // Testing only 439 void mesh_network_received_message(const uint8_t * pdu_data, uint8_t pdu_len, uint8_t flags); 440 void mesh_network_process_proxy_configuration_message(const uint8_t * pdu_data, uint8_t pdu_len); 441 void mesh_network_encrypt_proxy_configuration_message(mesh_network_pdu_t * network_pdu); 442 void mesh_network_dump(void); 443 void mesh_network_reset(void); 444 445 #if defined __cplusplus 446 } 447 #endif 448 449 #endif 450