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