[nrf fromtree] bluetooth: mesh: update max oob size till 32 bytes

Commit updates maximum OOB authentication size from 8 bytes
till 32 bytes according to specification errata ES-27446.
Since previous OOB API does not allow to expose OOB values
with such width the new API has been introduced.
The previous API was deprecated and hidden under
BT_MESH_PROV_OOB_API_LEGACY option and left for backward
compatibility with existing code base.

Signed-off-by: Aleksandr Khromykh <[email protected]>
(cherry picked from commit 613d228)
Signed-off-by: Aleksandr Khromykh <[email protected]>

Author: alxelax

doc/connectivity/bluetooth/api/mesh/provisioning.rst

@@ -144,7 +144,7 @@ sequence should be repeated after a delay of three seconds or more.
 When an Input OOB action is selected, the user should be prompted when the
 application receives the :c:member:`bt_mesh_prov.input` callback. The user
 response should be fed back to the Provisioning API through
-:c:func:`bt_mesh_input_string` or :c:func:`bt_mesh_input_number`. If
+:c:func:`bt_mesh_input_string` or :c:func:`bt_mesh_input_numeric`. If
 no user response is recorded within 60 seconds, the Provisioning process is
 aborted.
 

doc/releases/release-notes-4.4.rst

@@ -53,6 +53,15 @@ Removed APIs and options
 Deprecated APIs and options
 ===========================
 
+* Bluetooth
+
+  * Mesh
+
+    * The function :c:func:`bt_mesh_input_number` was deprecated. Applications should use
+      :c:func:`bt_mesh_input_numeric` instead.
+    * The callback :c:member:`output_number` in :c:struct:`bt_mesh_prov` structure was deprecated.
+      Applications should use :c:member:`output_numeric` callback instead.
+
 New APIs and options
 ====================
 
@@ -66,6 +75,12 @@ New APIs and options
 
 * Bluetooth
 
+  * Mesh
+
+    * :c:func:`bt_mesh_input_numeric` to provide provisioning numeric input OOB value.
+    * :c:member:`output_numeric` callback in :c:struct:`bt_mesh_prov` structure to
+      output numeric values during provisioning.
+
   * Services
 
     * Introduced Alert Notification Service (ANS) :kconfig:option:`CONFIG_BT_ANS`

include/zephyr/bluetooth/mesh/main.h

