xref: /btstack/src/ble/le_device_db_memory.c (revision eda85fbfc36515a53a1cde4ebbd056380fafe3f2)
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 #include "ble/le_device_db.h"
39 
40 #include "ble/core.h"
41 
42 #include <stdio.h>
43 #include <string.h>
44 #include "btstack_debug.h"
45 
46 // Central Device db implemenation using static memory
47 typedef struct le_device_memory_db {
48 
49     // Identification
50     int addr_type;
51     bd_addr_t addr;
52     sm_key_t irk;
53 
54     // Stored pairing information allows to re-establish an enncrypted connection
55     // with a peripheral that doesn't have any persistent memory
56     sm_key_t ltk;
57     uint16_t ediv;
58     uint8_t  rand[8];
59     uint8_t  key_size;
60     uint8_t  authenticated;
61     uint8_t  authorized;
62 
63 #ifdef ENABLE_LE_SIGNED_WRITE
64     // Signed Writes by remote
65     sm_key_t remote_csrk;
66     uint32_t remote_counter;
67 
68     // Signed Writes by us
69     sm_key_t local_csrk;
70     uint32_t local_counter;
71 #endif
72 
73 } le_device_memory_db_t;
74 
75 #define LE_DEVICE_MEMORY_SIZE 4
76 #define INVALID_ENTRY_ADDR_TYPE 0xff
77 
78 static le_device_memory_db_t le_devices[LE_DEVICE_MEMORY_SIZE];
79 
80 void le_device_db_init(void){
81     int i;
82     for (i=0;i<LE_DEVICE_MEMORY_SIZE;i++){
83         le_device_db_remove(i);
84     }
85 }
86 
87 void le_device_db_set_local_bd_addr(bd_addr_t bd_addr){
88     (void)bd_addr;
89 }
90 
91 // @returns number of device in db
92 int le_device_db_count(void){
93     int i;
94     int counter = 0;
95     for (i=0;i<LE_DEVICE_MEMORY_SIZE;i++){
96         if (le_devices[i].addr_type != INVALID_ENTRY_ADDR_TYPE) counter++;
97     }
98     return counter;
99 }
100 
101 // free device
102 void le_device_db_remove(int index){
103     le_devices[index].addr_type = INVALID_ENTRY_ADDR_TYPE;
104 }
105 
106 int le_device_db_add(int addr_type, bd_addr_t addr, sm_key_t irk){
107     int i;
108     int index = -1;
109     for (i=0;i<LE_DEVICE_MEMORY_SIZE;i++){
110          if (le_devices[i].addr_type == INVALID_ENTRY_ADDR_TYPE){
111             index = i;
112             break;
113          }
114     }
115 
116     if (index < 0) return -1;
117 
118     log_info("Central Device DB adding type %u - %s", addr_type, bd_addr_to_str(addr));
119     log_info_key("irk", irk);
120 
121     le_devices[index].addr_type = addr_type;
122     memcpy(le_devices[index].addr, addr, 6);
123     memcpy(le_devices[index].irk, irk, 16);
124 #ifdef ENABLE_LE_SIGNED_WRITE
125     le_devices[index].remote_counter = 0;
126 #endif
127     return index;
128 }
129 
130 
131 // get device information: addr type and address
132 void le_device_db_info(int index, int * addr_type, bd_addr_t addr, sm_key_t irk){
133     if (addr_type) *addr_type = le_devices[index].addr_type;
134     if (addr) memcpy(addr, le_devices[index].addr, 6);
135     if (irk) memcpy(irk, le_devices[index].irk, 16);
136 }
137 
138 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){
139     log_info("Central Device DB set encryption for %u, ediv x%04x, key size %u, authenticated %u, authorized %u",
140         index, ediv, key_size, authenticated, authorized);
141     le_device_memory_db_t * device = &le_devices[index];
142     device->ediv = ediv;
143     if (rand) memcpy(device->rand, rand, 8);
144     if (ltk) memcpy(device->ltk, ltk, 16);
145     device->key_size = key_size;
146     device->authenticated = authenticated;
147     device->authorized = authorized;
148 }
149 
150 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){
151     le_device_memory_db_t * device = &le_devices[index];
152     log_info("Central Device DB encryption for %u, ediv x%04x, keysize %u, authenticated %u, authorized %u",
153         index, device->ediv, device->key_size, device->authenticated, device->authorized);
154     if (ediv) *ediv = device->ediv;
155     if (rand) memcpy(rand, device->rand, 8);
156     if (ltk)  memcpy(ltk, device->ltk, 16);
157     if (key_size) *key_size = device->key_size;
158     if (authenticated) *authenticated = device->authenticated;
159     if (authorized) *authorized = device->authorized;
160 }
161 
162 #ifdef ENABLE_LE_SIGNED_WRITE
163 
164 // get signature key
165 void le_device_db_remote_csrk_get(int index, sm_key_t csrk){
166     if (index < 0 || index >= LE_DEVICE_MEMORY_SIZE){
167         log_error("le_device_db_remote_csrk_get called with invalid index %d", index);
168         return;
169     }
170     if (csrk) memcpy(csrk, le_devices[index].remote_csrk, 16);
171 }
172 
173 void le_device_db_remote_csrk_set(int index, sm_key_t csrk){
174     if (index < 0 || index >= LE_DEVICE_MEMORY_SIZE){
175         log_error("le_device_db_remote_csrk_set called with invalid index %d", index);
176         return;
177     }
178     if (csrk) memcpy(le_devices[index].remote_csrk, csrk, 16);
179 }
180 
181 void le_device_db_local_csrk_get(int index, sm_key_t csrk){
182     if (index < 0 || index >= LE_DEVICE_MEMORY_SIZE){
183         log_error("le_device_db_local_csrk_get called with invalid index %d", index);
184         return;
185     }
186     if (csrk) memcpy(csrk, le_devices[index].local_csrk, 16);
187 }
188 
189 void le_device_db_local_csrk_set(int index, sm_key_t csrk){
190     if (index < 0 || index >= LE_DEVICE_MEMORY_SIZE){
191         log_error("le_device_db_local_csrk_set called with invalid index %d", index);
192         return;
193     }
194     if (csrk) memcpy(le_devices[index].local_csrk, csrk, 16);
195 }
196 
197 // query last used/seen signing counter
198 uint32_t le_device_db_remote_counter_get(int index){
199     return le_devices[index].remote_counter;
200 }
201 
202 // update signing counter
203 void le_device_db_remote_counter_set(int index, uint32_t counter){
204     le_devices[index].remote_counter = counter;
205 }
206 
207 // query last used/seen signing counter
208 uint32_t le_device_db_local_counter_get(int index){
209     return le_devices[index].local_counter;
210 }
211 
212 // update signing counter
213 void le_device_db_local_counter_set(int index, uint32_t counter){
214     le_devices[index].local_counter = counter;
215 }
216 
217 #endif
218 
219 void le_device_db_dump(void){
220     log_info("Central Device DB dump, devices: %d", le_device_db_count());
221     int i;
222     for (i=0;i<LE_DEVICE_MEMORY_SIZE;i++){
223         if (le_devices[i].addr_type == INVALID_ENTRY_ADDR_TYPE) continue;
224         log_info("%u: %u %s", i, le_devices[i].addr_type, bd_addr_to_str(le_devices[i].addr));
225         log_info_key("irk", le_devices[i].irk);
226 #ifdef ENABLE_LE_SIGNED_WRITE
227         log_info_key("local csrk", le_devices[i].local_csrk);
228         log_info_key("remote csrk", le_devices[i].remote_csrk);
229 #endif
230     }
231 }
232