Feature/ndef btle oob security (#93)

* feat(ndef): add support for security fields to ndef * Updated bt/le oob pairing NDEF recordfunctions to support security values (randomizer/confirmation and temporary key) * doc: rebuild
esp-cpp · Jul 17, 2023 · b1f8e3d · b1f8e3d
1 parent 264b2a9
commit b1f8e3d
Show file tree

Hide file tree

Showing 75 changed files with 209 additions and 157 deletions.
diff --git a/components/ndef/include/ndef.hpp b/components/ndef/include/ndef.hpp
@@ -317,9 +317,14 @@ class Ndef {
    *       0xf412fa42fe9e.
    * @param device_class The bluetooth device class for this radio.
    * @param name Name of the BT device.
+   * @param random_value The Simple pairing randomizer R for the pairing.
+   * @param confirm_value The Simple pairing hash C (confirm value) for the
+   *                      pairing.
    * @return NDEF record object.
    */
-  static Ndef make_oob_pairing(uint64_t mac_addr, uint32_t device_class, std::string_view name) {
+  static Ndef make_oob_pairing(uint64_t mac_addr, uint32_t device_class, std::string_view name,
+                               std::string_view random_value = "",
+                               std::string_view confirm_value = "") {
     std::vector<uint8_t> data;
     // NOTE: for the extended inquiry response (EIR) data types see the
     // BT_HANDOVER_TYPE_ codes here:
@@ -344,6 +349,20 @@ class Ndef {
     // add optional EIR data (no specific order required)
     add_bt_eir(data, BtEir::LONG_LOCAL_NAME, name);
 
+    // (optional  0x22) secure connections confirmation value (16 bytes)
+    if (confirm_value.size() == 16) {
+      add_bt_eir(data, BtEir::SP_HASH_C192, confirm_value);
+    } else {
+      fmt::print("confirm_value must be 16 bytes, got {}\n", confirm_value.size());
+    }
+
+    // (optional  0x23) secure connections random value (16 bytes)
+    if (random_value.size() == 16) {
+      add_bt_eir(data, BtEir::SP_RANDOM_R192, random_value);
+    } else {
+      fmt::print("random_value must be 16 bytes, got {}\n", random_value.size());
+    }
+
     // now make sure the length is updated (includes length field)
     int length = data.size();
     data[0] = length;
@@ -359,10 +378,15 @@ class Ndef {
    * @param role The BLE role of the device (central / peripheral / dual)
    * @param name Name of the BLE device.
    * @param appearance BtAppearance of the device.
+   * @param random_value The Simple pairing randomizer R for the pairing.
+   * @param confirm_value The Simple pairing hash C (confirm value) for the
+   * @param tk Temporary key for the pairing (16 bytes, optional)
    * @return NDEF record object.
    */
   static Ndef make_le_oob_pairing(uint64_t mac_addr, BleRole role, std::string_view name,
-                                  BtAppearance appearance = BtAppearance::UNKNOWN) {
+                                  BtAppearance appearance = BtAppearance::UNKNOWN,
+                                  std::string_view random_value = "",
+                                  std::string_view confirm_value = "", std::string_view tk = "") {
     std::vector<uint8_t> data;
     // NOTE: for the extended inquiry response (EIR) data types see the
     // BT_HANDOVER_TYPE_ codes here:
@@ -387,6 +411,27 @@ class Ndef {
     // (mandatory 0x1C) LE role
     add_bt_eir(data, BtEir::LE_ROLE, std::string_view{(const char *)&role, 1});
 
+    // (optional  0x10) Security Manager TK value (LE legacy pairing) (16 bytes)
+    if (tk.size() == 16) {
+      add_bt_eir(data, BtEir::SECURITY_MANAGER_TK, tk);
+    } else {
+      fmt::print("tk must be 16 bytes, got {}\n", tk.size());
+    }
+
+    // (optional  0x22) secure connections confirmation value (16 bytes)
+    if (confirm_value.size() == 16) {
+      add_bt_eir(data, BtEir::LE_SC_CONFIRMATION, confirm_value);
+    } else {
+      fmt::print("confirm_value must be 16 bytes, got {}\n", confirm_value.size());
+    }
+
+    // (optional  0x23) secure connections random value (16 bytes)
+    if (random_value.size() == 16) {
+      add_bt_eir(data, BtEir::LE_SC_RANDOM, random_value);
+    } else {
+      fmt::print("random_value must be 16 bytes, got {}\n", random_value.size());
+    }
+
     // optional appearance
     uint8_t appearance_bytes[] = {(uint8_t)((uint16_t)appearance >> 8),
                                   (uint8_t)((uint16_t)appearance & 0xFF)};
@@ -398,11 +443,6 @@ class Ndef {
     // same device capable (controller) add_bt_eir(data, BtEir::FLAGS, std::string_view{(const char
     // *)&flags_bytes[0], sizeof(flags_bytes)});
 
-    // TODO: provide additional optional parameters
-    // (optional  0x10) Security Manager TK value (LE legacy pairing)
-    // (optional  0x22) LE secure connections confirmation value
-    // (optional  0x23) LE secure connections random value
-
     auto sv_data = std::string_view{(const char *)data.data(), data.size()};
     return Ndef(TNF::MIME_MEDIA, "application/vnd.bluetooth.le.oob", sv_data);
   }
@@ -538,6 +578,7 @@ class Ndef {
       num_eir_bytes = 3; // 24 bit class of device structure
       break;
     case BtEir::SECURITY_MANAGER_TK:
+      num_eir_bytes = payload.size();
       break;
     case BtEir::APPEARANCE:
       num_eir_bytes = 2; // 2 byte appearance type
@@ -548,9 +589,15 @@ class Ndef {
     case BtEir::LE_ROLE:
       num_eir_bytes = 1;
       break;
+    case BtEir::SP_HASH_C192:
     case BtEir::LE_SC_CONFIRMATION:
+      // NOTE: should be 16
+      num_eir_bytes = payload.size();
       break;
+    case BtEir::SP_RANDOM_R192:
     case BtEir::LE_SC_RANDOM:
+      // NOTE: should be 16
+      num_eir_bytes = payload.size();
       break;
     default:
       break;

diff --git a/docs/adc/adc_types.html b/docs/adc/adc_types.html
@@ -141,7 +141,7 @@
           <li><a href="index.html">ADC APIs</a> &raquo;</li>
       <li>ADC Types</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/adc/adc_types.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/adc/adc_types.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>

diff --git a/docs/adc/ads1x15.html b/docs/adc/ads1x15.html
@@ -142,7 +142,7 @@
           <li><a href="index.html">ADC APIs</a> &raquo;</li>
       <li>ADS1x15 I2C ADC</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/adc/ads1x15.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/adc/ads1x15.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -159,7 +159,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/ads1x15/include/ads1x15.hpp">components/ads1x15/include/ads1x15.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/ads1x15/include/ads1x15.hpp">components/ads1x15/include/ads1x15.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">

diff --git a/docs/adc/ads7138.html b/docs/adc/ads7138.html
@@ -142,7 +142,7 @@
           <li><a href="index.html">ADC APIs</a> &raquo;</li>
       <li>ADS7138 I2C ADC</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/adc/ads7138.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/adc/ads7138.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -164,7 +164,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/ads7138/include/ads7138.hpp">components/ads7138/include/ads7138.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/ads7138/include/ads7138.hpp">components/ads7138/include/ads7138.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">

diff --git a/docs/adc/continuous_adc.html b/docs/adc/continuous_adc.html
@@ -142,7 +142,7 @@
           <li><a href="index.html">ADC APIs</a> &raquo;</li>
       <li>Continuous ADC</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/adc/continuous_adc.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/adc/continuous_adc.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -164,7 +164,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/adc/include/continuous_adc.hpp">components/adc/include/continuous_adc.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/adc/include/continuous_adc.hpp">components/adc/include/continuous_adc.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">

diff --git a/docs/adc/index.html b/docs/adc/index.html
@@ -134,7 +134,7 @@
       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
       <li>ADC APIs</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/adc/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/adc/index.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>

diff --git a/docs/adc/oneshot_adc.html b/docs/adc/oneshot_adc.html
@@ -142,7 +142,7 @@
           <li><a href="index.html">ADC APIs</a> &raquo;</li>
       <li>Oneshot ADC</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/adc/oneshot_adc.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/adc/oneshot_adc.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -163,7 +163,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/adc/include/oneshot_adc.hpp">components/adc/include/oneshot_adc.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/adc/include/oneshot_adc.hpp">components/adc/include/oneshot_adc.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">

diff --git a/docs/bldc/bldc_driver.html b/docs/bldc/bldc_driver.html
@@ -139,7 +139,7 @@
           <li><a href="index.html">BLDC APIs</a> &raquo;</li>
       <li>BLDC Driver</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/bldc/bldc_driver.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/bldc/bldc_driver.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -156,7 +156,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/bldc_driver/include/bldc_driver.hpp">components/bldc_driver/include/bldc_driver.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/bldc_driver/include/bldc_driver.hpp">components/bldc_driver/include/bldc_driver.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">

diff --git a/docs/bldc/bldc_motor.html b/docs/bldc/bldc_motor.html
@@ -141,7 +141,7 @@
           <li><a href="index.html">BLDC APIs</a> &raquo;</li>
       <li>BLDC Motor</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/bldc/bldc_motor.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/bldc/bldc_motor.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -172,7 +172,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/bldc_motor/include/bldc_motor.hpp">components/bldc_motor/include/bldc_motor.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/bldc_motor/include/bldc_motor.hpp">components/bldc_motor/include/bldc_motor.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">
@@ -561,13 +561,13 @@ <h4>Example Usage<a class="headerlink" href="#classespp_1_1_bldc_motor_1bldc_mot
 <section id="id1">
 <h3>Header File<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/bldc_motor/include/bldc_types.hpp">components/bldc_motor/include/bldc_types.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/bldc_motor/include/bldc_types.hpp">components/bldc_motor/include/bldc_types.hpp</a></p></li>
 </ul>
 </section>
 <section id="id2">
 <h3>Header File<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/bldc_motor/include/sensor_direction.hpp">components/bldc_motor/include/sensor_direction.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/bldc_motor/include/sensor_direction.hpp">components/bldc_motor/include/sensor_direction.hpp</a></p></li>
 </ul>
 </section>
 </section>

diff --git a/docs/bldc/index.html b/docs/bldc/index.html
@@ -131,7 +131,7 @@
       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
       <li>BLDC APIs</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/bldc/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/bldc/index.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>

diff --git a/docs/button.html b/docs/button.html
@@ -134,7 +134,7 @@
       <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
       <li>Button APIs</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/button.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/button.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -160,7 +160,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/button/include/button.hpp">components/button/include/button.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/button/include/button.hpp">components/button/include/button.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">

diff --git a/docs/cli.html b/docs/cli.html
@@ -137,7 +137,7 @@
       <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
       <li>Command Line Interface (CLI) APIs</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/cli.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/cli.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -180,7 +180,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/cli/include/cli.hpp">components/cli/include/cli.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/cli/include/cli.hpp">components/cli/include/cli.hpp</a></p></li>
 </ul>
 </section>
 <section id="macros">
@@ -344,7 +344,7 @@ <h4>Oneshot CLI Example<a class="headerlink" href="#classespp_1_1_cli_1cli_ex1"
 <section id="id1">
 <h3>Header File<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/cli/include/line_input.hpp">components/cli/include/line_input.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/cli/include/line_input.hpp">components/cli/include/line_input.hpp</a></p></li>
 </ul>
 </section>
 <section id="id2">

diff --git a/docs/color.html b/docs/color.html
@@ -134,7 +134,7 @@
       <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
       <li>Color APIs</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/color.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/color.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -157,7 +157,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/color/include/color.hpp">components/color/include/color.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/color/include/color.hpp">components/color/include/color.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">

diff --git a/docs/controller.html b/docs/controller.html
@@ -134,7 +134,7 @@
       <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
       <li>Controller APIs</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/0c1c6a8/docs/en/controller.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/24d75ce/docs/en/controller.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -155,7 +155,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/0c1c6a8/components/controller/include/controller.hpp">components/controller/include/controller.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/24d75ce/components/controller/include/controller.hpp">components/controller/include/controller.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">