Skip to contentSkip to conversation

Enhance GATT to pass PTS tests

PATCH Superseded Frédéric Danis 3 participants 10 messages Jan 22, 2024 – Jan 23, 2024 Bluetooth drivers

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover Enhance GATT to pass PTS tests

The first patch allow to prevent automatic security level change to allow to the security error when running GATT/CL/GAR/BI-04-C using btgatt-client.

The other patches add commands to be able to call GATT discovery functions from btgatt-client and get their results.

Frédéric Danis (5):
gatt: Prevent security level change for PTS GATT tests
btgatt-client: Add function to search service based on UUID
btgatt-client: Add function to search characteristics
btgatt-client: Add function to search descriptors
btgatt-client: Add function to search all primary services

 src/shared/att.c         |  14 ++
 src/shared/att.h         |   1 +
 src/shared/gatt-client.c |   9 ++
 src/shared/gatt-client.h |   2 +
 tools/btgatt-client.c    | 296 +++++++++++++++++++++++++++++++++++++++
 5 files changed, 322 insertions(+)
Signature · 1 line
2.34.1
#1 lore raw

PATCH 1/5 gatt: Prevent security level change for PTS GATT tests

Some PTS GATT tests like GATT/CL/GAR/BI-04-C request to be able to get the security error and do not try to change the security level.

this commit adds a variable allowing to prevent to change the security level.

---
 src/shared/att.c         | 14 ++++++++++++++
 src/shared/att.h         |  1 +
 src/shared/gatt-client.c |  9 +++++++++
 src/shared/gatt-client.h |  2 ++
 tools/btgatt-client.c    | 38 ++++++++++++++++++++++++++++++++++++++
 5 files changed, 64 insertions(+)
src/shared/att.c +14 -0
index 62c884b65..decc24314 100644
@@ -87,6 +87,8 @@ struct bt_att {
 
 	struct sign_info *local_sign;
 	struct sign_info *remote_sign;
+
+	bool retry_on_sec_error;
 };
 
 struct sign_info {
@@ -786,6 +788,9 @@ static bool handle_error_rsp(struct bt_att_chan *chan, uint8_t *pdu,
 
 	*opcode = rsp->opcode;
 
+	if (!att->retry_on_sec_error)
+		return false;
+
 	/* If operation has already been marked as retry don't attempt to change
 	 * the security again.
 	 */
@@ -1262,6 +1267,7 @@ struct bt_att *bt_att_new(int fd, bool ext_signed)
 	att = new0(struct bt_att, 1);
 	att->chans = queue_new();
 	att->mtu = chan->mtu;
+	att->retry_on_sec_error = true;
 
 	/* crypto is optional, if not available leave it NULL */
 	if (!ext_signed)
@@ -2042,3 +2048,11 @@ bool bt_att_has_crypto(struct bt_att *att)
 
 	return att->crypto ? true : false;
 }
+
+void bt_att_set_retry_on_sec_error(struct bt_att *att, bool retry_on_sec_error)
+{
+	if (!att)
+		return;
+
+	att->retry_on_sec_error = retry_on_sec_error;
+}
src/shared/att.h +1 -0
index 4aa3de87b..8ed89ba80 100644
@@ -110,3 +110,4 @@ bool bt_att_set_local_key(struct bt_att *att, uint8_t sign_key[16],
 bool bt_att_set_remote_key(struct bt_att *att, uint8_t sign_key[16],
 			bt_att_counter_func_t func, void *user_data);
 bool bt_att_has_crypto(struct bt_att *att);
+void bt_att_set_retry_on_sec_error(struct bt_att *att, bool retry_on_sec_error);
src/shared/gatt-client.c +9 -0
index 5de679c9b..b484db9db 100644
@@ -3818,3 +3818,12 @@ bool bt_gatt_client_idle_unregister(struct bt_gatt_client *client,
 
 	return false;
 }
+
+void bt_gatt_client_set_retry_on_sec_error(struct bt_gatt_client *client,
+						bool retry_on_sec_error)
+{
+	if (!client)
+		return;
+
+	bt_att_set_retry_on_sec_error(client->att, retry_on_sec_error);
+}
src/shared/gatt-client.h +2 -0
index bccd04a62..fdb841df0 100644
@@ -134,3 +134,5 @@ unsigned int bt_gatt_client_idle_register(struct bt_gatt_client *client,
 					bt_gatt_client_destroy_func_t destroy);
 bool bt_gatt_client_idle_unregister(struct bt_gatt_client *client,
 						unsigned int id);
+void bt_gatt_client_set_retry_on_sec_error(struct bt_gatt_client *client,
+						bool retry_on_sec_error);
tools/btgatt-client.c +38 -0
index 58a03bd48..76c74c7a8 100644
@@ -1295,6 +1295,42 @@ static void cmd_set_sign_key(struct client *cli, char *cmd_str)
 		set_sign_key_usage();
 }
 
+static void set_retry_on_sec_error_usage(void)
+{
+	printf("Usage: set-retry-on-sec-error <y/n>\n"
+		"e.g.:\n"
+		"\tset-retry-on-sec-error n\n");
+}
+
+static void cmd_set_retry_on_sec_error(struct client *cli, char *cmd_str)
+{
+	char *argv[2];
+	int argc = 0;
+
+	if (!bt_gatt_client_is_ready(cli->gatt)) {
+		printf("GATT client not initialized\n");
+		return;
+	}
+
+	if (!parse_args(cmd_str, 1, argv, &argc)) {
+		printf("Too many arguments\n");
+		set_retry_on_sec_error_usage();
+		return;
+	}
+
+	if (argc < 1) {
+		set_retry_on_sec_error_usage();
+		return;
+	}
+
+	if (argv[0][0] == 'y')
+		bt_gatt_client_set_retry_on_sec_error(cli->gatt, true);
+	else if (argv[0][0] == 'n')
+		bt_gatt_client_set_retry_on_sec_error(cli->gatt, false);
+	else
+		printf("Invalid argument: %s\n", argv[0]);
+}
+
 static void cmd_help(struct client *cli, char *cmd_str);
 
 typedef void (*command_func_t)(struct client *cli, char *cmd_str);
@@ -1329,6 +1365,8 @@ static struct {
 				"\tGet security level on le connection"},
 	{ "set-sign-key", cmd_set_sign_key,
 				"\tSet signing key for signed write command"},
+	{ "set-retry-on-sec-error", cmd_set_retry_on_sec_error,
+			"\tSet retry on security error by elevating security"},
 	{ }
 };
 
