Skip to content

espressif: report pair() failures #11561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dhalbert wants to merge 1 commit into
base: main
Choose a base branch
from
+25 −3
Open

espressif: report pair() failures #11561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions ports/espressif/common-hal/_bleio/Connection.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,13 @@ int bleio_connection_event_cb(struct ble_gap_event *event, void *connection_in)
case BLE_GAP_EVENT_ENC_CHANGE: {
struct ble_gap_conn_desc desc;
ble_gap_conn_find(event->enc_change.conn_handle, &desc);
connection->sec_status = event->enc_change.status;
if (desc.sec_state.encrypted) {
connection->pair_status = PAIR_PAIRED;
} else if (connection->pair_status == PAIR_WAITING_NUMCMP) {
// Numeric comparison was rejected, or SM otherwise failed.
} else if (connection->pair_status == PAIR_WAITING ||
connection->pair_status == PAIR_WAITING_NUMCMP) {
// Pairing failed, or numeric comparison was rejected.
// This ends the wait in pair(), which reports sec_status.
connection->pair_status = PAIR_NOT_PAIRED;
}
// .authenticated is set once the MITM leg (numeric comparison / passkey entry)
Expand Down Expand Up @@ -187,6 +190,7 @@ void common_hal_bleio_connection_pair(bleio_connection_internal_t *self, bool bo
if (self->pair_status == PAIR_PAIRED) {
return;
}
self->sec_status = 0;
self->pair_status = PAIR_WAITING;
CHECK_NIMBLE_ERROR(ble_gap_security_initiate(self->conn_handle));
while (self->pair_status == PAIR_WAITING && !mp_hal_is_interrupted()) {
Expand All @@ -195,6 +199,22 @@ void common_hal_bleio_connection_pair(bleio_connection_internal_t *self, bool bo
if (mp_hal_is_interrupted()) {
return;
}
if (self->conn_handle == BLEIO_HANDLE_INVALID) {
mp_raise_ConnectionError(MP_ERROR_TEXT("Not connected"));
}
if (self->pair_status == PAIR_PAIRED) {
return;
}
// Same messages as nordic.
switch (self->sec_status) {
case BLE_HS_SM_US_ERR(BLE_SM_ERR_UNSPECIFIED):
case BLE_HS_SM_PEER_ERR(BLE_SM_ERR_UNSPECIFIED):
mp_raise_bleio_SecurityError(MP_ERROR_TEXT("Unspecified issue. The pairing request on the other device may have been declined or ignored."));
break;
default:
mp_raise_bleio_SecurityError(MP_ERROR_TEXT("Unknown security error: 0x%04x"), self->sec_status);
break;
}
}

// LE Secure Connections numeric comparison. Unlike pair(), these don't block: the peer
Expand Down
4 changes: 3 additions & 1 deletion ports/espressif/common-hal/_bleio/Connection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ typedef struct {
// EDIV: Encrypted Diversifier: Identifies LTK during legacy pairing.
uint16_t ediv;
volatile pair_status_t pair_status;
uint8_t sec_status; // Internal security status.
// NimBLE status from the last BLE_GAP_EVENT_ENC_CHANGE: 0 on success, otherwise why
// pairing or encryption failed. Reported by pair().
volatile int sec_status;
// The 6-digit LE Secure Connections numeric-comparison value stashed by
// BLE_GAP_EVENT_PASSKEY_ACTION. Only valid while pair_status == PAIR_WAITING_NUMCMP.
volatile uint32_t pairing_numcmp;
Expand Down
Loading