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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
|
"""Test Secure Group."""
import asyncio
from unittest.mock import Mock, patch
import pytest
from xknx.cemi import CEMIFrame, CEMILData, CEMIMessageCode
from xknx.exceptions import IPSecureError
from xknx.io.const import DEFAULT_MCAST_GRP, DEFAULT_MCAST_PORT, XKNX_SERIAL_NUMBER
from xknx.io.ip_secure import SecureGroup, SecureSequenceTimer
from xknx.knxip import HPAI, KNXIPFrame, RoutingIndication, SecureWrapper, TimerNotify
from xknx.telegram import GroupAddress, Telegram, apci
from ..conftest import EventLoopClockAdvancer
ONE_HOUR_MS = 60 * 60 * 1000
@patch("xknx.io.transport.udp_transport.UDPTransport.connect")
@patch("xknx.io.transport.udp_transport.UDPTransport.send")
class TestSecureGroup:
"""Test class for xknx/io/SecureGroup objects."""
mock_addr = ("127.0.0.1", 12345)
mock_backbone_key = bytes.fromhex(
"0a a2 27 b4 fd 7a 32 31 9b a9 96 0a c0 36 ce 0e"
"5c 45 07 b5 ae 55 16 1f 10 78 b1 dc fb 3c b6 31"
)
def assert_timer_notify(
self,
knxipframe: KNXIPFrame,
timer_value: int | None = None,
serial_number: bytes | None = None,
message_tag: bytes | None = None,
mac: bytes | None = None,
) -> bytes:
"""Assert that knxipframe is a TimerNotify."""
assert isinstance(knxipframe.body, TimerNotify)
if timer_value is not None:
assert knxipframe.body.timer_value == timer_value
if serial_number is not None:
assert knxipframe.body.serial_number == serial_number
if message_tag is not None:
assert knxipframe.body.message_tag == message_tag
if mac is not None:
assert knxipframe.body.message_authentication_code == mac
return knxipframe.body.message_tag
async def test_no_synchronize(
self,
mock_super_send: Mock,
mock_super_connect: Mock,
time_travel: EventLoopClockAdvancer,
) -> None:
"""Test synchronisazion not answered."""
secure_group = SecureGroup(
local_addr=self.mock_addr,
remote_addr=(DEFAULT_MCAST_GRP, DEFAULT_MCAST_PORT),
backbone_key=self.mock_backbone_key,
latency_ms=1000,
)
secure_timer = secure_group.secure_timer
connect_task = asyncio.create_task(secure_group.connect())
await time_travel(0)
mock_super_connect.assert_called_once()
self.assert_timer_notify(
mock_super_send.call_args[0][0],
serial_number=XKNX_SERIAL_NUMBER,
)
mock_super_send.reset_mock()
# synchronize timed out
await time_travel(
secure_timer.max_delay_time_follower_update_notify
+ 2 * secure_timer.latency_tolerance_ms / 1000
)
assert connect_task.done()
# we are timekeeper so we send TimerNotify after time_keeper_periodic
assert secure_timer.timekeeper
assert not secure_timer.sched_update
await time_travel(secure_timer.MIN_DELAY_TIME_KEEPER_PERIODIC_NOTIFY - 0.01)
mock_super_send.assert_not_called()
await time_travel(secure_timer.sync_latency_tolerance_ms / 1000 * 3 + 0.02)
self.assert_timer_notify(
mock_super_send.call_args[0][0],
serial_number=XKNX_SERIAL_NUMBER,
)
mock_super_send.reset_mock()
# test response to invalid timer as timekeeper
timer_invalid = KNXIPFrame.init_from_body(
TimerNotify(
timer_value=0,
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
message_authentication_code=bytes.fromhex(
"3195051bb981941d57e6c5b55355f341"
),
)
)
secure_group.handle_knxipframe(timer_invalid, HPAI(*self.mock_addr))
assert secure_timer.timekeeper
assert secure_timer.sched_update
await time_travel(secure_timer.MIN_DELAY_TIME_KEEPER_UPDATE_NOTIFY - 0.01)
mock_super_send.assert_not_called()
await time_travel(secure_timer.sync_latency_tolerance_ms / 1000 * 1 + 0.02)
self.assert_timer_notify(
mock_super_send.call_args[0][0],
message_tag=bytes.fromhex("12 34"),
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
)
# stop
secure_group.stop()
assert secure_timer._notify_timer_handle is None
async def test_synchronize(
self,
mock_super_send: Mock,
mock_super_connect: Mock,
time_travel: EventLoopClockAdvancer,
) -> None:
"""Test synchronisazion."""
secure_group = SecureGroup(
local_addr=self.mock_addr,
remote_addr=(DEFAULT_MCAST_GRP, DEFAULT_MCAST_PORT),
backbone_key=self.mock_backbone_key,
latency_ms=1000,
)
secure_timer = secure_group.secure_timer
connect_task = asyncio.create_task(secure_group.connect())
await time_travel(0)
mock_super_connect.assert_called_once()
_message_tag = self.assert_timer_notify(
mock_super_send.call_args[0][0],
serial_number=XKNX_SERIAL_NUMBER,
)
mock_super_send.reset_mock()
# incoming
timer_update = KNXIPFrame.init_from_body(
TimerNotify(
timer_value=ONE_HOUR_MS,
serial_number=XKNX_SERIAL_NUMBER,
message_tag=_message_tag,
)
)
with patch("xknx.io.ip_secure.SecureSequenceTimer.verify_timer_notify_mac"):
# TimerNotify MAC is random so we don't verify it in tests
secure_group.handle_knxipframe(timer_update, HPAI(*self.mock_addr))
await time_travel(0)
_leeway_for_ci = 50 # ms
assert (
ONE_HOUR_MS
<= secure_timer.current_timer_value()
<= ONE_HOUR_MS + _leeway_for_ci
)
assert connect_task.done()
# nothing sent until time_follower_periodic
assert not secure_timer.timekeeper
await time_travel(secure_timer.min_delay_time_follower_periodic_notify - 0.01)
mock_super_send.assert_not_called()
await time_travel(secure_timer.sync_latency_tolerance_ms / 1000 * 10 + 0.02)
self.assert_timer_notify(
mock_super_send.call_args[0][0],
serial_number=XKNX_SERIAL_NUMBER,
)
mock_super_send.reset_mock()
secure_group.stop()
assert secure_timer._notify_timer_handle is None
@patch( # keep implementation of reschedule
"xknx.io.ip_secure.SecureSequenceTimer.reschedule",
side_effect=SecureSequenceTimer.reschedule,
autospec=True,
)
@patch("xknx.io.ip_secure.SecureSequenceTimer._notify_timer_expired")
@patch("xknx.io.ip_secure.SecureSequenceTimer._monotonic_ms")
async def test_received_timer_notify(
self,
mock_monotonic_ms: Mock,
_mock_notify_timer_expired: Mock, # we don't want to actually send here
mock_reschedule: Mock,
mock_super_send: Mock,
mock_super_connect: Mock,
time_travel: EventLoopClockAdvancer,
) -> None:
"""Test handling of received TimerNotify frames."""
mock_monotonic_ms.return_value = 0
secure_group = SecureGroup(
local_addr=self.mock_addr,
remote_addr=(DEFAULT_MCAST_GRP, DEFAULT_MCAST_PORT),
backbone_key=self.mock_backbone_key,
latency_ms=1000,
)
secure_timer = secure_group.secure_timer
# TimerNotify with invalid MAC shall be discarded
timer_invalid_mac = KNXIPFrame.init_from_body(
TimerNotify(
timer_value=ONE_HOUR_MS,
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
)
)
secure_group.handle_knxipframe(timer_invalid_mac, HPAI(*self.mock_addr))
mock_reschedule.assert_not_called()
# E1
timer_newer = KNXIPFrame.init_from_body(
TimerNotify(
timer_value=ONE_HOUR_MS,
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
message_authentication_code=bytes.fromhex(
"d2fad5657a5788a36cdd8a3ef84c90ab"
),
)
)
secure_group.handle_knxipframe(timer_newer, HPAI(*self.mock_addr))
mock_reschedule.assert_called_once()
assert secure_timer.current_timer_value() == ONE_HOUR_MS
assert not secure_timer.timekeeper
assert not secure_timer.sched_update
mock_reschedule.reset_mock()
# E2
timer_exact = KNXIPFrame.init_from_body(
TimerNotify(
timer_value=ONE_HOUR_MS,
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
message_authentication_code=bytes.fromhex(
"d2fad5657a5788a36cdd8a3ef84c90ab"
),
)
)
secure_group.handle_knxipframe(timer_exact, HPAI(*self.mock_addr))
mock_reschedule.assert_called_once()
assert secure_timer.current_timer_value() == ONE_HOUR_MS
assert not secure_timer.timekeeper
assert not secure_timer.sched_update
mock_reschedule.reset_mock()
timer_valid = KNXIPFrame.init_from_body(
TimerNotify(
timer_value=ONE_HOUR_MS - secure_timer.sync_latency_tolerance_ms + 1,
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
message_authentication_code=bytes.fromhex(
"7572b70b4f986d7ae68891a00c0d46d3"
),
)
)
secure_group.handle_knxipframe(timer_valid, HPAI(*self.mock_addr))
mock_reschedule.assert_called_once()
assert secure_timer.current_timer_value() == ONE_HOUR_MS
assert not secure_timer.timekeeper
assert not secure_timer.sched_update
mock_reschedule.reset_mock()
# E3
timer_tolerable_1 = KNXIPFrame.init_from_body(
TimerNotify(
timer_value=ONE_HOUR_MS - secure_timer.sync_latency_tolerance_ms,
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
message_authentication_code=bytes.fromhex(
"3d70cc44607ad9b4a4425de95101a54c"
),
)
)
secure_group.handle_knxipframe(timer_tolerable_1, HPAI(*self.mock_addr))
mock_reschedule.assert_not_called()
timer_tolerable_2 = KNXIPFrame.init_from_body(
TimerNotify(
timer_value=ONE_HOUR_MS - secure_timer.latency_tolerance_ms + 1,
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
message_authentication_code=bytes.fromhex(
"66b8b2e52196bcce3dce2da7e0dc50ec"
),
)
)
secure_group.handle_knxipframe(timer_tolerable_2, HPAI(*self.mock_addr))
mock_reschedule.assert_not_called()
# E4
timer_invalid = KNXIPFrame.init_from_body(
TimerNotify(
timer_value=ONE_HOUR_MS - secure_timer.latency_tolerance_ms,
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
message_authentication_code=bytes.fromhex(
"873d9a5a25b8508446bbd5ff1bb4b465"
),
)
)
secure_group.handle_knxipframe(timer_invalid, HPAI(*self.mock_addr))
mock_reschedule.assert_called_once_with(
secure_timer, # self for Mock
update=(bytes.fromhex("12 34"), bytes.fromhex("00 fa 12 34 56 78")),
)
assert not secure_timer.timekeeper
assert secure_timer.sched_update
mock_reschedule.reset_mock()
# E4 from sched_update
secure_group.handle_knxipframe(timer_invalid, HPAI(*self.mock_addr))
mock_reschedule.assert_not_called()
@patch( # keep implementation of reschedule
"xknx.io.ip_secure.SecureSequenceTimer.reschedule",
side_effect=SecureSequenceTimer.reschedule,
autospec=True,
)
@patch("xknx.io.ip_secure.SecureSequenceTimer._notify_timer_expired")
@patch("xknx.io.ip_secure.SecureSequenceTimer._monotonic_ms")
@patch("xknx.io.transport.udp_transport.UDPTransport.handle_knxipframe")
@patch(
"xknx.io.ip_secure.SecureGroup.decrypt_frame",
return_value=True, # we are only interested in timer value
)
async def test_received_secure_wrapper(
self,
mock_decrypt_frame: Mock,
mock_super_handle_knxipframe: Mock,
mock_monotonic_ms: Mock,
_mock_notify_timer_expired: Mock, # we don't want to actually send here
mock_reschedule: Mock,
mock_super_send: Mock,
mock_super_connect: Mock,
time_travel: EventLoopClockAdvancer,
) -> None:
"""Test handling of received SecureWrapper frames."""
mock_monotonic_ms.return_value = 0
secure_group = SecureGroup(
local_addr=self.mock_addr,
remote_addr=(DEFAULT_MCAST_GRP, DEFAULT_MCAST_PORT),
backbone_key=self.mock_backbone_key,
latency_ms=1000,
)
secure_timer = secure_group.secure_timer
secure_timer.timer_authenticated = True
# E5
wrapper_newer = KNXIPFrame.init_from_body(
SecureWrapper(
sequence_information=ONE_HOUR_MS.to_bytes(6, "big"),
)
)
secure_group.handle_knxipframe(wrapper_newer, HPAI(*self.mock_addr))
mock_super_handle_knxipframe.assert_called_once()
mock_super_handle_knxipframe.reset_mock()
mock_reschedule.assert_called_once()
assert secure_timer.current_timer_value() == ONE_HOUR_MS
assert not secure_timer.sched_update
mock_reschedule.reset_mock()
# E6
wrapper_exact = KNXIPFrame.init_from_body(
SecureWrapper(sequence_information=ONE_HOUR_MS.to_bytes(6, "big"))
)
secure_group.handle_knxipframe(wrapper_exact, HPAI(*self.mock_addr))
mock_super_handle_knxipframe.assert_called_once()
mock_super_handle_knxipframe.reset_mock()
mock_reschedule.assert_called_once()
assert secure_timer.current_timer_value() == ONE_HOUR_MS
assert not secure_timer.timekeeper
assert not secure_timer.sched_update
mock_reschedule.reset_mock()
wrapper_valid = KNXIPFrame.init_from_body(
SecureWrapper(
sequence_information=(
ONE_HOUR_MS - secure_timer.sync_latency_tolerance_ms + 1
).to_bytes(6, "big")
)
)
secure_group.handle_knxipframe(wrapper_valid, HPAI(*self.mock_addr))
mock_super_handle_knxipframe.assert_called_once()
mock_super_handle_knxipframe.reset_mock()
mock_reschedule.assert_called_once()
assert secure_timer.current_timer_value() == ONE_HOUR_MS
assert not secure_timer.timekeeper
assert not secure_timer.sched_update
mock_reschedule.reset_mock()
# E7
wrapper_tolerable_1 = KNXIPFrame.init_from_body(
SecureWrapper(
sequence_information=(
ONE_HOUR_MS - secure_timer.sync_latency_tolerance_ms
).to_bytes(6, "big"),
)
)
secure_group.handle_knxipframe(wrapper_tolerable_1, HPAI(*self.mock_addr))
mock_super_handle_knxipframe.assert_called_once()
mock_super_handle_knxipframe.reset_mock()
mock_reschedule.assert_not_called()
wrapper_tolerable_2 = KNXIPFrame.init_from_body(
SecureWrapper(
sequence_information=(
ONE_HOUR_MS - secure_timer.latency_tolerance_ms + 1
).to_bytes(6, "big"),
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
)
)
secure_group.handle_knxipframe(wrapper_tolerable_2, HPAI(*self.mock_addr))
mock_super_handle_knxipframe.assert_called_once()
mock_super_handle_knxipframe.reset_mock()
mock_reschedule.assert_not_called()
# E8
wrapper_invalid = KNXIPFrame.init_from_body(
SecureWrapper(
sequence_information=(
ONE_HOUR_MS - secure_timer.latency_tolerance_ms
).to_bytes(6, "big"),
serial_number=bytes.fromhex("00 fa 12 34 56 78"),
message_tag=bytes.fromhex("12 34"),
)
)
secure_group.handle_knxipframe(wrapper_invalid, HPAI(*self.mock_addr))
mock_reschedule.assert_called_once_with(
secure_timer, # self for Mock
update=(bytes.fromhex("12 34"), bytes.fromhex("00 fa 12 34 56 78")),
)
assert not secure_timer.timekeeper
assert secure_timer.sched_update
mock_reschedule.reset_mock()
# E8 from sched_update
secure_group.handle_knxipframe(wrapper_invalid, HPAI(*self.mock_addr))
mock_super_handle_knxipframe.assert_not_called()
mock_reschedule.assert_not_called()
@patch( # keep implementation of reschedule
"xknx.io.ip_secure.SecureSequenceTimer.reschedule",
side_effect=SecureSequenceTimer.reschedule,
autospec=True,
)
@patch("xknx.io.ip_secure.SecureSequenceTimer._notify_timer_expired")
@patch("xknx.io.ip_secure.SecureSequenceTimer._monotonic_ms")
async def test_send_secure_wrapper(
self,
mock_monotonic_ms: Mock,
_mock_notify_timer_expired: Mock, # we don't want to actually send here
mock_reschedule: Mock,
mock_super_send: Mock,
mock_super_connect: Mock,
time_travel: EventLoopClockAdvancer,
) -> None:
"""Test sending SecureWrapper frames."""
mock_monotonic_ms.return_value = 0
secure_group = SecureGroup(
local_addr=self.mock_addr,
remote_addr=(DEFAULT_MCAST_GRP, DEFAULT_MCAST_PORT),
backbone_key=self.mock_backbone_key,
latency_ms=1000,
)
secure_timer = secure_group.secure_timer
secure_timer.timer_authenticated = True
raw_test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_IND,
data=CEMILData.init_from_telegram(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=apci.GroupValueRead(),
)
),
).to_knx()
assert not secure_timer.sched_update
secure_group.send(
KNXIPFrame.init_from_body(RoutingIndication(raw_cemi=raw_test_cemi))
)
mock_reschedule.assert_called_once()
mock_reschedule.reset_mock()
# no reschedule when sched_update is true
secure_timer.reschedule(update=(bytes(2), bytes(6)))
assert secure_timer.sched_update
mock_reschedule.reset_mock()
secure_group.send(
KNXIPFrame.init_from_body(RoutingIndication(raw_cemi=raw_test_cemi))
)
mock_reschedule.assert_not_called()
@patch("xknx.io.ip_secure.SecureSequenceTimer._notify_timer_expired")
@patch("xknx.io.ip_secure.SecureSequenceTimer._monotonic_ms")
async def test_send_secure_wrapper_timer_overflow(
self,
mock_monotonic_ms: Mock,
_mock_notify_timer_expired: Mock, # we don't want to actually send here
mock_super_send: Mock,
mock_super_connect: Mock,
) -> None:
"""Test raising when secure timer overflows."""
mock_monotonic_ms.return_value = 0xFF_FF_FF_FF_FF_FF + 1
secure_group = SecureGroup(
local_addr=self.mock_addr,
remote_addr=(DEFAULT_MCAST_GRP, DEFAULT_MCAST_PORT),
backbone_key=self.mock_backbone_key,
latency_ms=1000,
)
secure_timer = secure_group.secure_timer
secure_timer.timer_authenticated = True
raw_test_cemi = CEMIFrame(
code=CEMIMessageCode.L_DATA_IND,
data=CEMILData.init_from_telegram(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=apci.GroupValueRead(),
)
),
).to_knx()
with pytest.raises(IPSecureError):
secure_group.send(
KNXIPFrame.init_from_body(RoutingIndication(raw_cemi=raw_test_cemi))
)
async def test_receive_plain_frames(
self,
mock_super_send: Mock,
mock_super_connect: Mock,
) -> None:
"""Test class for KNXnet/IP secure routing."""
frame_received_mock = Mock()
secure_group = SecureGroup(
local_addr=self.mock_addr,
remote_addr=(DEFAULT_MCAST_GRP, DEFAULT_MCAST_PORT),
backbone_key=self.mock_backbone_key,
latency_ms=1000,
)
secure_group.register_callback(frame_received_mock)
plain_routing_indication = bytes.fromhex("0610 0530 0010 2900b06010fa10ff0080")
secure_group.data_received_callback(
plain_routing_indication, ("192.168.1.2", 3671)
)
frame_received_mock.assert_not_called()
plain_search_response = bytes.fromhex(
"0610020c006608010a0100280e57360102001000000000082d40834de000170c"
"000ab3274a3247697261204b4e582f49502d526f757465720000000000000000"
"000000000e02020203020402050207010901140700dc10f1fffe10f2ffff10f3"
"ffff10f4ffff"
)
secure_group.data_received_callback(
plain_search_response, ("192.168.1.2", 3671)
)
frame_received_mock.assert_called_once()
|
