asyncua.common.connection.SecureConnection.start_renewal() - Code Metrics - Inspection of "fix a potential race condition" - FreeOpcUa/opcua-asyncio - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#317)

by Olivier

created 2020-10-20 11:20 UTC

SecureConnection.start_renewal() A

↳ Parent: asyncua.common.connection

Complexity

Conditions

Size

Total Lines	2
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nop	1
dl	0
loc	2
rs	10
c	0
b	0
f	0

import hashlib
from datetime import datetime, timedelta
import logging
import copy

from asyncua import ua
from ..ua.ua_binary import struct_from_binary, struct_to_binary, header_from_binary, header_to_binary

logger = logging.getLogger('asyncua.uaprotocol')


class MessageChunk(ua.FrozenClass):
    """
    Message Chunk, as described in OPC UA specs Part 6, 6.7.2.
    """
    def __init__(self, security_policy, body=b'', msg_type=ua.MessageType.SecureMessage,
                 chunk_type=ua.ChunkType.Single):
        self.MessageHeader = ua.Header(msg_type, chunk_type)
        if msg_type in (ua.MessageType.SecureMessage, ua.MessageType.SecureClose):
            self.SecurityHeader = ua.SymmetricAlgorithmHeader()
        elif msg_type == ua.MessageType.SecureOpen:
            self.SecurityHeader = ua.AsymmetricAlgorithmHeader()
        else:
            raise ua.UaError(f"Unsupported message type: {msg_type}")
        self.SequenceHeader = ua.SequenceHeader()
        self.Body = body
        self.security_policy = security_policy

    @staticmethod
    def from_binary(security_policy, data):
        h = header_from_binary(data)
        return MessageChunk.from_header_and_body(security_policy, h, data)

    @staticmethod
    def from_header_and_body(security_policy, header, buf):
        if not len(buf) >= header.body_size:
            raise ValueError('Full body expected here')
        data = buf.copy(header.body_size)
        buf.skip(header.body_size)
        if header.MessageType in (ua.MessageType.SecureMessage, ua.MessageType.SecureClose):
            security_header = struct_from_binary(ua.SymmetricAlgorithmHeader, data)
            crypto = security_policy.symmetric_cryptography
        elif header.MessageType == ua.MessageType.SecureOpen:
            security_header = struct_from_binary(ua.AsymmetricAlgorithmHeader, data)
            crypto = security_policy.asymmetric_cryptography
        else:
            raise ua.UaError(f"Unsupported message type: {header.MessageType}")
        obj = MessageChunk(crypto)
        obj.MessageHeader = header
        obj.SecurityHeader = security_header
        decrypted = crypto.decrypt(data.read(len(data)))
        signature_size = crypto.vsignature_size()
        if signature_size > 0:
            signature = decrypted[-signature_size:]
            decrypted = decrypted[:-signature_size]
            crypto.verify(header_to_binary(obj.MessageHeader) + struct_to_binary(obj.SecurityHeader) + decrypted,
                          signature)
        data = ua.utils.Buffer(crypto.remove_padding(decrypted))
        obj.SequenceHeader = struct_from_binary(ua.SequenceHeader, data)
        obj.Body = data.read(len(data))
        return obj

    def encrypted_size(self, plain_size):
        size = plain_size + self.security_policy.signature_size()
        pbs = self.security_policy.plain_block_size()
        if size % pbs != 0:
            raise ua.UaError("Encryption error")
        return size // pbs * self.security_policy.encrypted_block_size()

    def to_binary(self):
        security = struct_to_binary(self.SecurityHeader)
        encrypted_part = struct_to_binary(self.SequenceHeader) + self.Body
        encrypted_part += self.security_policy.padding(len(encrypted_part))
        self.MessageHeader.body_size = len(security) + self.encrypted_size(len(encrypted_part))
        header = header_to_binary(self.MessageHeader)
        encrypted_part += self.security_policy.signature(header + security + encrypted_part)
        return header + security + self.security_policy.encrypt(encrypted_part)

    @staticmethod
    def max_body_size(crypto, max_chunk_size):
        max_encrypted_size = max_chunk_size - ua.Header.max_size() - ua.SymmetricAlgorithmHeader.max_size()
        max_plain_size = (max_encrypted_size // crypto.encrypted_block_size()) * crypto.plain_block_size()
        return max_plain_size - ua.SequenceHeader.max_size() - crypto.signature_size() - crypto.min_padding_size()

    @staticmethod
    def message_to_chunks(security_policy, body, max_chunk_size, message_type=ua.MessageType.SecureMessage,
                          channel_id=1, request_id=1, token_id=1):
        """
        Pack message body (as binary string) into one or more chunks.
        Size of each chunk will not exceed max_chunk_size.
        Returns a list of MessageChunks. SequenceNumber is not initialized here,
        it must be set by Secure Channel driver.
        """
        if message_type == ua.MessageType.SecureOpen:
            # SecureOpen message must be in a single chunk (specs, Part 6, 6.7.2)
            chunk = MessageChunk(security_policy.asymmetric_cryptography, body, message_type, ua.ChunkType.Single)
            chunk.SecurityHeader.SecurityPolicyURI = security_policy.URI
            if security_policy.host_certificate:
                chunk.SecurityHeader.SenderCertificate = security_policy.host_certificate
            if security_policy.peer_certificate:
                chunk.SecurityHeader.ReceiverCertificateThumbPrint =\
                    hashlib.sha1(security_policy.peer_certificate).digest()
            chunk.MessageHeader.ChannelId = channel_id
            chunk.SequenceHeader.RequestId = request_id
            return [chunk]

        crypto = security_policy.symmetric_cryptography
        max_size = MessageChunk.max_body_size(crypto, max_chunk_size)

        chunks = []
        for i in range(0, len(body), max_size):
            part = body[i:i + max_size]
            if i + max_size >= len(body):
                chunk_type = ua.ChunkType.Single
            else:
                chunk_type = ua.ChunkType.Intermediate
            chunk = MessageChunk(crypto, part, message_type, chunk_type)
            chunk.SecurityHeader.TokenId = token_id
            chunk.MessageHeader.ChannelId = channel_id
            chunk.SequenceHeader.RequestId = request_id
            chunks.append(chunk)
        return chunks

    def __str__(self):
        return f"{self.__class__.__name__}({self.MessageHeader}, {self.SequenceHeader}," \
               f" {self.SecurityHeader}, {len(self.Body)} bytes)"

    __repr__ = __str__


class SecureConnection:
    """
    Common logic for client and server
    """
    def __init__(self, security_policy):
        self._sequence_number = 0
        self._peer_sequence_number = None
        self._incoming_parts = []
        self.security_policy = security_policy
        self._policies = []
        self._open = False
        self.security_token = ua.ChannelSecurityToken()
        self.next_security_token = ua.ChannelSecurityToken()
        self.prev_security_token = ua.ChannelSecurityToken()
        self.local_nonce = 0
        self.remote_nonce = 0
        self._allow_prev_token = False
        self._max_chunk_size = 65536
        self._renewal_started = False

    def start_renewal(self):
        self._renewal_started = True

    def set_channel(self, params, request_type, client_nonce):
        """
        Called on client side when getting secure channel data from server.
        """
        self._renewal_started = False
        if request_type == ua.SecurityTokenRequestType.Issue:
            self.security_token = params.SecurityToken
            self.local_nonce = client_nonce
            self.remote_nonce = params.ServerNonce
            self.security_policy.make_local_symmetric_key(self.remote_nonce, self.local_nonce)
            self.security_policy.make_remote_symmetric_key(self.local_nonce, self.remote_nonce)
            self._open = True
        else:
            self.next_security_token = params.SecurityToken
            self.local_nonce = client_nonce
            self.remote_nonce = params.ServerNonce

        self._allow_prev_token = True

    def open(self, params, server):
        """
        Called on server side to open secure channel.
        """

        self.local_nonce = ua.utils.create_nonce(self.security_policy.symmetric_key_size)
        self.remote_nonce = params.ClientNonce
        response = ua.OpenSecureChannelResult()
        response.ServerNonce = self.local_nonce

        if not self._open or params.RequestType == ua.SecurityTokenRequestType.Issue:
            self._open = True
            self.security_token.TokenId = 13  # random value
            self.security_token.ChannelId = server.get_new_channel_id()
            self.security_token.RevisedLifetime = params.RequestedLifetime
            self.security_token.CreatedAt = datetime.utcnow()

            response.SecurityToken = self.security_token

            self.security_policy.make_local_symmetric_key(self.remote_nonce, self.local_nonce)
            self.security_policy.make_remote_symmetric_key(self.local_nonce, self.remote_nonce)
        else:
            self.next_security_token = copy.deepcopy(self.security_token)
            self.next_security_token.TokenId += 1
            self.next_security_token.RevisedLifetime = params.RequestedLifetime
            self.next_security_token.CreatedAt = datetime.utcnow()

            response.SecurityToken = self.next_security_token

        return response

    def close(self):
        self._open = False

    def is_open(self):
        return self._open

    def set_policy_factories(self, policies):
        """
        Set a list of available security policies.
        Use this in servers with multiple endpoints with different security.
        """
        self._policies = policies

    @staticmethod
    def _policy_matches(policy, uri, mode=None):
        return policy.URI == uri and (mode is None or policy.Mode == mode)

    def select_policy(self, uri, peer_certificate, mode=None):
        for policy in self._policies:
            if policy.matches(uri, mode):
                self.security_policy = policy.create(peer_certificate)
                return
        if self.security_policy.URI != uri or (mode is not None and self.security_policy.Mode != mode):
            raise ua.UaError(f"No matching policy: {uri}, {mode}")

    def revolve_tokens(self):
        """
        Revolve security tokens of the security channel. Start using the
        next security token negotiated during the renewal of the channel and
        remember the previous token until the other communication party
        """
        self.prev_security_token = self.security_token
        self.security_token = self.next_security_token
        self.next_security_token = ua.ChannelSecurityToken()
        self.security_policy.make_local_symmetric_key(self.remote_nonce, self.local_nonce)
        self.security_policy.make_remote_symmetric_key(self.local_nonce, self.remote_nonce)

    def message_to_binary(self, message, message_type=ua.MessageType.SecureMessage, request_id=0):
        """
        Convert OPC UA secure message to binary.
        The only supported types are SecureOpen, SecureMessage, SecureClose.
        If message_type is SecureMessage, the AlgorithmHeader should be passed as arg.
        """
        chunks = MessageChunk.message_to_chunks(self.security_policy, message, self._max_chunk_size,
                                                message_type=message_type, channel_id=self.security_token.ChannelId,
                                                request_id=request_id, token_id=self.security_token.TokenId)
        for chunk in chunks:
            self._sequence_number += 1
            if self._sequence_number >= (1 << 32):
                logger.debug("Wrapping sequence number: %d -> 1", self._sequence_number)
                self._sequence_number = 1
            chunk.SequenceHeader.SequenceNumber = self._sequence_number
        return b"".join([chunk.to_binary() for chunk in chunks])

    def _check_sym_header(self, security_hdr):
        """
        Validates the symmetric header of the message chunk and revolves the
        security token if needed.
        """
        assert isinstance(security_hdr, ua.SymmetricAlgorithmHeader), f"Expected SymAlgHeader, got: {security_hdr}"

        if security_hdr.TokenId == self.security_token.TokenId:
            return

        if security_hdr.TokenId == self.next_security_token.TokenId:
            self.revolve_tokens()
            return

        if self._allow_prev_token and security_hdr.TokenId == self.prev_security_token.TokenId:
            # From spec, part 4, section 5.5.2.1: Clients should accept Messages secured by an
            # expired SecurityToken for up to 25 % of the token lifetime. This should ensure that
            # Messages sent by the Server before the token expired are not rejected because of
            # network delays.
            timeout = self.prev_security_token.CreatedAt + \
                      timedelta(milliseconds=self.prev_security_token.RevisedLifetime * 1.25)
            if timeout < datetime.utcnow():
                raise ua.UaError(f"Security token id {security_hdr.TokenId} has timed out "
                                 f"({timeout} < {datetime.utcnow()})")
            return

        expected_tokens = [self.security_token.TokenId, self.next_security_token.TokenId]

        if self._renewal_started:
            extra_token = self.security_token.TokenId + 1
            expected_token.append(extra_token)


        if self._allow_prev_token:
            expected_tokens.insert(0, self.prev_security_token.TokenId)
        raise ua.UaError(f"Invalid security token id {security_hdr.TokenId}, expected one of: {expected_tokens}")

    def _check_incoming_chunk(self, chunk):
        if not isinstance(chunk, MessageChunk):
            raise ValueError(f'Expected chunk, got: {chunk}')
        if chunk.MessageHeader.MessageType != ua.MessageType.SecureOpen:
            if chunk.MessageHeader.ChannelId != self.security_token.ChannelId:
                raise ua.UaError(f'Wrong channel id {chunk.MessageHeader.ChannelId},'
                                 f' expected {self.security_token.ChannelId}')
        if self._incoming_parts:
            if self._incoming_parts[0].SequenceHeader.RequestId != chunk.SequenceHeader.RequestId:
                raise ua.UaError(f'Wrong request id {chunk.SequenceHeader.RequestId},'
                                 f' expected {self._incoming_parts[0].SequenceHeader.RequestId}')
        # The sequence number must monotonically increase (but it can wrap around)
        seq_num = chunk.SequenceHeader.SequenceNumber
        if self._peer_sequence_number is not None:
            if seq_num != self._peer_sequence_number + 1:
                wrap_limit = (1 << 32) - 1024
                if seq_num < 1024 and self._peer_sequence_number >= wrap_limit:
                    # The sequence number has wrapped around. See spec. part 6, 6.7.2
                    logger.debug('Sequence number wrapped: %d -> %d', self._peer_sequence_number, seq_num)
                else:
                    # Condition for monotonically increase is not met
                    raise ua.UaError(f"Received chunk: {chunk} with wrong sequence expecting:"
                                     f" {self._peer_sequence_number}, received: {seq_num},"
                                     f" spec says to close connection")
        self._peer_sequence_number = seq_num

    def receive_from_header_and_body(self, header, body):
        """
        Convert MessageHeader and binary body to OPC UA TCP message (see OPC UA
        specs Part 6, 7.1: Hello, Acknowledge or ErrorMessage), or a Message
        object, or None (if intermediate chunk is received)
        """
        if header.MessageType == ua.MessageType.SecureOpen:
            data = body.copy(header.body_size)
            security_header = struct_from_binary(ua.AsymmetricAlgorithmHeader, data)

            if not self.is_open():
                # Only call select_policy if the channel isn't open. Otherwise
                # it will break the Secure channel renewal.
                self.select_policy(security_header.SecurityPolicyURI, security_header.SenderCertificate)

        elif header.MessageType in (ua.MessageType.SecureMessage, ua.MessageType.SecureClose):
            data = body.copy(header.body_size)
            security_header = struct_from_binary(ua.SymmetricAlgorithmHeader, data)
            self._check_sym_header(security_header)

        if header.MessageType in (ua.MessageType.SecureMessage, ua.MessageType.SecureOpen, ua.MessageType.SecureClose):
            chunk = MessageChunk.from_header_and_body(self.security_policy, header, body)
            return self._receive(chunk)
        if header.MessageType == ua.MessageType.Hello:
            msg = struct_from_binary(ua.Hello, body)
            self._max_chunk_size = msg.ReceiveBufferSize
            return msg
        if header.MessageType == ua.MessageType.Acknowledge:
            msg = struct_from_binary(ua.Acknowledge, body)
            self._max_chunk_size = msg.SendBufferSize
            return msg
        if header.MessageType == ua.MessageType.Error:
            msg = struct_from_binary(ua.ErrorMessage, body)
            logger.warning(f"Received an error: {msg}")
            return msg
        raise ua.UaError(f"Unsupported message type {header.MessageType}")

    def _receive(self, msg):
        self._check_incoming_chunk(msg)
        self._incoming_parts.append(msg)
        if msg.MessageHeader.ChunkType == ua.ChunkType.Intermediate:
            return None
        if msg.MessageHeader.ChunkType == ua.ChunkType.Abort:
            err = struct_from_binary(ua.ErrorMessage, ua.utils.Buffer(msg.Body))
            logger.warning(f"Message {msg} aborted: {err}")
            # specs Part 6, 6.7.3 say that aborted message shall be ignored
            # and SecureChannel should not be closed
            self._incoming_parts = []
            return None
        if msg.MessageHeader.ChunkType == ua.ChunkType.Single:
            message = ua.Message(self._incoming_parts)
            self._incoming_parts = []
            return message
        raise ua.UaError(f"Unsupported chunk type: {msg}")


1			import hashlib
2			from datetime import datetime, timedelta
3			import logging
4			import copy
5
6			from asyncua import ua
7			from ..ua.ua_binary import struct_from_binary, struct_to_binary, header_from_binary, header_to_binary
8
9			logger = logging.getLogger('asyncua.uaprotocol')
10
11
12			class MessageChunk(ua.FrozenClass):
13			"""
14			Message Chunk, as described in OPC UA specs Part 6, 6.7.2.
15			"""
16			def __init__(self, security_policy, body=b'', msg_type=ua.MessageType.SecureMessage,
17			chunk_type=ua.ChunkType.Single):
18			self.MessageHeader = ua.Header(msg_type, chunk_type)
19			if msg_type in (ua.MessageType.SecureMessage, ua.MessageType.SecureClose):
20			self.SecurityHeader = ua.SymmetricAlgorithmHeader()
21			elif msg_type == ua.MessageType.SecureOpen:
22			self.SecurityHeader = ua.AsymmetricAlgorithmHeader()
23			else:
24			raise ua.UaError(f"Unsupported message type: {msg_type}")
25			self.SequenceHeader = ua.SequenceHeader()
26			self.Body = body
27			self.security_policy = security_policy
28
29			@staticmethod
30			def from_binary(security_policy, data):
31			h = header_from_binary(data)
32			return MessageChunk.from_header_and_body(security_policy, h, data)
33
34			@staticmethod
35			def from_header_and_body(security_policy, header, buf):
36			if not len(buf) >= header.body_size:
37			raise ValueError('Full body expected here')
38			data = buf.copy(header.body_size)
39			buf.skip(header.body_size)
40			if header.MessageType in (ua.MessageType.SecureMessage, ua.MessageType.SecureClose):
41			security_header = struct_from_binary(ua.SymmetricAlgorithmHeader, data)
42			crypto = security_policy.symmetric_cryptography
43			elif header.MessageType == ua.MessageType.SecureOpen:
44			security_header = struct_from_binary(ua.AsymmetricAlgorithmHeader, data)
45			crypto = security_policy.asymmetric_cryptography
46			else:
47			raise ua.UaError(f"Unsupported message type: {header.MessageType}")
48			obj = MessageChunk(crypto)
49			obj.MessageHeader = header
50			obj.SecurityHeader = security_header
51			decrypted = crypto.decrypt(data.read(len(data)))
52			signature_size = crypto.vsignature_size()
53			if signature_size > 0:
54			signature = decrypted[-signature_size:]
55			decrypted = decrypted[:-signature_size]
56			crypto.verify(header_to_binary(obj.MessageHeader) + struct_to_binary(obj.SecurityHeader) + decrypted,
57			signature)
58			data = ua.utils.Buffer(crypto.remove_padding(decrypted))
59			obj.SequenceHeader = struct_from_binary(ua.SequenceHeader, data)
60			obj.Body = data.read(len(data))
61			return obj
62
63			def encrypted_size(self, plain_size):
64			size = plain_size + self.security_policy.signature_size()
65			pbs = self.security_policy.plain_block_size()
66			if size % pbs != 0:
67			raise ua.UaError("Encryption error")
68			return size // pbs * self.security_policy.encrypted_block_size()
69
70			def to_binary(self):
71			security = struct_to_binary(self.SecurityHeader)
72			encrypted_part = struct_to_binary(self.SequenceHeader) + self.Body
73			encrypted_part += self.security_policy.padding(len(encrypted_part))
74			self.MessageHeader.body_size = len(security) + self.encrypted_size(len(encrypted_part))
75			header = header_to_binary(self.MessageHeader)
76			encrypted_part += self.security_policy.signature(header + security + encrypted_part)
77			return header + security + self.security_policy.encrypt(encrypted_part)
78
79			@staticmethod
80			def max_body_size(crypto, max_chunk_size):
81			max_encrypted_size = max_chunk_size - ua.Header.max_size() - ua.SymmetricAlgorithmHeader.max_size()
82			max_plain_size = (max_encrypted_size // crypto.encrypted_block_size()) * crypto.plain_block_size()
83			return max_plain_size - ua.SequenceHeader.max_size() - crypto.signature_size() - crypto.min_padding_size()
84
85			@staticmethod
86			def message_to_chunks(security_policy, body, max_chunk_size, message_type=ua.MessageType.SecureMessage,
87			channel_id=1, request_id=1, token_id=1):
88			"""
89			Pack message body (as binary string) into one or more chunks.
90			Size of each chunk will not exceed max_chunk_size.
91			Returns a list of MessageChunks. SequenceNumber is not initialized here,
92			it must be set by Secure Channel driver.
93			"""
94			if message_type == ua.MessageType.SecureOpen:
95			# SecureOpen message must be in a single chunk (specs, Part 6, 6.7.2)
96			chunk = MessageChunk(security_policy.asymmetric_cryptography, body, message_type, ua.ChunkType.Single)
97			chunk.SecurityHeader.SecurityPolicyURI = security_policy.URI
98			if security_policy.host_certificate:
99			chunk.SecurityHeader.SenderCertificate = security_policy.host_certificate
100			if security_policy.peer_certificate:
101			chunk.SecurityHeader.ReceiverCertificateThumbPrint =\
102			hashlib.sha1(security_policy.peer_certificate).digest()
103			chunk.MessageHeader.ChannelId = channel_id
104			chunk.SequenceHeader.RequestId = request_id
105			return [chunk]
106
107			crypto = security_policy.symmetric_cryptography
108			max_size = MessageChunk.max_body_size(crypto, max_chunk_size)
109
110			chunks = []
111			for i in range(0, len(body), max_size):
112			part = body[i:i + max_size]
113			if i + max_size >= len(body):
114			chunk_type = ua.ChunkType.Single
115			else:
116			chunk_type = ua.ChunkType.Intermediate
117			chunk = MessageChunk(crypto, part, message_type, chunk_type)
118			chunk.SecurityHeader.TokenId = token_id
119			chunk.MessageHeader.ChannelId = channel_id
120			chunk.SequenceHeader.RequestId = request_id
121			chunks.append(chunk)
122			return chunks
123
124			def __str__(self):
125			return f"{self.__class__.__name__}({self.MessageHeader}, {self.SequenceHeader}," \
126			f" {self.SecurityHeader}, {len(self.Body)} bytes)"
127
128			__repr__ = __str__
129
130
131			class SecureConnection:
132			"""
133			Common logic for client and server
134			"""
135			def __init__(self, security_policy):
136			self._sequence_number = 0
137			self._peer_sequence_number = None
138			self._incoming_parts = []
139			self.security_policy = security_policy
140			self._policies = []
141			self._open = False
142			self.security_token = ua.ChannelSecurityToken()
143			self.next_security_token = ua.ChannelSecurityToken()
144			self.prev_security_token = ua.ChannelSecurityToken()
145			self.local_nonce = 0
146			self.remote_nonce = 0
147			self._allow_prev_token = False
148			self._max_chunk_size = 65536
149			self._renewal_started = False
150
151			def start_renewal(self):
152			self._renewal_started = True
153
154			def set_channel(self, params, request_type, client_nonce):
155			"""
156			Called on client side when getting secure channel data from server.
157			"""
158			self._renewal_started = False
159			if request_type == ua.SecurityTokenRequestType.Issue:
160			self.security_token = params.SecurityToken
161			self.local_nonce = client_nonce
162			self.remote_nonce = params.ServerNonce
163			self.security_policy.make_local_symmetric_key(self.remote_nonce, self.local_nonce)
164			self.security_policy.make_remote_symmetric_key(self.local_nonce, self.remote_nonce)
165			self._open = True
166			else:
167			self.next_security_token = params.SecurityToken
168			self.local_nonce = client_nonce
169			self.remote_nonce = params.ServerNonce
170
171			self._allow_prev_token = True
172
173			def open(self, params, server):
174			"""
175			Called on server side to open secure channel.
176			"""
177
178			self.local_nonce = ua.utils.create_nonce(self.security_policy.symmetric_key_size)
179			self.remote_nonce = params.ClientNonce
180			response = ua.OpenSecureChannelResult()
181			response.ServerNonce = self.local_nonce
182
183			if not self._open or params.RequestType == ua.SecurityTokenRequestType.Issue:
184			self._open = True
185			self.security_token.TokenId = 13 # random value
186			self.security_token.ChannelId = server.get_new_channel_id()
187			self.security_token.RevisedLifetime = params.RequestedLifetime
188			self.security_token.CreatedAt = datetime.utcnow()
189
190			response.SecurityToken = self.security_token
191
192			self.security_policy.make_local_symmetric_key(self.remote_nonce, self.local_nonce)
193			self.security_policy.make_remote_symmetric_key(self.local_nonce, self.remote_nonce)
194			else:
195			self.next_security_token = copy.deepcopy(self.security_token)
196			self.next_security_token.TokenId += 1
197			self.next_security_token.RevisedLifetime = params.RequestedLifetime
198			self.next_security_token.CreatedAt = datetime.utcnow()
199
200			response.SecurityToken = self.next_security_token
201
202			return response
203
204			def close(self):
205			self._open = False
206
207			def is_open(self):
208			return self._open
209
210			def set_policy_factories(self, policies):
211			"""
212			Set a list of available security policies.
213			Use this in servers with multiple endpoints with different security.
214			"""
215			self._policies = policies
216
217			@staticmethod
218			def _policy_matches(policy, uri, mode=None):
219			return policy.URI == uri and (mode is None or policy.Mode == mode)
220
221			def select_policy(self, uri, peer_certificate, mode=None):
222			for policy in self._policies:
223			if policy.matches(uri, mode):
224			self.security_policy = policy.create(peer_certificate)
225			return
226			if self.security_policy.URI != uri or (mode is not None and self.security_policy.Mode != mode):
227			raise ua.UaError(f"No matching policy: {uri}, {mode}")
228
229			def revolve_tokens(self):
230			"""
231			Revolve security tokens of the security channel. Start using the
232			next security token negotiated during the renewal of the channel and
233			remember the previous token until the other communication party
234			"""
235			self.prev_security_token = self.security_token
236			self.security_token = self.next_security_token
237			self.next_security_token = ua.ChannelSecurityToken()
238			self.security_policy.make_local_symmetric_key(self.remote_nonce, self.local_nonce)
239			self.security_policy.make_remote_symmetric_key(self.local_nonce, self.remote_nonce)
240
241			def message_to_binary(self, message, message_type=ua.MessageType.SecureMessage, request_id=0):
242			"""
243			Convert OPC UA secure message to binary.
244			The only supported types are SecureOpen, SecureMessage, SecureClose.
245			If message_type is SecureMessage, the AlgorithmHeader should be passed as arg.
246			"""
247			chunks = MessageChunk.message_to_chunks(self.security_policy, message, self._max_chunk_size,
248			message_type=message_type, channel_id=self.security_token.ChannelId,
249			request_id=request_id, token_id=self.security_token.TokenId)
250			for chunk in chunks:
251			self._sequence_number += 1
252			if self._sequence_number >= (1 << 32):
253			logger.debug("Wrapping sequence number: %d -> 1", self._sequence_number)
254			self._sequence_number = 1
255			chunk.SequenceHeader.SequenceNumber = self._sequence_number
256			return b"".join([chunk.to_binary() for chunk in chunks])
257
258			def _check_sym_header(self, security_hdr):
259			"""
260			Validates the symmetric header of the message chunk and revolves the
261			security token if needed.
262			"""
263			assert isinstance(security_hdr, ua.SymmetricAlgorithmHeader), f"Expected SymAlgHeader, got: {security_hdr}"
264
265			if security_hdr.TokenId == self.security_token.TokenId:
266			return
267
268			if security_hdr.TokenId == self.next_security_token.TokenId:
269			self.revolve_tokens()
270			return
271
272			if self._allow_prev_token and security_hdr.TokenId == self.prev_security_token.TokenId:
273			# From spec, part 4, section 5.5.2.1: Clients should accept Messages secured by an
274			# expired SecurityToken for up to 25 % of the token lifetime. This should ensure that
275			# Messages sent by the Server before the token expired are not rejected because of
276			# network delays.
277			timeout = self.prev_security_token.CreatedAt + \
278			timedelta(milliseconds=self.prev_security_token.RevisedLifetime * 1.25)
279			if timeout < datetime.utcnow():
280			raise ua.UaError(f"Security token id {security_hdr.TokenId} has timed out "
281			f"({timeout} < {datetime.utcnow()})")
282			return
283
284			expected_tokens = [self.security_token.TokenId, self.next_security_token.TokenId]
285
286			if self._renewal_started:
287			extra_token = self.security_token.TokenId + 1
288			expected_token.append(extra_token)
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-10-20 11:13 UTC by Report Bug Copy Issue Report The variable `expected_token` does not seem to be defined. Loading history...
289
290			if self._allow_prev_token:
291			expected_tokens.insert(0, self.prev_security_token.TokenId)
292			raise ua.UaError(f"Invalid security token id {security_hdr.TokenId}, expected one of: {expected_tokens}")
293
294			def _check_incoming_chunk(self, chunk):
295			if not isinstance(chunk, MessageChunk):
296			raise ValueError(f'Expected chunk, got: {chunk}')
297			if chunk.MessageHeader.MessageType != ua.MessageType.SecureOpen:
298			if chunk.MessageHeader.ChannelId != self.security_token.ChannelId:
299			raise ua.UaError(f'Wrong channel id {chunk.MessageHeader.ChannelId},'
300			f' expected {self.security_token.ChannelId}')
301			if self._incoming_parts:
302			if self._incoming_parts[0].SequenceHeader.RequestId != chunk.SequenceHeader.RequestId:
303			raise ua.UaError(f'Wrong request id {chunk.SequenceHeader.RequestId},'
304			f' expected {self._incoming_parts[0].SequenceHeader.RequestId}')
305			# The sequence number must monotonically increase (but it can wrap around)
306			seq_num = chunk.SequenceHeader.SequenceNumber
307			if self._peer_sequence_number is not None:
308			if seq_num != self._peer_sequence_number + 1:
309			wrap_limit = (1 << 32) - 1024
310			if seq_num < 1024 and self._peer_sequence_number >= wrap_limit:
311			# The sequence number has wrapped around. See spec. part 6, 6.7.2
312			logger.debug('Sequence number wrapped: %d -> %d', self._peer_sequence_number, seq_num)
313			else:
314			# Condition for monotonically increase is not met
315			raise ua.UaError(f"Received chunk: {chunk} with wrong sequence expecting:"
316			f" {self._peer_sequence_number}, received: {seq_num},"
317			f" spec says to close connection")
318			self._peer_sequence_number = seq_num
319
320			def receive_from_header_and_body(self, header, body):
321			"""
322			Convert MessageHeader and binary body to OPC UA TCP message (see OPC UA
323			specs Part 6, 7.1: Hello, Acknowledge or ErrorMessage), or a Message
324			object, or None (if intermediate chunk is received)
325			"""
326			if header.MessageType == ua.MessageType.SecureOpen:
327			data = body.copy(header.body_size)
328			security_header = struct_from_binary(ua.AsymmetricAlgorithmHeader, data)
329
330			if not self.is_open():
331			# Only call select_policy if the channel isn't open. Otherwise
332			# it will break the Secure channel renewal.
333			self.select_policy(security_header.SecurityPolicyURI, security_header.SenderCertificate)
334
335			elif header.MessageType in (ua.MessageType.SecureMessage, ua.MessageType.SecureClose):
336			data = body.copy(header.body_size)
337			security_header = struct_from_binary(ua.SymmetricAlgorithmHeader, data)
338			self._check_sym_header(security_header)
339
340			if header.MessageType in (ua.MessageType.SecureMessage, ua.MessageType.SecureOpen, ua.MessageType.SecureClose):
341			chunk = MessageChunk.from_header_and_body(self.security_policy, header, body)
342			return self._receive(chunk)
343			if header.MessageType == ua.MessageType.Hello:
344			msg = struct_from_binary(ua.Hello, body)
345			self._max_chunk_size = msg.ReceiveBufferSize
346			return msg
347			if header.MessageType == ua.MessageType.Acknowledge:
348			msg = struct_from_binary(ua.Acknowledge, body)
349			self._max_chunk_size = msg.SendBufferSize
350			return msg
351			if header.MessageType == ua.MessageType.Error:
352			msg = struct_from_binary(ua.ErrorMessage, body)
353			logger.warning(f"Received an error: {msg}")
354			return msg
355			raise ua.UaError(f"Unsupported message type {header.MessageType}")
356
357			def _receive(self, msg):
358			self._check_incoming_chunk(msg)
359			self._incoming_parts.append(msg)
360			if msg.MessageHeader.ChunkType == ua.ChunkType.Intermediate:
361			return None
362			if msg.MessageHeader.ChunkType == ua.ChunkType.Abort:
363			err = struct_from_binary(ua.ErrorMessage, ua.utils.Buffer(msg.Body))
364			logger.warning(f"Message {msg} aborted: {err}")
365			# specs Part 6, 6.7.3 say that aborted message shall be ignored
366			# and SecureChannel should not be closed
367			self._incoming_parts = []
368			return None
369			if msg.MessageHeader.ChunkType == ua.ChunkType.Single:
370			message = ua.Message(self._incoming_parts)
371			self._incoming_parts = []
372			return message
373			raise ua.UaError(f"Unsupported chunk type: {msg}")
374

FreeOpcUa / opcua-asyncio

Pull Request — master (#317)

SecureConnection.start_renewal() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like