1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
|
"""Tests for KNX Data Secure."""
import asyncio
from pathlib import Path
from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from xknx import XKNX
from xknx.cemi import CEMIFrame, CEMILData, CEMIMessageCode
from xknx.dpt import DPTArray
from xknx.exceptions import DataSecureError
from xknx.secure.data_secure_asdu import (
SecurityAlgorithmIdentifier,
SecurityALService,
SecurityControlField,
)
from xknx.secure.keyring import Keyring, sync_load_keyring
from xknx.telegram import (
GroupAddress,
IndividualAddress,
Telegram,
TelegramDirection,
apci,
tpci,
)
@pytest.fixture(name="test_group_response_cemi")
def fixture_test_group_response_cemi() -> CEMIFrame:
"""Return a CEMI frame for a group response telegram."""
# src = 4.0.9; dst = 0/4/0; GroupValueResponse; value=(116, 41, 41)
# A+C; seq_num=155806854986
return CEMIFrame.from_knx(
bytes.fromhex("29003ce0400904001103f110002446cfef4ac085e7092ab062b44d")
)
@pytest.fixture(name="test_point_to_point_cemi")
def fixture_test_point_to_point_cemi() -> CEMIFrame:
"""Return a CEMI frame for a group response telegram."""
# Property Value Write PID_GRP_KEY_TABLE connectionless
# Object Idx = 5, PropId = 35h, Element Count = 1, Index = 1
# Data = 20 21 22 23 24 25 26 27 28 29 2A 2B 2C 2D 2E 2F
# A+C
# from AN158 v07 KNX Data Security AS - Annex A example
return CEMIFrame.from_knx(
bytes.fromhex(
"29 00 b0 60 ff 67 ff 00 22 03 f1 90 00 00 00 00"
"00 04 67 67 24 2a 23 08 ca 76 a1 17 74 21 4e e4"
"cf 5d 94 90 9f 74 3d 05 0d 8f c1 68"
)
)
class TestDataSecure:
"""Test class for KNX Data Secure."""
secure_test_keyring: Keyring
@classmethod
def setup_class(cls) -> None:
"""Set up any state specific to the execution of the given class."""
secure_test_keyfile = Path(__file__).parent / "resources/SecureTest.knxkeys"
cls.secure_test_keyring = sync_load_keyring(secure_test_keyfile, "test")
def setup_method(self) -> None:
"""Set up test methods."""
# pylint: disable=attribute-defined-outside-init
self.xknx = XKNX()
self.xknx.knxip_interface = AsyncMock()
self.xknx.current_address = IndividualAddress("5.0.1")
self.xknx.cemi_handler.data_secure_init(TestDataSecure.secure_test_keyring)
self.data_secure = self.xknx.cemi_handler.data_secure
@patch("xknx.secure.data_secure.DataSecure.outgoing_cemi")
@patch("xknx.secure.data_secure.DataSecure.received_cemi")
async def test_data_secure_init(
self, mock_ds_received_cemi: MagicMock, mock_ds_outgoing_cemi: MagicMock
) -> None:
"""Test DataSecure init and passing frames from CEMIHandler to DataSecure."""
assert self.data_secure is not None
assert len(self.data_secure._group_key_table) == 4
for ga_raw in [1024, 1027, 1028, 1029]:
assert GroupAddress(ga_raw) in self.data_secure._group_key_table
assert len(self.data_secure._individual_address_table) == 5
for ia_raw in ["4.0.0", "4.0.1", "4.0.9", "5.0.0", "5.0.1"]:
assert (
IndividualAddress(ia_raw) in self.data_secure._individual_address_table
)
# this is based on clock milliseconds
assert self.data_secure._sequence_number_sending > 0
test_telegram = Telegram(
destination_address=GroupAddress("0/4/0"),
payload=apci.GroupValueRead(),
)
task = asyncio.create_task(self.xknx.cemi_handler.send_telegram(test_telegram))
await asyncio.sleep(0)
# Frame is passed to DataSecure class. Encryption is not tested here.
mock_ds_outgoing_cemi.assert_called_once()
assert isinstance(
mock_ds_outgoing_cemi.call_args.kwargs["cemi_data"], CEMILData
)
self.xknx.cemi_handler._l_data_confirmation_event.set()
await task
test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_IND,
data=CEMILData.init_from_telegram(test_telegram),
)
# Reuse incoming plain APDU. Decryption is not tested here
mock_ds_received_cemi.return_value = test_cemi.data
with patch.object(
self.xknx.cemi_handler, "telegram_received"
) as mock_telegram_received: # suppress forwarding to telegras/management
self.xknx.cemi_handler.handle_cemi_frame(test_cemi)
mock_ds_received_cemi.assert_called_once()
assert isinstance(
mock_ds_received_cemi.call_args.kwargs["cemi_data"], CEMILData
)
mock_telegram_received.assert_called_once()
def test_data_secure_init_invalid_system_time(self) -> None:
"""Test DataSecure init with invalid system time."""
with (
patch("time.time", return_value=1515108203.0), # 2018-01-04T23:23:23+00:00
pytest.raises(DataSecureError, match=r"Initial sequence number out of .*"),
):
self.xknx.cemi_handler.data_secure_init(TestDataSecure.secure_test_keyring)
def test_data_secure_group_send(self) -> None:
"""Test outgoing DataSecure group communication."""
self.data_secure._sequence_number_sending = 160170101607
test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_REQ,
data=CEMILData.init_from_telegram(
Telegram(
destination_address=GroupAddress("0/4/0"),
payload=apci.GroupValueRead(),
),
src_addr=self.xknx.current_address,
),
)
secured_frame_data = self.data_secure.outgoing_cemi(test_cemi.data)
assert isinstance(secured_frame_data, CEMILData)
assert isinstance(secured_frame_data.payload, apci.SecureAPDU)
secured_asdu = secured_frame_data.payload.secured_data
assert int.from_bytes(secured_asdu.sequence_number_bytes, "big") == 160170101607
assert secured_asdu.secured_apdu == bytes.fromhex("cd18")
assert secured_asdu.message_authentication_code == bytes.fromhex("4afe5744")
# sequence number sending was incremented
assert self.data_secure._sequence_number_sending == 160170101608
assert secured_frame_data.to_knx() == bytes.fromhex(
"bce0500104000e03f11000254ae1cb67cd184afe5744"
)
def test_data_secure_group_receive(
self, test_group_response_cemi: CEMIFrame
) -> None:
"""Test incoming DataSecure group communication."""
assert (
self.data_secure._individual_address_table[IndividualAddress("4.0.9")]
== 155806854915
)
assert isinstance(test_group_response_cemi.data, CEMILData)
assert test_group_response_cemi.data.src_addr == IndividualAddress("4.0.9")
assert isinstance(test_group_response_cemi.data.payload, apci.SecureAPDU)
plain_frame_data = self.data_secure.received_cemi(test_group_response_cemi.data)
assert isinstance(plain_frame_data, CEMILData)
assert plain_frame_data.payload == apci.GroupValueResponse(
DPTArray((116, 41, 41))
)
# individual_address_table sequence number was updated
assert (
self.data_secure._individual_address_table[IndividualAddress("4.0.9")]
== 155806854986
)
def test_data_secure_individual_receive_tool_key(
self, test_point_to_point_cemi: CEMIFrame
) -> None:
"""Test incoming DataSecure point-to-point communication via tool key."""
self.xknx.current_address = IndividualAddress("15.15.0")
assert isinstance(test_point_to_point_cemi.data.payload, apci.SecureAPDU)
with pytest.raises(
DataSecureError, match=r"System broadcast and tool access not supported.*"
):
self.data_secure.received_cemi(test_point_to_point_cemi.data)
# don't raise through handle_cemi_frame()
assert (
self.xknx.cemi_handler.handle_cemi_frame(test_point_to_point_cemi) is None
)
def test_data_secure_individual_receive(
self, test_point_to_point_cemi: CEMIFrame
) -> None:
"""Test incoming DataSecure point-to-point communication."""
self.xknx.current_address = IndividualAddress("15.15.0")
assert isinstance(test_point_to_point_cemi.data.payload, apci.SecureAPDU)
# don't use tool key or system broadcast
# further validation is skipped so we can use the same test data
test_point_to_point_cemi.data.payload.scf.tool_access = False
test_point_to_point_cemi.data.payload.scf.system_broadcast = False
with pytest.raises(
DataSecureError,
match=r"Secure Point-to-Point communication not supported.*",
):
self.data_secure.received_cemi(test_point_to_point_cemi.data)
# don't raise through handle_cemi_frame()
assert (
self.xknx.cemi_handler.handle_cemi_frame(test_point_to_point_cemi) is None
)
def test_data_secure_group_receive_unknown_source(
self, test_group_response_cemi: CEMIFrame
) -> None:
"""Test incoming DataSecure group communication from unknown source."""
test_group_response_cemi.data.src_addr = IndividualAddress("1.2.3")
with pytest.raises(
DataSecureError,
match=r"Source address not found in Security Individual Address Table.*",
):
self.data_secure.received_cemi(test_group_response_cemi.data)
def test_data_secure_group_receive_unknown_destination(
self, test_group_response_cemi: CEMIFrame
) -> None:
"""Test incoming DataSecure group communication for unknown destination."""
test_group_response_cemi.data.dst_addr = GroupAddress("1/2/3")
with pytest.raises(
DataSecureError,
match=r"No key found for group address.*",
):
self.data_secure.received_cemi(test_group_response_cemi.data)
def test_data_secure_group_receive_wrong_sequence_number(
self, test_group_response_cemi: CEMIFrame
) -> None:
"""Test incoming DataSecure group communication with wrong sequence number."""
seq_num = 155806854986
assert (
test_group_response_cemi.data.payload.secured_data.sequence_number_bytes
== seq_num.to_bytes(6, "big")
)
# sequence number already used
self.data_secure._individual_address_table[IndividualAddress("4.0.9")] = seq_num
with pytest.raises(
DataSecureError,
match=r"Sequence number too low.*",
):
self.data_secure.received_cemi(test_group_response_cemi.data)
def test_data_secure_group_receive_wrong_mac(
self, test_group_response_cemi: CEMIFrame
) -> None:
"""Test incoming DataSecure group communication with wrong MAC."""
test_group_response_cemi.data.payload.secured_data.message_authentication_code = bytes(
4
)
with pytest.raises(
DataSecureError,
match=r"Data Secure MAC verification failed.*",
):
self.data_secure.received_cemi(test_group_response_cemi.data)
def test_data_secure_group_receive_plain_frame(self) -> None:
"""Test incoming DataSecure group communication with plain frame."""
src_addr = IndividualAddress("4.0.9")
test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_IND,
data=CEMILData.init_from_telegram(
Telegram(
destination_address=GroupAddress("0/4/0"),
direction=TelegramDirection.INCOMING,
payload=apci.GroupValueResponse(DPTArray((116, 41, 41))),
),
src_addr=src_addr,
),
)
assert src_addr in self.data_secure._individual_address_table
with pytest.raises(
DataSecureError,
match=r"Discarding frame with plain APDU for secure group address.*",
):
self.data_secure.received_cemi(test_cemi.data)
def test_non_secure_group_receive_plain_frame(self) -> None:
"""Test incoming non-secure group communication with plain frame."""
dst_addr = GroupAddress("1/2/3")
test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_IND,
data=CEMILData.init_from_telegram(
Telegram(
destination_address=dst_addr,
direction=TelegramDirection.INCOMING,
payload=apci.GroupValueResponse(DPTArray((116, 41, 41))),
),
src_addr=IndividualAddress("4.0.9"),
),
)
assert dst_addr not in self.data_secure._group_key_table
assert self.data_secure.received_cemi(test_cemi.data) == test_cemi.data
def test_non_secure_group_send_plain_frame(self) -> None:
"""Test outgoing non-secure group communication with plain frame."""
dst_addr = GroupAddress("1/2/3")
test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_REQ,
data=CEMILData.init_from_telegram(
Telegram(
destination_address=dst_addr,
direction=TelegramDirection.OUTGOING,
payload=apci.GroupValueResponse(DPTArray((116, 41, 41))),
),
src_addr=self.xknx.current_address,
),
)
assert dst_addr not in self.data_secure._group_key_table
assert self.data_secure.outgoing_cemi(test_cemi.data) == test_cemi.data
def test_non_secure_individual_receive_plain_frame(self) -> None:
"""Test incoming non-secure group communication with plain frame."""
src_addr = IndividualAddress("1.2.3")
test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_IND,
data=CEMILData.init_from_telegram(
Telegram(
destination_address=self.xknx.current_address,
direction=TelegramDirection.INCOMING,
payload=apci.PropertyValueWrite(
object_index=5,
property_id=0x35,
count=1,
start_index=1,
data=bytes.fromhex(
"20 21 22 23 24 25 26 27 28 29 2A 2B 2C 2D 2E 2F"
),
),
tpci=tpci.TDataIndividual(),
),
src_addr=IndividualAddress("4.0.9"),
),
)
assert src_addr not in self.data_secure._individual_address_table
assert self.data_secure.received_cemi(test_cemi.data) == test_cemi.data
def test_non_secure_individual_send_plain_frame(self) -> None:
"""Test outgoing non-secure group communication with plain frame."""
dst_addr = IndividualAddress("1.2.3")
test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_REQ,
data=CEMILData.init_from_telegram(
Telegram(
destination_address=dst_addr,
direction=TelegramDirection.INCOMING,
payload=apci.PropertyValueWrite(
object_index=5,
property_id=0x35,
count=1,
start_index=1,
data=bytes.fromhex(
"20 21 22 23 24 25 26 27 28 29 2A 2B 2C 2D 2E 2F"
),
),
tpci=tpci.TDataIndividual(),
),
src_addr=self.xknx.current_address,
),
)
assert dst_addr not in self.data_secure._individual_address_table
assert self.data_secure.outgoing_cemi(test_cemi.data) == test_cemi.data
def test_data_secure_authentication_only(self) -> None:
"""Test frame de-/serialization for DataSecure authentication only."""
# This is currently not used from xknx and I also don't know if it is used
# in any ETS or runtime KNX communication. Therefore a very generic test.
dst_addr = GroupAddress("0/4/0")
test_telegram = Telegram(
destination_address=dst_addr,
direction=TelegramDirection.OUTGOING,
payload=apci.GroupValueWrite(DPTArray((1, 2))),
)
test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_REQ,
data=CEMILData.init_from_telegram(
telegram=test_telegram,
src_addr=self.xknx.current_address,
),
)
scf = SecurityControlField(
algorithm=SecurityAlgorithmIdentifier.CCM_AUTHENTICATION,
service=SecurityALService.S_A_DATA,
system_broadcast=False,
tool_access=False,
)
key = self.data_secure._group_key_table[dst_addr]
outgoing_signed_cemi_data = self.data_secure._secure_data_cemi(
key=key, scf=scf, cemi_data=test_cemi.data
)
assert outgoing_signed_cemi_data.payload.secured_data is not None
# create new cemi to avoid mixed bytearray / byte parts
incoming_cemi = CEMIFrame.from_knx(
b"\x11\x00" + outgoing_signed_cemi_data.to_knx()
)
assert isinstance(incoming_cemi.data, CEMILData)
# receive same cemi - fake individual address table entry
self.data_secure._individual_address_table[incoming_cemi.data.src_addr] = 1
assert self.data_secure.received_cemi(incoming_cemi.data) == test_cemi.data
# Test wrong MAC
self.data_secure._individual_address_table[incoming_cemi.data.src_addr] = 1
incoming_cemi.data.payload.secured_data.message_authentication_code = bytes(4)
with pytest.raises(
DataSecureError,
match=r"Data Secure MAC verification failed.*",
):
self.data_secure.received_cemi(incoming_cemi.data)
|