bumble 0.0.211__py3-none-any.whl → 0.0.213__py3-none-any.whl

bumble/smp.py

@@ -26,18 +26,13 @@ from __future__ import annotations
 import logging
 import asyncio
 import enum
-import secrets
 from dataclasses import dataclass
 from typing import (
     TYPE_CHECKING,
     Any,
     Awaitable,
     Callable,
-    Dict,
-    List,
     Optional,
-    Tuple,
-    Type,
     cast,
 )
 
@@ -210,7 +205,7 @@ class SMP_Command:
     See Bluetooth spec @ Vol 3, Part H - 3 SECURITY MANAGER PROTOCOL
     '''
 
-    smp_classes: Dict[int, Type[SMP_Command]] = {}
+    smp_classes: dict[int, type[SMP_Command]] = {}
     fields: Any
     code = 0
     name = ''
@@ -254,7 +249,7 @@ class SMP_Command:
 
     @staticmethod
     def key_distribution_str(value: int) -> str:
-        key_types: List[str] = []
+        key_types: list[str] = []
         if value & SMP_ENC_KEY_DISTRIBUTION_FLAG:
             key_types.append('ENC')
         if value & SMP_ID_KEY_DISTRIBUTION_FLAG:
@@ -706,7 +701,7 @@ class Session:
         self.peer_identity_resolving_key = None
         self.peer_bd_addr: Optional[Address] = None
         self.peer_signature_key = None
-        self.peer_expected_distributions: List[Type[SMP_Command]] = []
+        self.peer_expected_distributions: list[type[SMP_Command]] = []
         self.dh_key = b''
         self.confirm_value = None
         self.passkey: Optional[int] = None
@@ -724,12 +719,13 @@ class Session:
         self.is_responder = not self.is_initiator
 
         # Listen for connection events
-        connection.on('disconnection', self.on_disconnection)
+        connection.on(connection.EVENT_DISCONNECTION, self.on_disconnection)
         connection.on(
-            'connection_encryption_change', self.on_connection_encryption_change
+            connection.EVENT_CONNECTION_ENCRYPTION_CHANGE,
+            self.on_connection_encryption_change,
         )
         connection.on(
-            'connection_encryption_key_refresh',
+            connection.EVENT_CONNECTION_ENCRYPTION_KEY_REFRESH,
             self.on_connection_encryption_key_refresh,
         )
 
@@ -766,7 +762,9 @@ class Session:
 
         # OOB
         self.oob_data_flag = (
-            1 if pairing_config.oob and pairing_config.oob.peer_data else 0
+            1
+            if pairing_config.oob and (not self.sc or pairing_config.oob.peer_data)
+            else 0
         )
 
         # Set up addresses
@@ -813,7 +811,7 @@ class Session:
             self.tk = bytes(16)
 
     @property
-    def pkx(self) -> Tuple[bytes, bytes]:
+    def pkx(self) -> tuple[bytes, bytes]:
         return (self.ecc_key.x[::-1], self.peer_public_key_x)
 
     @property
@@ -825,7 +823,7 @@ class Session:
         return self.pkx[0 if self.is_responder else 1]
 
     @property
-    def nx(self) -> Tuple[bytes, bytes]:
+    def nx(self) -> tuple[bytes, bytes]:
         assert self.peer_random_value
         return (self.r, self.peer_random_value)
 
@@ -899,7 +897,7 @@ class Session:
 
             self.send_pairing_failed(SMP_CONFIRM_VALUE_FAILED_ERROR)
 
-        utils.cancel_on_event(self.connection, 'disconnection', prompt())
+        self.connection.cancel_on_disconnection(prompt())
 
     def prompt_user_for_numeric_comparison(
         self, code: int, next_steps: Callable[[], None]
@@ -918,7 +916,7 @@ class Session:
 
             self.send_pairing_failed(SMP_CONFIRM_VALUE_FAILED_ERROR)
 
-        utils.cancel_on_event(self.connection, 'disconnection', prompt())
+        self.connection.cancel_on_disconnection(prompt())
 
     def prompt_user_for_number(self, next_steps: Callable[[int], None]) -> None:
         async def prompt() -> None:
@@ -935,12 +933,11 @@ class Session:
                 logger.warning(f'exception while prompting: {error}')
                 self.send_pairing_failed(SMP_PASSKEY_ENTRY_FAILED_ERROR)
 
-        utils.cancel_on_event(self.connection, 'disconnection', prompt())
+        self.connection.cancel_on_disconnection(prompt())
 
-    def display_passkey(self) -> None:
-        # Generate random Passkey/PIN code
-        self.passkey = secrets.randbelow(1000000)
-        assert self.passkey is not None
+    async def display_passkey(self) -> None:
+        # Get the passkey value from the delegate
+        self.passkey = await self.pairing_config.delegate.generate_passkey()
         logger.debug(f'Pairing PIN CODE: {self.passkey:06}')
         self.passkey_ready.set()
 
@@ -949,14 +946,7 @@ class Session:
             self.tk = self.passkey.to_bytes(16, byteorder='little')
             logger.debug(f'TK from passkey = {self.tk.hex()}')
 
-        try:
-            utils.cancel_on_event(
-                self.connection,
-                'disconnection',
-                self.pairing_config.delegate.display_number(self.passkey, digits=6),
-            )
-        except Exception as error:
-            logger.warning(f'exception while displaying number: {error}')
+        await self.pairing_config.delegate.display_number(self.passkey, digits=6)
 
     def input_passkey(self, next_steps: Optional[Callable[[], None]] = None) -> None:
         # Prompt the user for the passkey displayed on the peer
@@ -978,9 +968,16 @@ class Session:
         self, next_steps: Optional[Callable[[], None]] = None
     ) -> None:
         if self.passkey_display:
-            self.display_passkey()
-            if next_steps is not None:
-                next_steps()
+
+            async def display_passkey():
+                await self.display_passkey()
+                if next_steps is not None:
+                    next_steps()
+
+            try:
+                self.connection.cancel_on_disconnection(display_passkey())
+            except Exception as error:
+                logger.warning(f'exception while displaying passkey: {error}')
         else:
             self.input_passkey(next_steps)
 
@@ -1050,7 +1047,7 @@ class Session:
                 )
 
             # Perform the next steps asynchronously in case we need to wait for input
-            utils.cancel_on_event(self.connection, 'disconnection', next_steps())
+            self.connection.cancel_on_disconnection(next_steps())
         else:
             confirm_value = crypto.c1(
                 self.tk,
@@ -1173,8 +1170,8 @@ class Session:
                 self.connection.transport == PhysicalTransport.BR_EDR
                 and self.initiator_key_distribution & SMP_ENC_KEY_DISTRIBUTION_FLAG
             ):
-                self.ctkd_task = utils.cancel_on_event(
-                    self.connection, 'disconnection', self.get_link_key_and_derive_ltk()
+                self.ctkd_task = self.connection.cancel_on_disconnection(
+                    self.get_link_key_and_derive_ltk()
                 )
             elif not self.sc:
                 # Distribute the LTK, EDIV and RAND
@@ -1212,8 +1209,8 @@ class Session:
                 self.connection.transport == PhysicalTransport.BR_EDR
                 and self.responder_key_distribution & SMP_ENC_KEY_DISTRIBUTION_FLAG
             ):
-                self.ctkd_task = utils.cancel_on_event(
-                    self.connection, 'disconnection', self.get_link_key_and_derive_ltk()
+                self.ctkd_task = self.connection.cancel_on_disconnection(
+                    self.get_link_key_and_derive_ltk()
                 )
             # Distribute the LTK, EDIV and RAND
             elif not self.sc:
@@ -1268,7 +1265,7 @@ class Session:
             f'{[c.__name__ for c in self.peer_expected_distributions]}'
         )
 
-    def check_key_distribution(self, command_class: Type[SMP_Command]) -> None:
+    def check_key_distribution(self, command_class: type[SMP_Command]) -> None:
         # First, check that the connection is encrypted
         if not self.connection.is_encrypted:
             logger.warning(
@@ -1305,17 +1302,18 @@ class Session:
 
         # Wait for the pairing process to finish
         assert self.pairing_result
-        await utils.cancel_on_event(
-            self.connection, 'disconnection', self.pairing_result
-        )
+        await self.connection.cancel_on_disconnection(self.pairing_result)
 
     def on_disconnection(self, _: int) -> None:
-        self.connection.remove_listener('disconnection', self.on_disconnection)
         self.connection.remove_listener(
-            'connection_encryption_change', self.on_connection_encryption_change
+            self.connection.EVENT_DISCONNECTION, self.on_disconnection
+        )
+        self.connection.remove_listener(
+            self.connection.EVENT_CONNECTION_ENCRYPTION_CHANGE,
+            self.on_connection_encryption_change,
         )
         self.connection.remove_listener(
-            'connection_encryption_key_refresh',
+            self.connection.EVENT_CONNECTION_ENCRYPTION_KEY_REFRESH,
             self.on_connection_encryption_key_refresh,
         )
         self.manager.on_session_end(self)
@@ -1325,7 +1323,7 @@ class Session:
         if self.is_initiator:
             self.distribute_keys()
 
-        utils.cancel_on_event(self.connection, 'disconnection', self.on_pairing())
+        self.connection.cancel_on_disconnection(self.on_pairing())
 
     def on_connection_encryption_change(self) -> None:
         if self.connection.is_encrypted and not self.completed:
@@ -1376,8 +1374,10 @@ class Session:
                 ediv=self.ltk_ediv,
                 rand=self.ltk_rand,
             )
+            if not self.peer_ltk:
+                logger.error("peer_ltk is None")
             peer_ltk_key = PairingKeys.Key(
-                value=self.peer_ltk,
+                value=self.peer_ltk or b'',
                 authenticated=authenticated,
                 ediv=self.peer_ediv,
                 rand=self.peer_rand,
@@ -1434,10 +1434,8 @@ class Session:
     def on_smp_pairing_request_command(
         self, command: SMP_Pairing_Request_Command
     ) -> None:
-        utils.cancel_on_event(
-            self.connection,
-            'disconnection',
-            self.on_smp_pairing_request_command_async(command),
+        self.connection.cancel_on_disconnection(
+            self.on_smp_pairing_request_command_async(command)
         )
 
     async def on_smp_pairing_request_command_async(
@@ -1501,7 +1499,7 @@ class Session:
         # Display a passkey if we need to
         if not self.sc:
             if self.pairing_method == PairingMethod.PASSKEY and self.passkey_display:
-                self.display_passkey()
+                await self.display_passkey()
 
         # Respond
         self.send_pairing_response_command()
@@ -1683,7 +1681,7 @@ class Session:
                 ):
                     return
             elif self.pairing_method == PairingMethod.PASSKEY:
-                assert self.passkey and self.confirm_value
+                assert self.passkey is not None and self.confirm_value is not None
                 # Check that the random value matches what was committed to earlier
                 confirm_verifier = crypto.f4(
                     self.pkb,
@@ -1712,7 +1710,7 @@ class Session:
             ):
                 self.send_pairing_random_command()
             elif self.pairing_method == PairingMethod.PASSKEY:
-                assert self.passkey and self.confirm_value
+                assert self.passkey is not None and self.confirm_value is not None
                 # Check that the random value matches what was committed to earlier
                 confirm_verifier = crypto.f4(
                     self.pka,
@@ -1749,7 +1747,7 @@ class Session:
             ra = bytes(16)
             rb = ra
         elif self.pairing_method == PairingMethod.PASSKEY:
-            assert self.passkey
+            assert self.passkey is not None
             ra = self.passkey.to_bytes(16, byteorder='little')
             rb = ra
         elif self.pairing_method == PairingMethod.OOB:
@@ -1848,19 +1846,23 @@ class Session:
             elif self.pairing_method == PairingMethod.PASSKEY:
                 self.send_pairing_confirm_command()
         else:
-            if self.pairing_method == PairingMethod.PASSKEY:
-                self.display_or_input_passkey()
 
-            # Send our public key back to the initiator
-            self.send_public_key_command()
+            def next_steps() -> None:
+                # Send our public key back to the initiator
+                self.send_public_key_command()
 
-            if self.pairing_method in (
-                PairingMethod.JUST_WORKS,
-                PairingMethod.NUMERIC_COMPARISON,
-                PairingMethod.OOB,
-            ):
-                # We can now send the confirmation value
-                self.send_pairing_confirm_command()
+                if self.pairing_method in (
+                    PairingMethod.JUST_WORKS,
+                    PairingMethod.NUMERIC_COMPARISON,
+                    PairingMethod.OOB,
+                ):
+                    # We can now send the confirmation value
+                    self.send_pairing_confirm_command()
+
+            if self.pairing_method == PairingMethod.PASSKEY:
+                self.display_or_input_passkey(next_steps)
+            else:
+                next_steps()
 
     def on_smp_pairing_dhkey_check_command(
         self, command: SMP_Pairing_DHKey_Check_Command
@@ -1882,7 +1884,7 @@ class Session:
                     self.wait_before_continuing = None
                     self.send_pairing_dhkey_check_command()
 
-                utils.cancel_on_event(self.connection, 'disconnection', next_steps())
+                self.connection.cancel_on_disconnection(next_steps())
             else:
                 self.send_pairing_dhkey_check_command()
         else:
@@ -1932,9 +1934,9 @@ class Manager(utils.EventEmitter):
     '''
 
     device: Device
