/
uaprocessor.py
419 lines (371 loc) · 21.9 KB
/
uaprocessor.py
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
import time
import logging
from typing import Deque, Optional
from collections import deque
from asyncua import ua
from ..ua.ua_binary import nodeid_from_binary, struct_from_binary, struct_to_binary, uatcp_to_binary
from .internal_server import InternalServer, InternalSession
from ..common.connection import SecureConnection
from ..common.utils import ServiceError
_logger = logging.getLogger(__name__)
class PublishRequestData:
def __init__(self, requesthdr=None, algohdr=None, seqhdr=None):
self.requesthdr = requesthdr
self.algohdr = algohdr
self.seqhdr = seqhdr
self.timestamp = time.time()
class UaProcessor:
"""
Processor for OPC UA messages. Implements the OPC UA protocol for the server side.
"""
def __init__(self, internal_server: InternalServer, transport):
self.iserver: InternalServer = internal_server
self.name = transport.get_extra_info('peername')
self.sockname = transport.get_extra_info('sockname')
self.session: Optional[InternalSession] = None
self._transport = transport
# deque for Publish Requests
self._publish_requests: Deque[PublishRequestData] = deque()
# used when we need to wait for PublishRequest
self._publish_results: Deque[ua.PublishResult] = deque()
self._connection = SecureConnection(ua.SecurityPolicy())
def set_policies(self, policies):
self._connection.set_policy_factories(policies)
def send_response(self, requesthandle, algohdr, seqhdr, response, msgtype=ua.MessageType.SecureMessage):
response.ResponseHeader.RequestHandle = requesthandle
data = self._connection.message_to_binary(
struct_to_binary(response), message_type=msgtype, request_id=seqhdr.RequestId, algohdr=algohdr
)
self._transport.write(data)
def open_secure_channel(self, algohdr, seqhdr, body):
request = struct_from_binary(ua.OpenSecureChannelRequest, body)
self._connection.select_policy(
algohdr.SecurityPolicyURI, algohdr.SenderCertificate, request.Parameters.SecurityMode)
channel = self._connection.open(request.Parameters, self.iserver)
# send response
response = ua.OpenSecureChannelResponse()
response.Parameters = channel
self.send_response(request.RequestHeader.RequestHandle, None, seqhdr, response, ua.MessageType.SecureOpen)
def forward_publish_response(self, result: ua.PublishResult):
"""
Try to send a `PublishResponse` with the given `PublishResult`.
"""
_logger.info("forward publish response %s", result)
while True:
if not len(self._publish_requests):
self._publish_results.append(result)
_logger.info(
"Server wants to send publish answer but no publish request is available,"
"enqueuing notification, length of result queue is %s",
len(self._publish_results)
)
return
# We pop left from the Publish Request deque (FIFO)
requestdata = self._publish_requests.popleft()
if (requestdata.requesthdr.TimeoutHint == 0 or
requestdata.requesthdr.TimeoutHint != 0 and
time.time() - requestdata.timestamp < requestdata.requesthdr.TimeoutHint / 1000):
# Continue and use `requestdata` only if there was no timeout
break
response = ua.PublishResponse()
response.Parameters = result
self.send_response(requestdata.requesthdr.RequestHandle, requestdata.algohdr, requestdata.seqhdr, response)
async def process(self, header, body):
msg = self._connection.receive_from_header_and_body(header, body)
if isinstance(msg, ua.Message):
if header.MessageType == ua.MessageType.SecureOpen:
self.open_secure_channel(msg.SecurityHeader(), msg.SequenceHeader(), msg.body())
elif header.MessageType == ua.MessageType.SecureClose:
self._connection.close()
return False
elif header.MessageType == ua.MessageType.SecureMessage:
return await self.process_message(msg.SecurityHeader(), msg.SequenceHeader(), msg.body())
elif isinstance(msg, ua.Hello):
ack = ua.Acknowledge()
ack.ReceiveBufferSize = msg.ReceiveBufferSize
ack.SendBufferSize = msg.SendBufferSize
data = uatcp_to_binary(ua.MessageType.Acknowledge, ack)
self._transport.write(data)
elif isinstance(msg, ua.ErrorMessage):
_logger.warning("Received an error message type")
elif msg is None:
pass # msg is a ChunkType.Intermediate of an ua.MessageType.SecureMessage
else:
_logger.warning("Unsupported message type: %s", header.MessageType)
raise ServiceError(ua.StatusCodes.BadTcpMessageTypeInvalid)
return True
async def process_message(self, algohdr, seqhdr, body):
"""
Process incoming messages.
"""
typeid = nodeid_from_binary(body)
requesthdr = struct_from_binary(ua.RequestHeader, body)
_logger.debug('process_message %r %r', typeid, requesthdr)
try:
return await self._process_message(typeid, requesthdr, algohdr, seqhdr, body)
except ServiceError as e:
status = ua.StatusCode(e.code)
response = ua.ServiceFault()
response.ResponseHeader.ServiceResult = status
_logger.error("sending service fault response: %s (%s)", status.doc, status.name)
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
return True
except Exception:
_logger.exception('Error while processing message')
response = ua.ServiceFault()
response.ResponseHeader.ServiceResult = ua.StatusCode(ua.StatusCodes.BadInternalError)
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
return True
async def _process_message(self, typeid, requesthdr, algohdr, seqhdr, body):
if typeid == ua.NodeId(ua.ObjectIds.CreateSessionRequest_Encoding_DefaultBinary):
_logger.info("Create session request")
params = struct_from_binary(ua.CreateSessionParameters, body)
# create the session on server
self.session = self.iserver.create_session(self.name, external=True)
# get a session creation result to send back
sessiondata = await self.session.create_session(params, sockname=self.sockname)
response = ua.CreateSessionResponse()
response.Parameters = sessiondata
response.Parameters.ServerCertificate = self._connection.security_policy.client_certificate
if self._connection.security_policy.server_certificate is None:
data = params.ClientNonce
else:
data = self._connection.security_policy.server_certificate + params.ClientNonce
response.Parameters.ServerSignature.Signature = \
self._connection.security_policy.asymmetric_cryptography.signature(data)
response.Parameters.ServerSignature.Algorithm = self._connection.security_policy.AsymmetricSignatureURI
_logger.info("sending create session response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.CloseSessionRequest_Encoding_DefaultBinary):
_logger.info("Close session request")
if self.session:
deletesubs = ua.ua_binary.Primitives.Boolean.unpack(body)
await self.session.close_session(deletesubs)
else:
_logger.info("Request to close non-existing session")
response = ua.CloseSessionResponse()
_logger.info("sending close session response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.ActivateSessionRequest_Encoding_DefaultBinary):
_logger.info("Activate session request")
params = struct_from_binary(ua.ActivateSessionParameters, body)
if not self.session:
_logger.info("request to activate non-existing session")
raise ServiceError(ua.StatusCodes.BadSessionIdInvalid)
if self._connection.security_policy.client_certificate is None:
data = self.session.nonce
else:
data = self._connection.security_policy.client_certificate + self.session.nonce
self._connection.security_policy.asymmetric_cryptography.verify(data, params.ClientSignature.Signature)
result = self.session.activate_session(params)
response = ua.ActivateSessionResponse()
response.Parameters = result
_logger.info("sending read response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.ReadRequest_Encoding_DefaultBinary):
_logger.info("Read request")
params = struct_from_binary(ua.ReadParameters, body)
results = await self.session.read(params)
response = ua.ReadResponse()
response.Results = results
_logger.info("sending read response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.WriteRequest_Encoding_DefaultBinary):
_logger.info("Write request")
params = struct_from_binary(ua.WriteParameters, body)
results = await self.session.write(params)
response = ua.WriteResponse()
response.Results = results
_logger.info("sending write response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.BrowseRequest_Encoding_DefaultBinary):
_logger.info("Browse request")
params = struct_from_binary(ua.BrowseParameters, body)
results = await self.session.browse(params)
response = ua.BrowseResponse()
response.Results = results
_logger.info("sending browse response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.GetEndpointsRequest_Encoding_DefaultBinary):
_logger.info("get endpoints request")
params = struct_from_binary(ua.GetEndpointsParameters, body)
endpoints = await self.iserver.get_endpoints(params, sockname=self.sockname)
response = ua.GetEndpointsResponse()
response.Endpoints = endpoints
_logger.info("sending get endpoints response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.FindServersRequest_Encoding_DefaultBinary):
_logger.info("find servers request")
params = struct_from_binary(ua.FindServersParameters, body)
servers = self.iserver.find_servers(params)
response = ua.FindServersResponse()
response.Servers = servers
_logger.info("sending find servers response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.RegisterServerRequest_Encoding_DefaultBinary):
_logger.info("register server request")
serv = struct_from_binary(ua.RegisteredServer, body)
self.iserver.register_server(serv)
response = ua.RegisterServerResponse()
_logger.info("sending register server response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.RegisterServer2Request_Encoding_DefaultBinary):
_logger.info("register server 2 request")
params = struct_from_binary(ua.RegisterServer2Parameters, body)
results = self.iserver.register_server2(params)
response = ua.RegisterServer2Response()
response.ConfigurationResults = results
_logger.info("sending register server 2 response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.TranslateBrowsePathsToNodeIdsRequest_Encoding_DefaultBinary):
_logger.info("translate browsepaths to nodeids request")
params = struct_from_binary(ua.TranslateBrowsePathsToNodeIdsParameters, body)
paths = await self.session.translate_browsepaths_to_nodeids(params.BrowsePaths)
response = ua.TranslateBrowsePathsToNodeIdsResponse()
response.Results = paths
_logger.info("sending translate browsepaths to nodeids response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.AddNodesRequest_Encoding_DefaultBinary):
_logger.info("add nodes request")
params = struct_from_binary(ua.AddNodesParameters, body)
results = await self.session.add_nodes(params.NodesToAdd)
response = ua.AddNodesResponse()
response.Results = results
_logger.info("sending add node response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.DeleteNodesRequest_Encoding_DefaultBinary):
_logger.info("delete nodes request")
params = struct_from_binary(ua.DeleteNodesParameters, body)
results = await self.session.delete_nodes(params)
response = ua.DeleteNodesResponse()
response.Results = results
_logger.info("sending delete node response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.AddReferencesRequest_Encoding_DefaultBinary):
_logger.info("add references request")
params = struct_from_binary(ua.AddReferencesParameters, body)
results = await self.session.add_references(params.ReferencesToAdd)
response = ua.AddReferencesResponse()
response.Results = results
_logger.info("sending add references response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.DeleteReferencesRequest_Encoding_DefaultBinary):
_logger.info("delete references request")
params = struct_from_binary(ua.DeleteReferencesParameters, body)
results = await self.session.delete_references(params.ReferencesToDelete)
response = ua.DeleteReferencesResponse()
response.Parameters.Results = results
_logger.info("sending delete references response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.CreateSubscriptionRequest_Encoding_DefaultBinary):
_logger.info("create subscription request")
params = struct_from_binary(ua.CreateSubscriptionParameters, body)
result = await self.session.create_subscription(params, callback=self.forward_publish_response)
response = ua.CreateSubscriptionResponse()
response.Parameters = result
_logger.info("sending create subscription response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.DeleteSubscriptionsRequest_Encoding_DefaultBinary):
_logger.info("delete subscriptions request")
params = struct_from_binary(ua.DeleteSubscriptionsParameters, body)
results = await self.session.delete_subscriptions(params.SubscriptionIds)
response = ua.DeleteSubscriptionsResponse()
response.Results = results
_logger.info("sending delete subscription response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.CreateMonitoredItemsRequest_Encoding_DefaultBinary):
_logger.info("create monitored items request")
params = struct_from_binary(ua.CreateMonitoredItemsParameters, body)
results = await self.session.create_monitored_items(params)
response = ua.CreateMonitoredItemsResponse()
response.Results = results
_logger.info("sending create monitored items response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.ModifyMonitoredItemsRequest_Encoding_DefaultBinary):
_logger.info("modify monitored items request")
params = struct_from_binary(ua.ModifyMonitoredItemsParameters, body)
results = await self.session.modify_monitored_items(params)
response = ua.ModifyMonitoredItemsResponse()
response.Results = results
_logger.info("sending modify monitored items response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.DeleteMonitoredItemsRequest_Encoding_DefaultBinary):
_logger.info("delete monitored items request")
params = struct_from_binary(ua.DeleteMonitoredItemsParameters, body)
results = await self.session.delete_monitored_items(params)
response = ua.DeleteMonitoredItemsResponse()
response.Results = results
_logger.info("sending delete monitored items response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.HistoryReadRequest_Encoding_DefaultBinary):
_logger.info("history read request")
params = struct_from_binary(ua.HistoryReadParameters, body)
results = await self.session.history_read(params)
response = ua.HistoryReadResponse()
response.Results = results
_logger.info("sending history read response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.RegisterNodesRequest_Encoding_DefaultBinary):
_logger.info("register nodes request")
params = struct_from_binary(ua.RegisterNodesParameters, body)
_logger.info("Node registration not implemented")
response = ua.RegisterNodesResponse()
response.Parameters.RegisteredNodeIds = params.NodesToRegister
_logger.info("sending register nodes response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.UnregisterNodesRequest_Encoding_DefaultBinary):
_logger.info("unregister nodes request")
params = struct_from_binary(ua.UnregisterNodesParameters, body)
response = ua.UnregisterNodesResponse()
_logger.info("sending unregister nodes response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.PublishRequest_Encoding_DefaultBinary):
_logger.debug("publish request")
if not self.session:
return False
params = struct_from_binary(ua.PublishParameters, body)
data = PublishRequestData(requesthdr=requesthdr, seqhdr=seqhdr, algohdr=algohdr)
# Store the Publish Request (will be used to send publish answers from server)
self._publish_requests.append(data)
# If there is an enqueued result forward it immediately
while len(self._publish_results):
result = self._publish_results.popleft()
if result.SubscriptionId not in self.session.subscription_service.active_subscription_ids:
# Discard the result if the subscription is no longer active
continue
self.forward_publish_response(result)
break
self.session.publish(params.SubscriptionAcknowledgements)
_logger.debug("publish forward to server")
elif typeid == ua.NodeId(ua.ObjectIds.RepublishRequest_Encoding_DefaultBinary):
_logger.info("re-publish request")
params = struct_from_binary(ua.RepublishParameters, body)
msg = self.session.republish(params)
response = ua.RepublishResponse()
response.NotificationMessage = msg
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.CloseSecureChannelRequest_Encoding_DefaultBinary):
_logger.info("close secure channel request")
self._connection.close()
response = ua.CloseSecureChannelResponse()
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
return False
elif typeid == ua.NodeId(ua.ObjectIds.CallRequest_Encoding_DefaultBinary):
_logger.info("call request")
params = struct_from_binary(ua.CallParameters, body)
results = await self.session.call(params.MethodsToCall)
response = ua.CallResponse()
response.Results = results
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
else:
_logger.warning("Unknown message received %s", typeid)
raise ServiceError(ua.StatusCodes.BadServiceUnsupported)
return True
async def close(self):
"""
to be called when client has disconnected to ensure we really close
everything we should
"""
_logger.info("Cleanup client connection: %s", self.name)
if self.session:
await self.session.close_session(True)