Signature · 1 line
2.34.1
#2 lore raw

Re: [PATCH BlueZ 1/5] gatt: Prevent security level change for PTS GATT tests

Hi Frédéric,

Quoted 19 lines · Frédéric Danis

Some PTS GATT tests like GATT/CL/GAR/BI-04-C request to be able to get the security error and do not try to change the security level.

this commit adds a variable allowing to prevent to change the security level.

---
 src/shared/att.c         | 14 ++++++++++++++
 src/shared/att.h         |  1 +
 src/shared/gatt-client.c |  9 +++++++++
 src/shared/gatt-client.h |  2 ++
 tools/btgatt-client.c    | 38 ++++++++++++++++++++++++++++++++++++++
 5 files changed, 64 insertions(+)
src/shared/att.c +0 -0
index 62c884b65..decc24314 100644

src/shared/att.c struct bt_att { · line 91

Quoted 5 lines
src/shared/att.c +2 -0
@@ -87,6 +87,8 @@ struct bt_att {
 
        struct sign_info *local_sign;
        struct sign_info *remote_sign;
+
+       bool retry_on_sec_error;

Id use something like auto_retry, or perhaps just use att_send_op->retry instead.

Quoted 49 lines
src/shared/att.c +12 -0
 };
 
 struct sign_info {
@@ -786,6 +788,9 @@ static bool handle_error_rsp(struct bt_att_chan *chan, uint8_t *pdu,
 
        *opcode = rsp->opcode;
 
+       if (!att->retry_on_sec_error)
+               return false;
+
        /* If operation has already been marked as retry don't attempt to change
         * the security again.
         */
@@ -1262,6 +1267,7 @@ struct bt_att *bt_att_new(int fd, bool ext_signed)
        att = new0(struct bt_att, 1);
        att->chans = queue_new();
        att->mtu = chan->mtu;
+       att->retry_on_sec_error = true;
 
        /* crypto is optional, if not available leave it NULL */
        if (!ext_signed)
@@ -2042,3 +2048,11 @@ bool bt_att_has_crypto(struct bt_att *att)
 
        return att->crypto ? true : false;
 }
+
+void bt_att_set_retry_on_sec_error(struct bt_att *att, bool retry_on_sec_error)
+{
+       if (!att)
+               return;
+
+       att->retry_on_sec_error = retry_on_sec_error;
+}
src/shared/att.h +1 -0
index 4aa3de87b..8ed89ba80 100644
@@ -110,3 +110,4 @@ bool bt_att_set_local_key(struct bt_att *att, uint8_t sign_key[16],
 bool bt_att_set_remote_key(struct bt_att *att, uint8_t sign_key[16],
                        bt_att_counter_func_t func, void *user_data);
 bool bt_att_has_crypto(struct bt_att *att);
+void bt_att_set_retry_on_sec_error(struct bt_att *att, bool retry_on_sec_error);
src/shared/gatt-client.c +0 -0
index 5de679c9b..b484db9db 100644
@@ -3818,3 +3818,12 @@ bool bt_gatt_client_idle_unregister(struct bt_gatt_client *client,
 
        return false;

src/shared/gatt-client.c bool bt_gatt_client_idle_unregister(struct bt_gatt_client *client, · line 3829

Quoted 10 lines
src/shared/gatt-client.c +9 -0
 }
+
+void bt_gatt_client_set_retry_on_sec_error(struct bt_gatt_client *client,
+                                               bool retry_on_sec_error)
+{
+       if (!client)
+               return;
+
+       bt_att_set_retry_on_sec_error(client->att, retry_on_sec_error);
+}

I wonder if it wouldn't be better to just have it as bt_att_set_retry(guint op) and then set it via att_send_op->retry != retry; so it can be used on a per operation basis that way we can try to have a property over D-Bus to be able to pass such tests using bluetoothctl.

Quoted 70 lines
src/shared/gatt-client.h +2 -0
index bccd04a62..fdb841df0 100644
@@ -134,3 +134,5 @@ unsigned int bt_gatt_client_idle_register(struct bt_gatt_client *client,
                                        bt_gatt_client_destroy_func_t destroy);
 bool bt_gatt_client_idle_unregister(struct bt_gatt_client *client,
                                                unsigned int id);
+void bt_gatt_client_set_retry_on_sec_error(struct bt_gatt_client *client,
+                                               bool retry_on_sec_error);
tools/btgatt-client.c +38 -1
index 58a03bd48..76c74c7a8 100644
@@ -1295,6 +1295,42 @@ static void cmd_set_sign_key(struct client *cli, char *cmd_str)
                set_sign_key_usage();
 }
 
+static void set_retry_on_sec_error_usage(void)
+{
+       printf("Usage: set-retry-on-sec-error <y/n>\n"
+               "e.g.:\n"
+               "\tset-retry-on-sec-error n\n");
+}
+
+static void cmd_set_retry_on_sec_error(struct client *cli, char *cmd_str)
+{
+       char *argv[2];
+       int argc = 0;
+
+       if (!bt_gatt_client_is_ready(cli->gatt)) {
+               printf("GATT client not initialized\n");
+               return;
+       }
+
+       if (!parse_args(cmd_str, 1, argv, &argc)) {
+               printf("Too many arguments\n");
+               set_retry_on_sec_error_usage();
+               return;
+       }
+
+       if (argc < 1) {
+               set_retry_on_sec_error_usage();
+               return;
+       }
+
+       if (argv[0][0] == 'y')
+               bt_gatt_client_set_retry_on_sec_error(cli->gatt, true);
+       else if (argv[0][0] == 'n')
+               bt_gatt_client_set_retry_on_sec_error(cli->gatt, false);
+       else
+               printf("Invalid argument: %s\n", argv[0]);
+}
+
 static void cmd_help(struct client *cli, char *cmd_str);
 
 typedef void (*command_func_t)(struct client *cli, char *cmd_str);
@@ -1329,6 +1365,8 @@ static struct {
                                "\tGet security level on le connection"},
        { "set-sign-key", cmd_set_sign_key,
                                "\tSet signing key for signed write command"},
+       { "set-retry-on-sec-error", cmd_set_retry_on_sec_error,
+                       "\tSet retry on security error by elevating security"},
        { }
 };
 
--

2.34.1

Signature · 1 line
Luiz Augusto von Dentz
#3 lore raw
In reply to Frédéric Danis

This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list. This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=818707

---Test result---

Test Summary:

CheckPatch                    PASS      251.88 seconds
GitLint                       PASS      153.53 seconds
BuildEll                      PASS      42.15 seconds
BluezMake                     PASS      730.75 seconds
MakeCheck                     PASS      11.23 seconds
MakeDistcheck                 PASS      160.09 seconds
CheckValgrind                 PASS      224.46 seconds
CheckSmatch                   PASS      421.96 seconds
bluezmakeextell               PASS      106.00 seconds
IncrementalBuild              PASS      3388.99 seconds
ScanBuild                     WARNING   945.24 seconds

Details
##############################
Test: ScanBuild - WARNING
Desc: Run Scan Build
Output:
tools/btgatt-client.c:1571:15: warning: Null pointer passed to 1st parameter expecting 'nonnull'

        end_handle = strtol(argv[1], &endptr, 0);
                     ^~~~~~~~~~~~~~~~~~~~~~~~~~~
tools/btgatt-client.c:1893:2: warning: Value stored to 'argv' is never read
        argv += optind;
        ^       ~~~~~~

2 warnings generated.

---
Regards,
Linux Bluetooth

#4 lore raw

PATCH 2/5 btgatt-client: Add function to search service based on UUID

In reply to Frédéric Danis

This is requested to pass PTS GATT/CL/GAD/BV-02-C test.

---
 tools/btgatt-client.c | 75 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
tools/btgatt-client.c +75 -0
index 76c74c7a8..631e26879 100644
@@ -33,6 +33,7 @@
 #include "src/shared/queue.h"
 #include "src/shared/gatt-db.h"
 #include "src/shared/gatt-client.h"
+#include "src/shared/gatt-helpers.h"
 
 #define ATT_CID 4
 
@@ -1331,6 +1332,78 @@ static void cmd_set_retry_on_sec_error(struct client *cli, char *cmd_str)
 		printf("Invalid argument: %s\n", argv[0]);
 }
 
+static void search_service_usage(void)
+{
+	printf("Usage: search-service <uuid>\n"
+		"e.g.:\n"
+		"\tsearch-service 1800\n");
+}
+
+static void search_service_cb(bool success, uint8_t att_ecode,
+					struct bt_gatt_result *result,
+					void *user_data)
+{
+	struct bt_gatt_iter iter;
+	uint16_t start_handle, end_handle;
+	uint128_t u128;
+	bt_uuid_t uuid;
+	char uuid_str[MAX_LEN_UUID_STR];
+
+	if (!success) {
+		PRLOG("\nService discovery failed: %s (0x%02x)\n",
+				ecode_to_string(att_ecode), att_ecode);
+		return;
+	}
+
+	if (!result || !bt_gatt_iter_init(&iter, result))
+		return;
+
+	printf("\n");
+	while (bt_gatt_iter_next_service(&iter, &start_handle, &end_handle,
+						u128.data)) {
+		bt_uuid128_create(&uuid, u128);
+		bt_uuid_to_string(&uuid, uuid_str, sizeof(uuid_str));
+		printf("Found start handle: 0x%04x, end handle: 0x%04x, "
+			"UUID: %s\n",
+			start_handle, end_handle, uuid_str);
+	}
+	PRLOG("\n");
+}
+
+static void cmd_search_service(struct client *cli, char *cmd_str)
+{
+	char *argv[2];
+	int argc = 0;
+	bt_uuid_t uuid;
+
+	if (!bt_gatt_client_is_ready(cli->gatt)) {
+		printf("GATT client not initialized\n");
+		return;
+	}
+
+	if (!parse_args(cmd_str, 1, argv, &argc)) {
+		printf("Too many arguments\n");
+		search_service_usage();
+		return;
+	}
+
+	if (argc < 1) {
+		search_service_usage();
+		return;
+	}
+
+	if (bt_string_to_uuid(&uuid, argv[0]) < 0) {
+		printf("Invalid UUID: %s\n", argv[0]);
+		return;
+	}
+
+	bt_gatt_discover_primary_services(bt_gatt_client_get_att(cli->gatt),
+						&uuid, 0x0001, 0xFFFF,
+						search_service_cb,
+						NULL,
+						NULL);
+}
+
 static void cmd_help(struct client *cli, char *cmd_str);
 
 typedef void (*command_func_t)(struct client *cli, char *cmd_str);
@@ -1367,6 +1440,8 @@ static struct {
 				"\tSet signing key for signed write command"},
 	{ "set-retry-on-sec-error", cmd_set_retry_on_sec_error,
 			"\tSet retry on security error by elevating security"},
+	{ "search-service", cmd_search_service,
+				"\tSearch service"},
 	{ }
 };
 