-    sessions: Dict[int, Session]
+    sessions: dict[int, Session]
     pairing_config_factory: Callable[[Connection], PairingConfig]
-    session_proxy: Type[Session]
+    session_proxy: type[Session]
     _ecc_key: Optional[crypto.EccKey]
 
     def __init__(
@@ -1962,7 +1964,7 @@ class Manager(utils.EventEmitter):
     def on_smp_security_request_command(
         self, connection: Connection, request: SMP_Security_Request_Command
     ) -> None:
-        connection.emit('security_request', request.auth_req)
+        connection.emit(connection.EVENT_SECURITY_REQUEST, request.auth_req)
 
     def on_smp_pdu(self, connection: Connection, pdu: bytes) -> None:
         # Parse the L2CAP payload into an SMP Command object

bumble/tools/rtk_util.py

@@ -50,7 +50,7 @@ def do_parse(firmware_path):
 
 # -----------------------------------------------------------------------------
 async def do_load(usb_transport, force):
-    async with await transport.open_transport_or_link(usb_transport) as (
+    async with await transport.open_transport(usb_transport) as (
         hci_source,
         hci_sink,
     ):
@@ -69,7 +69,7 @@ async def do_load(usb_transport, force):
 
 # -----------------------------------------------------------------------------
 async def do_drop(usb_transport):
-    async with await transport.open_transport_or_link(usb_transport) as (
+    async with await transport.open_transport(usb_transport) as (
         hci_source,
         hci_sink,
     ):

bumble/transport/__init__.py

@@ -20,9 +20,9 @@ import logging
 import os
 from typing import Optional
 
+from bumble import utils
 from bumble.transport.common import (
     Transport,
-    AsyncPipeSink,
     SnoopingTransport,
     TransportSpecError,
 )
@@ -195,6 +195,7 @@ async def _open_transport(scheme: str, spec: Optional[str]) -> Transport:
 
 
 # -----------------------------------------------------------------------------
+@utils.deprecated("RemoteLink has been removed. Use open_transport instead.")
 async def open_transport_or_link(name: str) -> Transport:
     """
     Open a transport or a link relay.
@@ -205,21 +206,6 @@ async def open_transport_or_link(name: str) -> Transport:
         When the name starts with "link-relay:", open a link relay (see RemoteLink
         for details on what the arguments are).
         For other namespaces, see `open_transport`.
-
     """
-    if name.startswith('link-relay:'):
-        logger.warning('Link Relay has been deprecated.')
-        from bumble.controller import Controller
-        from bumble.link import RemoteLink  # lazy import
-
-        link = RemoteLink(name[11:])
-        await link.wait_until_connected()
-        controller = Controller('remote', link=link)  # type:ignore[arg-type]
-
-        class LinkTransport(Transport):
-            async def close(self):
-                link.close()
-
-        return _wrap_transport(LinkTransport(controller, AsyncPipeSink(controller)))
 
     return await open_transport(name)

bumble/transport/android_netsim.py

@@ -22,7 +22,7 @@ import os
 import pathlib
 import platform
 import sys
-from typing import Dict, Optional
+from typing import Optional
 
 import grpc.aio
 
@@ -143,7 +143,7 @@ def publish_grpc_port(grpc_port: int, instance_number: int) -> bool:
 
 # -----------------------------------------------------------------------------
 async def open_android_netsim_controller_transport(
-    server_host: Optional[str], server_port: int, options: Dict[str, str]
+    server_host: Optional[str], server_port: int, options: dict[str, str]
 ) -> Transport:
     if not server_port:
         raise TransportSpecError('invalid port')
@@ -288,7 +288,7 @@ async def open_android_netsim_controller_transport(
 async def open_android_netsim_host_transport_with_address(
     server_host: Optional[str],
     server_port: int,
-    options: Optional[Dict[str, str]] = None,
+    options: Optional[dict[str, str]] = None,
 ):
     if server_host == '_' or not server_host:
         server_host = 'localhost'
@@ -313,7 +313,7 @@ async def open_android_netsim_host_transport_with_address(
 
 # -----------------------------------------------------------------------------
 async def open_android_netsim_host_transport_with_channel(
-    channel, options: Optional[Dict[str, str]] = None
+    channel, options: Optional[dict[str, str]] = None
 ):
     # Wrapper for I/O operations
     class HciDevice:
@@ -451,7 +451,7 @@ async def open_android_netsim_transport(spec: Optional[str]) -> Transport:
         port = 0
         params_offset = 0
 
-    options: Dict[str, str] = {}
+    options: dict[str, str] = {}
     for param in params[params_offset:]:
         if '=' not in param:
             raise TransportSpecError('invalid parameter, expected <name>=<value>')

bumble/transport/common.py

@@ -21,7 +21,7 @@ import struct
 import asyncio
 import logging
 import io
-from typing import Any, ContextManager, Tuple, Optional, Protocol, Dict
+from typing import Any, ContextManager, Optional, Protocol
 
 from bumble import core
 from bumble import hci
@@ -38,7 +38,7 @@ logger = logging.getLogger(__name__)
 # Information needed to parse HCI packets with a generic parser:
 # For each packet type, the info represents:
 # (length-size, length-offset, unpack-type)
-HCI_PACKET_INFO: Dict[int, Tuple[int, int, str]] = {
+HCI_PACKET_INFO: dict[int, tuple[int, int, str]] = {
     hci.HCI_COMMAND_PACKET: (1, 2, 'B'),
     hci.HCI_ACL_DATA_PACKET: (2, 2, 'H'),
     hci.HCI_SYNCHRONOUS_DATA_PACKET: (1, 2, 'B'),
@@ -108,8 +108,8 @@ class PacketParser:
     NEED_BODY = 2
 
     sink: Optional[TransportSink]
-    extended_packet_info: Dict[int, Tuple[int, int, str]]
-    packet_info: Optional[Tuple[int, int, str]] = None
+    extended_packet_info: dict[int, tuple[int, int, str]]
+    packet_info: Optional[tuple[int, int, str]] = None
 
     def __init__(self, sink: Optional[TransportSink] = None) -> None:
         self.sink = sink

bumble/transport/pyusb.py

@@ -23,7 +23,7 @@ import time
 import usb.core
 import usb.util
 
-from typing import Optional, Set
+from typing import Optional
 from usb.core import Device as UsbDevice
 from usb.core import USBError
 from usb.util import CTRL_TYPE_CLASS, CTRL_RECIPIENT_OTHER
@@ -49,7 +49,7 @@ logger = logging.getLogger(__name__)
 # -----------------------------------------------------------------------------
 # Global
 # -----------------------------------------------------------------------------
-devices_in_use: Set[int] = set()
+devices_in_use: set[int] = set()
 
 
 # -----------------------------------------------------------------------------

bumble/utils.py

@@ -27,11 +27,8 @@ from typing import (
     Any,
     Awaitable,
     Callable,
-    List,
     Optional,
     Protocol,
-    Set,
-    Tuple,
     TypeVar,
     Union,
     overload,
@@ -156,7 +153,7 @@ class EventWatcher:
     ```
     '''
 
-    handlers: List[Tuple[pyee.EventEmitter, str, Callable[..., Any]]]
+    handlers: list[tuple[pyee.EventEmitter, str, Callable[..., Any]]]
 
     def __init__(self) -> None:
         self.handlers = []
@@ -329,7 +326,7 @@ class AsyncRunner:
     default_queue = WorkQueue()
 
     # Shared set of running tasks
-    running_tasks: Set[Awaitable] = set()
+    running_tasks: set[Awaitable] = set()
 
     @staticmethod
     def run_in_task(queue=None):