1 /* 2 * Copyright (C) 2014 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 LE_DEVICE_DB_H 39 #define LE_DEVICE_DB_H 40 41 #include "btstack_util.h" 42 #include "btstack_config.h" 43 44 #if defined __cplusplus 45 extern "C" { 46 #endif 47 48 /** 49 50 Note: LE Device DB for pure LE Peripherals is not required if only LE Legacy Pairing without signed writes is used 51 52 Per bonded device: 53 - it stores the Identity Resolving Key (IRK) and its address to resolve private addresses 54 - it stores the LTK + EDIV, RAND. EDIV + RAND allows a LE Peripheral to reconstruct the LTK 55 - it stores the Connection Signature Resolving Key (CSRK) and the last used counter. 56 The CSRK is used to generate the signatur on the remote device and is needed to verify the signature itself 57 The Counter is necessary to prevent reply attacks 58 59 */ 60 61 62 // LE Device db interface 63 64 /* API_START */ 65 66 /** 67 * @brief init 68 */ 69 void le_device_db_init(void); 70 71 72 /** 73 * @brief sets local bd addr. allows for db per Bluetooth controller 74 * @param bd_addr 75 */ 76 void le_device_db_set_local_bd_addr(bd_addr_t bd_addr); 77 78 /** 79 * @brief add device to db 80 * @param addr_type, address of the device 81 * @param irk of the device 82 * @returns index if successful, -1 otherwise 83 */ 84 int le_device_db_add(int addr_type, bd_addr_t addr, sm_key_t irk); 85 86 /** 87 * @brief get number of devices in db 88 * @returns number of device in db 89 */ 90 int le_device_db_count(void); 91 92 /** 93 * @brief get max number of devices in db for enumeration 94 * @returns max number of device in db 95 */ 96 int le_device_db_max_count(void); 97 98 /** 99 * @brief get device information: addr type and address needed to identify device 100 * @param index 101 * @param addr_type, address of the device as output 102 * @param irk of the device 103 */ 104 void le_device_db_info(int index, int * addr_type, bd_addr_t addr, sm_key_t irk); 105 106 107 /** 108 * @brief set remote encryption info 109 * @brief index 110 * @brief ediv 111 * @brief rand 112 * @brief ltk 113 * @brief key size 114 * @brief authenticated 115 * @brief authorized 116 * @breif secure_connection 117 */ 118 void le_device_db_encryption_set(int index, uint16_t ediv, uint8_t rand[8], sm_key_t ltk, int key_size, int authenticated, int authorized, int secure_connection); 119 120 /** 121 * @brief get remote encryption info 122 * @brief index 123 * @brief ediv 124 * @brief rand 125 * @brief ltk 126 * @brief key size 127 * @brief authenticated 128 * @brief authorized 129 * @breif secure_connection 130 */ 131 void le_device_db_encryption_get(int index, uint16_t * ediv, uint8_t rand[8], sm_key_t ltk, int * key_size, int * authenticated, int * authorized, int * secure_connection); 132 133 #ifdef ENABLE_LE_SIGNED_WRITE 134 135 /** 136 * @brief set local signing key for this device 137 * @param index 138 * @param signing key as input 139 */ 140 void le_device_db_local_csrk_set(int index, sm_key_t csrk); 141 142 /** 143 * @brief get local signing key for this device 144 * @param index 145 * @param signing key as output 146 */ 147 void le_device_db_local_csrk_get(int index, sm_key_t csrk); 148 149 /** 150 * @brief set remote signing key for this device 151 * @param index 152 * @param signing key as input 153 */ 154 void le_device_db_remote_csrk_set(int index, sm_key_t csrk); 155 156 /** 157 * @brief get remote signing key for this device 158 * @param index 159 * @param signing key as output 160 */ 161 void le_device_db_remote_csrk_get(int index, sm_key_t csrk); 162 163 /** 164 * @brief query last used/seen signing counter 165 * @param index 166 * @returns next expected counter, 0 after devices was added 167 */ 168 uint32_t le_device_db_remote_counter_get(int index); 169 170 /** 171 * @brief update signing counter 172 * @param index 173 * @param counter to store 174 */ 175 void le_device_db_remote_counter_set(int index, uint32_t counter); 176 177 /** 178 * @brief query last used/seen signing counter 179 * @param index 180 * @returns next expected counter, 0 after devices was added 181 */ 182 uint32_t le_device_db_local_counter_get(int index); 183 184 /** 185 * @brief update signing counter 186 * @param index 187 * @param counter to store 188 */ 189 void le_device_db_local_counter_set(int index, uint32_t counter); 190 191 #endif 192 193 /** 194 * @brief free device 195 * @param index 196 */ 197 void le_device_db_remove(int index); 198 199 void le_device_db_dump(void); 200 201 /* API_END */ 202 203 #if defined __cplusplus 204 } 205 #endif 206 207 #endif // LE_DEVICE_DB_H 208