Signature · 1 line
2.34.1
#5 lore raw

PATCH 3/5 btgatt-client: Add function to search characteristics

In reply to Frédéric Danis

This is requested to pass PTS GATT/CL/GAD/BV-05-C test. This search characteristics based on UUID, start and end handles.

---
 tools/btgatt-client.c | 88 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
tools/btgatt-client.c +88 -0
index 631e26879..bb0822658 100644
@@ -1404,6 +1404,92 @@ static void cmd_search_service(struct client *cli, char *cmd_str)
 						NULL);
 }
 
+static void search_characteristics_usage(void)
+{
+	printf("Usage: search-characteristics <start_hanlde> <end_handle> "
+		"<uuid>\n"
+		"e.g.:\n"
+		"\tsearch-characteristics 0x0001 0xFFFF 1800\n");
+}
+
+static void search_characteristics_cb(bool success, uint8_t att_ecode,
+					struct bt_gatt_result *result,
+					void *user_data)
+{
+	struct bt_gatt_iter iter;
+	uint16_t handle, length;
+	const uint8_t *value;
+	int i;
+
+	if (!success) {
+		PRLOG("\nCharacteristics discovery failed: %s (0x%02x)\n",
+				ecode_to_string(att_ecode), att_ecode);
+		return;
+	}
+
+	if (!result || !bt_gatt_iter_init(&iter, result))
+		return;
+
+	printf("\n");
+	while (bt_gatt_iter_next_read_by_type(&iter, &handle, &length,
+						&value)) {
+		printf("Found handle: 0x%04x value: ", handle);
+		for (i = 0; i < length; i++)
+			printf("%02x ", value[i]);
+		printf("\n");
+	}
+	PRLOG("\n");
+}
+
+static void cmd_search_characteristics(struct client *cli, char *cmd_str)
+{
+	char *argv[4];
+	int argc = 0;
+	uint16_t start_handle, end_handle;
+	char *endptr = NULL;
+	bt_uuid_t uuid;
+
+	if (!bt_gatt_client_is_ready(cli->gatt)) {
+		printf("GATT client not initialized\n");
+		return;
+	}
+
+	if (!parse_args(cmd_str, 3, argv, &argc)) {
+		printf("Too many arguments\n");
+		search_characteristics_usage();
+		return;
+	}
+
+	if (argc < 1) {
+		search_characteristics_usage();
+		return;
+	}
+
+	start_handle = strtol(argv[0], &endptr, 0);
+	if (!endptr || *endptr != '\0') {
+		printf("Invalid start handle: %s\n", argv[0]);
+		return;
+	}
+
+	end_handle = strtol(argv[1], &endptr, 0);
+	if (!endptr || *endptr != '\0') {
+		printf("Invalid end handle: %s\n", argv[1]);
+		return;
+	}
+
+	if (bt_string_to_uuid(&uuid, argv[2]) < 0) {
+		printf("Invalid UUID: %s\n", argv[2]);
+		return;
+	}
+
+	bt_gatt_read_by_type(bt_gatt_client_get_att(cli->gatt), start_handle,
+						end_handle,
+						&uuid,
+						search_characteristics_cb,
+						NULL,
+						NULL);
+}
+
 static void cmd_help(struct client *cli, char *cmd_str);
 
 typedef void (*command_func_t)(struct client *cli, char *cmd_str);
