src/ble/le_device_db_tlv.c (Bluetooth LE Stack)

Outline

#define BTSTACK_FILE__

#include "ble/le_device_db.h"

#include "ble/le_device_db_tlv.h"

#include "ble/core.h"

#include <string.h>

#include "btstack_debug.h"

#define INVALID_ENTRY_ADDR_TYPE

le_device_db_entry_t

entry_map

num_valid_entries

le_device_db_tlv_btstack_tlv_impl

le_device_db_tlv_btstack_tlv_context

le_device_db_tlv_tag_for_index(uint8_t)

le_device_db_tlv_fetch(int, le_device_db_entry_t *)

le_device_db_tlv_store(int, le_device_db_entry_t *)

le_device_db_tlv_delete(int)

le_device_db_tlv_scan()

le_device_db_init()

le_device_db_set_local_bd_addr(uint8_t *)

le_device_db_count()

le_device_db_max_count()

le_device_db_remove(int)

le_device_db_add(int, uint8_t *, uint8_t *)

le_device_db_info(int, int *, uint8_t *, uint8_t *)

le_device_db_encryption_set(int, uint16_t, uint8_t *, uint8_t *, int, int, int, int)

le_device_db_encryption_get(int, uint16_t *, uint8_t *, uint8_t *, int *, int *, int *, int *)

le_device_db_dump()

le_device_db_tlv_configure(const btstack_tlv_t *, void *)

Files

SourceVuRaspberry Pi Pico SDK and ExamplesBluetooth LE Stacksrc/ble/le_device_db_tlv.c

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

