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