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