1#!/usr/bin/env python3
2#
3#  Copyright (c) 2016, The OpenThread Authors.
4#  All rights reserved.
5#
6#  Redistribution and use in source and binary forms, with or without
7#  modification, are permitted provided that the following conditions are met:
8#  1. Redistributions of source code must retain the above copyright
9#     notice, this list of conditions and the following disclaimer.
10#  2. Redistributions in binary form must reproduce the above copyright
11#     notice, this list of conditions and the following disclaimer in the
12#     documentation and/or other materials provided with the distribution.
13#  3. Neither the name of the copyright holder nor the
14#     names of its contributors may be used to endorse or promote products
15#     derived from this software without specific prior written permission.
16#
17#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27#  POSSIBILITY OF SUCH DAMAGE.
28#
29import os
30from enum import Enum
31
32import coap
33import dtls
34import ipv6
35import lowpan
36import mesh_cop
37import message
38import mle
39import net_crypto
40import network_data
41import network_diag
42import network_layer
43import simulator
44import sniffer
45from tlvs_parsing import SubTlvsFactory
46
47MESH_LOCAL_PREFIX = 'fd00:db8::/64'
48MESH_LOCAL_PREFIX_REGEX_PATTERN = '^fd00:0?db8:0{0,4}:0{0,4}'
49ROUTING_LOCATOR = '64/:0:ff:fe00:/16'
50ROUTING_LOCATOR_REGEX_PATTERN = r'.*:(0)?:0{0,2}ff:fe00:\w{1,4}$'
51LINK_LOCAL = 'fe80:/112'
52LINK_LOCAL_REGEX_PATTERN = '^fe80:.*'
53ALOC_FLAG_REGEX_PATTERN = '.*:fc..$'
54LINK_LOCAL_All_THREAD_NODES_MULTICAST_ADDRESS = 'ff32:40:fd00:db8:0:0:0:1'
55REALM_LOCAL_All_THREAD_NODES_MULTICAST_ADDRESS = 'ff33:40:fd00:db8:0:0:0:1'
56REALM_LOCAL_ALL_NODES_ADDRESS = 'ff03::1'
57REALM_LOCAL_ALL_ROUTERS_ADDRESS = 'ff03::2'
58LINK_LOCAL_ALL_NODES_ADDRESS = 'ff02::1'
59LINK_LOCAL_ALL_ROUTERS_ADDRESS = 'ff02::2'
60TMF_PORT = 61631
61
62DOMAIN_PREFIX = 'fd00:7d03:7d03:7d03::/64'
63DOMAIN_PREFIX_REGEX_PATTERN = '^fd00:7d03:7d03:7d03:'
64DOMAIN_PREFIX_ALTER = 'fd00:7d04:7d04:7d04::/64'
65
66PORT_OFFSET = int(os.getenv('PORT_OFFSET', '0'))
67BACKBONE_IPV6_ADDR_START = f'{0x9100 + PORT_OFFSET:04x}'
68BACKBONE_PREFIX = f'{BACKBONE_IPV6_ADDR_START}::/64'
69BACKBONE_PREFIX_REGEX_PATTERN = f'^{BACKBONE_IPV6_ADDR_START}:'
70BACKBONE_DOCKER_NETWORK_NAME = f'backbone{PORT_OFFSET}'
71BACKBONE_DOCKER_NETWORK_DEFAULT_ID = 0
72BACKBONE_IFNAME = 'eth0'
73THREAD_IFNAME = 'wpan0'
74
75OTBR_DOCKER_IMAGE = os.getenv('OTBR_DOCKER_IMAGE', 'otbr-ot12-backbone-ci')
76OTBR_DOCKER_NAME_PREFIX = f'otbr_{PORT_OFFSET}_'
77
78ALL_NETWORK_BBRS_ADDRESS = 'ff32:40:fd00:db8:0:0:0:3'
79
80ALL_DOMAIN_BBRS_ADDRESS = 'ff32:40:fd00:7d03:7d03:7d03:0:3'
81ALL_DOMAIN_BBRS_ADDRESS_ALTER = 'ff32:40:fd00:7d04:7d04:7d04:0:3'
82
83ONLINK_GUA_PREFIX = '2021::/64'
84
85# Any address starts with 'fd' are considered on-link address.
86ONLINK_PREFIX_REGEX_PATTERN = '^fd'
87
88DEFAULT_NETWORK_KEY = bytearray([
89    0x00,
90    0x11,
91    0x22,
92    0x33,
93    0x44,
94    0x55,
95    0x66,
96    0x77,
97    0x88,
98    0x99,
99    0xaa,
100    0xbb,
101    0xcc,
102    0xdd,
103    0xee,
104    0xff,
105])
106
107
108class ADDRESS_TYPE(Enum):
109    LINK_LOCAL = 'LINK_LOCAL'  # For Thread interface link-local only
110    GLOBAL = 'GLOBAL'
111    RLOC = 'RLOC'
112    ALOC = 'ALOC'
113    ML_EID = 'ML_EID'
114    DUA = 'DUA'
115    BACKBONE_GUA = 'BACKBONE_GUA'
116    BACKBONE_LINK_LOCAL = 'BACKBONE_LINK_LOCAL'
117    OMR = 'OMR'
118    ONLINK_ULA = 'ONLINK_ULA'
119    ONLINK_GUA = 'ONLINK_GUA'
120
121
122RSSI = {
123    'LINK_QULITY_0': -100,
124    'LINK_QULITY_1': -95,
125    'LINK_QULITY_2': -85,
126    'LINK_QULITY_3': -65,
127}
128
129SNIFFER_ID = int(os.getenv('SNIFFER_ID', 34))
130
131CHANNEL = 11
132CHANNEL_MASK = 0x07fff800
133EXTENDED_PANID = 'dead00beef00cafe'
134NETWORK_NAME = 'OpenThread'
135PANID = 0xface
136PSKC = 'c23a76e98f1a6483639b1ac1271e2e27'
137SECURITY_POLICY = [672, 'onrc']
138
139LEADER_STARTUP_DELAY = 12
140ROUTER_STARTUP_DELAY = 10
141ED_STARTUP_DELAY = 5
142BORDER_ROUTER_STARTUP_DELAY = 20
143MAX_NEIGHBOR_AGE = 100
144INFINITE_COST_TIMEOUT = 90
145
146MAX_ADVERTISEMENT_INTERVAL = 32
147MLE_END_DEVICE_TIMEOUT = 100
148
149AQ_TIMEOUT = 3
150ADDRESS_QUERY_INITIAL_RETRY_DELAY = 15
151DEFAULT_CHILD_TIMEOUT = 6
152VIRTUAL_TIME = int(os.getenv('VIRTUAL_TIME', 0))
153PARENT_AGGREGATIOIN_DELAY = 5
154DUA_DAD_DELAY = 5
155DEFAULT_BBR_REGISTRATION_JITTER = 2
156DEFAULT_ROUTER_SELECTION_JITTER = 1
157
158LEADER_NOTIFY_SED_BY_CHILD_UPDATE_REQUEST = True
159
160THREAD_VERSION_1_1 = 2
161THREAD_VERSION_1_2 = 3
162THREAD_VERSION_1_3 = 4
163THREAD_VERSION_1_4 = 5
164
165PACKET_VERIFICATION_NONE = 0
166PACKET_VERIFICATION_DEFAULT = 1
167PACKET_VERIFICATION_TREL = 2
168
169# After leader reset it may retransmit link request 6 times with max 5.5s interval
170LEADER_RESET_DELAY = 41
171# After router reset it may retransmit link request 3 times with max 5.5s interval
172ROUTER_RESET_DELAY = 23
173MLE_MAX_CRITICAL_TRANSMISSION_COUNT = 6
174MLE_MAX_TRANSMISSION_COUNT = 3
175
176
177def create_default_network_data_prefix_sub_tlvs_factories():
178    return {
179        network_data.TlvType.HAS_ROUTE:
180            network_data.HasRouteFactory(routes_factory=network_data.RoutesFactory(
181                route_factory=network_data.RouteFactory())),
182        network_data.TlvType.BORDER_ROUTER:
183            network_data.BorderRouterFactory(),
184        network_data.TlvType.LOWPAN_ID:
185            network_data.LowpanIdFactory(),
186    }
187
188
189def create_default_network_data_prefix_sub_tlvs_factory():
190    return network_data.PrefixSubTlvsFactory(
191        sub_tlvs_factories=create_default_network_data_prefix_sub_tlvs_factories())
192
193
194def create_default_network_data_service_sub_tlvs_factories():
195    return {network_data.TlvType.SERVER: network_data.ServerFactory()}
196
197
198def create_default_network_data_service_sub_tlvs_factory():
199    return network_data.ServiceSubTlvsFactory(
200        sub_tlvs_factories=create_default_network_data_service_sub_tlvs_factories())
201
202
203def create_default_network_data_commissioning_data_sub_tlvs_factories():
204    return {
205        mesh_cop.TlvType.CHANNEL: mesh_cop.ChannelFactory(),
206        mesh_cop.TlvType.STEERING_DATA: mesh_cop.SteeringDataFactory(),
207        mesh_cop.TlvType.BORDER_AGENT_LOCATOR: mesh_cop.BorderAgentLocatorFactory(),
208        mesh_cop.TlvType.COMMISSIONER_SESSION_ID: mesh_cop.CommissionerSessionIdFactory(),
209        mesh_cop.TlvType.COMMISSIONER_UDP_PORT: mesh_cop.CommissionerUdpPortFactory(),
210    }
211
212
213def create_default_network_data_commissioning_data_sub_tlvs_factory():
214    return network_data.CommissioningDataSubTlvsFactory(
215        sub_tlvs_factories=create_default_network_data_commissioning_data_sub_tlvs_factories())
216
217
218def create_default_network_data_tlvs_factories():
219    return {
220        network_data.TlvType.PREFIX:
221            network_data.PrefixFactory(sub_tlvs_factory=create_default_network_data_prefix_sub_tlvs_factory()),
222        network_data.TlvType.SERVICE:
223            network_data.ServiceFactory(sub_tlvs_factory=create_default_network_data_service_sub_tlvs_factory()),
224        network_data.TlvType.COMMISSIONING:
225            network_data.CommissioningDataFactory(
226                sub_tlvs_factory=create_default_network_data_commissioning_data_sub_tlvs_factory()),
227    }
228
229
230def create_default_network_data_tlvs_factory():
231    return network_data.NetworkDataTlvsFactory(sub_tlvs_factories=create_default_network_data_tlvs_factories())
232
233
234def create_default_mle_tlv_route64_factory():
235    return mle.Route64Factory(link_quality_and_route_data_factory=mle.LinkQualityAndRouteDataFactory())
236
237
238def create_default_mle_tlv_network_data_factory():
239    return mle.NetworkDataFactory(network_data_tlvs_factory=create_default_network_data_tlvs_factory())
240
241
242def create_default_mle_tlv_address_registration_factory():
243    return mle.AddressRegistrationFactory(
244        addr_compressed_factory=mle.AddressCompressedFactory(),
245        addr_full_factory=mle.AddressFullFactory(),
246    )
247
248
249def create_default_mle_tlv_thread_discovery_factory():
250    return mle.ThreadDiscoveryFactory(thread_discovery_tlvs_factory=create_default_thread_discovery_tlvs_factory())
251
252
253def create_default_thread_discovery_tlvs_factory():
254    return mesh_cop.ThreadDiscoveryTlvsFactory(sub_tlvs_factories=create_default_thread_discovery_sub_tlvs_factories())
255
256
257def create_default_thread_discovery_sub_tlvs_factories():
258    return {
259        mesh_cop.TlvType.DISCOVERY_REQUEST: mesh_cop.DiscoveryRequestFactory(),
260        mesh_cop.TlvType.DISCOVERY_RESPONSE: mesh_cop.DiscoveryResponseFactory(),
261        mesh_cop.TlvType.EXTENDED_PANID: mesh_cop.ExtendedPanidFactory(),
262        mesh_cop.TlvType.NETWORK_NAME: mesh_cop.NetworkNameFactory(),
263        mesh_cop.TlvType.STEERING_DATA: mesh_cop.SteeringDataFactory(),
264        mesh_cop.TlvType.JOINER_UDP_PORT: mesh_cop.JoinerUdpPortFactory(),
265        mesh_cop.TlvType.COMMISSIONER_UDP_PORT: mesh_cop.CommissionerUdpPortFactory(),
266    }
267
268
269def create_default_mle_tlvs_factories():
270    return {
271        mle.TlvType.SOURCE_ADDRESS: mle.SourceAddressFactory(),
272        mle.TlvType.MODE: mle.ModeFactory(),
273        mle.TlvType.TIMEOUT: mle.TimeoutFactory(),
274        mle.TlvType.CHALLENGE: mle.ChallengeFactory(),
275        mle.TlvType.RESPONSE: mle.ResponseFactory(),
276        mle.TlvType.LINK_LAYER_FRAME_COUNTER: mle.LinkLayerFrameCounterFactory(),
277        mle.TlvType.MLE_FRAME_COUNTER: mle.MleFrameCounterFactory(),
278        mle.TlvType.ROUTE64: create_default_mle_tlv_route64_factory(),
279        mle.TlvType.ADDRESS16: mle.Address16Factory(),
280        mle.TlvType.LEADER_DATA: mle.LeaderDataFactory(),
281        mle.TlvType.NETWORK_DATA: create_default_mle_tlv_network_data_factory(),
282        mle.TlvType.TLV_REQUEST: mle.TlvRequestFactory(),
283        mle.TlvType.SCAN_MASK: mle.ScanMaskFactory(),
284        mle.TlvType.CONNECTIVITY: mle.ConnectivityFactory(),
285        mle.TlvType.LINK_MARGIN: mle.LinkMarginFactory(),
286        mle.TlvType.STATUS: mle.StatusFactory(),
287        mle.TlvType.VERSION: mle.VersionFactory(),
288        mle.TlvType.ADDRESS_REGISTRATION: create_default_mle_tlv_address_registration_factory(),
289        mle.TlvType.CHANNEL: mle.ChannelFactory(),
290        mle.TlvType.PANID: mle.PanIdFactory(),
291        mle.TlvType.ACTIVE_TIMESTAMP: mle.ActiveTimestampFactory(),
292        mle.TlvType.PENDING_TIMESTAMP: mle.PendingTimestampFactory(),
293        mle.TlvType.CSL_CHANNEL: mle.CslChannelFactory(),
294        mle.TlvType.CSL_SYNCHRONIZED_TIMEOUT: mle.CslSynchronizedTimeoutFactory(),
295        mle.TlvType.CSL_CLOCK_ACCURACY: mle.CslClockAccuracyFactory(),
296        mle.TlvType.ACTIVE_OPERATIONAL_DATASET: mle.ActiveOperationalDatasetFactory(),
297        mle.TlvType.PENDING_OPERATIONAL_DATASET: mle.PendingOperationalDatasetFactory(),
298        mle.TlvType.TIME_REQUEST: mle.TimeRequestFactory(),
299        mle.TlvType.TIME_PARAMETER: mle.TimeParameterFactory(),
300        mle.TlvType.THREAD_DISCOVERY: create_default_mle_tlv_thread_discovery_factory(),
301        mle.TlvType.LINK_METRICS_QUERY: mle.LinkMetricsQueryFactory(),
302        mle.TlvType.LINK_METRICS_MANAGEMENT: mle.LinkMetricsManagementFactory(),
303        mle.TlvType.LINK_METRICS_REPORT: mle.LinkMetricsReportFactory(),
304        mle.TlvType.LINK_PROBE: mle.LinkProbeFactory(),
305    }
306
307
308def create_default_mle_crypto_engine(network_key):
309    return net_crypto.CryptoEngine(crypto_material_creator=net_crypto.MleCryptoMaterialCreator(network_key))
310
311
312def create_default_mle_message_factory(network_key):
313    return mle.MleMessageFactory(
314        aux_sec_hdr_factory=net_crypto.AuxiliarySecurityHeaderFactory(),
315        mle_command_factory=mle.MleCommandFactory(tlvs_factories=create_default_mle_tlvs_factories()),
316        crypto_engine=create_default_mle_crypto_engine(network_key),
317    )
318
319
320def create_deafult_network_tlvs_factories():
321    return {
322        network_layer.TlvType.TARGET_EID:
323            network_layer.TargetEidFactory(),
324        network_layer.TlvType.MAC_EXTENDED_ADDRESS:
325            network_layer.MacExtendedAddressFactory(),
326        network_layer.TlvType.RLOC16:
327            network_layer.Rloc16Factory(),
328        network_layer.TlvType.ML_EID:
329            network_layer.MlEidFactory(),
330        network_layer.TlvType.STATUS:
331            network_layer.StatusFactory(),
332        network_layer.TlvType.TIME_SINCE_LAST_TRANSACTION:
333            network_layer.TimeSinceLastTransactionFactory(),
334        network_layer.TlvType.ROUTER_MASK:
335            network_layer.RouterMaskFactory(),
336        network_layer.TlvType.ND_OPTION:
337            network_layer.NdOptionFactory(),
338        network_layer.TlvType.ND_DATA:
339            network_layer.NdDataFactory(),
340        network_layer.TlvType.THREAD_NETWORK_DATA:
341            network_layer.ThreadNetworkDataFactory(create_default_network_data_tlvs_factory()),
342        network_layer.TlvType.XTAL_ACCURACY:
343            network_layer.XtalAccuracyFactory(),
344        # Routing information are distributed in a Thread network by MLE Routing TLV
345        # which is in fact MLE Route64 TLV. Thread specification v1.1. - Chapter 5.20
346        network_layer.TlvType.MLE_ROUTING:
347            create_default_mle_tlv_route64_factory(),
348        network_layer.TlvType.IPv6_ADDRESSES:
349            network_layer.IPv6AddressesFactory(),
350    }
351
352
353def create_default_network_tlvs_factory():
354    return SubTlvsFactory(sub_tlvs_factories=create_deafult_network_tlvs_factories())
355
356
357def create_default_mesh_cop_tlvs_factories():
358    return {
359        mesh_cop.TlvType.CHANNEL: mesh_cop.ChannelFactory(),
360        mesh_cop.TlvType.PAN_ID: mesh_cop.PanidFactory(),
361        mesh_cop.TlvType.EXTENDED_PANID: mesh_cop.ExtendedPanidFactory(),
362        mesh_cop.TlvType.NETWORK_NAME: mesh_cop.NetworkNameFactory(),
363        mesh_cop.TlvType.PSKC: mesh_cop.PSKcFactory(),
364        mesh_cop.TlvType.NETWORK_KEY: mesh_cop.NetworkKeyFactory(),
365        mesh_cop.TlvType.NETWORK_KEY_SEQUENCE_COUNTER: mesh_cop.NetworkKeySequenceCounterFactory(),
366        mesh_cop.TlvType.NETWORK_MESH_LOCAL_PREFIX: mesh_cop.NetworkMeshLocalPrefixFactory(),
367        mesh_cop.TlvType.STEERING_DATA: mesh_cop.SteeringDataFactory(),
368        mesh_cop.TlvType.BORDER_AGENT_LOCATOR: mesh_cop.BorderAgentLocatorFactory(),
369        mesh_cop.TlvType.COMMISSIONER_ID: mesh_cop.CommissionerIdFactory(),
370        mesh_cop.TlvType.COMMISSIONER_SESSION_ID: mesh_cop.CommissionerSessionIdFactory(),
371        mesh_cop.TlvType.SECURITY_POLICY: mesh_cop.SecurityPolicyFactory(),
372        mesh_cop.TlvType.GET: mesh_cop.GetFactory(),
373        mesh_cop.TlvType.ACTIVE_TIMESTAMP: mesh_cop.ActiveTimestampFactory(),
374        mesh_cop.TlvType.COMMISSIONER_UDP_PORT: mesh_cop.CommissionerUdpPortFactory(),
375        mesh_cop.TlvType.STATE: mesh_cop.StateFactory(),
376        mesh_cop.TlvType.JOINER_DTLS_ENCAPSULATION: mesh_cop.JoinerDtlsEncapsulationFactory(),
377        mesh_cop.TlvType.JOINER_UDP_PORT: mesh_cop.JoinerUdpPortFactory(),
378        mesh_cop.TlvType.JOINER_IID: mesh_cop.JoinerIIDFactory(),
379        mesh_cop.TlvType.JOINER_ROUTER_LOCATOR: mesh_cop.JoinerRouterLocatorFactory(),
380        mesh_cop.TlvType.JOINER_ROUTER_KEK: mesh_cop.JoinerRouterKEKFactory(),
381        mesh_cop.TlvType.PROVISIONING_URL: mesh_cop.ProvisioningUrlFactory(),
382        mesh_cop.TlvType.VENDOR_NAME: mesh_cop.VendorNameFactory(),
383        mesh_cop.TlvType.VENDOR_MODEL: mesh_cop.VendorModelFactory(),
384        mesh_cop.TlvType.VENDOR_SW_VERSION: mesh_cop.VendorSWVersionFactory(),
385        mesh_cop.TlvType.VENDOR_DATA: mesh_cop.VendorDataFactory(),
386        mesh_cop.TlvType.VENDOR_STACK_VERSION: mesh_cop.VendorStackVersionFactory(),
387        mesh_cop.TlvType.UDP_ENCAPSULATION: mesh_cop.UdpEncapsulationFactory(),
388        mesh_cop.TlvType.IPV6_ADDRESS: mesh_cop.Ipv6AddressFactory(),
389        mesh_cop.TlvType.PENDING_TIMESTAMP: mesh_cop.PendingTimestampFactory(),
390        mesh_cop.TlvType.DELAY_TIMER: mesh_cop.DelayTimerFactory(),
391        mesh_cop.TlvType.CHANNEL_MASK: mesh_cop.ChannelMaskFactory(),
392        mesh_cop.TlvType.COUNT: mesh_cop.CountFactory(),
393        mesh_cop.TlvType.PERIOD: mesh_cop.PeriodFactory(),
394        mesh_cop.TlvType.SCAN_DURATION: mesh_cop.ScanDurationFactory(),
395        mesh_cop.TlvType.ENERGY_LIST: mesh_cop.EnergyListFactory(),
396    }
397
398
399def create_default_mesh_cop_tlvs_factory():
400    return SubTlvsFactory(sub_tlvs_factories=create_default_mesh_cop_tlvs_factories())
401
402
403def create_default_network_diag_tlv_factories():
404    return {
405        network_diag.TlvType.EXT_ADDRESS: network_layer.MacExtendedAddressFactory(),
406        network_diag.TlvType.ADDRESS16: mle.Address16Factory(),
407        network_diag.TlvType.MODE: mle.ModeFactory(),
408        network_diag.TlvType.POLLING_PERIOD: mle.TimeoutFactory(),
409        network_diag.TlvType.CONNECTIVITY: mle.ConnectivityFactory(),
410        network_diag.TlvType.ROUTE64: create_default_mle_tlv_route64_factory(),
411        network_diag.TlvType.LEADER_DATA: mle.LeaderDataFactory(),
412        network_diag.TlvType.NETWORK_DATA: create_default_mle_tlv_network_data_factory(),
413        network_diag.TlvType.IPV6_ADDRESS_LIST: network_diag.Ipv6AddressListFactory(),
414        network_diag.TlvType.MAC_COUNTERS: network_diag.MacCountersFactory(),
415        network_diag.TlvType.BATTERY_LEVEL: network_diag.BatteryLevelFactory(),
416        network_diag.TlvType.SUPPLY_VOLTAGE: network_diag.SupplyVoltageFactory(),
417        network_diag.TlvType.CHILD_TABLE: network_diag.ChildTableFactory(),
418        network_diag.TlvType.CHANNEL_PAGES: network_diag.ChannelPagesFactory(),
419        network_diag.TlvType.TYPE_LIST: network_diag.TypeListFactory(),
420        network_diag.TlvType.MAX_CHILD_TIMEOUT: network_diag.MaxChildTimeoutFactory()
421    }
422
423
424def create_default_network_diag_tlvs_factory():
425    return SubTlvsFactory(sub_tlvs_factories=create_default_network_diag_tlv_factories())
426
427
428def create_default_uri_path_based_payload_factories():
429    network_layer_tlvs_factory = create_default_network_tlvs_factory()
430    mesh_cop_tlvs_factory = create_default_mesh_cop_tlvs_factory()
431    network_diag_tlvs_factory = create_default_network_diag_tlvs_factory()
432
433    return {
434        '/a/as': network_layer_tlvs_factory,
435        '/a/aq': network_layer_tlvs_factory,
436        '/a/ar': network_layer_tlvs_factory,
437        '/a/ae': network_layer_tlvs_factory,
438        '/a/an': network_layer_tlvs_factory,
439        '/a/sd': network_layer_tlvs_factory,
440        '/c/lp': mesh_cop_tlvs_factory,
441        '/c/cs': mesh_cop_tlvs_factory,
442        '/d/da': network_diag_tlvs_factory,
443        '/d/dg': network_diag_tlvs_factory,
444        '/d/dq': network_diag_tlvs_factory,
445        '/d/dr': network_diag_tlvs_factory,
446        '/n/mr': network_layer_tlvs_factory,
447        '/n/dr': network_layer_tlvs_factory,
448        '/n/dn': network_layer_tlvs_factory,
449    }
450
451
452def create_default_coap_message_factory():
453    return coap.CoapMessageFactory(
454        options_factory=coap.CoapOptionsFactory(),
455        uri_path_based_payload_factories=create_default_uri_path_based_payload_factories(),
456        message_id_to_uri_path_binder=coap.CoapMessageIdToUriPathBinder(),
457    )
458
459
460def create_default_ipv6_hop_by_hop_options_factories():
461    return {109: ipv6.MPLOptionFactory()}
462
463
464def create_default_ipv6_hop_by_hop_options_factory():
465    return ipv6.HopByHopOptionsFactory(options_factories=create_default_ipv6_hop_by_hop_options_factories())
466
467
468def create_default_based_on_src_dst_ports_udp_payload_factory(network_key):
469    mle_message_factory = create_default_mle_message_factory(network_key)
470    coap_message_factory = create_default_coap_message_factory()
471    dtls_message_factory = create_default_dtls_message_factory()
472
473    return ipv6.UdpBasedOnSrcDstPortsPayloadFactory(
474        src_dst_port_based_payload_factories={
475            19788: mle_message_factory,
476            61631: coap_message_factory,
477            1000: dtls_message_factory,
478            5683: coap_message_factory,
479            5684: dtls_message_factory,
480        })
481
482
483def create_default_dtls_message_factory():
484    return dtls.MessageFactory()
485
486
487def create_default_ipv6_icmp_body_factories():
488    return {
489        ipv6.ICMP_DESTINATION_UNREACHABLE: ipv6.ICMPv6DestinationUnreachableFactory(),
490        ipv6.ICMP_ECHO_REQUEST: ipv6.ICMPv6EchoBodyFactory(),
491        ipv6.ICMP_ECHO_RESPONSE: ipv6.ICMPv6EchoBodyFactory(),
492        'default': ipv6.BytesPayloadFactory(),
493    }
494
495
496def create_default_ipv6_upper_layer_factories(network_key):
497    return {
498        ipv6.IPV6_NEXT_HEADER_UDP:
499            ipv6.UDPDatagramFactory(
500                udp_header_factory=ipv6.UDPHeaderFactory(),
501                udp_payload_factory=create_default_based_on_src_dst_ports_udp_payload_factory(network_key),
502            ),
503        ipv6.IPV6_NEXT_HEADER_ICMP:
504            ipv6.ICMPv6Factory(body_factories=create_default_ipv6_icmp_body_factories()),
505    }
506
507
508def create_default_lowpan_extension_headers_factories():
509    return {
510        ipv6.IPV6_NEXT_HEADER_HOP_BY_HOP:
511            lowpan.LowpanHopByHopFactory(hop_by_hop_options_factory=create_default_ipv6_hop_by_hop_options_factory())
512    }
513
514
515def create_default_ipv6_extension_headers_factories():
516    return {
517        ipv6.IPV6_NEXT_HEADER_HOP_BY_HOP:
518            ipv6.HopByHopFactory(hop_by_hop_options_factory=create_default_ipv6_hop_by_hop_options_factory())
519    }
520
521
522def create_default_ipv6_packet_factory(network_key):
523    return ipv6.IPv6PacketFactory(
524        ehf=create_default_ipv6_extension_headers_factories(),
525        ulpf=create_default_ipv6_upper_layer_factories(network_key),
526    )
527
528
529def create_default_lowpan_decompressor(context_manager):
530    return lowpan.LowpanDecompressor(
531        lowpan_ip_header_factory=lowpan.LowpanIpv6HeaderFactory(context_manager=context_manager),
532        lowpan_extension_headers_factory=lowpan.LowpanExtensionHeadersFactory(
533            ext_headers_factories=create_default_lowpan_extension_headers_factories()),
534        lowpan_udp_header_factory=lowpan.LowpanUdpHeaderFactory(),
535    )
536
537
538def create_default_thread_context_manager():
539    context_manager = lowpan.ContextManager()
540    context_manager[0] = lowpan.Context(MESH_LOCAL_PREFIX)
541
542    return context_manager
543
544
545def create_default_lowpan_parser(context_manager, network_key=DEFAULT_NETWORK_KEY):
546    return lowpan.LowpanParser(
547        lowpan_mesh_header_factory=lowpan.LowpanMeshHeaderFactory(),
548        lowpan_decompressor=create_default_lowpan_decompressor(context_manager),
549        lowpan_fragements_buffers_manager=lowpan.LowpanFragmentsBuffersManager(),
550        ipv6_packet_factory=create_default_ipv6_packet_factory(network_key),
551    )
552
553
554def create_default_thread_message_factory(network_key=DEFAULT_NETWORK_KEY):
555    context_manager = create_default_thread_context_manager()
556    lowpan_parser = create_default_lowpan_parser(context_manager, network_key)
557
558    return message.MessageFactory(lowpan_parser=lowpan_parser)
559
560
561def create_default_thread_sniffer(use_message_factory=True):
562    return sniffer.Sniffer(create_default_thread_message_factory() if use_message_factory else None)
563
564
565def create_default_simulator(use_message_factory=True):
566    if VIRTUAL_TIME:
567        return simulator.VirtualTime(use_message_factory=use_message_factory)
568    return simulator.RealTime(use_message_factory=use_message_factory)
569