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 #define MESH_CONTROL_PAYLOAD_MAX 256 56 57 #define MESH_ADDRESS_UNSASSIGNED 0x0000u 58 #define MESH_ADDRESS_ALL_PROXIES 0xFFFCu 59 #define MESH_ADDRESS_ALL_FRIENDS 0xFFFDu 60 #define MESH_ADDRESS_ALL_RELAYS 0xFFFEu 61 #define MESH_ADDRESS_ALL_NODES 0xFFFFu 62 63 typedef enum { 64 MESH_NETWORK_PDU_RECEIVED, 65 MESH_NETWORK_PDU_SENT, 66 MESH_NETWORK_PDU_ENCRYPTED, 67 MESH_NETWORK_CAN_SEND_NOW, 68 } mesh_network_callback_type_t; 69 70 typedef enum { 71 MESH_PDU_TYPE_NETWORK = 0, 72 MESH_PDU_TYPE_TRANSPORT, 73 MESH_PDU_TYPE_SEGMENTED, 74 MESH_PDU_TYPE_UNSEGMENTED, 75 MESH_PDU_TYPE_ACCESS, 76 MESH_PDU_TYPE_CONTROL, 77 MESH_PDU_TYPE_UPPER_SEGMENTED_ACCESS, 78 MESH_PDU_TYPE_UPPER_UNSEGMENTED_ACCESS, 79 MESH_PDU_TYPE_UPPER_SEGMENTED_CONTROL, 80 MESH_PDU_TYPE_UPPER_UNSEGMENTED_CONTROL, 81 } mesh_pdu_type_t; 82 83 typedef struct mesh_pdu { 84 // allow for linked lists 85 btstack_linked_item_t item; 86 // type 87 mesh_pdu_type_t pdu_type; 88 89 } mesh_pdu_t; 90 91 // 92 #define MESH_NETWORK_PDU_FLAGS_PROXY_CONFIGURATION 1 93 #define MESH_NETWORK_PDU_FLAGS_GATT_BEARER 2 94 #define MESH_NETWORK_PDU_FLAGS_RELAY 4 95 96 typedef struct mesh_network_pdu { 97 mesh_pdu_t pdu_header; 98 99 // meta data network layer 100 uint16_t netkey_index; 101 // MESH_NETWORK_PDU_FLAGS 102 uint16_t flags; 103 104 // pdu 105 uint16_t len; 106 uint8_t data[MESH_NETWORK_PAYLOAD_MAX]; 107 } mesh_network_pdu_t; 108 109 #define MESH_TRANSPORT_FLAG_SEQ_RESERVED 1 110 #define MESH_TRANSPORT_FLAG_CONTROL 2 111 112 113 typedef struct { 114 // generic pdu header 115 mesh_pdu_t pdu_header; 116 // meta data transport layer 117 uint16_t appkey_index; 118 // MESH_TRANSPORT_FLAG 119 uint16_t flags; 120 // pdu segment 121 mesh_network_pdu_t * segment; 122 } mesh_unsegmented_pdu_t; 123 124 typedef struct { 125 mesh_pdu_t pdu_header; 126 127 // rx/tx: acknowledgement timer / segment transmission timer 128 btstack_timer_source_t acknowledgement_timer; 129 // rx: incomplete timer / tx: resend timer 130 btstack_timer_source_t incomplete_timer; 131 // block access 132 uint32_t block_ack; 133 // meta data network layer 134 uint16_t netkey_index; 135 // meta data transport layer 136 uint16_t appkey_index; 137 // transmic size 138 uint8_t transmic_len; 139 // akf - aid for access, opcode for control 140 uint8_t akf_aid_control; 141 // network pdu header 142 uint8_t network_header[9]; 143 // MESH_TRANSPORT_FLAG 144 uint16_t flags; 145 // acknowledgement timer active 146 uint8_t acknowledgement_timer_active; 147 // incomplete timer active 148 uint8_t incomplete_timer_active; 149 // message complete 150 uint8_t message_complete; 151 // seq_zero for segmented messages 152 uint16_t seq_zero; 153 // pdu segments 154 uint16_t len; 155 btstack_linked_list_t segments; 156 } mesh_segmented_pdu_t; 157 158 typedef struct { 159 mesh_pdu_t pdu_header; 160 161 // meta data network layer 162 uint16_t netkey_index; 163 // meta data transport layer 164 uint16_t appkey_index; 165 // transmic size 166 uint8_t transmic_len; 167 // akf - aid for access, opcode for control 168 uint8_t akf_aid_control; 169 // network pdu header 170 uint8_t network_header[9]; 171 // MESH_TRANSPORT_FLAG 172 uint16_t flags; 173 // pdu 174 uint16_t len; 175 uint8_t data[MESH_ACCESS_PAYLOAD_MAX]; 176 } mesh_transport_pdu_t; 177 178 typedef struct { 179 // generic pdu header 180 mesh_pdu_t pdu_header; 181 // meta data network layer 182 uint16_t netkey_index; 183 // meta data transport layer 184 uint16_t appkey_index; 185 // transmic size 186 uint8_t transmic_len; 187 // akf - aid for access, opcode for control 188 uint8_t akf_aid_control; 189 // network pdu header 190 uint8_t network_header[9]; 191 // MESH_TRANSPORT_FLAG 192 uint16_t flags; 193 // payload 194 uint16_t len; 195 uint8_t data[MESH_ACCESS_PAYLOAD_MAX]; 196 197 } mesh_access_pdu_t; 198 199 // for unsegmented + segmented access + segmented control pdus 200 typedef struct { 201 // generic pdu header 202 mesh_pdu_t pdu_header; 203 // ivi_nid 204 uint8_t ivi_nid; 205 // ctl_ttl 206 uint8_t ctl_ttl; 207 // src 208 uint16_t src; 209 // dst 210 uint16_t dst; 211 // seq 212 uint32_t seq; 213 // meta data network layer 214 uint16_t netkey_index; 215 // meta data transport layer 216 uint16_t appkey_index; 217 uint8_t transmic_len; 218 // akf - aid for access, opcode for control 219 uint8_t akf_aid_control; 220 // MESH_TRANSPORT_FLAG 221 uint16_t flags; 222 // payload, single segmented or list of them 223 uint16_t len; 224 union { 225 btstack_linked_list_t segments; 226 struct mesh_network_pdu * segment; 227 } payload; 228 229 // access acknowledged message 230 uint16_t retransmit_count; 231 uint32_t retransmit_timeout_ms; 232 uint32_t ack_opcode; 233 234 // associated lower transport pdu 235 mesh_pdu_t * lower_pdu; 236 } mesh_upper_transport_pdu_t; 237 238 typedef struct { 239 // generic pdu header 240 mesh_pdu_t pdu_header; 241 // meta data network layer 242 uint16_t netkey_index; 243 // akf - aid for access, opcode for control 244 uint8_t akf_aid_control; 245 // network pdu header 246 uint8_t network_header[9]; 247 // MESH_TRANSPORT_FLAG 248 uint16_t flags; 249 // payload 250 uint16_t len; 251 uint8_t data[MESH_CONTROL_PAYLOAD_MAX]; 252 } mesh_control_pdu_t; 253 254 typedef enum { 255 MESH_KEY_REFRESH_NOT_ACTIVE = 0, 256 MESH_KEY_REFRESH_FIRST_PHASE, 257 MESH_KEY_REFRESH_SECOND_PHASE 258 } mesh_key_refresh_state_t; 259 260 typedef enum { 261 MESH_SECURE_NETWORK_BEACON_W2_AUTH_VALUE, 262 MESH_SECURE_NETWORK_BEACON_W4_AUTH_VALUE, 263 MESH_SECURE_NETWORK_BEACON_AUTH_VALUE, 264 MESH_SECURE_NETWORK_BEACON_W2_SEND_ADV, 265 MESH_SECURE_NETWORK_BEACON_ADV_SENT, 266 MESH_SECURE_NETWORK_BEACON_W2_SEND_GATT, 267 MESH_SECURE_NETWORK_BEACON_GATT_SENT, 268 MESH_SECURE_NETWORK_BEACON_W4_INTERVAL 269 } mesh_secure_network_beacon_state_t; 270 271 typedef struct { 272 btstack_linked_item_t item; 273 274 // netkey index 275 uint16_t netkey_index; 276 277 // current / old key 278 mesh_network_key_t * old_key; 279 280 // new key (only set during key refresh) 281 mesh_network_key_t * new_key; 282 283 // key refresh state 284 mesh_key_refresh_state_t key_refresh; 285 286 // advertisement using node id active 287 uint8_t node_id_advertisement_running; 288 289 290 // advertisement using network id (used by proxy) 291 adv_bearer_connectable_advertisement_data_item_t advertisement_with_network_id; 292 293 // advertising using node id (used by proxy) 294 adv_bearer_connectable_advertisement_data_item_t advertisement_with_node_id; 295 296 // secure network beacons 297 mesh_secure_network_beacon_state_t beacon_state; 298 uint32_t beacon_interval_ms; 299 uint32_t beacon_observation_start_ms; 300 uint16_t beacon_observation_counter; 301 302 } mesh_subnet_t; 303 304 typedef struct { 305 btstack_linked_list_iterator_t it; 306 } mesh_subnet_iterator_t; 307 308 /** 309 * @brief Init Mesh Network Layer 310 */ 311 void mesh_network_init(void); 312 313 /** 314 * @brief Set higher layer Network PDU handler 315 * @param packet_handler 316 */ 317 void mesh_network_set_higher_layer_handler(void (*packet_handler)(mesh_network_callback_type_t callback_type, mesh_network_pdu_t * network_pdu)); 318 319 /** 320 * @brief Set higher layer Proxy PDU handler 321 * @param packet_handler 322 */ 323 void mesh_network_set_proxy_message_handler(void (*packet_handler)(mesh_network_callback_type_t callback_type, mesh_network_pdu_t * network_pdu)); 324 325 /** 326 * @brief Mark packet as processed 327 * @param newtork_pdu received via call packet_handler 328 */ 329 void mesh_network_message_processed_by_higher_layer(mesh_network_pdu_t * network_pdu); 330 331 /** 332 * @brief Send network_pdu after encryption 333 * @param network_pdu 334 */ 335 void mesh_network_send_pdu(mesh_network_pdu_t * network_pdu); 336 337 /* 338 * @brief Setup network pdu header 339 * @param netkey_index 340 * @param nid 341 * @param ctl 342 * @param ttl 343 * @param seq 344 * @param dst 345 * @param transport_pdu_data 346 * @param transport_pdu_len 347 */ 348 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); 349 350 /** 351 * Setup network pdu header without modifying len or payload 352 * @param network_pdu 353 * @param netkey_index 354 * @param nid 355 * @param ctl 356 * @param ttl 357 * @param seq 358 * @param src 359 * @param dest 360 */ 361 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); 362 363 /** 364 * @brief Validate network addresses 365 * @param ctl 366 * @param src 367 * @param dst 368 * @returns 1 if valid, 369 */ 370 int mesh_network_addresses_valid(uint8_t ctl, uint16_t src, uint16_t dst); 371 372 /** 373 * @brief Check if Unicast address 374 * @param addr 375 * @returns 1 if unicast 376 */ 377 int mesh_network_address_unicast(uint16_t addr); 378 379 /** 380 * @brief Check if Unicast address 381 * @param addr 382 * @returns 1 if unicast 383 */ 384 int mesh_network_address_group(uint16_t addr); 385 386 /** 387 * @brief Check if All Proxies address 388 * @param addr 389 * @returns 1 if all proxies 390 */ 391 int mesh_network_address_all_proxies(uint16_t addr); 392 393 /** 394 * @brief Check if All Nodes address 395 * @param addr 396 * @returns 1 if all nodes 397 */ 398 int mesh_network_address_all_nodes(uint16_t addr); 399 400 /** 401 * @brief Check if All Friends address 402 * @param addr 403 * @returns 1 if all friends 404 */ 405 int mesh_network_address_all_friends(uint16_t addr); 406 407 /** 408 * @brief Check if All Relays address 409 * @param addr 410 * @returns 1 if all relays 411 */ 412 int mesh_network_address_all_relays(uint16_t addr); 413 414 415 /** 416 * @brief Check if Virtual address 417 * @param addr 418 * @returns 1 if virtual 419 */ 420 int mesh_network_address_virtual(uint16_t addr); 421 422 423 /** 424 * @brief Add subnet to list 425 * @param subnet 426 */ 427 void mesh_subnet_add(mesh_subnet_t * subnet); 428 429 /** 430 * @brief Remove subnet from list 431 * @param subnet 432 */ 433 void mesh_subnet_remove(mesh_subnet_t * subnet); 434 435 /** 436 * @brief Get subnet for netkey_index 437 * @param netkey_index 438 * @returns mesh_subnet_t or NULL 439 */ 440 mesh_subnet_t * mesh_subnet_get_by_netkey_index(uint16_t netkey_index); 441 442 /** 443 * @brief Get number of stored subnets 444 * @returns count 445 */ 446 int mesh_subnet_list_count(void); 447 448 /** 449 * @brief Iterate over all subnets 450 * @param it 451 */ 452 void mesh_subnet_iterator_init(mesh_subnet_iterator_t *it); 453 454 /** 455 * @brief Check if another subnet is available 456 * @param it 457 * @return 458 */ 459 int mesh_subnet_iterator_has_more(mesh_subnet_iterator_t *it); 460 461 /** 462 * @brief Get next subnet 463 * @param it 464 * @return 465 */ 466 mesh_subnet_t * mesh_subnet_iterator_get_next(mesh_subnet_iterator_t *it); 467 468 /** 469 * @brief Setup subnet for given netkey index 470 */ 471 void mesh_subnet_setup_for_netkey_index(uint16_t netkey_index); 472 473 474 /** 475 * @brief Get outgoing network key for subnet based on key refresh phase 476 */ 477 mesh_network_key_t * mesh_subnet_get_outgoing_network_key(mesh_subnet_t * subnet); 478 479 // buffer pool 480 mesh_network_pdu_t * mesh_network_pdu_get(void); 481 void mesh_network_pdu_free(mesh_network_pdu_t * network_pdu); 482 483 // Mesh Network PDU Getter 484 uint16_t mesh_network_control(mesh_network_pdu_t * network_pdu); 485 uint8_t mesh_network_nid(mesh_network_pdu_t * network_pdu); 486 uint8_t mesh_network_ttl(mesh_network_pdu_t * network_pdu); 487 uint32_t mesh_network_seq(mesh_network_pdu_t * network_pdu); 488 uint16_t mesh_network_src(mesh_network_pdu_t * network_pdu); 489 uint16_t mesh_network_dst(mesh_network_pdu_t * network_pdu); 490 int mesh_network_segmented(mesh_network_pdu_t * network_pdu); 491 uint8_t mesh_network_control_opcode(mesh_network_pdu_t * network_pdu); 492 uint8_t * mesh_network_pdu_data(mesh_network_pdu_t * network_pdu); 493 uint8_t mesh_network_pdu_len(mesh_network_pdu_t * network_pdu); 494 495 // Mesh Network PDU Setter 496 void mesh_network_pdu_set_seq(mesh_network_pdu_t * network_pdu, uint32_t seq); 497 498 // Testing only 499 void mesh_network_received_message(const uint8_t * pdu_data, uint8_t pdu_len, uint8_t flags); 500 void mesh_network_process_proxy_configuration_message(const uint8_t * pdu_data, uint8_t pdu_len); 501 void mesh_network_encrypt_proxy_configuration_message(mesh_network_pdu_t * network_pdu); 502 void mesh_network_dump(void); 503 void mesh_network_reset(void); 504 505 #if defined __cplusplus 506 } 507 #endif 508 509 #endif 510