Skip to content

Commit dfd5e3e

Browse files
andrewleechclaude
andrewleech
and
claude
committed
aioble: Add pairing and bonding multitests.
Adds comprehensive tests for BLE pairing and bonding functionality: - ble_pair.py: Tests encryption without persistent bonding (bond=False) - ble_bond.py: Tests encryption with persistent bonding (bond=True) Both tests verify: - Encrypted characteristic access requiring pairing - Proper connection state tracking (encrypted, authenticated, bonded) - Cross-compatibility with BTstack implementation - Bond storage via aioble.security module Tests use custom EncryptedCharacteristic class to add _FLAG_READ_ENCRYPTED requirement, ensuring pairing is mandatory for characteristic access. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 5b496e9 commit dfd5e3e

File tree

4 files changed

+332
-0
lines changed

4 files changed

+332
-0
lines changed

‎micropython/bluetooth/aioble/multitests/ble_bond.py‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# Test BLE GAP pairing with bonding (persistent pairing) using aioble
2+
3+
import sys
4+
5+
# ruff: noqa: E402
6+
sys.path.append("")
7+
8+
from micropython import const
9+
import machine
10+
import time
11+
import os
12+
13+
import asyncio
14+
import aioble
15+
import aioble.security
16+
import bluetooth
17+
18+
TIMEOUT_MS = 5000
19+
20+
SERVICE_UUID = bluetooth.UUID("A5A5A5A5-FFFF-9999-1111-5A5A5A5A5A5A")
21+
CHAR_UUID = bluetooth.UUID("00000000-1111-2222-3333-444444444444")
22+
23+
_FLAG_READ = const(0x0002)
24+
_FLAG_READ_ENCRYPTED = const(0x0200)
25+
26+
27+
# For aioble, we need to directly use the low-level bluetooth API for encrypted characteristics
28+
class EncryptedCharacteristic(aioble.Characteristic):
29+
def __init__(self, service, uuid, **kwargs):
30+
super().__init__(service, uuid, read=True, **kwargs)
31+
# Override flags to add encryption requirement
32+
self.flags |= _FLAG_READ_ENCRYPTED
33+
34+
35+
# Acting in peripheral role.
36+
async def instance0_task():
37+
# Clean up any existing secrets from previous tests
38+
try:
39+
os.remove("ble_secrets.json")
40+
except:
41+
pass
42+
43+
# Load secrets (will be empty initially but enables bond storage)
44+
aioble.security.load_secrets()
45+
46+
service = aioble.Service(SERVICE_UUID)
47+
characteristic = EncryptedCharacteristic(service, CHAR_UUID)
48+
aioble.register_services(service)
49+
50+
multitest.globals(BDADDR=aioble.config("mac"))
51+
multitest.next()
52+
53+
# Write initial characteristic value.
54+
characteristic.write("bonded_data")
55+
56+
# Wait for central to connect to us.
57+
print("advertise")
58+
connection = await aioble.advertise(
59+
20_000, adv_data=b"\x02\x01\x06\x04\xffMPY", timeout_ms=TIMEOUT_MS
60+
)
61+
print("connected")
62+
63+
# Wait for pairing to complete
64+
print("wait_for_bonding")
65+
start_time = time.ticks_ms()
66+
while not connection.encrypted and time.ticks_diff(time.ticks_ms(), start_time) < TIMEOUT_MS:
67+
await asyncio.sleep_ms(100)
68+
69+
# Give additional time for bonding to complete after encryption
70+
await asyncio.sleep_ms(500)
71+
72+
if connection.encrypted:
73+
print("bonded encrypted=1 authenticated={} bonded={}".format(
74+
1 if connection.authenticated else 0,
75+
1 if connection.bonded else 0
76+
))
77+
else:
78+
print("bonding_timeout")
79+
80+
# Wait for the central to disconnect.
81+
await connection.disconnected(timeout_ms=TIMEOUT_MS)
82+
print("disconnected")
83+
84+
85+
def instance0():
86+
try:
87+
asyncio.run(instance0_task())
88+
finally:
89+
aioble.stop()
90+
91+
92+
# Acting in central role.
93+
async def instance1_task():
94+
multitest.next()
95+
96+
# Clean up any existing secrets from previous tests
97+
try:
98+
os.remove("ble_secrets.json")
99+
except:
100+
pass
101+
102+
# Load secrets (will be empty initially but enables bond storage)
103+
aioble.security.load_secrets()
104+
105+
# Connect to peripheral.
106+
print("connect")
107+
device = aioble.Device(*BDADDR)
108+
connection = await device.connect(timeout_ms=TIMEOUT_MS)
109+
110+
# Discover characteristics (before pairing).
111+
service = await connection.service(SERVICE_UUID)
112+
print("service", service.uuid)
113+
characteristic = await service.characteristic(CHAR_UUID)
114+
print("characteristic", characteristic.uuid)
115+
116+
# Pair with bonding enabled.
117+
print("bond")
118+
await connection.pair(
119+
bond=True, # Enable bonding
120+
le_secure=True,
121+
mitm=False,
122+
timeout_ms=TIMEOUT_MS
123+
)
124+
125+
# Give additional time for bonding to complete after encryption
126+
await asyncio.sleep_ms(500)
127+
128+
print("bonded encrypted={} authenticated={} bonded={}".format(
129+
1 if connection.encrypted else 0,
130+
1 if connection.authenticated else 0,
131+
1 if connection.bonded else 0
132+
))
133+
134+
# Read the peripheral's characteristic, should be encrypted.
135+
print("read_encrypted")
136+
data = await characteristic.read(timeout_ms=TIMEOUT_MS)
137+
print("read", data)
138+
139+
# Check if secrets were saved
140+
try:
141+
os.stat("ble_secrets.json")
142+
print("secrets_exist", "yes")
143+
except:
144+
print("secrets_exist", "no")
145+
146+
# Disconnect from peripheral.
147+
print("disconnect")
148+
await connection.disconnect(timeout_ms=TIMEOUT_MS)
149+
print("disconnected")
150+
151+
152+
def instance1():
153+
try:
154+
asyncio.run(instance1_task())
155+
finally:
156+
aioble.stop()