@@ -173,6 +173,7 @@ struct bt_mesh_prov {
 	 */
 	void         (*capabilities)(const struct bt_mesh_dev_capabilities *cap);
 
+#if defined CONFIG_BT_MESH_PROV_OOB_API_LEGACY
 	/** @brief Output of a number is requested.
 	 *
 	 *  This callback notifies the application that it should
@@ -183,7 +184,21 @@ struct bt_mesh_prov {
 	 *
 	 *  @return Zero on success or negative error code otherwise
 	 */
-	int         (*output_number)(bt_mesh_output_action_t act, uint32_t num);
+	int         (*output_number)(bt_mesh_output_action_t act, uint32_t num) __deprecated;
+#else
+	/** @brief Output of a numeric value is requested.
+	 *
+	 *  This callback notifies the application that it should
+	 *  output the given numeric value using the given action.
+	 *
+	 *  @param act Action for outputting the numeric value.
+	 *  @param numeric memory with numeric value in the little endian format to be outputted.
+	 *  @param size size of the numeric value in bytes.
+	 *
+	 *  @return Zero on success or negative error code otherwise
+	 */
+	int         (*output_numeric)(bt_mesh_output_action_t act, uint8_t *numeric, size_t size);
+#endif
 
 	/** @brief Output of a string is requested.
 	 *
@@ -202,7 +217,7 @@ struct bt_mesh_prov {
 	 *  request input from the user using the given action. The
 	 *  requested input will either be a string or a number, and
 	 *  the application needs to consequently call the
-	 *  bt_mesh_input_string() or bt_mesh_input_number() functions
+	 *  bt_mesh_input_string() or bt_mesh_input_numeric() functions
 	 *  once the data has been acquired from the user.
 	 *
 	 *  @param act Action for inputting data.
@@ -313,7 +328,7 @@ struct bt_mesh_rpr_node;
 
 /** @brief Provide provisioning input OOB string.
  *
- *  This is intended to be called after the bt_mesh_prov input callback
+ *  This is intended to be called after the @ref bt_mesh_prov::input callback
  *  has been called with BT_MESH_ENTER_STRING as the action.
  *
  *  @param str String.
@@ -322,16 +337,30 @@ struct bt_mesh_rpr_node;
  */
 int bt_mesh_input_string(const char *str);
 
+#if defined CONFIG_BT_MESH_PROV_OOB_API_LEGACY
 /** @brief Provide provisioning input OOB number.
  *
- *  This is intended to be called after the bt_mesh_prov input callback
- *  has been called with BT_MESH_ENTER_NUMBER as the action.
+ *  This is intended to be called after the @ref bt_mesh_prov::input callback
+ *  has been called with @ref BT_MESH_ENTER_NUMBER as the action.
  *
  *  @param num Number.
  *
  *  @return Zero on success or (negative) error code otherwise.
  */
-int bt_mesh_input_number(uint32_t num);
+__deprecated int bt_mesh_input_number(uint32_t num);
+#endif
+
+/** @brief Provide provisioning input OOB numeric value.
+ *
+ *  This is intended to be called after the @ref bt_mesh_prov::input callback
+ *  has been called with @ref BT_MESH_ENTER_NUMBER as the action.
+ *
+ *  @param numeric Pointer to the numeric value in little endian.
+ *  @param size Size of the numeric value in bytes (this is not OOB size).
+ *
+ *  @return Zero on success or (negative) error code otherwise.
+ */
+int bt_mesh_input_numeric(uint8_t *numeric, size_t size);
 
 /** @brief Provide Device public key.
  *
@@ -347,7 +376,7 @@ int bt_mesh_prov_remote_pub_key_set(const uint8_t public_key[64]);
  *
  *  Instruct the unprovisioned device to use the specified Input OOB
  *  authentication action. When using @ref BT_MESH_PUSH, @ref BT_MESH_TWIST or
- *  @ref BT_MESH_ENTER_NUMBER, the @ref bt_mesh_prov::output_number callback is
+ *  @ref BT_MESH_ENTER_NUMBER, the @ref bt_mesh_prov::output_numeric callback is
  *  called with a random number that has to be entered on the unprovisioned
  *  device.
  *
@@ -372,7 +401,7 @@ int bt_mesh_auth_method_set_input(bt_mesh_input_action_t action, uint8_t size);
  *
  *  When using @ref BT_MESH_BLINK, @ref BT_MESH_BEEP, @ref BT_MESH_VIBRATE
  *  or @ref BT_MESH_DISPLAY_NUMBER, and the application has to call
- *  @ref bt_mesh_input_number with the random number indicated by
+ *  @ref bt_mesh_input_numeric with the random number indicated by
  *  the unprovisioned device.
  *
  *  When using @ref BT_MESH_DISPLAY_STRING, the application has to call

samples/bluetooth/mesh/src/main.c

@@ -267,9 +267,16 @@ static const struct bt_mesh_comp comp = {
 };
 
 /* Provisioning */
-
-static int output_number(bt_mesh_output_action_t action, uint32_t number)
+static int output_numeric(bt_mesh_output_action_t action, uint8_t *numeric, size_t size)
 {
+	uint32_t number;
+
+	if (size != sizeof(number)) {
+		printk("Wrong OOB size: %u\n", size);
+		return -EINVAL;
+	}
+
+	number = sys_get_le32(numeric);
 	printk("OOB Number: %u\n", number);
 
 	board_output_number(action, number);
@@ -293,7 +300,7 @@ static const struct bt_mesh_prov prov = {
 	.uuid = dev_uuid,
 	.output_size = 4,
 	.output_actions = BT_MESH_DISPLAY_NUMBER,
-	.output_number = output_number,
+	.output_numeric = output_numeric,
 	.complete = prov_complete,
 	.reset = prov_reset,
 };

samples/boards/nordic/mesh/onoff-app/src/main.c

@@ -47,6 +47,7 @@
 #include <zephyr/bluetooth/hci.h>
 #include <zephyr/bluetooth/mesh.h>
 #include <stdio.h>
+#include <inttypes.h>
 
 /* Model Operation Codes */
 #define BT_MESH_MODEL_OP_GEN_ONOFF_GET		BT_MESH_MODEL_OP_2(0x82, 0x01)
@@ -366,9 +367,13 @@ static int gen_onoff_status(const struct bt_mesh_model *model,
 	return 0;
 }
 
-static int output_number(bt_mesh_output_action_t action, uint32_t number)
+static int output_numeric(bt_mesh_output_action_t action, uint8_t *numeric, size_t size)
 {
-	printk("OOB Number %06u\n", number);
+	uint64_t number = 0ull;
+
+	sys_get_le(&number, numeric, size);
+
+	printk("OOB Number %06" PRIu64 "\n", number);
 	return 0;
 }
 
@@ -525,7 +530,7 @@ static const struct bt_mesh_prov prov = {
 #if 1
 	.output_size = 6,
 	.output_actions = (BT_MESH_DISPLAY_NUMBER | BT_MESH_DISPLAY_STRING),
-	.output_number = output_number,
+	.output_numeric = output_numeric,
 	.output_string = output_string,
 #else
 	.output_size = 0,

samples/boards/nordic/mesh/onoff_level_lighting_vnd_app/src/mesh/ble_mesh.c

@@ -10,9 +10,13 @@
 
 #ifdef OOB_AUTH_ENABLE
 
-static int output_number(bt_mesh_output_action_t action, uint32_t number)
+static int output_numeric(bt_mesh_output_action_t action, uint8_t *numeric, size_t size)
 {
-	printk("OOB Number: %u\n", number);
+	uint64_t number = 0ull;
+
+	sys_get_le(&number, numeric, size);
+
+	printk("OOB Number %06" PRIu64 "\n", number);
 	return 0;
 }
 
@@ -42,7 +46,7 @@ static const struct bt_mesh_prov prov = {
 
 	.output_size = 6,
 	.output_actions = BT_MESH_DISPLAY_NUMBER | BT_MESH_DISPLAY_STRING,
-	.output_number = output_number,
+	.output_numeric = output_numeric,
 	.output_string = output_string,
 
 #endif

subsys/bluetooth/mesh/Kconfig

@@ -376,6 +376,18 @@ config BT_MESH_OOB_AUTH_REQUIRED
 	bool "OOB authentication mandates to use HMAC SHA256"
 	depends on BT_MESH_ECDH_P256_HMAC_SHA256_AES_CCM
 
+config BT_MESH_PROV_OOB_API_LEGACY
+	bool "Reduced maximum OOB authentication size support [DEPRECATED]"
+	select DEPRECATED
+	depends on BT_MESH_PROV
+	help
+	  By default, the maximum OOB authentication size is 32 bytes.
+	  Enable this option to use the legacy API which is only compatible with
+	  specification v1.1 and earlier. This limits OOB authentication to 8
+	  bytes maximum.
+	  This option is intended for backward compatibility.
+	  Not recommended for new designs due to reduced security.
+
 config BT_MESH_PROVISIONER
 	bool "Provisioner support"
 	depends on BT_MESH_CDB