@@ -1442,6 +1528,8 @@ static struct {
 			"\tSet retry on security error by elevating security"},
 	{ "search-service", cmd_search_service,
 				"\tSearch service"},
+	{ "search-characteristics", cmd_search_characteristics,
+				"\tSearch characteristics"},
 	{ }
 };
 
Signature · 1 line
2.34.1
#6 lore raw

PATCH 4/5 btgatt-client: Add function to search descriptors

In reply to Frédéric Danis

This is requested to pass PTS GATT/CL/GAD/BV-06-C test. This search descriptors based on start and end handles.

---
 tools/btgatt-client.c | 79 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
tools/btgatt-client.c +79 -0
index bb0822658..a7d5d76ba 100644
@@ -1490,6 +1490,83 @@ static void cmd_search_characteristics(struct client *cli, char *cmd_str)
 						NULL);
 }
 
+static void search_descriptors_usage(void)
+{
+	printf("Usage: search-descriptors <start_hanlde> <end_handle>\n"
+		"e.g.:\n"
+		"\tsearch-descriptors 0x0001 0xFFFF\n");
+}
+
+static void search_descriptors_cb(bool success, uint8_t att_ecode,
+					struct bt_gatt_result *result,
+					void *user_data)
+{
+	struct bt_gatt_iter iter;
+	uint16_t handle;
+	uint128_t u128;
+	bt_uuid_t uuid;
+	char uuid_str[MAX_LEN_UUID_STR];
+
+	if (!success) {
+		PRLOG("\nDescriptors discovery failed: %s (0x%02x)\n",
+				ecode_to_string(att_ecode), att_ecode);
+		return;
+	}
+
+	if (!result || !bt_gatt_iter_init(&iter, result))
+		return;
+
+	printf("\n");
+	while (bt_gatt_iter_next_descriptor(&iter, &handle, u128.data)) {
+		bt_uuid128_create(&uuid, u128);
+		bt_uuid_to_string(&uuid, uuid_str, sizeof(uuid_str));
+		printf("Found handle: 0x%04x UUID: %s\n", handle, uuid_str);
+	}
+	PRLOG("\n");
+}
+
+static void cmd_search_descriptors(struct client *cli, char *cmd_str)
+{
+	char *argv[3];
+	int argc = 0;
+	uint16_t start_handle, end_handle;
+	char *endptr = NULL;
+
+	if (!bt_gatt_client_is_ready(cli->gatt)) {
+		printf("GATT client not initialized\n");
+		return;
+	}
+
+	if (!parse_args(cmd_str, 2, argv, &argc)) {
+		printf("Too many arguments\n");
+		search_descriptors_usage();
+		return;
+	}
+
+	if (argc < 1) {
+		search_descriptors_usage();
+		return;
+	}
+
+	start_handle = strtol(argv[0], &endptr, 0);
+	if (!endptr || *endptr != '\0') {
+		printf("Invalid start handle: %s\n", argv[0]);
+		return;
+	}
+
+	end_handle = strtol(argv[1], &endptr, 0);
+	if (!endptr || *endptr != '\0') {
+		printf("Invalid end handle: %s\n", argv[1]);
+		return;
+	}
+
+	bt_gatt_discover_descriptors(bt_gatt_client_get_att(cli->gatt),
+						start_handle, end_handle,
+						search_descriptors_cb,
+						NULL,
+						NULL);
+}
+
 static void cmd_help(struct client *cli, char *cmd_str);
 
 typedef void (*command_func_t)(struct client *cli, char *cmd_str);