‎micropython/bluetooth/aioble/multitests/ble_bond.py.exp‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
--- instance0 ---
2+
advertise
3+
connected
4+
wait_for_bonding
5+
bonded encrypted=1 authenticated=0 bonded=1
6+
disconnected
7+
--- instance1 ---
8+
connect
9+
service UUID('a5a5a5a5-ffff-9999-1111-5a5a5a5a5a5a')
10+
characteristic UUID('00000000-1111-2222-3333-444444444444')
11+
bond
12+
bonded encrypted=1 authenticated=0 bonded=1
13+
read_encrypted
14+
read b'bonded_data'
15+
secrets_exist yes
16+
disconnect
17+
disconnected

‎micropython/bluetooth/aioble/multitests/ble_pair.py‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
# Test BLE GAP pairing and bonding with aioble
2+
3+
import sys
4+
5+
# ruff: noqa: E402
6+
sys.path.append("")
7+
8+
from micropython import const
9+
import machine
10+
import time
11+
12+
import asyncio
13+
import aioble
14+
import bluetooth
15+
16+
TIMEOUT_MS = 5000
17+
18+
SERVICE_UUID = bluetooth.UUID("A5A5A5A5-FFFF-9999-1111-5A5A5A5A5A5A")
19+
CHAR_UUID = bluetooth.UUID("00000000-1111-2222-3333-444444444444")
20+
21+
_FLAG_READ = const(0x0002)
22+
_FLAG_READ_ENCRYPTED = const(0x0200)
23+
24+
25+
# For aioble, we need to directly use the low-level bluetooth API for encrypted characteristics
26+
class EncryptedCharacteristic(aioble.Characteristic):
27+
def __init__(self, service, uuid, **kwargs):
28+
super().__init__(service, uuid, read=True, **kwargs)
29+
# Override flags to add encryption requirement
30+
self.flags |= _FLAG_READ_ENCRYPTED
31+
32+
33+
# Acting in peripheral role.
34+
async def instance0_task():
35+
# Clear any existing bond state
36+
import os
37+
try:
38+
os.remove("ble_secrets.json")
39+
except:
40+
pass
41+
42+
service = aioble.Service(SERVICE_UUID)
43+
characteristic = EncryptedCharacteristic(service, CHAR_UUID)
44+
aioble.register_services(service)
45+
46+
multitest.globals(BDADDR=aioble.config("mac"))
47+
multitest.next()
48+
49+
# Write initial characteristic value.
50+
characteristic.write("encrypted_data")
51+
52+
# Wait for central to connect to us.
53+
print("advertise")
54+
connection = await aioble.advertise(
55+
20_000, adv_data=b"\x02\x01\x06\x04\xffMPY", timeout_ms=TIMEOUT_MS
56+
)
57+
print("connected")
58+
59+
# Wait for pairing to complete
60+
print("wait_for_pairing")
61+
start_time = time.ticks_ms()
62+
while not connection.encrypted and time.ticks_diff(time.ticks_ms(), start_time) < TIMEOUT_MS:
63+
await asyncio.sleep_ms(100)
64+
65+
# Give a small delay for bonding state to stabilize
66+
await asyncio.sleep_ms(200)
67+
68+
if connection.encrypted:
69+
print("paired encrypted=1 authenticated={} bonded={}".format(
70+
1 if connection.authenticated else 0,
71+
1 if connection.bonded else 0
72+
))
73+
else:
74+
print("pairing_timeout")
75+
76+
# Wait for the central to disconnect.
77+
await connection.disconnected(timeout_ms=TIMEOUT_MS)
78+
print("disconnected")
79+
80+
81+
def instance0():
82+
try:
83+
asyncio.run(instance0_task())
84+
finally:
85+
aioble.stop()
86+
87+
88+
# Acting in central role.
89+
async def instance1_task():
90+
multitest.next()
91+
92+
# Clear any existing bond state
93+
import os
94+
try:
95+
os.remove("ble_secrets.json")
96+
except:
97+
pass
98+
99+
# Connect to peripheral.
100+
print("connect")
101+
device = aioble.Device(*BDADDR)
102+
connection = await device.connect(timeout_ms=TIMEOUT_MS)
103+
104+
# Discover characteristics (before pairing).
105+
service = await connection.service(SERVICE_UUID)
106+
print("service", service.uuid)
107+
characteristic = await service.characteristic(CHAR_UUID)
108+
print("characteristic", characteristic.uuid)
109+
110+
# Pair with the peripheral.
111+
print("pair")
112+
await connection.pair(
113+
bond=False, # Don't bond for this test
114+
le_secure=True,
115+
mitm=False,
116+
timeout_ms=TIMEOUT_MS
117+
)
118+
119+
# Give a small delay for bonding state to stabilize
120+
await asyncio.sleep_ms(200)
121+
122+
print("paired encrypted={} authenticated={} bonded={}".format(
123+
1 if connection.encrypted else 0,
124+
1 if connection.authenticated else 0,
125+
1 if connection.bonded else 0
126+
))
127+
128+
# Read the peripheral's characteristic, should be encrypted.
129+
print("read_encrypted")
130+
data = await characteristic.read(timeout_ms=TIMEOUT_MS)
131+
print("read", data)
132+
133+
# Disconnect from peripheral.
134+
print("disconnect")
135+
await connection.disconnect(timeout_ms=TIMEOUT_MS)
136+
print("disconnected")
137+
138+
139+
def instance1():
140+
try:
141+
asyncio.run(instance1_task())
142+
finally:
143+
aioble.stop()

‎micropython/bluetooth/aioble/multitests/ble_pair.py.exp‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
--- instance0 ---
2+
advertise
3+
connected
4+
wait_for_pairing
5+
paired encrypted=1 authenticated=0 bonded=0
6+
disconnected
7+
--- instance1 ---
8+
connect
9+
service UUID('a5a5a5a5-ffff-9999-1111-5a5a5a5a5a5a')
10+
characteristic UUID('00000000-1111-2222-3333-444444444444')
11+
pair
12+
paired encrypted=1 authenticated=0 bonded=0
13+
read_encrypted
14+
read b'encrypted_data'
15+
disconnect
16+
disconnected

0 commit comments

Comments
 (0)