293 lines
14 KiB
Python
293 lines
14 KiB
Python
#!/usr/bin/env python3
|
|
#
|
|
# Copyright 2020 - The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
from datetime import timedelta
|
|
|
|
from google.protobuf import empty_pb2 as empty_proto
|
|
from blueberry.tests.gd.cert.event_stream import EventStream
|
|
from blueberry.tests.gd.cert.event_stream import FilteringEventStream
|
|
from blueberry.tests.gd.cert.event_stream import IEventStream
|
|
from blueberry.tests.gd.cert.closable import Closable
|
|
from blueberry.tests.gd.cert.closable import safeClose
|
|
from blueberry.tests.gd.cert.captures import HciCaptures
|
|
from bluetooth_packets_python3 import hci_packets
|
|
from blueberry.tests.gd.cert.truth import assertThat
|
|
from blueberry.facade.hci import hci_facade_pb2 as hci_facade
|
|
from blueberry.facade import common_pb2 as common
|
|
from blueberry.tests.gd.cert.matchers import HciMatchers
|
|
from bluetooth_packets_python3.hci_packets import LeSetExtendedAdvertisingParametersLegacyBuilder
|
|
from bluetooth_packets_python3.hci_packets import LegacyAdvertisingEventProperties
|
|
from bluetooth_packets_python3.hci_packets import PeerAddressType
|
|
from bluetooth_packets_python3.hci_packets import AdvertisingFilterPolicy
|
|
from bluetooth_packets_python3.hci_packets import LeSetAdvertisingSetRandomAddressBuilder
|
|
from bluetooth_packets_python3.hci_packets import GapData
|
|
from bluetooth_packets_python3.hci_packets import GapDataType
|
|
from bluetooth_packets_python3.hci_packets import LeSetExtendedAdvertisingDataBuilder
|
|
from bluetooth_packets_python3.hci_packets import Operation
|
|
from bluetooth_packets_python3.hci_packets import OwnAddressType
|
|
from bluetooth_packets_python3.hci_packets import Enable
|
|
from bluetooth_packets_python3.hci_packets import FragmentPreference
|
|
from bluetooth_packets_python3.hci_packets import LeSetExtendedScanResponseDataBuilder
|
|
from bluetooth_packets_python3.hci_packets import LeSetExtendedAdvertisingEnableBuilder
|
|
from bluetooth_packets_python3.hci_packets import EnabledSet
|
|
from bluetooth_packets_python3.hci_packets import OpCode
|
|
from bluetooth_packets_python3.hci_packets import AclBuilder
|
|
from bluetooth_packets_python3 import RawBuilder
|
|
|
|
|
|
class PyHciAclConnection(IEventStream):
|
|
|
|
def __init__(self, handle, acl_stream, device):
|
|
self.handle = int(handle)
|
|
self.device = device
|
|
# todo, handle we got is 0, so doesn't match - fix before enabling filtering
|
|
self.our_acl_stream = FilteringEventStream(acl_stream, None)
|
|
|
|
def send(self, pb_flag, b_flag, data):
|
|
acl = AclBuilder(self.handle, pb_flag, b_flag, RawBuilder(data))
|
|
self.device.hci.SendAcl(common.Data(payload=bytes(acl.Serialize())))
|
|
|
|
def send_first(self, data):
|
|
self.send(hci_packets.PacketBoundaryFlag.FIRST_AUTOMATICALLY_FLUSHABLE,
|
|
hci_packets.BroadcastFlag.POINT_TO_POINT, bytes(data))
|
|
|
|
def send_continuing(self, data):
|
|
self.send(hci_packets.PacketBoundaryFlag.CONTINUING_FRAGMENT, hci_packets.BroadcastFlag.POINT_TO_POINT,
|
|
bytes(data))
|
|
|
|
def get_event_queue(self):
|
|
return self.our_acl_stream.get_event_queue()
|
|
|
|
|
|
class PyHciLeAclConnection(IEventStream):
|
|
|
|
def __init__(self, handle, acl_stream, device, peer, peer_type, peer_resolvable, local_resolvable):
|
|
self.handle = int(handle)
|
|
self.device = device
|
|
self.peer = peer
|
|
self.peer_type = peer_type
|
|
self.peer_resolvable = peer_resolvable
|
|
self.local_resolvable = local_resolvable
|
|
# todo, handle we got is 0, so doesn't match - fix before enabling filtering
|
|
self.our_acl_stream = FilteringEventStream(acl_stream, None)
|
|
|
|
def send(self, pb_flag, b_flag, data):
|
|
acl = AclBuilder(self.handle, pb_flag, b_flag, RawBuilder(data))
|
|
self.device.hci.SendAcl(common.Data(payload=bytes(acl.Serialize())))
|
|
|
|
def send_first(self, data):
|
|
self.send(hci_packets.PacketBoundaryFlag.FIRST_AUTOMATICALLY_FLUSHABLE,
|
|
hci_packets.BroadcastFlag.POINT_TO_POINT, bytes(data))
|
|
|
|
def send_continuing(self, data):
|
|
self.send(hci_packets.PacketBoundaryFlag.CONTINUING_FRAGMENT, hci_packets.BroadcastFlag.POINT_TO_POINT,
|
|
bytes(data))
|
|
|
|
def get_event_queue(self):
|
|
return self.our_acl_stream.get_event_queue()
|
|
|
|
def local_resolvable_address(self):
|
|
return self.local_resolvable
|
|
|
|
def peer_resolvable_address(self):
|
|
return self.peer_resolvable
|
|
|
|
def peer_address(self):
|
|
return self.peer
|
|
|
|
|
|
class PyHciAdvertisement(object):
|
|
|
|
def __init__(self, handle, py_hci):
|
|
self.handle = handle
|
|
self.py_hci = py_hci
|
|
|
|
def set_data(self, complete_name):
|
|
data = GapData()
|
|
data.data_type = GapDataType.COMPLETE_LOCAL_NAME
|
|
data.data = list(complete_name)
|
|
self.py_hci.send_command(
|
|
LeSetExtendedAdvertisingDataBuilder(self.handle, Operation.COMPLETE_ADVERTISEMENT,
|
|
FragmentPreference.CONTROLLER_SHOULD_NOT, [data]))
|
|
|
|
def set_scan_response(self, shortened_name):
|
|
data = GapData()
|
|
data.data_type = GapDataType.SHORTENED_LOCAL_NAME
|
|
data.data = list(shortened_name)
|
|
self.py_hci.send_command(
|
|
LeSetExtendedScanResponseDataBuilder(self.handle, Operation.COMPLETE_ADVERTISEMENT,
|
|
FragmentPreference.CONTROLLER_SHOULD_NOT, [data]))
|
|
|
|
def start(self):
|
|
enabled_set = EnabledSet()
|
|
enabled_set.advertising_handle = self.handle
|
|
enabled_set.duration = 0
|
|
enabled_set.max_extended_advertising_events = 0
|
|
self.py_hci.send_command(LeSetExtendedAdvertisingEnableBuilder(Enable.ENABLED, [enabled_set]))
|
|
assertThat(self.py_hci.get_event_stream()).emits(
|
|
HciMatchers.CommandComplete(OpCode.LE_SET_EXTENDED_ADVERTISING_ENABLE))
|
|
|
|
|
|
class PyHci(Closable):
|
|
|
|
event_stream = None
|
|
le_event_stream = None
|
|
acl_stream = None
|
|
|
|
def __init__(self, device, acl_streaming=False):
|
|
"""
|
|
If you are planning on personally using the ACL data stream
|
|
coming from HCI, specify acl_streaming=True. You probably only
|
|
want this if you are testing HCI itself.
|
|
"""
|
|
self.device = device
|
|
self.event_stream = EventStream(self.device.hci.StreamEvents(empty_proto.Empty()))
|
|
self.le_event_stream = EventStream(self.device.hci.StreamLeSubevents(empty_proto.Empty()))
|
|
if acl_streaming:
|
|
self.register_for_events(hci_packets.EventCode.ROLE_CHANGE, hci_packets.EventCode.CONNECTION_REQUEST,
|
|
hci_packets.EventCode.CONNECTION_COMPLETE,
|
|
hci_packets.EventCode.CONNECTION_PACKET_TYPE_CHANGED)
|
|
self.register_for_le_events(hci_packets.SubeventCode.ENHANCED_CONNECTION_COMPLETE)
|
|
self.acl_stream = EventStream(self.device.hci.StreamAcl(empty_proto.Empty()))
|
|
|
|
def close(self):
|
|
safeClose(self.event_stream)
|
|
safeClose(self.le_event_stream)
|
|
safeClose(self.acl_stream)
|
|
|
|
def get_event_stream(self):
|
|
return self.event_stream
|
|
|
|
def get_le_event_stream(self):
|
|
return self.le_event_stream
|
|
|
|
def get_raw_acl_stream(self):
|
|
if self.acl_stream is None:
|
|
raise Exception("Please construct '%s' with acl_streaming=True!" % self.__class__.__name__)
|
|
return self.acl_stream
|
|
|
|
def register_for_events(self, *event_codes):
|
|
for event_code in event_codes:
|
|
self.device.hci.RequestEvent(hci_facade.EventRequest(code=int(event_code)))
|
|
|
|
def register_for_le_events(self, *event_codes):
|
|
for event_code in event_codes:
|
|
self.device.hci.RequestLeSubevent(hci_facade.EventRequest(code=int(event_code)))
|
|
|
|
def send_command(self, command):
|
|
self.device.hci.SendCommand(common.Data(payload=bytes(command.Serialize())))
|
|
|
|
def enable_inquiry_and_page_scan(self):
|
|
self.send_command(hci_packets.WriteScanEnableBuilder(hci_packets.ScanEnable.INQUIRY_AND_PAGE_SCAN))
|
|
|
|
def read_own_address(self):
|
|
self.send_command(hci_packets.ReadBdAddrBuilder())
|
|
read_bd_addr = HciCaptures.ReadBdAddrCompleteCapture()
|
|
assertThat(self.event_stream).emits(read_bd_addr)
|
|
return read_bd_addr.get().GetBdAddr()
|
|
|
|
def initiate_connection(self, remote_addr):
|
|
self.send_command(
|
|
hci_packets.CreateConnectionBuilder(
|
|
remote_addr if isinstance(remote_addr, str) else remote_addr.decode('utf-8'),
|
|
0xcc18, # Packet Type
|
|
hci_packets.PageScanRepetitionMode.R1,
|
|
0x0,
|
|
hci_packets.ClockOffsetValid.INVALID,
|
|
hci_packets.CreateConnectionRoleSwitch.ALLOW_ROLE_SWITCH))
|
|
|
|
def accept_connection(self):
|
|
connection_request = HciCaptures.ConnectionRequestCapture()
|
|
assertThat(self.event_stream).emits(connection_request)
|
|
|
|
self.send_command(
|
|
hci_packets.AcceptConnectionRequestBuilder(connection_request.get().GetBdAddr(),
|
|
hci_packets.AcceptConnectionRequestRole.REMAIN_PERIPHERAL))
|
|
return self.complete_connection()
|
|
|
|
def complete_connection(self):
|
|
connection_complete = HciCaptures.ConnectionCompleteCapture()
|
|
assertThat(self.event_stream).emits(connection_complete)
|
|
|
|
handle = connection_complete.get().GetConnectionHandle()
|
|
if self.acl_stream is None:
|
|
raise Exception("Please construct '%s' with acl_streaming=True!" % self.__class__.__name__)
|
|
return PyHciAclConnection(handle, self.acl_stream, self.device)
|
|
|
|
def set_random_le_address(self, addr):
|
|
self.send_command(hci_packets.LeSetRandomAddressBuilder(addr))
|
|
assertThat(self.event_stream).emits(HciMatchers.CommandComplete(OpCode.LE_SET_RANDOM_ADDRESS))
|
|
|
|
def initiate_le_connection(self, remote_addr):
|
|
phy_scan_params = hci_packets.LeCreateConnPhyScanParameters()
|
|
phy_scan_params.scan_interval = 0x60
|
|
phy_scan_params.scan_window = 0x30
|
|
phy_scan_params.conn_interval_min = 0x18
|
|
phy_scan_params.conn_interval_max = 0x28
|
|
phy_scan_params.conn_latency = 0
|
|
phy_scan_params.supervision_timeout = 0x1f4
|
|
phy_scan_params.min_ce_length = 0
|
|
phy_scan_params.max_ce_length = 0
|
|
self.send_command(
|
|
hci_packets.LeExtendedCreateConnectionBuilder(
|
|
hci_packets.InitiatorFilterPolicy.USE_PEER_ADDRESS, hci_packets.OwnAddressType.RANDOM_DEVICE_ADDRESS,
|
|
hci_packets.AddressType.RANDOM_DEVICE_ADDRESS, remote_addr, 1, [phy_scan_params]))
|
|
assertThat(self.event_stream).emits(HciMatchers.CommandStatus(OpCode.LE_EXTENDED_CREATE_CONNECTION))
|
|
|
|
def incoming_le_connection(self):
|
|
connection_complete = HciCaptures.LeConnectionCompleteCapture()
|
|
assertThat(self.le_event_stream).emits(connection_complete)
|
|
|
|
handle = connection_complete.get().GetConnectionHandle()
|
|
peer = connection_complete.get().GetPeerAddress()
|
|
peer_type = connection_complete.get().GetPeerAddressType()
|
|
local_resolvable = connection_complete.get().GetLocalResolvablePrivateAddress()
|
|
peer_resolvable = connection_complete.get().GetPeerResolvablePrivateAddress()
|
|
if self.acl_stream is None:
|
|
raise Exception("Please construct '%s' with acl_streaming=True!" % self.__class__.__name__)
|
|
return PyHciLeAclConnection(handle, self.acl_stream, self.device, peer, peer_type, peer_resolvable,
|
|
local_resolvable)
|
|
|
|
def incoming_le_connection_fails(self):
|
|
connection_complete = HciCaptures.LeConnectionCompleteCapture()
|
|
assertThat(self.le_event_stream).emitsNone(connection_complete, timeout=timedelta(seconds=5))
|
|
|
|
def add_device_to_resolving_list(self, peer_address_type, peer_address, peer_irk, local_irk):
|
|
self.send_command(
|
|
hci_packets.LeAddDeviceToResolvingListBuilder(peer_address_type, peer_address, peer_irk, local_irk))
|
|
|
|
def create_advertisement(self,
|
|
handle,
|
|
own_address,
|
|
properties=LegacyAdvertisingEventProperties.ADV_IND,
|
|
min_interval=400,
|
|
max_interval=450,
|
|
channel_map=7,
|
|
own_address_type=OwnAddressType.RANDOM_DEVICE_ADDRESS,
|
|
peer_address_type=PeerAddressType.PUBLIC_DEVICE_OR_IDENTITY_ADDRESS,
|
|
peer_address='00:00:00:00:00:00',
|
|
filter_policy=AdvertisingFilterPolicy.ALL_DEVICES,
|
|
tx_power=0xF8,
|
|
sid=1,
|
|
scan_request_notification=Enable.DISABLED):
|
|
|
|
self.send_command(
|
|
LeSetExtendedAdvertisingParametersLegacyBuilder(handle, properties, min_interval, max_interval, channel_map,
|
|
own_address_type, peer_address_type, peer_address,
|
|
filter_policy, tx_power, sid, scan_request_notification))
|
|
|
|
self.send_command(LeSetAdvertisingSetRandomAddressBuilder(handle, own_address))
|
|
return PyHciAdvertisement(handle, self)
|