The two first patches allow to prevent automatic security level change
to allow to display 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.
v1 -> v2: Re-use att_send_op->retry and make it possible to prevent
security upgrade on a per operation basis
Remove "btgatt-client: Add function to search descriptors"
as GATT/CL/GAD/BV-06-C test is optional
Fix command arguments check in btgatt-client
v2 -> v3: Split first commit in two, one for src/shared and the other
for tools directories
Frédéric Danis (5):
shared/gatt: Prevent security level change for PTS GATT tests
btgatt-client: Add command to prevent security level change
btgatt-client: Add function to search service based on UUID
btgatt-client: Add function to search characteristics
btgatt-client: Add function to search all primary services
src/shared/att.c | 26 ++++
src/shared/att.h | 1 +
src/shared/gatt-client.c | 19 +++
src/shared/gatt-client.h | 3 +
tools/btgatt-client.c | 251 +++++++++++++++++++++++++++++++++++++--
5 files changed, 288 insertions(+), 12 deletions(-)
--
2.34.1
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 the ability to prevent to change the security level for
an operation.
---
src/shared/att.c | 26 ++++++++++++++++++++++++++
src/shared/att.h | 1 +
src/shared/gatt-client.c | 19 +++++++++++++++++++
src/shared/gatt-client.h | 3 +++
4 files changed, 49 insertions(+)
diff --git a/src/shared/att.c b/src/shared/att.c
index 62c884b65..485ef071b 100644
--- a/src/shared/att.c
+++ b/src/shared/att.c
@@ -2042,3 +2042,29 @@ bool bt_att_has_crypto(struct bt_att *att)
return att->crypto ? true : false;
}
+
+bool bt_att_set_retry(struct bt_att *att, unsigned int id, bool retry)
+{
+ struct att_send_op *op;
+
+ if (!id)
+ return false;
+
+ op = queue_find(att->req_queue, match_op_id, UINT_TO_PTR(id));
+ if (op)
+ goto done;
+
+ op = queue_find(att->ind_queue, match_op_id, UINT_TO_PTR(id));
+ if (op)
+ goto done;
+
+ op = queue_find(att->write_queue, match_op_id, UINT_TO_PTR(id));
+
+done:
+ if (!op)
+ return false;
+
+ op->retry = !retry;
+
+ return true;
+}
diff --git a/src/shared/att.h b/src/shared/att.h
index 4aa3de87b..6fd78636e 100644
--- a/src/shared/att.h
+++ b/src/shared/att.h
@@ -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);
+bool bt_att_set_retry(struct bt_att *att, unsigned int id, bool retry);
diff --git a/src/shared/gatt-client.c b/src/shared/gatt-client.c
index 5de679c9b..6340bcd85 100644
--- a/src/shared/gatt-client.c
+++ b/src/shared/gatt-client.c
@@ -3818,3 +3818,22 @@ bool bt_gatt_client_idle_unregister(struct bt_gatt_client *client,
return false;
}
+
+bool bt_gatt_client_set_retry(struct bt_gatt_client *client,
+ unsigned int id,
+ bool retry)
+{
+ struct request *req;
+
+ if (!client || !id)
+ return false;
+
+ req = queue_find(client->pending_requests, match_req_id,
+ UINT_TO_PTR(id));
+ if (!req)
+ return false;
+
+ bt_att_set_retry(client->att, req->att_id, retry);
+
+ return true;
+}
diff --git a/src/shared/gatt-client.h b/src/shared/gatt-client.h
index bccd04a62..63cf99500 100644
--- a/src/shared/gatt-client.h
+++ b/src/shared/gatt-client.h
@@ -134,3 +134,6 @@ 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);
+bool bt_gatt_client_set_retry(struct bt_gatt_client *client,
+ unsigned int id,
+ bool retry);
--
2.34.1
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(-)
diff --git a/tools/btgatt-client.c b/tools/btgatt-client.c
index 04fd3ce0f..b47914da3 100644
--- a/tools/btgatt-client.c
+++ b/tools/btgatt-client.c
@@ -1354,13 +1354,6 @@ static void cmd_set_sign_key(struct client *cli, char *cmd_str)
set_sign_key_usage();
}
-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)
@@ -1392,6 +1385,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];
@@ -1536,6 +1550,8 @@ static struct {
"\tSet retry on security error by elevating security"},
{ "set-sign-key", cmd_set_sign_key,
"\tSet signing key for signed write command"},
+ { "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,
--
2.34.1
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 | 82 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 82 insertions(+)
diff --git a/tools/btgatt-client.c b/tools/btgatt-client.c
index 99a123697..04fd3ce0f 100644
--- a/tools/btgatt-client.c
+++ b/tools/btgatt-client.c
@@ -1420,6 +1420,86 @@ 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) || argc != 3) {
+ 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);
@@ -1458,6 +1538,8 @@ static struct {
"\tSet signing key for signed write command"},
{ "search-service", cmd_search_service,
"\tSearch service"},
+ { "search-characteristics", cmd_search_characteristics,
+ "\tSearch characteristics"},
{ }
};
--
2.34.1
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 the ability to prevent to change the security level.
---
tools/btgatt-client.c | 84 ++++++++++++++++++++++++++++++++++++-------
1 file changed, 72 insertions(+), 12 deletions(-)
diff --git a/tools/btgatt-client.c b/tools/btgatt-client.c
index 58a03bd48..3bcb7e1cf 100644
--- a/tools/btgatt-client.c
+++ b/tools/btgatt-client.c
@@ -57,6 +57,7 @@ struct client {
struct bt_gatt_client *gatt;
unsigned int reliable_session_id;
+ bool sec_retry;
};
static void print_prompt(void)
@@ -172,6 +173,7 @@ static struct client *client_create(int fd, uint16_t mtu)
fprintf(stderr, "Failed to allocate memory for client\n");
return NULL;
}
+ cli->sec_retry = true;
cli->att = bt_att_new(fd, false);
if (!cli->att) {
@@ -488,6 +490,7 @@ static void cmd_read_multiple(struct client *cli, char *cmd_str)
char *argv[512];
int i;
char *endptr = NULL;
+ unsigned int id;
if (!bt_gatt_client_is_ready(cli->gatt)) {
printf("GATT client not initialized\n");
@@ -514,9 +517,12 @@ static void cmd_read_multiple(struct client *cli, char *cmd_str)
}
}
- if (!bt_gatt_client_read_multiple(cli->gatt, value, argc,
- read_multiple_cb, NULL, NULL))
+ id = bt_gatt_client_read_multiple(cli->gatt, value, argc,
+ read_multiple_cb, NULL, NULL);
+ if (!id)
printf("Failed to initiate read multiple procedure\n");
+ else if (!cli->sec_retry)
+ bt_gatt_client_set_retry(cli->gatt, id, false);
free(value);
}
@@ -558,6 +564,7 @@ static void cmd_read_value(struct client *cli, char *cmd_str)
int argc = 0;
uint16_t handle;
char *endptr = NULL;
+ unsigned int id;
if (!bt_gatt_client_is_ready(cli->gatt)) {
printf("GATT client not initialized\n");
@@ -575,9 +582,12 @@ static void cmd_read_value(struct client *cli, char *cmd_str)
return;
}
- if (!bt_gatt_client_read_value(cli->gatt, handle, read_cb,
- NULL, NULL))
+ id = bt_gatt_client_read_value(cli->gatt, handle, read_cb,
+ NULL, NULL);
+ if (!id)
printf("Failed to initiate read value procedure\n");
+ else if (!cli->sec_retry)
+ bt_gatt_client_set_retry(cli->gatt, id, false);
}
static void read_long_value_usage(void)
@@ -592,6 +602,7 @@ static void cmd_read_long_value(struct client *cli, char *cmd_str)
uint16_t handle;
uint16_t offset;
char *endptr = NULL;
+ unsigned int id;
if (!bt_gatt_client_is_ready(cli->gatt)) {
printf("GATT client not initialized\n");
@@ -616,9 +627,12 @@ static void cmd_read_long_value(struct client *cli, char *cmd_str)
return;
}
- if (!bt_gatt_client_read_long_value(cli->gatt, handle, offset, read_cb,
- NULL, NULL))
+ id = bt_gatt_client_read_long_value(cli->gatt, handle, offset, read_cb,
+ NULL, NULL);
+ if (!id)
printf("Failed to initiate read long value procedure\n");
+ else if (!cli->sec_retry)
+ bt_gatt_client_set_retry(cli->gatt, id, false);
}
static void write_value_usage(void)
@@ -659,6 +673,7 @@ static void cmd_write_value(struct client *cli, char *cmd_str)
uint8_t *value = NULL;
bool without_response = false;
bool signed_write = false;
+ unsigned int id;
if (!bt_gatt_client_is_ready(cli->gatt)) {
printf("GATT client not initialized\n");
@@ -740,10 +755,13 @@ static void cmd_write_value(struct client *cli, char *cmd_str)
goto done;
}
- if (!bt_gatt_client_write_value(cli->gatt, handle, value, length,
+ id = bt_gatt_client_write_value(cli->gatt, handle, value, length,
write_cb,
- NULL, NULL))
+ NULL, NULL);
+ if (!id)
printf("Failed to initiate write procedure\n");
+ else if (!cli->sec_retry)
+ bt_gatt_client_set_retry(cli->gatt, id, false);
done:
free(value);
@@ -789,6 +807,7 @@ static void cmd_write_long_value(struct client *cli, char *cmd_str)
int length;
uint8_t *value = NULL;
bool reliable_writes = false;
+ unsigned int id;
if (!bt_gatt_client_is_ready(cli->gatt)) {
printf("GATT client not initialized\n");
@@ -863,11 +882,14 @@ static void cmd_write_long_value(struct client *cli, char *cmd_str)
}
}
- if (!bt_gatt_client_write_long_value(cli->gatt, reliable_writes, handle,
+ id = bt_gatt_client_write_long_value(cli->gatt, reliable_writes, handle,
offset, value, length,
write_long_cb,
- NULL, NULL))
+ NULL, NULL);
+ if (!id)
printf("Failed to initiate long write procedure\n");
+ else if (!cli->sec_retry)
+ bt_gatt_client_set_retry(cli->gatt, id, false);
free(value);
}
@@ -999,12 +1021,18 @@ done:
value, length,
write_long_cb, NULL,
NULL);
- if (!cli->reliable_session_id)
+ if (!cli->reliable_session_id) {
printf("Failed to proceed prepare write\n");
- else
+ } else {
+ if (!cli->sec_retry)
+ bt_gatt_client_set_retry(cli->gatt,
+ cli->reliable_session_id,
+ false);
+
printf("Prepare write success.\n"
"Session id: %d to be used on next write\n",
cli->reliable_session_id);
+ }
free(value);
}
@@ -1236,6 +1264,36 @@ static void cmd_get_security(struct client *cli, char *cmd_str)
printf("Security level: %u\n", level);
}
+static void set_security_retry_usage(void)
+{
+ printf("Usage: set-security-retry <y/n>\n"
+ "e.g.:\n"
+ "\tset-security-retry n\n");
+}
+
+static void cmd_set_security_retry(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) || argc != 1) {
+ set_security_retry_usage();
+ return;
+ }
+
+ if (argv[0][0] == 'y')
+ cli->sec_retry = true;
+ else if (argv[0][0] == 'n')
+ cli->sec_retry = false;
+ else
+ printf("Invalid argument: %s\n", argv[0]);
+}
+
static bool convert_sign_key(char *optarg, uint8_t key[16])
{
int i;
@@ -1327,6 +1385,8 @@ static struct {
"\tSet security level on le connection"},
{ "get-security", cmd_get_security,
"\tGet security level on le connection"},
+ { "set-security-retry", cmd_set_security_retry,
+ "\tSet retry on security error by elevating security"},
{ "set-sign-key", cmd_set_sign_key,
"\tSet signing key for signed write command"},
{ }
--
2.34.1
This is requested to pass PTS GATT/CL/GAD/BV-02-C test.
---
tools/btgatt-client.c | 69 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 69 insertions(+)
diff --git a/tools/btgatt-client.c b/tools/btgatt-client.c
index 3bcb7e1cf..99a123697 100644
--- a/tools/btgatt-client.c
+++ b/tools/btgatt-client.c
@@ -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
@@ -1353,6 +1354,72 @@ static void cmd_set_sign_key(struct client *cli, char *cmd_str)
set_sign_key_usage();
}
+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) || 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);
@@ -1389,6 +1456,8 @@ static struct {
"\tSet retry on security error by elevating security"},
{ "set-sign-key", cmd_set_sign_key,
"\tSet signing key for signed write command"},
+ { "search-service", cmd_search_service,
+ "\tSearch service"},
{ }
};
--
2.34.1
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=819996
---Test result---
Test Summary:
CheckPatch PASS 1.77 seconds
GitLint PASS 1.18 seconds
BuildEll PASS 23.97 seconds
BluezMake PASS 720.09 seconds
MakeCheck PASS 12.02 seconds
MakeDistcheck PASS 162.59 seconds
CheckValgrind PASS 227.38 seconds
CheckSmatch PASS 329.62 seconds
bluezmakeextell PASS 108.21 seconds
IncrementalBuild PASS 3305.31 seconds
ScanBuild WARNING 923.40 seconds
Details
##############################
Test: ScanBuild - WARNING
Desc: Run Scan Build
Output:
tools/btgatt-client.c:1824:2: warning: Value stored to 'argv' is never read
argv += optind;
^ ~~~~~~
1 warning generated.
---
Regards,
Linux Bluetooth
Hello:
This series was applied to bluetooth/bluez.git (master)
by Luiz Augusto von Dentz <[email protected]>:
On Thu, 25 Jan 2024 20:08:00 +0100 you wrote:
> The two first patches allow to prevent automatic security level change
> to allow to display 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.
>
> [...]
Here is the summary with links:
- [BlueZ,v3,1/5] shared/gatt: Prevent security level change for PTS GATT tests
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=6c15afefcd71
- [BlueZ,v3,2/5] btgatt-client: Add command to prevent security level change
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=f0cef854f963
- [BlueZ,v3,3/5] btgatt-client: Add function to search service based on UUID
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=68cd2ae6f513
- [BlueZ,v3,4/5] btgatt-client: Add function to search characteristics
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=647adf9260ff
- [BlueZ,v3,5/5] btgatt-client: Add function to search all primary services
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=0de32f67f685
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html