-
-
Notifications
You must be signed in to change notification settings - Fork 266
Expand file tree
/
Copy pathasync_client.py
More file actions
886 lines (714 loc) · 32.9 KB
/
async_client.py
File metadata and controls
886 lines (714 loc) · 32.9 KB
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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
"""
Async S7CommPlus client for S7-1200/1500 PLCs.
Provides the same API as S7CommPlusClient but using asyncio for
non-blocking I/O. Uses asyncio.Lock for concurrent safety.
When a PLC does not support S7CommPlus data operations, the client
transparently falls back to the legacy S7 protocol for data block
read/write operations (using synchronous calls in an executor).
Example::
async with S7CommPlusAsyncClient() as client:
await client.connect("192.168.1.10")
data = await client.db_read(1, 0, 4)
await client.db_write(1, 0, struct.pack(">f", 23.5))
"""
import asyncio
import logging
import ssl
import struct
from typing import Any, Optional
from .protocol import (
DataType,
ElementID,
FunctionCode,
ObjectId,
Opcode,
ProtocolVersion,
READ_FUNCTION_CODES,
S7COMMPLUS_LOCAL_TSAP,
S7COMMPLUS_REMOTE_TSAP,
)
from .codec import encode_header, decode_header, encode_typed_value, encode_object_qualifier
from .vlq import encode_uint32_vlq, decode_uint32_vlq, decode_uint64_vlq
from .client import _build_read_payload, _parse_read_response, _build_write_payload, _parse_write_response
logger = logging.getLogger(__name__)
# COTP constants
_COTP_CR = 0xE0
_COTP_CC = 0xD0
_COTP_DT = 0xF0
class S7CommPlusAsyncClient:
"""Async S7CommPlus client for S7-1200/1500 PLCs.
Supports all S7CommPlus protocol versions (V1/V2/V3/TLS). The protocol
version is auto-detected from the PLC's CreateObject response during
connection setup.
Uses asyncio for all I/O operations and asyncio.Lock for
concurrent safety when shared between multiple coroutines.
When the PLC does not support S7CommPlus data operations, the client
automatically falls back to legacy S7 protocol for db_read/db_write.
"""
def __init__(self) -> None:
self._reader: Optional[asyncio.StreamReader] = None
self._writer: Optional[asyncio.StreamWriter] = None
self._session_id: int = 0
self._sequence_number: int = 0
self._protocol_version: int = 0
self._connected = False
self._lock = asyncio.Lock()
self._legacy_client: Optional[Any] = None
self._use_legacy_data: bool = False
self._host: str = ""
self._port: int = 102
self._rack: int = 0
self._slot: int = 1
# V2+ IntegrityId tracking
self._integrity_id_read: int = 0
self._integrity_id_write: int = 0
self._with_integrity_id: bool = False
# TLS state
self._tls_active: bool = False
self._oms_secret: Optional[bytes] = None
self._server_session_version: Optional[int] = None
@property
def connected(self) -> bool:
if self._use_legacy_data and self._legacy_client is not None:
return bool(self._legacy_client.connected)
return self._connected
@property
def protocol_version(self) -> int:
return self._protocol_version
@property
def session_id(self) -> int:
return self._session_id
@property
def using_legacy_fallback(self) -> bool:
"""Whether the client is using legacy S7 protocol for data operations."""
return self._use_legacy_data
@property
def tls_active(self) -> bool:
"""Whether TLS is active on the connection."""
return self._tls_active
@property
def oms_secret(self) -> Optional[bytes]:
"""OMS exporter secret from TLS session (None if TLS not active)."""
return self._oms_secret
async def connect(
self,
host: str,
port: int = 102,
rack: int = 0,
slot: int = 1,
*,
use_tls: bool = False,
tls_cert: Optional[str] = None,
tls_key: Optional[str] = None,
tls_ca: Optional[str] = None,
) -> None:
"""Connect to an S7-1200/1500 PLC.
The connection sequence:
1. COTP connection (same as legacy S7comm)
2. InitSSL handshake
3. TLS activation (if use_tls=True, required for V2)
4. CreateObject to establish S7CommPlus session
5. Enable IntegrityId tracking (V2+)
If the PLC does not support S7CommPlus data operations, a secondary
legacy S7 connection is established transparently for data access.
Args:
host: PLC IP address or hostname
port: TCP port (default 102)
rack: PLC rack number
slot: PLC slot number
use_tls: Whether to activate TLS after InitSSL.
tls_cert: Path to client TLS certificate (PEM)
tls_key: Path to client private key (PEM)
tls_ca: Path to CA certificate for PLC verification (PEM)
"""
self._host = host
self._port = port
self._rack = rack
self._slot = slot
# TCP connect
self._reader, self._writer = await asyncio.open_connection(host, port)
try:
# Step 1: COTP handshake with S7CommPlus TSAP values
await self._cotp_connect(S7COMMPLUS_LOCAL_TSAP, S7COMMPLUS_REMOTE_TSAP)
# Step 2: InitSSL handshake
await self._init_ssl()
# Step 3: TLS activation (between InitSSL and CreateObject)
if use_tls:
await self._activate_tls(tls_cert=tls_cert, tls_key=tls_key, tls_ca=tls_ca)
# Step 4: S7CommPlus session setup (CreateObject)
await self._create_session()
# Step 5: Version-specific validation (before session setup handshake)
if self._protocol_version >= ProtocolVersion.V3:
if not use_tls:
logger.warning(
"PLC reports V3 protocol but TLS is not enabled. Connection may not work without use_tls=True."
)
elif self._protocol_version == ProtocolVersion.V2:
if not self._tls_active:
from ..error import S7ConnectionError
raise S7ConnectionError("PLC reports V2 protocol but TLS is not active. V2 requires TLS. Use use_tls=True.")
# Enable IntegrityId tracking for V2+
self._with_integrity_id = True
self._integrity_id_read = 0
self._integrity_id_write = 0
logger.info("V2 IntegrityId tracking enabled")
self._connected = True
# Step 6: Session setup - echo ServerSessionVersion back to PLC
if self._server_session_version is not None:
session_setup_ok = await self._setup_session()
else:
logger.warning("PLC did not provide ServerSessionVersion - session setup incomplete")
session_setup_ok = False
logger.info(
f"Async S7CommPlus connected to {host}:{port}, "
f"version=V{self._protocol_version}, session={self._session_id}, "
f"tls={self._tls_active}"
)
# Check if S7CommPlus session setup succeeded
if not session_setup_ok:
logger.info("S7CommPlus session setup failed, falling back to legacy S7 protocol")
await self._setup_legacy_fallback()
except Exception:
await self.disconnect()
raise
async def authenticate(self, password: str, username: str = "") -> None:
"""Perform PLC password authentication (legitimation).
Must be called after connect() and before data operations on
password-protected PLCs. Requires TLS to be active (V2+).
The method auto-detects legacy vs new legitimation based on
the PLC's firmware version.
Args:
password: PLC password
username: Username for new-style auth (optional)
Raises:
S7ConnectionError: If not connected, TLS not active, or auth fails
"""
if not self._connected:
from ..error import S7ConnectionError
raise S7ConnectionError("Not connected")
if not self._tls_active or self._oms_secret is None:
from ..error import S7ConnectionError
raise S7ConnectionError("Legitimation requires TLS. Connect with use_tls=True.")
# Step 1: Get challenge from PLC
challenge = await self._get_legitimation_challenge()
logger.info(f"Received legitimation challenge ({len(challenge)} bytes)")
# Step 2: Build response (auto-detect legacy vs new)
from .legitimation import build_legacy_response, build_new_response
if username:
response_data = build_new_response(password, challenge, self._oms_secret, username)
await self._send_legitimation_new(response_data)
else:
try:
response_data = build_new_response(password, challenge, self._oms_secret, "")
await self._send_legitimation_new(response_data)
except NotImplementedError:
response_data = build_legacy_response(password, challenge)
await self._send_legitimation_legacy(response_data)
logger.info("PLC legitimation completed successfully")
async def _activate_tls(
self,
tls_cert: Optional[str] = None,
tls_key: Optional[str] = None,
tls_ca: Optional[str] = None,
) -> None:
"""Activate TLS 1.3 over the COTP connection.
Called after InitSSL and before CreateObject. Uses asyncio's
start_tls() to upgrade the existing connection to TLS.
Args:
tls_cert: Path to client TLS certificate (PEM)
tls_key: Path to client private key (PEM)
tls_ca: Path to CA certificate for PLC verification (PEM)
"""
if self._writer is None:
from ..error import S7ConnectionError
raise S7ConnectionError("Cannot activate TLS: not connected")
ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
ctx.minimum_version = ssl.TLSVersion.TLSv1_3
# TLS 1.3 ciphersuites are configured differently from TLS 1.2
if hasattr(ctx, "set_ciphersuites"):
ctx.set_ciphersuites("TLS_AES_256_GCM_SHA384:TLS_AES_128_GCM_SHA256")
# If set_ciphersuites not available, TLS 1.3 uses its mandatory defaults
if tls_cert and tls_key:
ctx.load_cert_chain(tls_cert, tls_key)
if tls_ca:
ctx.load_verify_locations(tls_ca)
else:
ctx.check_hostname = False
ctx.verify_mode = ssl.CERT_NONE
# Upgrade existing transport to TLS using asyncio start_tls
transport = self._writer.transport
loop = asyncio.get_event_loop()
new_transport = await loop.start_tls(
transport,
transport.get_protocol(),
ctx,
server_hostname=self._host,
)
# Update reader/writer to use the TLS transport
self._writer._transport = new_transport
self._tls_active = True
# Extract OMS exporter secret for legitimation key derivation
if new_transport is None:
from ..error import S7ConnectionError
raise S7ConnectionError("TLS handshake failed: no transport returned")
ssl_object = new_transport.get_extra_info("ssl_object")
if ssl_object is not None:
try:
self._oms_secret = ssl_object.export_keying_material("EXPERIMENTAL_OMS", 32, None)
logger.debug("OMS exporter secret extracted from TLS session")
except (AttributeError, ssl.SSLError) as e:
logger.warning(f"Could not extract OMS exporter secret: {e}")
self._oms_secret = None
logger.info("TLS 1.3 activated on async COTP connection")
async def _get_legitimation_challenge(self) -> bytes:
"""Request legitimation challenge from PLC.
Sends GetVarSubStreamed with address ServerSessionRequest (303).
Returns:
Challenge bytes from PLC
"""
from .protocol import LegitimationId, DataType as DT
payload = bytearray()
payload += struct.pack(">I", self._session_id)
payload += encode_uint32_vlq(1)
payload += encode_uint32_vlq(1)
payload += encode_uint32_vlq(LegitimationId.SERVER_SESSION_REQUEST)
payload += struct.pack(">I", 0)
resp_payload = await self._send_request(FunctionCode.GET_VAR_SUBSTREAMED, bytes(payload))
offset = 0
return_value, consumed = decode_uint64_vlq(resp_payload, offset)
offset += consumed
if return_value != 0:
from ..error import S7ConnectionError
raise S7ConnectionError(f"GetVarSubStreamed for challenge failed: return_value={return_value}")
if offset + 2 > len(resp_payload):
from ..error import S7ConnectionError
raise S7ConnectionError("Challenge response too short")
_flags = resp_payload[offset]
datatype = resp_payload[offset + 1]
offset += 2
if datatype == DT.BLOB:
length, consumed = decode_uint32_vlq(resp_payload, offset)
offset += consumed
return bytes(resp_payload[offset : offset + length])
else:
count, consumed = decode_uint32_vlq(resp_payload, offset)
offset += consumed
return bytes(resp_payload[offset : offset + count])
async def _send_legitimation_new(self, encrypted_response: bytes) -> None:
"""Send new-style legitimation response (AES-256-CBC encrypted)."""
from .protocol import LegitimationId, DataType as DT
payload = bytearray()
payload += struct.pack(">I", self._session_id)
payload += encode_uint32_vlq(1)
payload += encode_uint32_vlq(LegitimationId.LEGITIMATE)
payload += bytes([0x00, DT.BLOB])
payload += encode_uint32_vlq(len(encrypted_response))
payload += encrypted_response
payload += struct.pack(">I", 0)
resp_payload = await self._send_request(FunctionCode.SET_VARIABLE, bytes(payload))
if len(resp_payload) >= 1:
return_value, _ = decode_uint64_vlq(resp_payload, 0)
if return_value < 0:
from ..error import S7ConnectionError
raise S7ConnectionError(f"Legitimation rejected by PLC: return_value={return_value}")
logger.debug(f"New legitimation return_value={return_value}")
async def _send_legitimation_legacy(self, response: bytes) -> None:
"""Send legacy legitimation response (SHA-1 XOR)."""
from .protocol import LegitimationId, DataType as DT
payload = bytearray()
payload += struct.pack(">I", self._session_id)
payload += encode_uint32_vlq(1)
payload += encode_uint32_vlq(LegitimationId.SERVER_SESSION_RESPONSE)
payload += bytes([0x10, DT.USINT]) # flags=0x10 (array)
payload += encode_uint32_vlq(len(response))
payload += response
payload += struct.pack(">I", 0)
resp_payload = await self._send_request(FunctionCode.SET_VARIABLE, bytes(payload))
if len(resp_payload) >= 1:
return_value, _ = decode_uint64_vlq(resp_payload, 0)
if return_value < 0:
from ..error import S7ConnectionError
raise S7ConnectionError(f"Legacy legitimation rejected by PLC: return_value={return_value}")
logger.debug(f"Legacy legitimation return_value={return_value}")
async def _setup_legacy_fallback(self) -> None:
"""Establish a secondary legacy S7 connection for data operations."""
from ..client import Client
loop = asyncio.get_event_loop()
client = Client()
await loop.run_in_executor(None, lambda: client.connect(self._host, self._rack, self._slot, self._port))
self._legacy_client = client
self._use_legacy_data = True
logger.info(f"Legacy S7 fallback connected to {self._host}:{self._port}")
async def disconnect(self) -> None:
"""Disconnect from PLC."""
if self._legacy_client is not None:
try:
self._legacy_client.disconnect()
except Exception:
pass
self._legacy_client = None
self._use_legacy_data = False
if self._connected and self._session_id:
try:
await self._delete_session()
except Exception:
pass
self._connected = False
self._session_id = 0
self._sequence_number = 0
self._protocol_version = 0
self._with_integrity_id = False
self._integrity_id_read = 0
self._integrity_id_write = 0
self._tls_active = False
self._oms_secret = None
self._server_session_version = None
if self._writer:
try:
self._writer.close()
await self._writer.wait_closed()
except Exception:
pass
self._writer = None
self._reader = None
async def db_read(self, db_number: int, start: int, size: int) -> bytes:
"""Read raw bytes from a data block.
Args:
db_number: Data block number
start: Start byte offset
size: Number of bytes to read
Returns:
Raw bytes read from the data block
"""
if self._use_legacy_data and self._legacy_client is not None:
client = self._legacy_client
loop = asyncio.get_event_loop()
data = await loop.run_in_executor(None, lambda: client.db_read(db_number, start, size))
return bytes(data)
payload = _build_read_payload([(db_number, start, size)])
response = await self._send_request(FunctionCode.GET_MULTI_VARIABLES, payload)
results = _parse_read_response(response)
if not results:
raise RuntimeError("Read returned no data")
if results[0] is None:
raise RuntimeError("Read failed: PLC returned error for item")
return results[0]
async def db_write(self, db_number: int, start: int, data: bytes) -> None:
"""Write raw bytes to a data block.
Args:
db_number: Data block number
start: Start byte offset
data: Bytes to write
"""
if self._use_legacy_data and self._legacy_client is not None:
client = self._legacy_client
loop = asyncio.get_event_loop()
await loop.run_in_executor(None, lambda: client.db_write(db_number, start, bytearray(data)))
return
payload = _build_write_payload([(db_number, start, data)])
response = await self._send_request(FunctionCode.SET_MULTI_VARIABLES, payload)
_parse_write_response(response)
async def db_read_multi(self, items: list[tuple[int, int, int]]) -> list[bytes]:
"""Read multiple data block regions in a single request.
Args:
items: List of (db_number, start_offset, size) tuples
Returns:
List of raw bytes for each item
"""
if self._use_legacy_data and self._legacy_client is not None:
client = self._legacy_client
loop = asyncio.get_event_loop()
multi_results: list[bytes] = []
for db_number, start, size in items:
def _read(db: int = db_number, s: int = start, sz: int = size) -> bytearray:
return bytearray(client.db_read(db, s, sz))
data = await loop.run_in_executor(None, _read)
multi_results.append(bytes(data))
return multi_results
payload = _build_read_payload(items)
response = await self._send_request(FunctionCode.GET_MULTI_VARIABLES, payload)
parsed = _parse_read_response(response)
return [r if r is not None else b"" for r in parsed]
async def explore(self) -> bytes:
"""Browse the PLC object tree.
Returns:
Raw response payload
"""
return await self._send_request(FunctionCode.EXPLORE, b"")
# -- Internal methods --
async def _send_request(self, function_code: int, payload: bytes) -> bytes:
"""Send an S7CommPlus request and receive the response.
For V2+ with IntegrityId tracking, inserts IntegrityId after the
14-byte request header and strips it from the response.
"""
async with self._lock:
if not self._connected or self._writer is None or self._reader is None:
raise RuntimeError("Not connected")
seq_num = self._next_sequence_number()
request_header = struct.pack(
">BHHHHIB",
Opcode.REQUEST,
0x0000,
function_code,
0x0000,
seq_num,
self._session_id,
0x36,
)
# For V2+ with IntegrityId, insert after header
integrity_id_bytes = b""
if self._with_integrity_id and self._protocol_version >= ProtocolVersion.V2:
is_read = function_code in READ_FUNCTION_CODES
integrity_id = self._integrity_id_read if is_read else self._integrity_id_write
integrity_id_bytes = encode_uint32_vlq(integrity_id)
request = request_header + integrity_id_bytes + payload
frame = encode_header(self._protocol_version, len(request)) + request
frame += struct.pack(">BBH", 0x72, self._protocol_version, 0x0000)
await self._send_cotp_dt(frame)
# Increment appropriate IntegrityId counter
if self._with_integrity_id and self._protocol_version >= ProtocolVersion.V2:
if function_code in READ_FUNCTION_CODES:
self._integrity_id_read = (self._integrity_id_read + 1) & 0xFFFFFFFF
else:
self._integrity_id_write = (self._integrity_id_write + 1) & 0xFFFFFFFF
response_data = await self._recv_cotp_dt()
version, data_length, consumed = decode_header(response_data)
response = response_data[consumed : consumed + data_length]
if len(response) < 14:
raise RuntimeError("Response too short")
# For V2+, skip IntegrityId in response
resp_offset = 14
if self._with_integrity_id and self._protocol_version >= ProtocolVersion.V2:
if resp_offset < len(response):
_resp_iid, iid_consumed = decode_uint32_vlq(response, resp_offset)
resp_offset += iid_consumed
return response[resp_offset:]
async def _cotp_connect(self, local_tsap: int, remote_tsap: bytes) -> None:
"""Perform COTP Connection Request / Confirm handshake."""
if self._writer is None or self._reader is None:
raise RuntimeError("Not connected")
# Build COTP CR
base_pdu = struct.pack(">BBHHB", 6, _COTP_CR, 0x0000, 0x0001, 0x00)
calling_tsap = struct.pack(">BBH", 0xC1, 2, local_tsap)
called_tsap = struct.pack(">BB", 0xC2, len(remote_tsap)) + remote_tsap
pdu_size_param = struct.pack(">BBB", 0xC0, 1, 0x0A)
params = calling_tsap + called_tsap + pdu_size_param
cr_pdu = struct.pack(">B", 6 + len(params)) + base_pdu[1:] + params
# Send TPKT + CR
tpkt = struct.pack(">BBH", 3, 0, 4 + len(cr_pdu)) + cr_pdu
self._writer.write(tpkt)
await self._writer.drain()
# Receive TPKT + CC
tpkt_header = await self._reader.readexactly(4)
_, _, length = struct.unpack(">BBH", tpkt_header)
payload = await self._reader.readexactly(length - 4)
if len(payload) < 7 or payload[1] != _COTP_CC:
raise RuntimeError(f"Expected COTP CC, got {payload[1]:#04x}")
async def _init_ssl(self) -> None:
"""Send InitSSL request (required before CreateObject)."""
seq_num = self._next_sequence_number()
request = struct.pack(
">BHHHHIB",
Opcode.REQUEST,
0x0000,
FunctionCode.INIT_SSL,
0x0000,
seq_num,
0x00000000,
0x30, # Transport flags for InitSSL
)
request += struct.pack(">I", 0)
frame = encode_header(ProtocolVersion.V1, len(request)) + request
frame += struct.pack(">BBH", 0x72, ProtocolVersion.V1, 0x0000)
await self._send_cotp_dt(frame)
response_data = await self._recv_cotp_dt()
version, data_length, consumed = decode_header(response_data)
response = response_data[consumed : consumed + data_length]
if len(response) < 14:
raise RuntimeError("InitSSL response too short")
logger.debug(f"InitSSL response received, version=V{version}")
async def _create_session(self) -> None:
"""Send CreateObject to establish S7CommPlus session."""
seq_num = self._next_sequence_number()
# Build CreateObject request header
request = struct.pack(
">BHHHHIB",
Opcode.REQUEST,
0x0000,
FunctionCode.CREATE_OBJECT,
0x0000,
seq_num,
ObjectId.OBJECT_NULL_SERVER_SESSION, # SessionId = 288
0x36,
)
# RequestId: ObjectServerSessionContainer (285)
request += struct.pack(">I", ObjectId.OBJECT_SERVER_SESSION_CONTAINER)
# RequestValue: ValueUDInt(0)
request += bytes([0x00, DataType.UDINT]) + encode_uint32_vlq(0)
# Unknown padding
request += struct.pack(">I", 0)
# RequestObject: NullServerSession PObject
request += bytes([ElementID.START_OF_OBJECT])
request += struct.pack(">I", ObjectId.GET_NEW_RID_ON_SERVER)
request += encode_uint32_vlq(ObjectId.CLASS_SERVER_SESSION)
request += encode_uint32_vlq(0) # ClassFlags
request += encode_uint32_vlq(0) # AttributeId
# Attribute: ServerSessionClientRID = 0x80c3c901
request += bytes([ElementID.ATTRIBUTE])
request += encode_uint32_vlq(ObjectId.SERVER_SESSION_CLIENT_RID)
request += encode_typed_value(DataType.RID, 0x80C3C901)
# Nested: ClassSubscriptions
request += bytes([ElementID.START_OF_OBJECT])
request += struct.pack(">I", ObjectId.GET_NEW_RID_ON_SERVER)
request += encode_uint32_vlq(ObjectId.CLASS_SUBSCRIPTIONS)
request += encode_uint32_vlq(0)
request += encode_uint32_vlq(0)
request += bytes([ElementID.TERMINATING_OBJECT])
request += bytes([ElementID.TERMINATING_OBJECT])
request += struct.pack(">I", 0)
# Frame header + trailer
frame = encode_header(ProtocolVersion.V1, len(request)) + request
frame += struct.pack(">BBH", 0x72, ProtocolVersion.V1, 0x0000)
await self._send_cotp_dt(frame)
response_data = await self._recv_cotp_dt()
version, data_length, consumed = decode_header(response_data)
response = response_data[consumed : consumed + data_length]
if len(response) < 14:
raise RuntimeError("CreateObject response too short")
self._session_id = struct.unpack_from(">I", response, 9)[0]
self._protocol_version = version
# Parse ServerSessionVersion from response payload
self._parse_create_object_response(response[14:])
def _parse_create_object_response(self, payload: bytes) -> None:
"""Parse CreateObject response to extract ServerSessionVersion (attribute 306)."""
offset = 0
while offset < len(payload):
tag = payload[offset]
if tag == ElementID.ATTRIBUTE:
offset += 1
if offset >= len(payload):
break
attr_id, consumed = decode_uint32_vlq(payload, offset)
offset += consumed
if attr_id == ObjectId.SERVER_SESSION_VERSION:
if offset + 2 > len(payload):
break
_flags = payload[offset]
datatype = payload[offset + 1]
offset += 2
if datatype in (DataType.UDINT, DataType.DWORD):
value, consumed = decode_uint32_vlq(payload, offset)
offset += consumed
self._server_session_version = value
logger.info(f"ServerSessionVersion = {value}")
return
else:
# Skip attribute value
if offset + 2 > len(payload):
break
_flags = payload[offset]
_dt = payload[offset + 1]
offset += 2
# Best-effort skip: advance past common VLQ-encoded values
if offset < len(payload):
_, consumed = decode_uint32_vlq(payload, offset)
offset += consumed
elif tag == ElementID.START_OF_OBJECT:
offset += 1
if offset + 4 > len(payload):
break
offset += 4 # RelationId
_, consumed = decode_uint32_vlq(payload, offset)
offset += consumed # ClassId
_, consumed = decode_uint32_vlq(payload, offset)
offset += consumed # ClassFlags
_, consumed = decode_uint32_vlq(payload, offset)
offset += consumed # AttributeId
elif tag == ElementID.TERMINATING_OBJECT:
offset += 1
elif tag == 0x00:
offset += 1
else:
offset += 1
logger.debug("ServerSessionVersion not found in CreateObject response")
async def _setup_session(self) -> bool:
"""Echo ServerSessionVersion back to the PLC via SetMultiVariables.
Without this step, the PLC rejects all subsequent data operations
with ERROR2 (0x05A9).
Returns:
True if session setup succeeded.
"""
if self._server_session_version is None:
return False
payload = bytearray()
payload += struct.pack(">I", self._session_id)
payload += encode_uint32_vlq(1) # Item count
payload += encode_uint32_vlq(1) # Total address field count
payload += encode_uint32_vlq(ObjectId.SERVER_SESSION_VERSION)
payload += encode_uint32_vlq(1) # ItemNumber
payload += bytes([0x00, DataType.UDINT])
payload += encode_uint32_vlq(self._server_session_version)
payload += bytes([0x00]) # Fill byte
payload += encode_object_qualifier()
payload += struct.pack(">I", 0) # Trailing padding
try:
resp_payload = await self._send_request(FunctionCode.SET_MULTI_VARIABLES, bytes(payload))
if len(resp_payload) >= 1:
return_value, _ = decode_uint64_vlq(resp_payload, 0)
if return_value != 0:
logger.warning(f"SetupSession: PLC returned error {return_value}")
return False
else:
logger.info("Session setup completed successfully")
return True
return False
except Exception as e:
logger.warning(f"SetupSession failed: {e}")
return False
async def _delete_session(self) -> None:
"""Send DeleteObject to close the session."""
seq_num = self._next_sequence_number()
request = struct.pack(
">BHHHHIB",
Opcode.REQUEST,
0x0000,
FunctionCode.DELETE_OBJECT,
0x0000,
seq_num,
self._session_id,
0x36,
)
request += struct.pack(">I", 0)
frame = encode_header(self._protocol_version, len(request)) + request
frame += struct.pack(">BBH", 0x72, self._protocol_version, 0x0000)
await self._send_cotp_dt(frame)
try:
await asyncio.wait_for(self._recv_cotp_dt(), timeout=1.0)
except Exception:
pass
async def _send_cotp_dt(self, data: bytes) -> None:
"""Send data wrapped in COTP DT + TPKT."""
if self._writer is None:
raise RuntimeError("Not connected")
cotp_dt = struct.pack(">BBB", 2, _COTP_DT, 0x80) + data
tpkt = struct.pack(">BBH", 3, 0, 4 + len(cotp_dt)) + cotp_dt
self._writer.write(tpkt)
await self._writer.drain()
async def _recv_cotp_dt(self) -> bytes:
"""Receive TPKT + COTP DT and return the payload."""
if self._reader is None:
raise RuntimeError("Not connected")
tpkt_header = await self._reader.readexactly(4)
_, _, length = struct.unpack(">BBH", tpkt_header)
payload = await self._reader.readexactly(length - 4)
if len(payload) < 3 or payload[1] != _COTP_DT:
raise RuntimeError(f"Expected COTP DT, got {payload[1]:#04x}")
return payload[3:]
def _next_sequence_number(self) -> int:
seq = self._sequence_number
self._sequence_number = (self._sequence_number + 1) & 0xFFFF
return seq
async def __aenter__(self) -> "S7CommPlusAsyncClient":
return self
async def __aexit__(self, *args: Any) -> None:
await self.disconnect()