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