class UaProcessor(object):
def __init__(self, internal_server, socket):
self.logger = logging.getLogger(__name__)
self.iserver = internal_server
self.name = socket.get_extra_info('peername')
self.sockname = socket.get_extra_info('sockname')
self.session = None
self.socket = socket
self._socketlock = Lock()
self._datalock = RLock()
self._publishdata_queue = []
self._publish_result_queue = [
] # used when we need to wait for PublishRequest
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):
with self._socketlock:
response.ResponseHeader.RequestHandle = requesthandle
data = self._connection.message_to_binary(
struct_to_binary(response),
message_type=msgtype,
request_id=seqhdr.RequestId,
algohdr=algohdr)
self.socket.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):
self.logger.info("forward publish response %s", result)
with self._datalock:
while True:
if len(self._publishdata_queue) == 0:
self._publish_result_queue.append(result)
self.logger.info(
"Server wants to send publish answer but no publish request is available,"
"enqueing notification, length of result queue is %s",
len(self._publish_result_queue))
return
requestdata = self._publishdata_queue.pop(0)
if requestdata.requesthdr.TimeoutHint == 0 or requestdata.requesthdr.TimeoutHint != 0 and time.time(
) - requestdata.timestamp < requestdata.requesthdr.TimeoutHint / 1000:
break
response = ua.PublishResponse()
response.Parameters = result
self.send_response(requestdata.requesthdr.RequestHandle,
requestdata.algohdr, requestdata.seqhdr, response)
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 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.socket.write(data)
elif isinstance(msg, ua.ErrorMessage):
self.logger.warning("Received an error message type")
elif msg is None:
pass # msg is a ChunkType.Intermediate of an ua.MessageType.SecureMessage
else:
self.logger.warning("Unsupported message type: %s",
header.MessageType)
raise utils.ServiceError(ua.StatusCodes.BadTcpMessageTypeInvalid)
return True
def process_message(self, algohdr, seqhdr, body):
typeid = nodeid_from_binary(body)
requesthdr = struct_from_binary(ua.RequestHeader, body)
try:
return self._process_message(typeid, requesthdr, algohdr, seqhdr,
body)
except utils.ServiceError as e:
status = ua.StatusCode(e.code)
response = ua.ServiceFault()
response.ResponseHeader.ServiceResult = status
self.logger.info("sending service fault response: %s (%s)",
status.doc, status.name)
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
return True
def _process_message(self, typeid, requesthdr, algohdr, seqhdr, body):
if typeid == ua.NodeId(
ua.ObjectIds.CreateSessionRequest_Encoding_DefaultBinary):
self.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 = 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 = "http://www.w3.org/2000/09/xmldsig#rsa-sha1"
self.logger.info("sending create session response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.CloseSessionRequest_Encoding_DefaultBinary):
self.logger.info("Close session request")
deletesubs = ua.ua_binary.Primitives.Boolean.unpack(body)
self.session.close_session(deletesubs)
response = ua.CloseSessionResponse()
self.logger.info("sending close session response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.ActivateSessionRequest_Encoding_DefaultBinary):
self.logger.info("Activate session request")
params = struct_from_binary(ua.ActivateSessionParameters, body)
if not self.session:
self.logger.info("request to activate non-existing session")
raise utils.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
self.logger.info("sending read response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.ReadRequest_Encoding_DefaultBinary):
self.logger.info("Read request")
params = struct_from_binary(ua.ReadParameters, body)
results = self.session.read(params)
response = ua.ReadResponse()
response.Results = results
self.logger.info("sending read response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.WriteRequest_Encoding_DefaultBinary):
self.logger.info("Write request")
params = struct_from_binary(ua.WriteParameters, body)
results = self.session.write(params)
response = ua.WriteResponse()
response.Results = results
self.logger.info("sending write response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.BrowseRequest_Encoding_DefaultBinary):
self.logger.info("Browse request")
params = struct_from_binary(ua.BrowseParameters, body)
results = self.session.browse(params)
response = ua.BrowseResponse()
response.Results = results
self.logger.info("sending browse response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.GetEndpointsRequest_Encoding_DefaultBinary):
self.logger.info("get endpoints request")
params = struct_from_binary(ua.GetEndpointsParameters, body)
endpoints = self.iserver.get_endpoints(params,
sockname=self.sockname)
response = ua.GetEndpointsResponse()
response.Endpoints = endpoints
self.logger.info("sending get endpoints response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.FindServersRequest_Encoding_DefaultBinary):
self.logger.info("find servers request")
params = struct_from_binary(ua.FindServersParameters, body)
servers = self.iserver.find_servers(params)
response = ua.FindServersResponse()
response.Servers = servers
self.logger.info("sending find servers response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.RegisterServerRequest_Encoding_DefaultBinary):
self.logger.info("register server request")
serv = struct_from_binary(ua.RegisteredServer, body)
self.iserver.register_server(serv)
response = ua.RegisterServerResponse()
self.logger.info("sending register server response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.RegisterServer2Request_Encoding_DefaultBinary):
self.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
self.logger.info("sending register server 2 response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.
TranslateBrowsePathsToNodeIdsRequest_Encoding_DefaultBinary):
self.logger.info("translate browsepaths to nodeids request")
params = struct_from_binary(
ua.TranslateBrowsePathsToNodeIdsParameters, body)
paths = self.session.translate_browsepaths_to_nodeids(
params.BrowsePaths)
response = ua.TranslateBrowsePathsToNodeIdsResponse()
response.Results = paths
self.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):
self.logger.info("add nodes request")
params = struct_from_binary(ua.AddNodesParameters, body)
results = self.session.add_nodes(params.NodesToAdd)
response = ua.AddNodesResponse()
response.Results = results
self.logger.info("sending add node response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.DeleteNodesRequest_Encoding_DefaultBinary):
self.logger.info("delete nodes request")
params = struct_from_binary(ua.DeleteNodesParameters, body)
results = self.session.delete_nodes(params)
response = ua.DeleteNodesResponse()
response.Results = results
self.logger.info("sending delete node response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.AddReferencesRequest_Encoding_DefaultBinary):
self.logger.info("add references request")
params = struct_from_binary(ua.AddReferencesParameters, body)
results = self.session.add_references(params.ReferencesToAdd)
response = ua.AddReferencesResponse()
response.Results = results
self.logger.info("sending add references response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.DeleteReferencesRequest_Encoding_DefaultBinary):
self.logger.info("delete references request")
params = struct_from_binary(ua.DeleteReferencesParameters, body)
results = self.session.delete_references(params.ReferencesToDelete)
response = ua.DeleteReferencesResponse()
response.Parameters.Results = results
self.logger.info("sending delete references response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.CreateSubscriptionRequest_Encoding_DefaultBinary):
self.logger.info("create subscription request")
params = struct_from_binary(ua.CreateSubscriptionParameters, body)
result = self.session.create_subscription(
params, self.forward_publish_response)
response = ua.CreateSubscriptionResponse()
response.Parameters = result
self.logger.info("sending create subscription response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.DeleteSubscriptionsRequest_Encoding_DefaultBinary
):
self.logger.info("delete subscriptions request")
params = struct_from_binary(ua.DeleteSubscriptionsParameters, body)
results = self.session.delete_subscriptions(params.SubscriptionIds)
response = ua.DeleteSubscriptionsResponse()
response.Results = results
self.logger.info("sending delte subscription response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.CreateMonitoredItemsRequest_Encoding_DefaultBinary
):
self.logger.info("create monitored items request")
params = struct_from_binary(ua.CreateMonitoredItemsParameters,
body)
results = self.session.create_monitored_items(params)
response = ua.CreateMonitoredItemsResponse()
response.Results = results
self.logger.info("sending create monitored items response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.ModifyMonitoredItemsRequest_Encoding_DefaultBinary
):
self.logger.info("modify monitored items request")
params = struct_from_binary(ua.ModifyMonitoredItemsParameters,
body)
results = self.session.modify_monitored_items(params)
response = ua.ModifyMonitoredItemsResponse()
response.Results = results
self.logger.info("sending modify monitored items response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.DeleteMonitoredItemsRequest_Encoding_DefaultBinary
):
self.logger.info("delete monitored items request")
params = struct_from_binary(ua.DeleteMonitoredItemsParameters,
body)
results = self.session.delete_monitored_items(params)
response = ua.DeleteMonitoredItemsResponse()
response.Results = results
self.logger.info("sending delete monitored items response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.HistoryReadRequest_Encoding_DefaultBinary):
self.logger.info("history read request")
params = struct_from_binary(ua.HistoryReadParameters, body)
results = self.session.history_read(params)
response = ua.HistoryReadResponse()
response.Results = results
self.logger.info("sending history read response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.RegisterNodesRequest_Encoding_DefaultBinary):
self.logger.info("register nodes request")
params = struct_from_binary(ua.RegisterNodesParameters, body)
self.logger.info("Node registration not implemented")
response = ua.RegisterNodesResponse()
response.Parameters.RegisteredNodeIds = params.NodesToRegister
self.logger.info("sending register nodes response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.UnregisterNodesRequest_Encoding_DefaultBinary):
self.logger.info("unregister nodes request")
params = struct_from_binary(ua.UnregisterNodesParameters, body)
response = ua.UnregisterNodesResponse()
self.logger.info("sending unregister nodes response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
elif typeid == ua.NodeId(
ua.ObjectIds.PublishRequest_Encoding_DefaultBinary):
self.logger.info("publish request")
if not self.session:
return False
params = struct_from_binary(ua.PublishParameters, body)
data = PublishRequestData()
data.requesthdr = requesthdr
data.seqhdr = seqhdr
data.algohdr = algohdr
with self._datalock:
self._publishdata_queue.append(
data) # will be used to send publish answers from server
if self._publish_result_queue:
result = self._publish_result_queue.pop(0)
self.forward_publish_response(result)
self.session.publish(params.SubscriptionAcknowledgements)
self.logger.info("publish forward to server")
elif typeid == ua.NodeId(
ua.ObjectIds.RepublishRequest_Encoding_DefaultBinary):
self.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):
self.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):
self.logger.info("call request")
params = struct_from_binary(ua.CallParameters, body)
results = self.session.call(params.MethodsToCall)
response = ua.CallResponse()
response.Results = results
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr,
response)
else:
self.logger.warning("Unknown message received %s", typeid)
raise utils.ServiceError(ua.StatusCodes.BadNotImplemented)
return True
def close(self):
"""
to be called when client has disconnected to ensure we really close
everything we should
"""
self.logger.info("Cleanup client connection: %s", self.name)
if self.session:
self.session.close_session(True)
class UASocketClient(object):
"""
handle socket connection and send ua messages
timeout is the timeout used while waiting for an ua answer from server
"""
def __init__(self, timeout=1, security_policy=ua.SecurityPolicy()):
self.logger = logging.getLogger(__name__ + ".Socket")
self._thread = None
self._lock = Lock()
self.timeout = timeout
self._socket = None
self._do_stop = False
self.authentication_token = ua.NodeId()
self._request_id = 0
self._request_handle = 0
self._callbackmap = {}
self._connection = SecureConnection(security_policy)
def start(self):
"""
Start receiving thread.
this is called automatically in connect and
should not be necessary to call directly
"""
self._thread = Thread(target=self._run)
self._thread.start()
def _send_request(self, request, callback=None, timeout=1000, message_type=ua.MessageType.SecureMessage):
"""
send request to server, lower-level method
timeout is the timeout written in ua header
returns future
"""
with self._lock:
request.RequestHeader = self._create_request_header(timeout)
self.logger.debug("Sending: %s", request)
try:
binreq = struct_to_binary(request)
except Exception:
# reset reqeust handle if any error
# see self._create_request_header
self._request_handle -= 1
raise
self._request_id += 1
future = Future()
if callback:
future.add_done_callback(callback)
self._callbackmap[self._request_id] = future
msg = self._connection.message_to_binary(binreq, message_type=message_type, request_id=self._request_id)
self._socket.write(msg)
return future
def send_request(self, request, callback=None, timeout=1000, message_type=ua.MessageType.SecureMessage):
"""
send request to server.
timeout is the timeout written in ua header
returns response object if no callback is provided
"""
future = self._send_request(request, callback, timeout, message_type)
if not callback:
data = future.result(self.timeout)
self.check_answer(data, " in response to " + request.__class__.__name__)
return data
def check_answer(self, data, context):
data = data.copy()
typeid = nodeid_from_binary(data)
if typeid == ua.FourByteNodeId(ua.ObjectIds.ServiceFault_Encoding_DefaultBinary):
self.logger.warning("ServiceFault from server received %s", context)
hdr = struct_from_binary(ua.ResponseHeader, data)
hdr.ServiceResult.check()
return False
return True
def _run(self):
self.logger.info("Thread started")
while not self._do_stop:
try:
self._receive()
except ua.utils.SocketClosedException:
self.logger.info("Socket has closed connection")
break
except UaError:
self.logger.exception("Protocol Error")
self.logger.info("Thread ended")
def _receive(self):
msg = self._connection.receive_from_socket(self._socket)
if msg is None:
return
elif isinstance(msg, ua.Message):
self._call_callback(msg.request_id(), msg.body())
elif isinstance(msg, ua.Acknowledge):
self._call_callback(0, msg)
elif isinstance(msg, ua.ErrorMessage):
self.logger.warning("Received an error: %s", msg)
else:
raise ua.UaError("Unsupported message type: %s", msg)
def _call_callback(self, request_id, body):
with self._lock:
future = self._callbackmap.pop(request_id, None)
if future is None:
raise ua.UaError(
"No future object found for request: {0}, callbacks in list are {1}"
.format(request_id, self._callbackmap.keys())
)
future.set_result(body)
def _create_request_header(self, timeout=1000):
hdr = ua.RequestHeader()
hdr.AuthenticationToken = self.authentication_token
self._request_handle += 1
hdr.RequestHandle = self._request_handle
hdr.TimeoutHint = timeout
return hdr
def connect_socket(self, host, port):
"""
connect to server socket and start receiving thread
"""
self.logger.info("opening connection")
sock = socket.create_connection((host, port))
# nodelay ncessary to avoid packing in one frame, some servers do not like it
sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
self._socket = ua.utils.SocketWrapper(sock)
self.start()
def disconnect_socket(self):
self.logger.info("Request to close socket received")
self._do_stop = True
self._socket.socket.shutdown(socket.SHUT_RDWR)
self._socket.socket.close()
self.logger.info("Socket closed, waiting for receiver thread to terminate...")
if self._thread and self._thread.is_alive():
self._thread.join()
self.logger.info("Done closing socket: Receiving thread terminated, socket disconnected")
def send_hello(self, url, max_messagesize=0, max_chunkcount=0):
hello = ua.Hello()
hello.EndpointUrl = url
hello.MaxMessageSize = max_messagesize
hello.MaxChunkCount = max_chunkcount
future = Future()
with self._lock:
self._callbackmap[0] = future
binmsg = uatcp_to_binary(ua.MessageType.Hello, hello)
self._socket.write(binmsg)
ack = future.result(self.timeout)
return ack
def open_secure_channel(self, params):
self.logger.info("open_secure_channel")
request = ua.OpenSecureChannelRequest()
request.Parameters = params
future = self._send_request(request, message_type=ua.MessageType.SecureOpen)
# FIXME: we have a race condition here
# we can get a packet with the new token id before we reach to store it..
response = struct_from_binary(ua.OpenSecureChannelResponse, future.result(self.timeout))
response.ResponseHeader.ServiceResult.check()
self._connection.set_channel(response.Parameters)
return response.Parameters
def close_secure_channel(self):
"""
close secure channel. It seems to trigger a shutdown of socket in most servers, so be prepare to reconnect.
OPC UA specs Part 6, 7.1.4 say that Server does not send a CloseSecureChannel response and should just close
socket
"""
self.logger.info("close_secure_channel")
request = ua.CloseSecureChannelRequest()
future = self._send_request(request, message_type=ua.MessageType.SecureClose)
with self._lock:
# don't expect any more answers
future.cancel()
self._callbackmap.clear()
class UASocketClient(object):
"""
handle socket connection and send ua messages
timeout is the timeout used while waiting for an ua answer from server
"""
def __init__(self, timeout=1, security_policy=ua.SecurityPolicy()):
self.logger = logging.getLogger(__name__ + ".Socket")
self._thread = None
self._lock = Lock()
self.timeout = timeout
self._socket = None
self._do_stop = False
self.authentication_token = ua.NodeId()
self._request_id = 0
self._request_handle = 0
self._callbackmap = {}
self._connection = SecureConnection(security_policy)
def start(self):
"""
Start receiving thread.
this is called automatically in connect and
should not be necessary to call directly
"""
self._thread = Thread(target=self._run)
self._thread.start()
def _send_request(self,
request,
callback=None,
timeout=1000,
message_type=ua.MessageType.SecureMessage):
"""
send request to server, lower-level method
timeout is the timeout written in ua header
returns future
"""
with self._lock:
request.RequestHeader = self._create_request_header(timeout)
self.logger.debug("Sending: %s", request)
try:
binreq = struct_to_binary(request)
except Exception:
# reset reqeust handle if any error
# see self._create_request_header
self._request_handle -= 1
raise
self._request_id += 1
future = Future()
if callback:
future.add_done_callback(callback)
self._callbackmap[self._request_id] = future
# Change to the new security token if the connection has been renewed.
if self._connection.next_security_token.TokenId != 0:
self._connection.revolve_tokens()
msg = self._connection.message_to_binary(
binreq, message_type=message_type, request_id=self._request_id)
self._socket.write(msg)
return future
def send_request(self,
request,
callback=None,
timeout=1000,
message_type=ua.MessageType.SecureMessage):
"""
send request to server.
timeout is the timeout written in ua header
returns response object if no callback is provided
"""
future = self._send_request(request, callback, timeout, message_type)
if not callback:
data = future.result(self.timeout)
self.check_answer(data,
" in response to " + request.__class__.__name__)
return data
def check_answer(self, data, context):
data = data.copy()
typeid = nodeid_from_binary(data)
if typeid == ua.FourByteNodeId(
ua.ObjectIds.ServiceFault_Encoding_DefaultBinary):
self.logger.warning("ServiceFault from server received %s",
context)
hdr = struct_from_binary(ua.ResponseHeader, data)
hdr.ServiceResult.check()
return False
return True
def _run(self):
self.logger.info("Thread started")
while not self._do_stop:
try:
self._receive()
except ua.utils.SocketClosedException:
self.logger.info("Socket has closed connection")
self._connection.close()
break
except UaError:
self.logger.exception("Protocol Error")
self._cancel_all_callbacks()
self.logger.info("Thread ended")
def _receive(self):
msg = self._connection.receive_from_socket(self._socket)
if msg is None:
return
elif isinstance(msg, ua.Message):
self._call_callback(msg.request_id(), msg.body())
elif isinstance(msg, ua.Acknowledge):
self._call_callback(0, msg)
elif isinstance(msg, ua.ErrorMessage):
self.logger.fatal("Received an error: %s", msg)
self._call_callback(0, ua.UaStatusCodeError(msg.Error.value))
else:
raise ua.UaError("Unsupported message type: %s", msg)
def _call_callback(self, request_id, body):
with self._lock:
future = self._callbackmap.pop(request_id, None)
if future is None:
raise ua.UaError(
"No future object found for request: {0}, callbacks in list are {1}"
.format(request_id, self._callbackmap.keys()))
future.set_result(body)
def _cancel_all_callbacks(self):
for request_id, fut in self._callbackmap.items():
self.logger.info("Cancelling request {:d}".format(request_id))
fut.cancel()
self._callbackmap.clear()
def _create_request_header(self, timeout=1000):
hdr = ua.RequestHeader()
hdr.AuthenticationToken = self.authentication_token
self._request_handle += 1
hdr.RequestHandle = self._request_handle
hdr.TimeoutHint = timeout
return hdr
def connect_socket(self, host, port):
"""
connect to server socket and start receiving thread
"""
self.logger.info("opening connection")
# Create socket with timeout for initial connection
sock = socket.create_connection((host, port), timeout=self.timeout)
# set to blocking mode again
sock.settimeout(None)
# nodelay necessary to avoid packing in one frame, some servers do not like it
sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
self._socket = ua.utils.SocketWrapper(sock)
self.start()
def disconnect_socket(self):
self.logger.info("Request to close socket received")
self._do_stop = True
try:
self._socket.socket.shutdown(socket.SHUT_RDWR)
except (socket.error, OSError) as exc:
if exc.errno in (errno.ENOTCONN, errno.EBADF):
pass # Socket is not connected, so can't send FIN packet.
else:
raise
self._socket.socket.close()
self.logger.info(
"Socket closed, waiting for receiver thread to terminate...")
if self._thread and self._thread.is_alive():
self._thread.join()
self._cancel_all_callbacks()
self.logger.info(
"Done closing socket: Receiving thread terminated, socket disconnected"
)
def send_hello(self, url, max_messagesize=0, max_chunkcount=0):
hello = ua.Hello()
hello.EndpointUrl = url
hello.MaxMessageSize = max_messagesize
hello.MaxChunkCount = max_chunkcount
future = Future()
with self._lock:
self._callbackmap[0] = future
binmsg = uatcp_to_binary(ua.MessageType.Hello, hello)
self._socket.write(binmsg)
ack = future.result(self.timeout)
return ack
def open_secure_channel(self, params):
self.logger.info("open_secure_channel")
request = ua.OpenSecureChannelRequest()
request.Parameters = params
future = self._send_request(request,
message_type=ua.MessageType.SecureOpen)
response = struct_from_binary(ua.OpenSecureChannelResponse,
future.result(self.timeout))
response.ResponseHeader.ServiceResult.check()
self._connection.set_channel(response.Parameters, params.RequestType,
params.ClientNonce)
return response.Parameters
def close_secure_channel(self):
"""
close secure channel. It seems to trigger a shutdown of socket in most servers, so be prepare to reconnect.
OPC UA specs Part 6, 7.1.4 say that Server does not send a CloseSecureChannel response and should just close
socket
"""
self.logger.info("close_secure_channel")
request = ua.CloseSecureChannelRequest()
try:
future = self._send_request(
request, message_type=ua.MessageType.SecureClose)
with self._lock:
# some servers send a response here, most do not ... so we ignore
future.cancel()
except (socket.error, OSError) as exc:
if exc.errno in (errno.ENOTCONN, errno.EBADF):
# Socket is closed, so can't send CloseSecureChannelRequest.
self.logger.warning(
"close_secure_channel() failed: socket already closed")
else:
raise
def is_secure_channel_open(self):
return self._connection.is_open()
class UaProcessor(object):
def __init__(self, internal_server, socket):
self.logger = logging.getLogger(__name__)
self.iserver = internal_server
self.name = socket.get_extra_info('peername')
self.sockname = socket.get_extra_info('sockname')
self.session = None
self.socket = socket
self._socketlock = Lock()
self._datalock = RLock()
self._publishdata_queue = []
self._publish_result_queue = [] # used when we need to wait for PublishRequest
self._connection = SecureConnection(ua.SecurityPolicy())
@property
def local_discovery_service(self):
return self.iserver.local_discovery_service
def set_policies(self, policies):
self._connection.set_policy_factories(policies)
def send_response(self, requesthandle, algohdr, seqhdr, response, msgtype=ua.MessageType.SecureMessage):
with self._socketlock:
response.ResponseHeader.RequestHandle = requesthandle
data = self._connection.message_to_binary(
struct_to_binary(response), message_type=msgtype, request_id=seqhdr.RequestId, algohdr=algohdr)
self.socket.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):
self.logger.info("forward publish response %s", result)
with self._datalock:
while True:
if len(self._publishdata_queue) == 0:
self._publish_result_queue.append(result)
self.logger.info("Server wants to send publish answer but no publish request is available,"
"enqueing notification, length of result queue is %s",
len(self._publish_result_queue))
return
requestdata = self._publishdata_queue.pop(0)
if requestdata.requesthdr.TimeoutHint == 0 or requestdata.requesthdr.TimeoutHint != 0 and time.time() - requestdata.timestamp < requestdata.requesthdr.TimeoutHint / 1000:
break
response = ua.PublishResponse()
response.Parameters = result
self.send_response(requestdata.requesthdr.RequestHandle, requestdata.algohdr, requestdata.seqhdr, response)
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 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.socket.write(data)
elif isinstance(msg, ua.ErrorMessage):
self.logger.warning("Received an error message type")
elif msg is None:
pass # msg is a ChunkType.Intermediate of an ua.MessageType.SecureMessage
else:
self.logger.warning("Unsupported message type: %s", header.MessageType)
raise utils.ServiceError(ua.StatusCodes.BadTcpMessageTypeInvalid)
return True
def process_message(self, algohdr, seqhdr, body):
typeid = nodeid_from_binary(body)
requesthdr = struct_from_binary(ua.RequestHeader, body)
try:
return self._process_message(typeid, requesthdr, algohdr, seqhdr, body)
except utils.ServiceError as e:
status = ua.StatusCode(e.code)
response = ua.ServiceFault()
response.ResponseHeader.ServiceResult = status
self.logger.info("sending service fault response: %s (%s)", status.doc, status.name)
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
return True
def _process_message(self, typeid, requesthdr, algohdr, seqhdr, body):
if typeid == ua.NodeId(ua.ObjectIds.CreateSessionRequest_Encoding_DefaultBinary):
self.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 = 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 = "http://www.w3.org/2000/09/xmldsig#rsa-sha1"
self.logger.info("sending create session response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.CloseSessionRequest_Encoding_DefaultBinary):
self.logger.info("Close session request")
if self.session:
deletesubs = ua.ua_binary.Primitives.Boolean.unpack(body)
self.session.close_session(deletesubs)
else:
self.logger.info("Request to close non-existing session")
response = ua.CloseSessionResponse()
self.logger.info("sending close session response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.ActivateSessionRequest_Encoding_DefaultBinary):
self.logger.info("Activate session request")
params = struct_from_binary(ua.ActivateSessionParameters, body)
if not self.session:
self.logger.info("request to activate non-existing session")
raise utils.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
self.logger.info("sending read response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.ReadRequest_Encoding_DefaultBinary):
self.logger.info("Read request")
params = struct_from_binary(ua.ReadParameters, body)
results = self.session.read(params)
response = ua.ReadResponse()
response.Results = results
self.logger.info("sending read response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.WriteRequest_Encoding_DefaultBinary):
self.logger.info("Write request")
params = struct_from_binary(ua.WriteParameters, body)
results = self.session.write(params)
response = ua.WriteResponse()
response.Results = results
self.logger.info("sending write response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.BrowseRequest_Encoding_DefaultBinary):
self.logger.info("Browse request")
params = struct_from_binary(ua.BrowseParameters, body)
results = self.session.browse(params)
response = ua.BrowseResponse()
response.Results = results
self.logger.info("sending browse response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.GetEndpointsRequest_Encoding_DefaultBinary):
self.logger.info("get endpoints request")
params = struct_from_binary(ua.GetEndpointsParameters, body)
endpoints = self.iserver.get_endpoints(params, sockname=self.sockname)
response = ua.GetEndpointsResponse()
response.Endpoints = endpoints
self.logger.info("sending get endpoints response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.FindServersRequest_Encoding_DefaultBinary):
self.logger.info("find servers request")
params = struct_from_binary(ua.FindServersParameters, body)
servers = self.local_discovery_service.find_servers(params)
response = ua.FindServersResponse()
response.Servers = servers
self.logger.info("sending find servers response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.RegisterServerRequest_Encoding_DefaultBinary):
self.logger.info("register server request")
serv = struct_from_binary(ua.RegisteredServer, body)
self.local_discovery_service.register_server(serv)
response = ua.RegisterServerResponse()
self.logger.info("sending register server response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.RegisterServer2Request_Encoding_DefaultBinary):
self.logger.info("register server 2 request")
params = struct_from_binary(ua.RegisterServer2Parameters, body)
results = self.local_discovery_service.register_server2(params)
response = ua.RegisterServer2Response()
response.ConfigurationResults = results
self.logger.info("sending register server 2 response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.TranslateBrowsePathsToNodeIdsRequest_Encoding_DefaultBinary):
self.logger.info("translate browsepaths to nodeids request")
params = struct_from_binary(ua.TranslateBrowsePathsToNodeIdsParameters, body)
paths = self.session.translate_browsepaths_to_nodeids(params.BrowsePaths)
response = ua.TranslateBrowsePathsToNodeIdsResponse()
response.Results = paths
self.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):
self.logger.info("add nodes request")
params = struct_from_binary(ua.AddNodesParameters, body)
results = self.session.add_nodes(params.NodesToAdd)
response = ua.AddNodesResponse()
response.Results = results
self.logger.info("sending add node response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.DeleteNodesRequest_Encoding_DefaultBinary):
self.logger.info("delete nodes request")
params = struct_from_binary(ua.DeleteNodesParameters, body)
results = self.session.delete_nodes(params)
response = ua.DeleteNodesResponse()
response.Results = results
self.logger.info("sending delete node response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.AddReferencesRequest_Encoding_DefaultBinary):
self.logger.info("add references request")
params = struct_from_binary(ua.AddReferencesParameters, body)
results = self.session.add_references(params.ReferencesToAdd)
response = ua.AddReferencesResponse()
response.Results = results
self.logger.info("sending add references response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.DeleteReferencesRequest_Encoding_DefaultBinary):
self.logger.info("delete references request")
params = struct_from_binary(ua.DeleteReferencesParameters, body)
results = self.session.delete_references(params.ReferencesToDelete)
response = ua.DeleteReferencesResponse()
response.Parameters.Results = results
self.logger.info("sending delete references response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.CreateSubscriptionRequest_Encoding_DefaultBinary):
self.logger.info("create subscription request")
params = struct_from_binary(ua.CreateSubscriptionParameters, body)
result = self.session.create_subscription(params, self.forward_publish_response)
response = ua.CreateSubscriptionResponse()
response.Parameters = result
self.logger.info("sending create subscription response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.ModifySubscriptionRequest_Encoding_DefaultBinary):
self.logger.info("modify subscription request")
params = struct_from_binary(ua.ModifySubscriptionParameters, body)
result = self.session.modify_subscription(params, self.forward_publish_response)
response = ua.ModifySubscriptionResponse()
response.Parameters = result
self.logger.info("sending modify subscription response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.DeleteSubscriptionsRequest_Encoding_DefaultBinary):
self.logger.info("delete subscriptions request")
params = struct_from_binary(ua.DeleteSubscriptionsParameters, body)
results = self.session.delete_subscriptions(params.SubscriptionIds)
response = ua.DeleteSubscriptionsResponse()
response.Results = results
self.logger.info("sending delte subscription response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.CreateMonitoredItemsRequest_Encoding_DefaultBinary):
self.logger.info("create monitored items request")
params = struct_from_binary(ua.CreateMonitoredItemsParameters, body)
results = self.session.create_monitored_items(params)
response = ua.CreateMonitoredItemsResponse()
response.Results = results
self.logger.info("sending create monitored items response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.ModifyMonitoredItemsRequest_Encoding_DefaultBinary):
self.logger.info("modify monitored items request")
params = struct_from_binary(ua.ModifyMonitoredItemsParameters, body)
results = self.session.modify_monitored_items(params)
response = ua.ModifyMonitoredItemsResponse()
response.Results = results
self.logger.info("sending modify monitored items response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.DeleteMonitoredItemsRequest_Encoding_DefaultBinary):
self.logger.info("delete monitored items request")
params = struct_from_binary(ua.DeleteMonitoredItemsParameters, body)
results = self.session.delete_monitored_items(params)
response = ua.DeleteMonitoredItemsResponse()
response.Results = results
self.logger.info("sending delete monitored items response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.HistoryReadRequest_Encoding_DefaultBinary):
self.logger.info("history read request")
params = struct_from_binary(ua.HistoryReadParameters, body)
results = self.session.history_read(params)
response = ua.HistoryReadResponse()
response.Results = results
self.logger.info("sending history read response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.RegisterNodesRequest_Encoding_DefaultBinary):
self.logger.info("register nodes request")
params = struct_from_binary(ua.RegisterNodesParameters, body)
self.logger.info("Node registration not implemented")
response = ua.RegisterNodesResponse()
response.Parameters.RegisteredNodeIds = params.NodesToRegister
self.logger.info("sending register nodes response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.UnregisterNodesRequest_Encoding_DefaultBinary):
self.logger.info("unregister nodes request")
params = struct_from_binary(ua.UnregisterNodesParameters, body)
response = ua.UnregisterNodesResponse()
self.logger.info("sending unregister nodes response")
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
elif typeid == ua.NodeId(ua.ObjectIds.PublishRequest_Encoding_DefaultBinary):
self.logger.info("publish request")
if not self.session:
return False
params = struct_from_binary(ua.PublishParameters, body)
data = PublishRequestData()
data.requesthdr = requesthdr
data.seqhdr = seqhdr
data.algohdr = algohdr
with self._datalock:
self._publishdata_queue.append(data) # will be used to send publish answers from server
if self._publish_result_queue:
result = self._publish_result_queue.pop(0)
self.forward_publish_response(result)
self.session.publish(params.SubscriptionAcknowledgements)
self.logger.info("publish forward to server")
elif typeid == ua.NodeId(ua.ObjectIds.RepublishRequest_Encoding_DefaultBinary):
self.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):
self.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):
self.logger.info("call request")
params = struct_from_binary(ua.CallParameters, body)
results = self.session.call(params.MethodsToCall)
response = ua.CallResponse()
response.Results = results
self.send_response(requesthdr.RequestHandle, algohdr, seqhdr, response)
else:
self.logger.warning("Unknown message received %s", typeid)
raise utils.ServiceError(ua.StatusCodes.BadNotImplemented)
return True
def close(self):
"""
to be called when client has disconnected to ensure we really close
everything we should
"""
self.logger.info("Cleanup client connection: %s", self.name)
if self.session:
self.session.close_session(True)