@@ -1530,6 +1607,8 @@ static struct {
 				"\tSearch service"},
 	{ "search-characteristics", cmd_search_characteristics,
 				"\tSearch characteristics"},
+	{ "search-descriptors", cmd_search_descriptors,
+				"\tSearch descriptors"},
 	{ }
 };
 
Signature · 1 line
2.34.1
#7 lore raw

Re: [PATCH BlueZ 4/5] btgatt-client: Add function to search descriptors

Hi Frédéric,

Quoted 3 lines · Frédéric Danis

This is requested to pass PTS GATT/CL/GAD/BV-06-C test. This search descriptors based on start and end handles.

Is this test mandatory though? Afaik if we do support the discovery of all procedure this becomes useless, because the stack can perform these operations locally by using its cache.

Quoted 105 lines
---
 tools/btgatt-client.c | 79 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
tools/btgatt-client.c +79 -1
index bb0822658..a7d5d76ba 100644
@@ -1490,6 +1490,83 @@ static void cmd_search_characteristics(struct client *cli, char *cmd_str)
                                                NULL);
 }
 
+static void search_descriptors_usage(void)
+{
+       printf("Usage: search-descriptors <start_hanlde> <end_handle>\n"
+               "e.g.:\n"
+               "\tsearch-descriptors 0x0001 0xFFFF\n");
+}
+
+static void search_descriptors_cb(bool success, uint8_t att_ecode,
+                                       struct bt_gatt_result *result,
+                                       void *user_data)
+{
+       struct bt_gatt_iter iter;
+       uint16_t handle;
+       uint128_t u128;
+       bt_uuid_t uuid;
+       char uuid_str[MAX_LEN_UUID_STR];
+
+       if (!success) {
+               PRLOG("\nDescriptors discovery failed: %s (0x%02x)\n",
+                               ecode_to_string(att_ecode), att_ecode);
+               return;
+       }
+
+       if (!result || !bt_gatt_iter_init(&iter, result))
+               return;
+
+       printf("\n");
+       while (bt_gatt_iter_next_descriptor(&iter, &handle, u128.data)) {
+               bt_uuid128_create(&uuid, u128);
+               bt_uuid_to_string(&uuid, uuid_str, sizeof(uuid_str));
+               printf("Found handle: 0x%04x UUID: %s\n", handle, uuid_str);
+       }
+       PRLOG("\n");
+}
+
+static void cmd_search_descriptors(struct client *cli, char *cmd_str)
+{
+       char *argv[3];
+       int argc = 0;
+       uint16_t start_handle, end_handle;
+       char *endptr = NULL;
+
+       if (!bt_gatt_client_is_ready(cli->gatt)) {
+               printf("GATT client not initialized\n");
+               return;
+       }
+
+       if (!parse_args(cmd_str, 2, argv, &argc)) {
+               printf("Too many arguments\n");
+               search_descriptors_usage();
+               return;
+       }
+
+       if (argc < 1) {
+               search_descriptors_usage();
+               return;
+       }
+
+       start_handle = strtol(argv[0], &endptr, 0);
+       if (!endptr || *endptr != '\0') {
+               printf("Invalid start handle: %s\n", argv[0]);
+               return;
+       }
+
+       end_handle = strtol(argv[1], &endptr, 0);
+       if (!endptr || *endptr != '\0') {
+               printf("Invalid end handle: %s\n", argv[1]);
+               return;
+       }
+
+       bt_gatt_discover_descriptors(bt_gatt_client_get_att(cli->gatt),
+                                               start_handle, end_handle,
+                                               search_descriptors_cb,
+                                               NULL,
+                                               NULL);
+}
+
 static void cmd_help(struct client *cli, char *cmd_str);
 
 typedef void (*command_func_t)(struct client *cli, char *cmd_str);