/* * Copyright (C) 2017 BlueKitchen GmbH * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the copyright holders nor the names of * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * 4. Any redistribution, use, or modification is done solely for * personal benefit and not for any commercial purpose or for * monetary gain. * * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * Please inquire about commercial licensing options at * contact@bluekitchen-gmbh.com * */ #define BTSTACK_FILE__ "le_device_db_tlv.c" #include "ble/le_device_db.h" #include "ble/le_device_db_tlv.h" #include "ble/core.h" #include <string.h> #include "btstack_debug.h" // LE Device DB Implementation storing entries in btstack_tlv // Local cache is used to keep track of deleted entries in TLV #define INVALID_ENTRY_ADDR_TYPE 0xff // Single stored entry typedef struct le_device_db_entry_t { uint32_t seq_nr; // used for "least recently stored" eviction strategy // Identification int addr_type; bd_addr_t addr; sm_key_t irk; // Stored pairing information allows to re-establish an enncrypted connection // with a peripheral that doesn't have any persistent memory sm_key_t ltk; uint16_t ediv; uint8_t rand[8]; uint8_t key_size; uint8_t authenticated; uint8_t authorized; uint8_t secure_connection; #ifdef ENABLE_LE_SIGNED_WRITE // Signed Writes by remote sm_key_t remote_csrk; uint32_t remote_counter; // Signed Writes by us sm_key_t local_csrk; uint32_t local_counter; #endif } le_device_db_entry_t; #ifndef NVM_NUM_DEVICE_DB_ENTRIES #error "NVM_NUM_DEVICE_DB_ENTRIES not defined, please define in btstack_config.h" #endif #if NVM_NUM_DEVICE_DB_ENTRIES == 0 #error "NVM_NUM_DEVICE_DB_ENTRIES must not be 0, please update in btstack_config.h" #endif // only stores if entry present static uint8_t entry_map[NVM_NUM_DEVICE_DB_ENTRIES]; static uint32_t num_valid_entries; static const btstack_tlv_t * le_device_db_tlv_btstack_tlv_impl; static void * le_device_db_tlv_btstack_tlv_context; static uint32_t le_device_db_tlv_tag_for_index(uint8_t index){ static const char tag_0 = 'B'; static const char tag_1 = 'T'; static const char tag_2 = 'D'; return (tag_0 << 24u) | (tag_1 << 16u) | (tag_2 << 8u) | index; } // @return success // @param index = entry_pos static bool le_device_db_tlv_fetch(int index, le_device_db_entry_t * entry){ btstack_assert(le_device_db_tlv_btstack_tlv_impl != NULL); btstack_assert(index >= 0); btstack_assert(index < NVM_NUM_DEVICE_DB_ENTRIES); uint32_t tag = le_device_db_tlv_tag_for_index(index); int size = le_device_db_tlv_btstack_tlv_impl->get_tag(le_device_db_tlv_btstack_tlv_context, tag, (uint8_t*) entry, sizeof(le_device_db_entry_t)); return size == sizeof(le_device_db_entry_t); } // @return success // @param index = entry_pos static bool le_device_db_tlv_store(int index, le_device_db_entry_t * entry){ btstack_assert(le_device_db_tlv_btstack_tlv_impl != NULL); btstack_assert(index >= 0); btstack_assert(index < NVM_NUM_DEVICE_DB_ENTRIES); uint32_t tag = le_device_db_tlv_tag_for_index(index); int result = le_device_db_tlv_btstack_tlv_impl->store_tag(le_device_db_tlv_btstack_tlv_context, tag, (uint8_t*) entry, sizeof(le_device_db_entry_t)); return result == 0; } // @param index = entry_pos static bool le_device_db_tlv_delete(int index){ btstack_assert(le_device_db_tlv_btstack_tlv_impl != NULL); btstack_assert(index >= 0); btstack_assert(index < NVM_NUM_DEVICE_DB_ENTRIES); uint32_t tag = le_device_db_tlv_tag_for_index(index); le_device_db_tlv_btstack_tlv_impl->delete_tag(le_device_db_tlv_btstack_tlv_context, tag); return true; } static void le_device_db_tlv_scan(void){ int i; num_valid_entries = 0; memset(entry_map, 0, sizeof(entry_map)); for (i=0;i<NVM_NUM_DEVICE_DB_ENTRIES;i++){ // lookup entry le_device_db_entry_t entry; if (!le_device_db_tlv_fetch(i, &entry)) continue; entry_map[i] = 1; num_valid_entries++; } void le_device_db_init(void){ if (!le_device_db_tlv_btstack_tlv_impl) { log_error("btstack_tlv not initialized"); } } // not used void le_device_db_set_local_bd_addr(bd_addr_t bd_addr){ (void)bd_addr; } // @return number of device in db int le_device_db_count(void){ return num_valid_entries; } int le_device_db_max_count(void){ return NVM_NUM_DEVICE_DB_ENTRIES; } void le_device_db_remove(int index){ btstack_assert(index >= 0); btstack_assert(index < le_device_db_max_count()); // check if entry exists if (entry_map[index] == 0u) return; // delete entry in TLV le_device_db_tlv_delete(index); // mark as unused entry_map[index] = 0; // keep track num_valid_entries--; } int le_device_db_add(int addr_type, bd_addr_t addr, sm_key_t irk){ uint32_t highest_seq_nr = 0; uint32_t lowest_seq_nr = 0xFFFFFFFFU; int index_for_lowest_seq_nr = -1; int index_for_addr = -1; int index_for_empty = -1; bool new_entry = false; // find unused entry in the used list int i; for (i=0;i<NVM_NUM_DEVICE_DB_ENTRIES;i++){ if (entry_map[i] != 0u) { le_device_db_entry_t entry; le_device_db_tlv_fetch(i, &entry); // found addr? if ((memcmp(addr, entry.addr, 6) == 0) && (addr_type == entry.addr_type)){ index_for_addr = i; } // update highest seq nr if (entry.seq_nr > highest_seq_nr){ highest_seq_nr = entry.seq_nr; } // find entry with lowest seq nr if ((index_for_lowest_seq_nr == -1) || (entry.seq_nr < lowest_seq_nr)){ index_for_lowest_seq_nr = i; lowest_seq_nr = entry.seq_nr; } } else { index_for_empty = i; } }for (i=0;i log_info("index_for_addr %x, index_for_empy %x, index_for_lowest_seq_nr %x", index_for_addr, index_for_empty, index_for_lowest_seq_nr); uint32_t index_to_use = 0; if (index_for_addr >= 0){ index_to_use = index_for_addr; } else if (index_for_empty >= 0){ new_entry = true; index_to_use = index_for_empty; } else if (index_for_lowest_seq_nr >= 0){ index_to_use = index_for_lowest_seq_nr; } else { // should not happen return -1; } log_info("new entry for index %u", (unsigned int) index_to_use); // store entry at index le_device_db_entry_t entry; log_info("LE Device DB adding type %u - %s", addr_type, bd_addr_to_str(addr)); log_info_key("irk", irk); memset(&entry, 0, sizeof(le_device_db_entry_t)); entry.addr_type = addr_type; (void)memcpy(entry.addr, addr, 6); (void)memcpy(entry.irk, irk, 16); entry.seq_nr = highest_seq_nr + 1u; #ifdef ENABLE_LE_SIGNED_WRITE entry.remote_counter = 0; #endif // store bool ok = le_device_db_tlv_store(index_to_use, &entry); if (!ok){ log_error("tag store failed"); return -1; } // set in entry_mape entry_map[index_to_use] = 1; // keep track - don't increase if old entry found or replaced if (new_entry){ num_valid_entries++; } return index_to_use; } // get device information: addr type and address void le_device_db_info(int index, int * addr_type, bd_addr_t addr, sm_key_t irk){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); // set defaults if not found if (!ok) { memset(&entry, 0, sizeof(le_device_db_entry_t)); entry.addr_type = BD_ADDR_TYPE_UNKNOWN; } // setup return values if (addr_type != NULL) *addr_type = entry.addr_type; if (addr != NULL) (void)memcpy(addr, entry.addr, 6); if (irk != NULL) (void)memcpy(irk, entry.irk, 16); } 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){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return; // update log_info("LE Device DB set encryption for %u, ediv x%04x, key size %u, authenticated %u, authorized %u, secure connection %u", index, ediv, key_size, authenticated, authorized, secure_connection); entry.ediv = ediv; if (rand != NULL){ (void)memcpy(entry.rand, rand, 8); } if (ltk != 0) { (void)memcpy(entry.ltk, ltk, 16); } entry.key_size = key_size; entry.authenticated = authenticated; entry.authorized = authorized; entry.secure_connection = secure_connection; // store ok = le_device_db_tlv_store(index, &entry); if (!ok){ log_error("Set encryption data failed"); } } 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){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return; // update user fields log_info("LE Device DB encryption for %u, ediv x%04x, keysize %u, authenticated %u, authorized %u, secure connection %u", index, entry.ediv, entry.key_size, entry.authenticated, entry.authorized, entry.secure_connection); if (ediv != NULL) *ediv = entry.ediv; if (rand != NULL) (void)memcpy(rand, entry.rand, 8); if (ltk != NULL) (void)memcpy(ltk, entry.ltk, 16); if (key_size != NULL) *key_size = entry.key_size; if (authenticated != NULL) *authenticated = entry.authenticated; if (authorized != NULL) *authorized = entry.authorized; if (secure_connection != NULL) *secure_connection = entry.secure_connection; } #ifdef ENABLE_LE_SIGNED_WRITE // get signature key void le_device_db_remote_csrk_get(int index, sm_key_t csrk){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return; if (csrk) (void)memcpy(csrk, entry.remote_csrk, 16); } void le_device_db_remote_csrk_set(int index, sm_key_t csrk){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return; if (!csrk) return; // update (void)memcpy(entry.remote_csrk, csrk, 16); // store le_device_db_tlv_store(index, &entry); } void le_device_db_local_csrk_get(int index, sm_key_t csrk){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return; if (!csrk) return; // fill (void)memcpy(csrk, entry.local_csrk, 16); } void le_device_db_local_csrk_set(int index, sm_key_t csrk){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return; if (!csrk) return; // update (void)memcpy(entry.local_csrk, csrk, 16); // store le_device_db_tlv_store(index, &entry); } // query last used/seen signing counter uint32_t le_device_db_remote_counter_get(int index){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return 0; return entry.remote_counter; } // update signing counter void le_device_db_remote_counter_set(int index, uint32_t counter){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return; entry.remote_counter = counter; // store le_device_db_tlv_store(index, &entry); } // query last used/seen signing counter uint32_t le_device_db_local_counter_get(int index){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return 0; return entry.local_counter; } // update signing counter void le_device_db_local_counter_set(int index, uint32_t counter){ // fetch entry le_device_db_entry_t entry; int ok = le_device_db_tlv_fetch(index, &entry); if (!ok) return; // update entry.local_counter = counter; // store le_device_db_tlv_store(index, &entry); } #endif void le_device_db_dump(void){ log_info("LE Device DB dump, devices: %d", le_device_db_count()); uint32_t i; for (i=0;i<NVM_NUM_DEVICE_DB_ENTRIES;i++){ if (!entry_map[i]) continue; // fetch entry le_device_db_entry_t entry; le_device_db_tlv_fetch(i, &entry); log_info("%u: %u %s", (unsigned int) i, entry.addr_type, bd_addr_to_str(entry.addr)); log_info_key("ltk", entry.ltk); log_info_key("irk", entry.irk); #ifdef ENABLE_LE_SIGNED_WRITE log_info_key("local csrk", entry.local_csrk); log_info_key("remote csrk", entry.remote_csrk); #endif } void le_device_db_tlv_configure(const btstack_tlv_t * btstack_tlv_impl, void * btstack_tlv_context){ le_device_db_tlv_btstack_tlv_impl = btstack_tlv_impl; le_device_db_tlv_btstack_tlv_context = btstack_tlv_context; le_device_db_tlv_scan(); }

Details