Files
Esko Dijk f121ebcffa [tcat] enable TCAT Commissioner to receive Alerts/TLV events over TLS and improve connection mgmt (#12011)
This enables the TCAT Commissioner to receive data such as TLS Alerts,
or asynchronously sent 'event' TLVs, over TLS.  Processing TLS Alert
is required to detect the sending of Alert by the TCAT Device, which
is a requirement to be verified in cert tests. An async background
process is started to receive and log the received events.

Also some minor improvements in connection state management: when
certain commands are given after the TCAT link is disconnected, or
when a TCAT link could not be established, a message will be printed
to clearly say it's disconnected, instead of a cryptic error. Error
messages are now clearly prefixed with 'Error:'.

The CA certificate store for CommCert3 is extended with an additional
CA certificate, so that it can be verified in cert tests that a TCAT
Device rejects a wrong Commissioner with a TLS Alert (previously this
couldn't be tested).

Also includes a fix of the pyproject.toml such that Poetry does not
display the long warning on installation.

Also includes an improvement of TLV displaying to the user with a
STRING field, if the value is a string.

Also includes some syntax fixes that were flagged by the IDE, such as
missing return types for methods, or member variables that were not
initialized in the __init__().
2026-01-27 14:24:48 -08:00

101 lines
4.0 KiB
Python

"""
Copyright (c) 2024-2026, The OpenThread Authors.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
"""
import asyncio
from itertools import count, takewhile
import logging
from typing import Iterator, Union
from bleak import BleakClient
from bleak.backends.device import BLEDevice
from bleak.backends.characteristic import BleakGATTCharacteristic
logger = logging.getLogger(__name__)
class BleStream:
def __init__(self, client, service_uuid, tx_char_uuid, rx_char_uuid):
self.__receive_buffer = b''
self.__last_recv_time = None
self.client = client
self.service_uuid = service_uuid
self.tx_char_uuid = tx_char_uuid
self.rx_char_uuid = rx_char_uuid
def __str__(self):
return f"BleStream[{self.client}]"
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc_value, traceback):
if self.client.is_connected:
await self.client.disconnect()
def __handle_rx(self, _: BleakGATTCharacteristic, data: bytearray):
logger.debug(f'rx {len(data)} bytes')
self.__receive_buffer += data
self.__last_recv_time = asyncio.get_running_loop().time()
@staticmethod
def __sliced(data: bytes, n: int) -> Iterator[bytes]:
return takewhile(len, (data[i:i + n] for i in count(0, n)))
@classmethod
async def create(cls, address_or_ble_device: Union[BLEDevice, str], service_uuid, tx_char_uuid, rx_char_uuid):
client = BleakClient(address_or_ble_device)
await client.connect()
self = cls(client, service_uuid, tx_char_uuid, rx_char_uuid)
await client.start_notify(self.tx_char_uuid, self.__handle_rx)
return self
async def send(self, data):
logger.debug(f'tx {len(data)} bytes')
services = self.client.services.get_service(self.service_uuid)
rx_char = services.get_characteristic(self.rx_char_uuid)
for s in BleStream.__sliced(data, rx_char.max_write_without_response_size):
await self.client.write_gatt_char(rx_char, s)
return len(data)
async def recv(self, bufsize, recv_timeout=0.200):
if not self.__receive_buffer:
return b''
while asyncio.get_running_loop().time() - self.__last_recv_time <= recv_timeout:
await asyncio.sleep(0.020)
data = self.__receive_buffer[:bufsize]
self.__receive_buffer = self.__receive_buffer[bufsize:]
logger.debug(f'rx {len(data)} bytes')
return data
async def disconnect(self):
if self.client.is_connected:
await self.client.disconnect()