@@ -1530,6 +1607,8 @@ static struct {
                                "\tSearch service"},
        { "search-characteristics", cmd_search_characteristics,
                                "\tSearch characteristics"},
+       { "search-descriptors", cmd_search_descriptors,
+                               "\tSearch descriptors"},
        { }
 };
 
--

2.34.1

Signature · 1 line
Luiz Augusto von Dentz
#8 lore raw

Re: [PATCH BlueZ 4/5] btgatt-client: Add function to search descriptors

Hi Luiz,

Quoted 9 lines · Luiz Augusto von Dentz

Hi Frédéric,

Quoted 2 lines · Frédéric Danis

This is requested to pass PTS GATT/CL/GAD/BV-06-C test. This search descriptors based on start and end handles.

Is this test mandatory though? Afaik if we do support the discovery of all procedure this becomes useless, because the stack can perform these operations locally by using its cache.

This test is optional, as tests GATT/CL/GAR/BI-10-C and GATT/CL/GAR/BI-11-C which also needs this patch to pass. GATT/CL/GAR/BI-10-C and GATT/CL/GAR/BI-11-C request the ability to prevent security upgrade. This may need to add a security retry flag to bt_gatt_read_by_type() in src/shared/gatt-helpers.{ch} to be able to call bt_att_set_retry() introduced in the first patch of this series. Does it seem correct?

