-
-
Notifications
You must be signed in to change notification settings - Fork 266
Expand file tree
/
Copy pathconnection.py
More file actions
1042 lines (854 loc) · 39.7 KB
/
connection.py
File metadata and controls
1042 lines (854 loc) · 39.7 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
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
S7CommPlus connection management.
Establishes an ISO-on-TCP connection to S7-1200/1500 PLCs using the
S7CommPlus protocol, with support for all protocol versions:
- V1: Early S7-1200 (FW >= V4.0). Simple session handshake.
- V2: Adds integrity checking and session authentication.
- V3: Adds public-key-based key exchange.
- V3 + TLS: TIA Portal V17+. Standard TLS 1.3 with per-device certificates.
The wire protocol (VLQ encoding, data types, function codes, object model) is
the same across all versions -- only the session authentication layer differs.
Connection sequence (all versions)::
1. TCP connect to port 102
2. COTP Connection Request / Confirm
- Local TSAP: 0x0600
- Remote TSAP: "SIMATIC-ROOT-HMI" (16-byte ASCII string)
3. InitSSL request / response (unencrypted)
4. TLS activation (for V3/TLS PLCs)
5. S7CommPlus CreateObject request (NullServer session setup)
- SessionId = ObjectNullServerSession (288)
- Proper PObject tree with ServerSession class
6. PLC responds with CreateObject response containing:
- Protocol version (V1/V2/V3)
- Session ID
- Server session challenge (V2/V3)
Version-specific authentication after step 6::
V1: No further authentication needed
V2: Session key derivation and integrity checking
V3 (no TLS): Public-key key exchange
V3 (TLS): TLS 1.3 handshake is already done in step 4
Reference: thomas-v2/S7CommPlusDriver (C#, LGPL-3.0)
"""
import logging
import ssl
import struct
from typing import Optional, Type
from types import TracebackType
from ..connection import ISOTCPConnection
from .protocol import (
FunctionCode,
Opcode,
ProtocolVersion,
ElementID,
ObjectId,
S7COMMPLUS_LOCAL_TSAP,
S7COMMPLUS_REMOTE_TSAP,
READ_FUNCTION_CODES,
)
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 .protocol import DataType
logger = logging.getLogger(__name__)
def _element_size(datatype: int) -> int:
"""Return the fixed byte size for an array element, or 0 for variable-length."""
if datatype in (DataType.BOOL, DataType.USINT, DataType.BYTE, DataType.SINT):
return 1
elif datatype in (DataType.UINT, DataType.WORD, DataType.INT):
return 2
elif datatype in (DataType.REAL, DataType.RID):
return 4
elif datatype in (DataType.LREAL, DataType.TIMESTAMP):
return 8
else:
return 0
class S7CommPlusConnection:
"""S7CommPlus connection with multi-version support.
Wraps an ISOTCPConnection and adds:
- S7CommPlus session establishment (CreateObject)
- Protocol version detection from PLC response
- Version-appropriate authentication (V1/V2/V3/TLS)
- Frame send/receive (TLS-encrypted when using V17+ firmware)
Currently implements V1 authentication. V2/V3/TLS authentication
layers are planned for future development.
"""
def __init__(
self,
host: str,
port: int = 102,
):
self.host = host
self.port = port
self._iso_conn = ISOTCPConnection(
host=host,
port=port,
local_tsap=S7COMMPLUS_LOCAL_TSAP,
remote_tsap=S7COMMPLUS_REMOTE_TSAP,
)
self._ssl_context: Optional[ssl.SSLContext] = None
self._ssl_socket: Optional[ssl.SSLSocket] = None
self._session_id: int = 0
self._sequence_number: int = 0
self._protocol_version: int = 0 # Detected from PLC response
self._tls_active: bool = False
self._connected = False
self._server_session_version: Optional[int] = None
# V2+ IntegrityId tracking
self._integrity_id_read: int = 0
self._integrity_id_write: int = 0
self._with_integrity_id: bool = False
# TLS OMS exporter secret (for legitimation key derivation)
self._oms_secret: Optional[bytes] = None
@property
def connected(self) -> bool:
return self._connected
@property
def protocol_version(self) -> int:
"""Protocol version negotiated with the PLC."""
return self._protocol_version
@property
def session_id(self) -> int:
"""Session ID assigned by the PLC."""
return self._session_id
@property
def tls_active(self) -> bool:
"""Whether TLS encryption is active on this connection."""
return self._tls_active
@property
def integrity_id_read(self) -> int:
"""Current read IntegrityId counter (V2+)."""
return self._integrity_id_read
@property
def integrity_id_write(self) -> int:
"""Current write IntegrityId counter (V2+)."""
return self._integrity_id_write
@property
def oms_secret(self) -> Optional[bytes]:
"""OMS exporter secret from TLS session (for legitimation)."""
return self._oms_secret
def connect(
self,
timeout: float = 5.0,
use_tls: bool = False,
tls_cert: Optional[str] = None,
tls_key: Optional[str] = None,
tls_ca: Optional[str] = None,
) -> None:
"""Establish S7CommPlus connection.
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. Session setup (echo ServerSessionVersion)
6. Enable IntegrityId tracking (V2+)
Args:
timeout: Connection timeout in seconds
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)
"""
try:
# Step 1: COTP connection (same TSAP for all S7CommPlus versions)
self._iso_conn.connect(timeout)
# Step 2: InitSSL handshake (required before CreateObject)
self._init_ssl()
# Step 3: TLS activation (between InitSSL and CreateObject)
if use_tls:
self._activate_tls(tls_cert=tls_cert, tls_key=tls_key, tls_ca=tls_ca)
# Step 4: CreateObject (S7CommPlus session setup)
# CreateObject always uses V1 framing
self._create_session()
# Step 5: Session setup - echo ServerSessionVersion back to PLC
if self._server_session_version is not None:
self._setup_session()
else:
logger.warning("PLC did not provide ServerSessionVersion - session setup incomplete")
# Step 6: Version-specific post-setup
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")
# V1: No further authentication needed after CreateObject
self._connected = True
logger.info(
f"S7CommPlus connected to {self.host}:{self.port}, "
f"version=V{self._protocol_version}, session={self._session_id}, "
f"tls={self._tls_active}"
)
except Exception:
self.disconnect()
raise
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 (stored in ServerSessionVersion).
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 via GetVarSubStreamed
challenge = 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:
# New-style auth with username always uses AES-256-CBC
response_data = build_new_response(password, challenge, self._oms_secret, username)
self._send_legitimation_new(response_data)
else:
# Try new-style first, fall back to legacy SHA-1 XOR
try:
response_data = build_new_response(password, challenge, self._oms_secret, "")
self._send_legitimation_new(response_data)
except NotImplementedError:
# cryptography package not available, use legacy
response_data = build_legacy_response(password, challenge)
self._send_legitimation_legacy(response_data)
logger.info("PLC legitimation completed successfully")
def _get_legitimation_challenge(self) -> bytes:
"""Request legitimation challenge from PLC.
Sends GetVarSubStreamed with address ServerSessionRequest (303).
Returns:
Challenge bytes from PLC (typically 20 bytes)
"""
from .protocol import LegitimationId
# Build GetVarSubStreamed request
payload = bytearray()
# InObjectId = session ID
payload += struct.pack(">I", self._session_id)
# Item count = 1
payload += encode_uint32_vlq(1)
# Address field count = 1
payload += encode_uint32_vlq(1)
# Address = ServerSessionRequest (303)
payload += encode_uint32_vlq(LegitimationId.SERVER_SESSION_REQUEST)
# Trailing padding
payload += struct.pack(">I", 0)
resp_payload = self.send_request(FunctionCode.GET_VAR_SUBSTREAMED, bytes(payload))
# Parse response: return value + value list
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}")
# Value is a USIntArray (BLOB) - read flags + type + length + data
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
from .protocol import DataType
if datatype == DataType.BLOB:
length, consumed = decode_uint32_vlq(resp_payload, offset)
offset += consumed
return bytes(resp_payload[offset : offset + length])
else:
# Try reading as array of USINT
count, consumed = decode_uint32_vlq(resp_payload, offset)
offset += consumed
return bytes(resp_payload[offset : offset + count])
def _send_legitimation_new(self, encrypted_response: bytes) -> None:
"""Send new-style legitimation response (AES-256-CBC encrypted).
Uses SetVariable with address Legitimate (1846).
"""
from .protocol import LegitimationId, DataType
payload = bytearray()
# InObjectId = session ID
payload += struct.pack(">I", self._session_id)
# Address field count = 1
payload += encode_uint32_vlq(1)
# Address = Legitimate (1846)
payload += encode_uint32_vlq(LegitimationId.LEGITIMATE)
# Value: BLOB(0, encrypted_response)
payload += bytes([0x00, DataType.BLOB])
payload += encode_uint32_vlq(len(encrypted_response))
payload += encrypted_response
# Trailing padding
payload += struct.pack(">I", 0)
resp_payload = self.send_request(FunctionCode.SET_VARIABLE, bytes(payload))
# Check return value
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}")
def _send_legitimation_legacy(self, response: bytes) -> None:
"""Send legacy legitimation response (SHA-1 XOR).
Uses SetVariable with address ServerSessionResponse (304).
"""
from .protocol import LegitimationId, DataType
payload = bytearray()
# InObjectId = session ID
payload += struct.pack(">I", self._session_id)
# Address field count = 1
payload += encode_uint32_vlq(1)
# Address = ServerSessionResponse (304)
payload += encode_uint32_vlq(LegitimationId.SERVER_SESSION_RESPONSE)
# Value: array of USINT (the XOR'd response bytes)
payload += bytes([0x10, DataType.USINT]) # flags=0x10 (array)
payload += encode_uint32_vlq(len(response))
payload += response
# Trailing padding
payload += struct.pack(">I", 0)
resp_payload = self.send_request(FunctionCode.SET_VARIABLE, bytes(payload))
# Check return value
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}")
def disconnect(self) -> None:
"""Disconnect from PLC."""
if self._connected and self._session_id:
try:
self._delete_session()
except Exception:
pass
self._connected = False
self._tls_active = False
self._ssl_socket = None
self._oms_secret = None
self._session_id = 0
self._sequence_number = 0
self._protocol_version = 0
self._server_session_version = None
self._with_integrity_id = False
self._integrity_id_read = 0
self._integrity_id_write = 0
self._iso_conn.disconnect()
def send_request(self, function_code: int, payload: bytes = b"") -> bytes:
"""Send an S7CommPlus request and receive the response.
For V2+ with IntegrityId tracking enabled, the IntegrityId is
appended after the 14-byte request header (as a VLQ uint32).
Read vs write counters are selected based on the function code.
Args:
function_code: S7CommPlus function code
payload: Request payload (after the 14-byte request header)
Returns:
Response payload (after the 14-byte response header)
"""
if not self._connected:
from ..error import S7ConnectionError
raise S7ConnectionError("Not connected")
seq_num = self._next_sequence_number()
# Build request header (14 bytes)
request_header = struct.pack(
">BHHHHIB",
Opcode.REQUEST,
0x0000, # Reserved
function_code,
0x0000, # Reserved
seq_num,
self._session_id,
0x36, # Transport flags
)
# For V2+ with IntegrityId enabled, insert IntegrityId 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
if is_read:
integrity_id = self._integrity_id_read
else:
integrity_id = self._integrity_id_write
integrity_id_bytes = encode_uint32_vlq(integrity_id)
logger.debug(f" IntegrityId: {'read' if is_read else 'write'}={integrity_id}")
request = request_header + integrity_id_bytes + payload
logger.debug(f"=== SEND REQUEST === function_code=0x{function_code:04X} seq={seq_num} session=0x{self._session_id:08X}")
logger.debug(f" Request header (14 bytes): {request_header.hex(' ')}")
if integrity_id_bytes:
logger.debug(f" IntegrityId ({len(integrity_id_bytes)} bytes): {integrity_id_bytes.hex(' ')}")
logger.debug(f" Request payload ({len(payload)} bytes): {payload.hex(' ')}")
# Determine frame version: V2 data PDUs use V2, but CreateObject uses V1
frame_version = self._protocol_version
# Add S7CommPlus frame header and trailer, then send
frame = encode_header(frame_version, len(request)) + request
frame += struct.pack(">BBH", 0x72, frame_version, 0x0000)
logger.debug(f" Full frame ({len(frame)} bytes): {frame.hex(' ')}")
self._iso_conn.send_data(frame)
# Increment the appropriate IntegrityId counter after sending
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
# Receive response
response_frame = self._iso_conn.receive_data()
logger.debug(f"=== RECV RESPONSE === raw frame ({len(response_frame)} bytes): {response_frame.hex(' ')}")
# Parse frame header, use data_length to exclude trailer
version, data_length, consumed = decode_header(response_frame)
logger.debug(f" Frame header: version=V{version}, data_length={data_length}, header_size={consumed}")
response = response_frame[consumed : consumed + data_length]
logger.debug(f" Response data ({len(response)} bytes): {response.hex(' ')}")
if len(response) < 14:
from ..error import S7ConnectionError
raise S7ConnectionError("Response too short")
# Parse response header for debug
resp_opcode = response[0]
resp_func = struct.unpack_from(">H", response, 3)[0]
resp_seq = struct.unpack_from(">H", response, 7)[0]
resp_session = struct.unpack_from(">I", response, 9)[0]
resp_transport = response[13]
logger.debug(
f" Response header: opcode=0x{resp_opcode:02X} function=0x{resp_func:04X} "
f"seq={resp_seq} session=0x{resp_session:08X} transport=0x{resp_transport:02X}"
)
# For V2+ responses, skip IntegrityId in response before returning payload
resp_offset = 14
if self._with_integrity_id and self._protocol_version >= ProtocolVersion.V2:
if resp_offset < len(response):
resp_integrity_id, iid_consumed = decode_uint32_vlq(response, resp_offset)
resp_offset += iid_consumed
logger.debug(f" Response IntegrityId: {resp_integrity_id}")
resp_payload = response[resp_offset:]
logger.debug(f" Response payload ({len(resp_payload)} bytes): {resp_payload.hex(' ')}")
# Check for trailer bytes after data_length
trailer = response_frame[consumed + data_length :]
if trailer:
logger.debug(f" Trailer ({len(trailer)} bytes): {trailer.hex(' ')}")
return resp_payload
def _init_ssl(self) -> None:
"""Send InitSSL request to prepare the connection.
This is the first S7CommPlus message sent after COTP connect.
The PLC responds with an InitSSL response. For PLCs that support
TLS, the caller should then activate TLS before sending CreateObject.
For V1 PLCs without TLS, the response may indicate that TLS is
not supported, but the connection can continue without it.
Reference: thomas-v2/S7CommPlusDriver InitSslRequest
"""
seq_num = self._next_sequence_number()
# InitSSL request: header + padding
request = struct.pack(
">BHHHHIB",
Opcode.REQUEST,
0x0000, # Reserved
FunctionCode.INIT_SSL,
0x0000, # Reserved
seq_num,
0x00000000, # No session yet
0x30, # Transport flags (0x30 for InitSSL)
)
# Trailing padding
request += struct.pack(">I", 0)
# Wrap in S7CommPlus frame header + trailer
frame = encode_header(ProtocolVersion.V1, len(request)) + request
frame += struct.pack(">BBH", 0x72, ProtocolVersion.V1, 0x0000)
logger.debug(f"=== InitSSL === sending ({len(frame)} bytes): {frame.hex(' ')}")
self._iso_conn.send_data(frame)
# Receive InitSSL response
response_frame = self._iso_conn.receive_data()
logger.debug(f"=== InitSSL === received ({len(response_frame)} bytes): {response_frame.hex(' ')}")
# Parse S7CommPlus frame header
version, data_length, consumed = decode_header(response_frame)
response = response_frame[consumed:]
if len(response) < 14:
from ..error import S7ConnectionError
raise S7ConnectionError("InitSSL response too short")
logger.debug(f"InitSSL response: version=V{version}, data_length={data_length}")
logger.debug(f"InitSSL response body ({len(response)} bytes): {response.hex(' ')}")
def _create_session(self) -> None:
"""Send CreateObject request to establish an S7CommPlus session.
Builds a NullServerSession CreateObject request matching the
structure expected by S7-1200/1500 PLCs:
Reference: thomas-v2/S7CommPlusDriver CreateObjectRequest.SetNullServerSessionData()
"""
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 for initial setup
0x36, # Transport flags
)
# RequestId: ObjectServerSessionContainer (285)
request += struct.pack(">I", ObjectId.OBJECT_SERVER_SESSION_CONTAINER)
# RequestValue: ValueUDInt(0) = DatatypeFlags(0x00) + Datatype.UDInt(0x04) + VLQ(0)
request += bytes([0x00, DataType.UDINT]) + encode_uint32_vlq(0)
# Unknown padding (always 0)
request += struct.pack(">I", 0)
# RequestObject: PObject for NullServerSession
# StartOfObject
request += bytes([ElementID.START_OF_OBJECT])
# RelationId: GetNewRIDOnServer (211)
request += struct.pack(">I", ObjectId.GET_NEW_RID_ON_SERVER)
# ClassId: ClassServerSession (287), VLQ encoded
request += encode_uint32_vlq(ObjectId.CLASS_SERVER_SESSION)
# ClassFlags: 0
request += encode_uint32_vlq(0)
# AttributeId: None (0)
request += encode_uint32_vlq(0)
# Attribute: ServerSessionClientRID (300) = RID 0x80c3c901
request += bytes([ElementID.ATTRIBUTE])
request += encode_uint32_vlq(ObjectId.SERVER_SESSION_CLIENT_RID)
request += encode_typed_value(DataType.RID, 0x80C3C901)
# Nested object: 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) # ClassFlags
request += encode_uint32_vlq(0) # AttributeId
request += bytes([ElementID.TERMINATING_OBJECT])
# End outer object
request += bytes([ElementID.TERMINATING_OBJECT])
# Trailing padding
request += struct.pack(">I", 0)
# Wrap in S7CommPlus frame header + trailer
frame = encode_header(ProtocolVersion.V1, len(request)) + request
# S7CommPlus trailer (end-of-frame marker)
frame += struct.pack(">BBH", 0x72, ProtocolVersion.V1, 0x0000)
logger.debug(f"=== CreateObject === sending ({len(frame)} bytes): {frame.hex(' ')}")
self._iso_conn.send_data(frame)
# Receive response
response_frame = self._iso_conn.receive_data()
logger.debug(f"=== CreateObject === received ({len(response_frame)} bytes): {response_frame.hex(' ')}")
# Parse S7CommPlus frame header
version, data_length, consumed = decode_header(response_frame)
response = response_frame[consumed:]
logger.debug(f"CreateObject response: version=V{version}, data_length={data_length}")
logger.debug(f"CreateObject response body ({len(response)} bytes): {response.hex(' ')}")
if len(response) < 14:
from ..error import S7ConnectionError
raise S7ConnectionError("CreateObject response too short")
# Extract session ID from response header
self._session_id = struct.unpack_from(">I", response, 9)[0]
self._protocol_version = version
# Parse and log the full response header
resp_opcode = response[0]
resp_func = struct.unpack_from(">H", response, 3)[0]
resp_seq = struct.unpack_from(">H", response, 7)[0]
resp_transport = response[13]
logger.debug(
f"CreateObject response header: opcode=0x{resp_opcode:02X} function=0x{resp_func:04X} "
f"seq={resp_seq} session=0x{self._session_id:08X} transport=0x{resp_transport:02X}"
)
logger.debug(f"CreateObject response payload: {response[14:].hex(' ')}")
logger.debug(f"Session created: id=0x{self._session_id:08X} ({self._session_id}), version=V{version}")
# Parse response payload to extract ServerSessionVersion
self._parse_create_object_response(response[14:])
def _parse_create_object_response(self, payload: bytes) -> None:
"""Parse CreateObject response payload to extract ServerSessionVersion.
The response contains a PObject tree with attributes. We scan for
attribute 306 (ServerSessionVersion) which must be echoed back to
complete the session handshake.
Args:
payload: Response payload after the 14-byte response header
"""
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:
# Next bytes are the typed value: flags + datatype + VLQ value
if offset + 2 > len(payload):
break
_flags = payload[offset]
datatype = payload[offset + 1]
offset += 2
if datatype == DataType.UDINT:
value, consumed = decode_uint32_vlq(payload, offset)
offset += consumed
self._server_session_version = value
logger.info(f"ServerSessionVersion = {value}")
return
elif datatype == DataType.DWORD:
value, consumed = decode_uint32_vlq(payload, offset)
offset += consumed
self._server_session_version = value
logger.info(f"ServerSessionVersion = {value}")
return
else:
# Skip unknown type - try to continue scanning
logger.debug(f"ServerSessionVersion has unexpected type {datatype:#04x}")
else:
# Skip this attribute's value - we don't parse it, just advance
# Try to skip the typed value (flags + datatype + value)
if offset + 2 > len(payload):
break
_flags = payload[offset]
datatype = payload[offset + 1]
offset += 2
offset = self._skip_typed_value(payload, offset, datatype, _flags)
elif tag == ElementID.START_OF_OBJECT:
offset += 1
# Skip RelationId (4 bytes fixed) + ClassId (VLQ) + ClassFlags (VLQ) + AttributeId (VLQ)
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:
# Null terminator / padding
offset += 1
else:
# Unknown tag - try to skip
offset += 1
logger.debug("ServerSessionVersion not found in CreateObject response")
def _skip_typed_value(self, data: bytes, offset: int, datatype: int, flags: int) -> int:
"""Skip over a typed value in the PObject tree.
Best-effort: advances offset past common value types.
Returns new offset.
"""
is_array = bool(flags & 0x10)
if is_array:
if offset >= len(data):
return offset
count, consumed = decode_uint32_vlq(data, offset)
offset += consumed
# For fixed-size types, skip count * size
elem_size = _element_size(datatype)
if elem_size > 0:
offset += count * elem_size
else:
# Variable-length: skip each VLQ element
for _ in range(count):
if offset >= len(data):
break
_, consumed = decode_uint32_vlq(data, offset)
offset += consumed
return offset
if datatype == DataType.NULL:
return offset
elif datatype in (DataType.BOOL, DataType.USINT, DataType.BYTE, DataType.SINT):
return offset + 1
elif datatype in (DataType.UINT, DataType.WORD, DataType.INT):
return offset + 2
elif datatype in (DataType.UDINT, DataType.DWORD, DataType.AID, DataType.DINT):
_, consumed = decode_uint32_vlq(data, offset)
return offset + consumed
elif datatype in (DataType.ULINT, DataType.LWORD, DataType.LINT):
_, consumed = decode_uint64_vlq(data, offset)
return offset + consumed
elif datatype == DataType.REAL:
return offset + 4
elif datatype == DataType.LREAL:
return offset + 8
elif datatype == DataType.TIMESTAMP:
return offset + 8
elif datatype == DataType.TIMESPAN:
_, consumed = decode_uint64_vlq(data, offset) # int64 VLQ
return offset + consumed
elif datatype == DataType.RID:
return offset + 4
elif datatype in (DataType.BLOB, DataType.WSTRING):
length, consumed = decode_uint32_vlq(data, offset)
return offset + consumed + length
elif datatype == DataType.STRUCT:
count, consumed = decode_uint32_vlq(data, offset)
offset += consumed
for _ in range(count):
if offset + 2 > len(data):
break
sub_flags = data[offset]
sub_type = data[offset + 1]
offset += 2
offset = self._skip_typed_value(data, offset, sub_type, sub_flags)
return offset
else:
# Unknown type - can't skip reliably
return offset
def _setup_session(self) -> None:
"""Send SetMultiVariables to echo ServerSessionVersion back to the PLC.
This completes the session handshake by writing the ServerSessionVersion
attribute back to the session object. Without this step, the PLC rejects
all subsequent data operations with ERROR2 (0x05A9).
Reference: thomas-v2/S7CommPlusDriver SetSessionSetupData
"""
if self._server_session_version is None:
return
seq_num = self._next_sequence_number()
# Build SetMultiVariables request
request = struct.pack(
">BHHHHIB",
Opcode.REQUEST,
0x0000,
FunctionCode.SET_MULTI_VARIABLES,
0x0000,
seq_num,
self._session_id,
0x36, # Transport flags
)
payload = bytearray()
# InObjectId = session ID (tells PLC which object we're writing to)
payload += struct.pack(">I", self._session_id)
# Item count = 1
payload += encode_uint32_vlq(1)
# Total address field count = 1 (just the attribute ID)
payload += encode_uint32_vlq(1)
# Address: attribute ID = ServerSessionVersion (306) as VLQ
payload += encode_uint32_vlq(ObjectId.SERVER_SESSION_VERSION)
# Value: ItemNumber = 1 (VLQ)
payload += encode_uint32_vlq(1)
# PValue: flags=0x00, type=UDInt, VLQ-encoded value
payload += bytes([0x00, DataType.UDINT])
payload += encode_uint32_vlq(self._server_session_version)
# Fill byte
payload += bytes([0x00])
# ObjectQualifier
payload += encode_object_qualifier()
# Trailing padding
payload += struct.pack(">I", 0)
request += bytes(payload)
# Wrap in S7CommPlus frame
frame = encode_header(self._protocol_version, len(request)) + request
frame += struct.pack(">BBH", 0x72, self._protocol_version, 0x0000)
logger.debug(f"=== SetupSession === sending ({len(frame)} bytes): {frame.hex(' ')}")
self._iso_conn.send_data(frame)
# Receive response
response_frame = self._iso_conn.receive_data()
logger.debug(f"=== SetupSession === received ({len(response_frame)} bytes): {response_frame.hex(' ')}")
version, data_length, consumed = decode_header(response_frame)
response = response_frame[consumed : consumed + data_length]
if len(response) < 14:
from ..error import S7ConnectionError
raise S7ConnectionError("SetupSession response too short")
resp_func = struct.unpack_from(">H", response, 3)[0]
logger.debug(f"SetupSession response: function=0x{resp_func:04X}")
# Parse return value from payload
resp_payload = response[14:]
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}")
else:
logger.info("Session setup completed successfully")
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)
self._iso_conn.send_data(frame)
# Best-effort receive
try:
self._iso_conn.receive_data()
except Exception:
pass
def _next_sequence_number(self) -> int:
"""Get next sequence number and increment."""
seq = self._sequence_number
self._sequence_number = (self._sequence_number + 1) & 0xFFFF
return seq
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. Wraps the underlying
TCP socket with TLS and extracts the OMS exporter secret for
legitimation key derivation.
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)
"""
ctx = self._setup_ssl_context(
cert_path=tls_cert,
key_path=tls_key,
ca_path=tls_ca,
)
# Wrap the raw TCP socket used by ISOTCPConnection
raw_socket = self._iso_conn.socket
if raw_socket is None:
from ..error import S7ConnectionError
raise S7ConnectionError("Cannot activate TLS: no TCP socket")
self._ssl_socket = ctx.wrap_socket(raw_socket, server_hostname=self.host)
# Replace the socket in ISOTCPConnection so all subsequent
# send_data/receive_data calls go through TLS
self._iso_conn.socket = self._ssl_socket
self._tls_active = True
# Extract OMS exporter secret for legitimation key derivation
try:
self._oms_secret = self._ssl_socket.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 COTP connection")
def _setup_ssl_context(
self,
cert_path: Optional[str] = None,