Passed
Pull Request — master (#209)
by
unknown
02:10
created

PublishRequestData.__init__()   A

Complexity

Conditions 1

Size

Total Lines 4
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 4
nop 3
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
import time
2
import logging
3
from typing import Deque, Optional
4
from collections import deque
5
6
from asyncua import ua
7
from ..ua.ua_binary import nodeid_from_binary, struct_from_binary, struct_to_binary, uatcp_to_binary
8
from .internal_server import InternalServer, InternalSession
9
from ..common.connection import SecureConnection
10
from ..common.utils import ServiceError
11
12
_logger = logging.getLogger(__name__)
13
14
15
class PublishRequestData:
16
17
    def __init__(self, requesthdr=None, seqhdr=None):
18
        self.requesthdr = requesthdr
19
        self.seqhdr = seqhdr
20
        self.timestamp = time.time()
21
22
23
class UaProcessor:
24
    """
25
    Processor for OPC UA messages. Implements the OPC UA protocol for the server side.
26
    """
27
28
    def __init__(self, internal_server: InternalServer, transport):
29
        self.iserver: InternalServer = internal_server
30
        self.name = transport.get_extra_info('peername')
31
        self.sockname = transport.get_extra_info('sockname')
32
        self.session: Optional[InternalSession] = None
33
        self._transport = transport
34
        # deque for Publish Requests
35
        self._publish_requests: Deque[PublishRequestData] = deque()
36
        # used when we need to wait for PublishRequest
37
        self._publish_results: Deque[ua.PublishResult] = deque()
38
        self._connection = SecureConnection(ua.SecurityPolicy())
39
40
    def set_policies(self, policies):
41
        self._connection.set_policy_factories(policies)
42
43
    def send_response(self, requesthandle, seqhdr, response, msgtype=ua.MessageType.SecureMessage):
44
        response.ResponseHeader.RequestHandle = requesthandle
45
        data = self._connection.message_to_binary(
46
            struct_to_binary(response), message_type=msgtype, request_id=seqhdr.RequestId)
47
        self._transport.write(data)
48
49
    def open_secure_channel(self, algohdr, seqhdr, body):
50
        request = struct_from_binary(ua.OpenSecureChannelRequest, body)
51
52
        self._connection.select_policy(
53
            algohdr.SecurityPolicyURI, algohdr.SenderCertificate, request.Parameters.SecurityMode)
54
55
        channel = self._connection.open(request.Parameters, self.iserver)
56
        # send response
57
        response = ua.OpenSecureChannelResponse()
58
        response.Parameters = channel
59
        self.send_response(request.RequestHeader.RequestHandle, seqhdr, response, ua.MessageType.SecureOpen)
60
61
    async def forward_publish_response(self, result: ua.PublishResult):
62
        """
63
        Try to send a `PublishResponse` with the given `PublishResult`.
64
        """
65
        #_logger.info("forward publish response %s", result)
66
        while True:
67
            if not self._publish_requests:
68
                self._publish_results.append(result)
69
                _logger.info(
70
                    "Server wants to send publish answer but no publish request is available,"
71
                    "enqueuing notification, length of result queue is %s",
72
                    len(self._publish_results)
73
                )
74
                return
75
            # We pop left from the Publish Request deque (FIFO)
76
            requestdata = self._publish_requests.popleft()
77
            if (requestdata.requesthdr.TimeoutHint == 0 or
78
                    requestdata.requesthdr.TimeoutHint != 0 and
79
                    time.time() - requestdata.timestamp < requestdata.requesthdr.TimeoutHint / 1000):
80
                # Continue and use `requestdata` only if there was no timeout
81
                break
82
        response = ua.PublishResponse()
83
        response.Parameters = result
84
        self.send_response(requestdata.requesthdr.RequestHandle, requestdata.seqhdr, response)
85
86
    async def process(self, header, body):
87
        try:
88
            msg = self._connection.receive_from_header_and_body(header, body)
89
        except ua.uaerrors.BadUserAccessDenied as e:
90
            _logger.warning("Unauthenticated user attempted to connect")
91
            return False
92
        if isinstance(msg, ua.Message):
93
            if header.MessageType == ua.MessageType.SecureOpen:
94
                self.open_secure_channel(msg.SecurityHeader(), msg.SequenceHeader(), msg.body())
95
            elif header.MessageType == ua.MessageType.SecureClose:
96
                self._connection.close()
97
                return False
98
            elif header.MessageType == ua.MessageType.SecureMessage:
99
                return await self.process_message(msg.SequenceHeader(), msg.body())
100
        elif isinstance(msg, ua.Hello):
101
            ack = ua.Acknowledge()
102
            ack.ReceiveBufferSize = msg.ReceiveBufferSize
103
            ack.SendBufferSize = msg.SendBufferSize
104
            data = uatcp_to_binary(ua.MessageType.Acknowledge, ack)
105
            self._transport.write(data)
106
        elif isinstance(msg, ua.ErrorMessage):
107
            _logger.warning("Received an error message type")
108
        elif msg is None:
109
            pass  # msg is a ChunkType.Intermediate of an ua.MessageType.SecureMessage
110
        else:
111
            _logger.warning("Unsupported message type: %s", header.MessageType)
112
            raise ServiceError(ua.StatusCodes.BadTcpMessageTypeInvalid)
113
        return True
114
115
    async def process_message(self, seqhdr, body):
116
        """
117
        Process incoming messages.
118
        """
119
        typeid = nodeid_from_binary(body)
120
        requesthdr = struct_from_binary(ua.RequestHeader, body)
121
        _logger.debug('process_message %r %r', typeid, requesthdr)
122
        try:
123
            return await self._process_message(typeid, requesthdr, seqhdr, body)
124
        except ServiceError as e:
125
            status = ua.StatusCode(e.code)
126
            response = ua.ServiceFault()
127
            response.ResponseHeader.ServiceResult = status
128
            _logger.error("sending service fault response: %s (%s)", status.doc, status.name)
129
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
130
            return True
131
        except ua.uaerrors.BadUserAccessDenied as e:
132
            user = self._connection.security_policy.user
133
            _logger.warning(f"{user} attempted to do something they are not permitted to do")
134
            response = ua.ServiceFault()
135
            response.ResponseHeader.ServiceResult = ua.StatusCode(ua.StatusCodes.BadUserAccessDenied)
136
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
137
        except Exception:
138
            _logger.exception('Error while processing message')
139
            response = ua.ServiceFault()
140
            response.ResponseHeader.ServiceResult = ua.StatusCode(ua.StatusCodes.BadInternalError)
141
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
142
            return True
143
144
    async def _process_message(self, typeid, requesthdr, seqhdr, body):
145
        user = self._connection.security_policy.user
146
        if user is None:
147
            extra_log_str = "(user unknown)"
148
        else:
149
            extra_log_str = "(user {})".format(user.name)
150
            if self._connection.security_policy.permissions.check_validity(user, typeid, body) is False:
151
                raise ua.uaerrors.BadUserAccessDenied
152
153
        if typeid == ua.NodeId(ua.ObjectIds.CreateSessionRequest_Encoding_DefaultBinary):
154
            _logger.info("Create session request {}".format(extra_log_str))
155
            params = struct_from_binary(ua.CreateSessionParameters, body)
156
            # create the session on server
157
            self.session = self.iserver.create_session(self.name, user=user, external=True)
158
            # get a session creation result to send back
159
            sessiondata = await self.session.create_session(params, sockname=self.sockname)
160
            response = ua.CreateSessionResponse()
161
            response.Parameters = sessiondata
162
            response.Parameters.ServerCertificate = self._connection.security_policy.host_certificate
163
            if self._connection.security_policy.peer_certificate is None:
164
                data = params.ClientNonce
165
            else:
166
                data = self._connection.security_policy.peer_certificate + params.ClientNonce
167
            response.Parameters.ServerSignature.Signature = \
168
                self._connection.security_policy.asymmetric_cryptography.signature(data)
169
            response.Parameters.ServerSignature.Algorithm = self._connection.security_policy.AsymmetricSignatureURI
170
            #_logger.info("sending create session response")
171
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
172
173
        elif typeid == ua.NodeId(ua.ObjectIds.CloseSessionRequest_Encoding_DefaultBinary):
174
            _logger.info("Close session request {}".format(extra_log_str))
175
            if self.session:
176
                deletesubs = ua.ua_binary.Primitives.Boolean.unpack(body)
177
                await self.session.close_session(deletesubs)
178
            else:
179
                _logger.info("Request to close non-existing session {}".format(extra_log_str))
180
181
            response = ua.CloseSessionResponse()
182
            _logger.info("sending close session response {}".format(extra_log_str))
183
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
184
185
        elif typeid == ua.NodeId(ua.ObjectIds.ActivateSessionRequest_Encoding_DefaultBinary):
186
            _logger.info("Activate session request {}".format(extra_log_str))
187
            params = struct_from_binary(ua.ActivateSessionParameters, body)
188
            if not self.session:
189
                _logger.info("request to activate non-existing session {}".format(extra_log_str))
190
                raise ServiceError(ua.StatusCodes.BadSessionIdInvalid)
191
            if self._connection.security_policy.host_certificate is None:
192
                data = self.session.nonce
193
            else:
194
                data = self._connection.security_policy.host_certificate + self.session.nonce
195
            self._connection.security_policy.asymmetric_cryptography.verify(data, params.ClientSignature.Signature)
196
            result = self.session.activate_session(params)
197
            response = ua.ActivateSessionResponse()
198
            response.Parameters = result
199
            #_logger.info("sending read response")
200
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
201
202
        elif typeid == ua.NodeId(ua.ObjectIds.ReadRequest_Encoding_DefaultBinary):
203
            _logger.info("Read request {}".format(extra_log_str))
204
            params = struct_from_binary(ua.ReadParameters, body)
205
            results = await self.session.read(params)
206
            response = ua.ReadResponse()
207
            response.Results = results
208
            #_logger.info("sending read response")
209
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
210
211
        elif typeid == ua.NodeId(ua.ObjectIds.WriteRequest_Encoding_DefaultBinary):
212
            _logger.info("Write request {}".format(extra_log_str))
213
            params = struct_from_binary(ua.WriteParameters, body)
214
            results = await self.session.write(params)
215
            response = ua.WriteResponse()
216
            response.Results = results
217
            #_logger.info("sending write response")
218
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
219
220
        elif typeid == ua.NodeId(ua.ObjectIds.BrowseRequest_Encoding_DefaultBinary):
221
            _logger.info("Browse request {}".format(extra_log_str))
222
            params = struct_from_binary(ua.BrowseParameters, body)
223
            results = await self.session.browse(params)
224
            response = ua.BrowseResponse()
225
            response.Results = results
226
            #_logger.info("sending browse response")
227
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
228
229
        elif typeid == ua.NodeId(ua.ObjectIds.GetEndpointsRequest_Encoding_DefaultBinary):
230
            _logger.info("get endpoints request {}".format(extra_log_str))
231
            params = struct_from_binary(ua.GetEndpointsParameters, body)
232
            endpoints = await self.iserver.get_endpoints(params, sockname=self.sockname)
233
            response = ua.GetEndpointsResponse()
234
            response.Endpoints = endpoints
235
            #_logger.info("sending get endpoints response")
236
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
237
238
        elif typeid == ua.NodeId(ua.ObjectIds.FindServersRequest_Encoding_DefaultBinary):
239
            _logger.info("find servers request {}".format(extra_log_str))
240
            params = struct_from_binary(ua.FindServersParameters, body)
241
            servers = self.iserver.find_servers(params)
242
            response = ua.FindServersResponse()
243
            response.Servers = servers
244
            #_logger.info("sending find servers response")
245
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
246
247
        elif typeid == ua.NodeId(ua.ObjectIds.RegisterServerRequest_Encoding_DefaultBinary):
248
            _logger.info("register server request {}".format(extra_log_str))
249
            serv = struct_from_binary(ua.RegisteredServer, body)
250
            self.iserver.register_server(serv)
251
            response = ua.RegisterServerResponse()
252
            #_logger.info("sending register server response")
253
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
254
255
        elif typeid == ua.NodeId(ua.ObjectIds.RegisterServer2Request_Encoding_DefaultBinary):
256
            _logger.info("register server 2 request {}".format(extra_log_str))
257
            params = struct_from_binary(ua.RegisterServer2Parameters, body)
258
            results = self.iserver.register_server2(params)
259
            response = ua.RegisterServer2Response()
260
            response.ConfigurationResults = results
261
            #_logger.info("sending register server 2 response")
262
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
263
264
        elif typeid == ua.NodeId(ua.ObjectIds.TranslateBrowsePathsToNodeIdsRequest_Encoding_DefaultBinary):
265
            _logger.info("translate browsepaths to nodeids request {}".format(extra_log_str))
266
            params = struct_from_binary(ua.TranslateBrowsePathsToNodeIdsParameters, body)
267
            paths = await self.session.translate_browsepaths_to_nodeids(params.BrowsePaths)
268
            response = ua.TranslateBrowsePathsToNodeIdsResponse()
269
            response.Results = paths
270
            #_logger.info("sending translate browsepaths to nodeids response")
271
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
272
273
        elif typeid == ua.NodeId(ua.ObjectIds.AddNodesRequest_Encoding_DefaultBinary):
274
            _logger.info("add nodes request {}".format(extra_log_str))
275
            params = struct_from_binary(ua.AddNodesParameters, body)
276
            results = await self.session.add_nodes(params.NodesToAdd)
277
            response = ua.AddNodesResponse()
278
            response.Results = results
279
            #_logger.info("sending add node response")
280
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
281
282
        elif typeid == ua.NodeId(ua.ObjectIds.DeleteNodesRequest_Encoding_DefaultBinary):
283
            _logger.info("delete nodes request {}".format(extra_log_str))
284
            params = struct_from_binary(ua.DeleteNodesParameters, body)
285
            results = await self.session.delete_nodes(params)
286
            response = ua.DeleteNodesResponse()
287
            response.Results = results
288
            #_logger.info("sending delete node response")
289
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
290
291
        elif typeid == ua.NodeId(ua.ObjectIds.AddReferencesRequest_Encoding_DefaultBinary):
292
            _logger.info("add references request {}".format(extra_log_str))
293
            params = struct_from_binary(ua.AddReferencesParameters, body)
294
            results = await self.session.add_references(params.ReferencesToAdd)
295
            response = ua.AddReferencesResponse()
296
            response.Results = results
297
            #_logger.info("sending add references response")
298
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
299
300
        elif typeid == ua.NodeId(ua.ObjectIds.DeleteReferencesRequest_Encoding_DefaultBinary):
301
            _logger.info("delete references request {}".format(extra_log_str))
302
            params = struct_from_binary(ua.DeleteReferencesParameters, body)
303
            results = await self.session.delete_references(params.ReferencesToDelete)
304
            response = ua.DeleteReferencesResponse()
305
            response.Parameters.Results = results
306
            #_logger.info("sending delete references response")
307
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
308
309
        elif typeid == ua.NodeId(ua.ObjectIds.CreateSubscriptionRequest_Encoding_DefaultBinary):
310
            _logger.info("create subscription request {}".format(extra_log_str))
311
            params = struct_from_binary(ua.CreateSubscriptionParameters, body)
312
            result = await self.session.create_subscription(params, callback=self.forward_publish_response)
313
            response = ua.CreateSubscriptionResponse()
314
            response.Parameters = result
315
            #_logger.info("sending create subscription response")
316
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
317
318
        elif typeid == ua.NodeId(ua.ObjectIds.DeleteSubscriptionsRequest_Encoding_DefaultBinary):
319
            _logger.info("delete subscriptions request {}".format(extra_log_str))
320
            params = struct_from_binary(ua.DeleteSubscriptionsParameters, body)
321
            results = await self.session.delete_subscriptions(params.SubscriptionIds)
322
            response = ua.DeleteSubscriptionsResponse()
323
            response.Results = results
324
            #_logger.info("sending delete subscription response")
325
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
326
327
        elif typeid == ua.NodeId(ua.ObjectIds.CreateMonitoredItemsRequest_Encoding_DefaultBinary):
328
            _logger.info("create monitored items request {}".format(extra_log_str))
329
            params = struct_from_binary(ua.CreateMonitoredItemsParameters, body)
330
            results = await self.session.create_monitored_items(params)
331
            response = ua.CreateMonitoredItemsResponse()
332
            response.Results = results
333
            #_logger.info("sending create monitored items response")
334
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
335
336
        elif typeid == ua.NodeId(ua.ObjectIds.ModifyMonitoredItemsRequest_Encoding_DefaultBinary):
337
            _logger.info("modify monitored items request {}".format(extra_log_str))
338
            params = struct_from_binary(ua.ModifyMonitoredItemsParameters, body)
339
            results = await self.session.modify_monitored_items(params)
340
            response = ua.ModifyMonitoredItemsResponse()
341
            response.Results = results
342
            #_logger.info("sending modify monitored items response")
343
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
344
345
        elif typeid == ua.NodeId(ua.ObjectIds.DeleteMonitoredItemsRequest_Encoding_DefaultBinary):
346
            _logger.info("delete monitored items request {}".format(extra_log_str))
347
            params = struct_from_binary(ua.DeleteMonitoredItemsParameters, body)
348
            results = await self.session.delete_monitored_items(params)
349
            response = ua.DeleteMonitoredItemsResponse()
350
            response.Results = results
351
            #_logger.info("sending delete monitored items response")
352
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
353
354
        elif typeid == ua.NodeId(ua.ObjectIds.HistoryReadRequest_Encoding_DefaultBinary):
355
            _logger.info("history read request {}".format(extra_log_str))
356
            params = struct_from_binary(ua.HistoryReadParameters, body)
357
            results = await self.session.history_read(params)
358
            response = ua.HistoryReadResponse()
359
            response.Results = results
360
            #_logger.info("sending history read response")
361
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
362
363
        elif typeid == ua.NodeId(ua.ObjectIds.RegisterNodesRequest_Encoding_DefaultBinary):
364
            _logger.info("register nodes request {}".format(extra_log_str))
365
            params = struct_from_binary(ua.RegisterNodesParameters, body)
366
            _logger.info("Node registration not implemented")
367
            response = ua.RegisterNodesResponse()
368
            response.Parameters.RegisteredNodeIds = params.NodesToRegister
369
            #_logger.info("sending register nodes response")
370
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
371
372
        elif typeid == ua.NodeId(ua.ObjectIds.UnregisterNodesRequest_Encoding_DefaultBinary):
373
            _logger.info("unregister nodes request {}".format(extra_log_str))
374
            params = struct_from_binary(ua.UnregisterNodesParameters, body)
375
            response = ua.UnregisterNodesResponse()
376
            #_logger.info("sending unregister nodes response")
377
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
378
379
        elif typeid == ua.NodeId(ua.ObjectIds.PublishRequest_Encoding_DefaultBinary):
380
            _logger.debug("publish request {}".format(extra_log_str))
381
            if not self.session:
382
                return False
383
            params = struct_from_binary(ua.PublishParameters, body)
384
            data = PublishRequestData(requesthdr=requesthdr, seqhdr=seqhdr)
385
            # Store the Publish Request (will be used to send publish answers from server)
386
            self._publish_requests.append(data)
387
            # If there is an enqueued result forward it immediately
388
            while self._publish_results:
389
                result = self._publish_results.popleft()
390
                if result.SubscriptionId not in self.session.subscription_service.active_subscription_ids:
391
                    # Discard the result if the subscription is no longer active
392
                    continue
393
                await self.forward_publish_response(result)
394
                break
395
            self.session.publish(params.SubscriptionAcknowledgements)
396
            #_logger.debug("publish forward to server")
397
398
        elif typeid == ua.NodeId(ua.ObjectIds.RepublishRequest_Encoding_DefaultBinary):
399
            _logger.info("re-publish request {}".format(extra_log_str))
400
            params = struct_from_binary(ua.RepublishParameters, body)
401
            msg = self.session.republish(params)
402
            response = ua.RepublishResponse()
403
            response.NotificationMessage = msg
404
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
405
406
        elif typeid == ua.NodeId(ua.ObjectIds.CloseSecureChannelRequest_Encoding_DefaultBinary):
407
            _logger.info("close secure channel request {}".format(extra_log_str))
408
            self._connection.close()
409
            response = ua.CloseSecureChannelResponse()
410
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
411
            return False
412
413
        elif typeid == ua.NodeId(ua.ObjectIds.CallRequest_Encoding_DefaultBinary):
414
            _logger.info("call request {}".format(extra_log_str))
415
            params = struct_from_binary(ua.CallParameters, body)
416
            results = await self.session.call(params.MethodsToCall)
417
            response = ua.CallResponse()
418
            response.Results = results
419
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
420
421
        elif typeid == ua.NodeId(ua.ObjectIds.SetMonitoringModeRequest_Encoding_DefaultBinary):
422
            _logger.info("set monitoring mode request {}".format(extra_log_str))
423
            params = struct_from_binary(ua.SetMonitoringModeParameters, body)
424
            # FIXME: Implement SetMonitoringMode
425
            # For now send dummy results to keep clients happy
426
            response = ua.SetMonitoringModeResponse()
427
            results = ua.SetMonitoringModeResult()
428
            ids = params.MonitoredItemIds
429
            statuses = [ua.StatusCode(ua.StatusCodes.Good) for node_id in ids]
430
            results.Results = statuses
431
            response.Parameters = results
432
            _logger.info("sending set monitoring mode response")
433
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
434
435
        elif typeid == ua.NodeId(ua.ObjectIds.SetPublishingModeRequest_Encoding_DefaultBinary):
436
            _logger.info("set publishing mode request {}".format(extra_log_str))
437
            params = struct_from_binary(ua.SetPublishingModeParameters, body)
438
            # FIXME: Implement SetPublishingMode
439
            # For now send dummy results to keep clients happy
440
            response = ua.SetPublishingModeResponse()
441
            results = ua.SetPublishingModeResult()
442
            ids = params.SubscriptionIds
443
            statuses = [ua.StatusCode(ua.StatusCodes.Good) for node_id in ids]
444
            results.Results = statuses
445
            response.Parameters = results
446
            _logger.info("sending set publishing mode response")
447
            self.send_response(requesthdr.RequestHandle, seqhdr, response)
448
449
        else:
450
            _logger.warning("Unknown message received %s {}".format(extra_log_str), typeid)
451
            raise ServiceError(ua.StatusCodes.BadServiceUnsupported)
452
453
        return True
454
455
    async def close(self):
456
        """
457
        to be called when client has disconnected to ensure we really close
458
        everything we should
459
        """
460
        _logger.info("Cleanup client connection: %s", self.name)
461
        if self.session:
462
            await self.session.close_session(True)
463