Quoted 105 lines
Quoted 105 lines
---
  tools/btgatt-client.c | 79 +++++++++++++++++++++++++++++++++++++++++++
  1 file changed, 79 insertions(+)
tools/btgatt-client.c +79 -1
index bb0822658..a7d5d76ba 100644
@@ -1490,6 +1490,83 @@ static void cmd_search_characteristics(struct client *cli, char *cmd_str)
                                                 NULL);
  }
 
+static void search_descriptors_usage(void)
+{
+       printf("Usage: search-descriptors <start_hanlde> <end_handle>\n"
+               "e.g.:\n"
+               "\tsearch-descriptors 0x0001 0xFFFF\n");
+}
+
+static void search_descriptors_cb(bool success, uint8_t att_ecode,
+                                       struct bt_gatt_result *result,
+                                       void *user_data)
+{
+       struct bt_gatt_iter iter;
+       uint16_t handle;
+       uint128_t u128;
+       bt_uuid_t uuid;
+       char uuid_str[MAX_LEN_UUID_STR];
+
+       if (!success) {
+               PRLOG("\nDescriptors discovery failed: %s (0x%02x)\n",
+                               ecode_to_string(att_ecode), att_ecode);
+               return;
+       }
+
+       if (!result || !bt_gatt_iter_init(&iter, result))
+               return;
+
+       printf("\n");
+       while (bt_gatt_iter_next_descriptor(&iter, &handle, u128.data)) {
+               bt_uuid128_create(&uuid, u128);
+               bt_uuid_to_string(&uuid, uuid_str, sizeof(uuid_str));
+               printf("Found handle: 0x%04x UUID: %s\n", handle, uuid_str);
+       }
+       PRLOG("\n");
+}
+
+static void cmd_search_descriptors(struct client *cli, char *cmd_str)
+{
+       char *argv[3];
+       int argc = 0;
+       uint16_t start_handle, end_handle;
+       char *endptr = NULL;
+
+       if (!bt_gatt_client_is_ready(cli->gatt)) {
+               printf("GATT client not initialized\n");
+               return;
+       }
+
+       if (!parse_args(cmd_str, 2, argv, &argc)) {
+               printf("Too many arguments\n");
+               search_descriptors_usage();
+               return;
+       }
+
+       if (argc < 1) {
+               search_descriptors_usage();
+               return;
+       }
+
+       start_handle = strtol(argv[0], &endptr, 0);
+       if (!endptr || *endptr != '\0') {
+               printf("Invalid start handle: %s\n", argv[0]);
+               return;
+       }
+
+       end_handle = strtol(argv[1], &endptr, 0);
+       if (!endptr || *endptr != '\0') {
+               printf("Invalid end handle: %s\n", argv[1]);
+               return;
+       }
+
+       bt_gatt_discover_descriptors(bt_gatt_client_get_att(cli->gatt),
+                                               start_handle, end_handle,
+                                               search_descriptors_cb,
+                                               NULL,
+                                               NULL);
+}
+
  static void cmd_help(struct client *cli, char *cmd_str);
 
  typedef void (*command_func_t)(struct client *cli, char *cmd_str);
