mbed-os/connectivity/FEATURE_BLE
Jamie Smith 97c267219a
Fix all Doxygen errors and make any future errors fatal (#118)
* Start working on fixing doxygen warnings

* Upgrade doxyfile to Doxygen 1.9.1

* Clean up some unmatched groups and add some exclusions

* Fix docs for rtos::ThisThread not showing up

* Fix up KV store docs

* Fix incorrect @files, some more incorrect groups

* Fix lots of broken links

* Start fixing mbedtls groups

* Fix more mbedtls docs

* Fix remaining mbedtls files with missing or incorrect grouping

* Fix a huge amount of PSA docs errors

* Fix a few more mbedtls docs errors

* Fix __cplusplus not defined for docs, clean up call in callback typedef, fix some docs errors

* Fix some broken doc links in HAL headers

* Fix more PSA doc errors

* Fix some doxygen errors in networking code

* Fix lots of network related doc errors

* Try and fix some CI failures

* Use Doxygen Action instead of doxygen in Mbed container to get the right version

* Try removing docs check

* Add first part of doxygen action

* Add next part of doxygen action

* Fix yaml syntax error

* Add in license check fix

* Try using verbose scancode

* Fix some more docs issues, workaround scancode-toolkit#3179

* Clean up the LoRaRadio get_state() function on each implementation.  Also fix some other compile and doc errors.

* Fix all remaining doxygen errors

* Fix escaping, for realsies this time

* Remove Doxygen unsupported config options, fix some more get_status() declarations

* Fix some UNITTESTS build errors

* Fix one more compile error

* Another unittest error
2022-12-30 18:41:41 -05:00
..
include/ble Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
libraries Fix compilation of I2C code on static pinmap targets (#110) 2022-12-04 00:17:49 -08:00
source Enable Arduino Nano 33 BLE (#55) 2022-10-16 10:32:38 -07:00
tests/UNITTESTS cmake: Avoid linking to gcov 2021-07-22 15:41:49 +01:00
.gitignore remove generic, TPPs, nested namespaces 2020-08-07 11:59:14 +01:00
.mbedignore remove generic, TPPs, nested namespaces 2020-08-07 11:59:14 +01:00
CMakeLists.txt Fix compilation of I2C code on static pinmap targets (#110) 2022-12-04 00:17:49 -08:00
DOXYGEN_FRONTPAGE_BLE.md remove generic, TPPs, nested namespaces 2020-08-07 11:59:14 +01:00
LICENSE remove generic, TPPs, nested namespaces 2020-08-07 11:59:14 +01:00
README.md Bluetooth: Inform privacy risk of using signed writes. 2022-05-06 13:44:33 +01:00
apache-2.0.txt remove generic, TPPs, nested namespaces 2020-08-07 11:59:14 +01:00
ble.doxyfile remove generic, TPPs, nested namespaces 2020-08-07 11:59:14 +01:00
mbed_lib.json add information about privacy refresh to config option 2021-06-02 12:06:12 +01:00

README.md

mbed Bluetooth Low Energy Stack

This is the Github repository for the BLE_API. Please see the Mbed OS Example BLE GitHub Repo for all code examples, and the Mbed OS BLE API page for all code documentation and general help.

Getting Started

Privacy notice

The Cordio Bluetooth stack only stores one single signing key. This key is then shared across all bonded devices. If a malicious device bonds with the Mbed OS application it then gains knowledge of the shared signing key of the Mbed OS device. The malicious device can then track the Mbed OS device whenever a signing write is issued from it.

To overcome this privacy issue do not issue signed writes from the Mbed OS device. A signed write occurs when the member function write of GattClient is called with its cmd argument set to GATT_OP_SIGNED_WRITE_CMD.

Instead of using signed writes, enable encryption on the connection. This is achieved by calling the function setLinkEncryption of the SecurityManager. Set the encryption to at least ENCRYPTED.