@@ -1530,6 +1607,8 @@ static struct {
                                 "\tSearch service"},
         { "search-characteristics", cmd_search_characteristics,
                                 "\tSearch characteristics"},
+       { "search-descriptors", cmd_search_descriptors,
+                               "\tSearch descriptors"},
         { }
  };
 
--

2.34.1

Signature · 6 lines
Frédéric Danis
Senior Software Engineer

Collabora Ltd.
Platinum Building, St John's Innovation Park, Cambridge CB4 0DS, United Kingdom
Registered in England & Wales, no. 5513718
#9 lore raw

PATCH 5/5 btgatt-client: Add function to search all primary services

In reply to Frédéric Danis

This is requested to pass PTS GATT/CL/GAD/BV-01-C test.

---
 tools/btgatt-client.c | 30 +++++++++++++++++++++++-------
 1 file changed, 23 insertions(+), 7 deletions(-)
tools/btgatt-client.c +23 -7
index a7d5d76ba..d097727dc 100644
@@ -1332,13 +1332,6 @@ static void cmd_set_retry_on_sec_error(struct client *cli, char *cmd_str)
 		printf("Invalid argument: %s\n", argv[0]);
 }
 
-static void search_service_usage(void)
-{
-	printf("Usage: search-service <uuid>\n"
-		"e.g.:\n"
-		"\tsearch-service 1800\n");
-}
-
 static void search_service_cb(bool success, uint8_t att_ecode,
 					struct bt_gatt_result *result,
 					void *user_data)
@@ -1370,6 +1363,27 @@ static void search_service_cb(bool success, uint8_t att_ecode,
 	PRLOG("\n");
 }
 
+static void cmd_search_all_primary_services(struct client *cli, char *cmd_str)
+{
+	if (!bt_gatt_client_is_ready(cli->gatt)) {
+		printf("GATT client not initialized\n");
+		return;
+	}
+
+	bt_gatt_discover_all_primary_services(bt_gatt_client_get_att(cli->gatt),
+						NULL,
+						search_service_cb,
+						NULL,
+						NULL);
+}
+
+static void search_service_usage(void)
+{
+	printf("Usage: search-service <uuid>\n"
+		"e.g.:\n"
+		"\tsearch-service 1800\n");
+}
+
 static void cmd_search_service(struct client *cli, char *cmd_str)
 {
 	char *argv[2];
@@ -1603,6 +1617,8 @@ static struct {
 				"\tSet signing key for signed write command"},
 	{ "set-retry-on-sec-error", cmd_set_retry_on_sec_error,
 			"\tSet retry on security error by elevating security"},
+	{ "search-all-primary-services", cmd_search_all_primary_services,
+				"\tSearch all primary services"},
 	{ "search-service", cmd_search_service,
 				"\tSearch service"},
 	{ "search-characteristics", cmd_search_characteristics,
Signature · 1 line
2.34.1