-
Notifications
You must be signed in to change notification settings - Fork 961
/
Copy pathMqttPubSubConnection.cs
1193 lines (1037 loc) · 51.5 KB
/
MqttPubSubConnection.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* ========================================================================
* Copyright (c) 2005-2021 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
using System;
using System.Collections.Generic;
using System.Data;
using System.Security.Cryptography.X509Certificates;
using System.Threading.Tasks;
using MQTTnet;
using MQTTnet.Client;
using MQTTnet.Formatter;
using MQTTnet.Protocol;
using Opc.Ua.PubSub.Encoding;
using Opc.Ua.PubSub.PublishedData;
using DataSet = Opc.Ua.PubSub.PublishedData.DataSet;
namespace Opc.Ua.PubSub.Transport
{
/// <summary>
/// MQTT implementation of <see cref="UaPubSubConnection"/> class.
/// </summary>
internal class MqttPubSubConnection : UaPubSubConnection, IMqttPubSubConnection
{
#region Private Fields
private string m_brokerHostName = "localhost";
private string m_urlScheme;
private int m_brokerPort = Utils.MqttDefaultPort;
private int m_reconnectIntervalSeconds = 5;
private IMqttClient m_publisherMqttClient;
private IMqttClient m_subscriberMqttClient;
private readonly MessageMapping m_messageMapping;
private readonly MessageCreator m_messageCreator;
private CertificateValidator m_certificateValidator;
private MqttClientTlsOptions m_mqttClientTlsOptions;
private MqttClientOptions m_publisherMqttClientOptions;
private MqttClientOptions m_subscriberMqttClientOptions;
private readonly List<MqttMetadataPublisher> m_metaDataPublishers = new List<MqttMetadataPublisher>();
#endregion
#region Public Properties
/// <summary>
/// Gets the host name or IP address of the broker.
/// </summary>
public string BrokerHostName { get => m_brokerHostName; }
/// <summary>
/// Gets the port of the mqttConnection.
/// </summary>
public int BrokerPort { get { return m_brokerPort; } }
/// <summary>
/// Gets the scheme of the Url.
/// </summary>
public string UrlScheme { get => m_urlScheme; }
/// <summary>
/// Gets and sets the MqttClientOptions for the publisher connection
/// </summary>
public MqttClientOptions PublisherMqttClientOptions
{
get
{
if (!IsRunning)
{
return m_publisherMqttClientOptions;
}
else
{
throw new InvalidConstraintException("Can't access PublisherMqttClientOptions if connection is started");
}
}
set
{
if (!IsRunning)
{
m_publisherMqttClientOptions = value;
}
else
{
throw new InvalidConstraintException("Can't change PublisherMqttClientOptions if connection is started");
}
}
}
/// <summary>
/// Gets and sets the MqttClientOptions for the subscriber connection
/// </summary>
public MqttClientOptions SubscriberMqttClientOptions
{
get
{
if (!IsRunning)
{
return m_subscriberMqttClientOptions;
}
else
{
throw new InvalidConstraintException("Can't access SubscriberMqttClientOptions if connection is started");
}
}
set
{
if (!IsRunning)
{
m_subscriberMqttClientOptions = value;
}
else
{
throw new InvalidConstraintException("Can't change SubscriberMqttClientOptions if connection is started");
}
}
}
#endregion Public Properties
#region Constants
/// <summary>
/// Value in seconds with which to surpass the max keep alive value found.
/// </summary>
private readonly int m_maxKeepAliveIncrement = 5;
#endregion
#region Constructor
/// <summary>
/// Create new instance of <see cref="MqttPubSubConnection"/> from <see cref="PubSubConnectionDataType"/> configuration data
/// </summary>
/// <param name="uaPubSubApplication"></param>
/// <param name="pubSubConnectionDataType"></param>
/// <param name="messageMapping"></param>
public MqttPubSubConnection(UaPubSubApplication uaPubSubApplication, PubSubConnectionDataType pubSubConnectionDataType, MessageMapping messageMapping)
: base(uaPubSubApplication, pubSubConnectionDataType)
{
m_transportProtocol = TransportProtocol.MQTT;
m_messageMapping = messageMapping;
// initialize the message creators for current message
if (m_messageMapping == MessageMapping.Json)
{
m_messageCreator = new JsonMessageCreator(this);
}
else if (m_messageMapping == MessageMapping.Uadp)
{
m_messageCreator = new UadpMessageCreator(this);
}
else
{
Utils.Trace(Utils.TraceMasks.Error, "The current MessageMapping {0} does not have a valid message creator", m_messageMapping);
}
m_publisherMqttClientOptions = GetMqttClientOptions();
m_subscriberMqttClientOptions = GetMqttClientOptions();
Utils.Trace("MqttPubSubConnection with name '{0}' was created.", pubSubConnectionDataType.Name);
}
#endregion
#region Public Methods
/// <summary>
/// Determine if the connection can publish metadata for specified writer group and data set writer
/// </summary>
public bool CanPublishMetaData(WriterGroupDataType writerGroupConfiguration,
DataSetWriterDataType dataSetWriter)
{
return !CanPublish(writerGroupConfiguration)
? false
: Application.UaPubSubConfigurator.FindStateForObject(dataSetWriter) == PubSubState.Operational;
}
/// <summary>
/// Create the list of network messages built from the provided writerGroupConfiguration
/// </summary>
public override IList<UaNetworkMessage> CreateNetworkMessages(WriterGroupDataType writerGroupConfiguration, WriterGroupPublishState state)
{
if (!(ExtensionObject.ToEncodeable(writerGroupConfiguration.TransportSettings) is BrokerWriterGroupTransportDataType))
{
//Wrong configuration of writer group MessageSettings
return null;
}
if (m_messageCreator != null)
{
return m_messageCreator.CreateNetworkMessages(writerGroupConfiguration, state);
}
// no other encoding is implemented
return null;
}
/// <summary>
/// Create and return the DataSetMetaData message for a DataSetWriter
/// </summary>
/// <returns></returns>
public UaNetworkMessage CreateDataSetMetaDataNetworkMessage(WriterGroupDataType writerGroup, DataSetWriterDataType dataSetWriter)
{
PublishedDataSetDataType publishedDataSet = Application.DataCollector.GetPublishedDataSet(dataSetWriter.DataSetName);
if (publishedDataSet != null && publishedDataSet.DataSetMetaData != null)
{
if (m_messageCreator != null)
{
return m_messageCreator.CreateDataSetMetaDataNetworkMessage(writerGroup,
dataSetWriter.DataSetWriterId, publishedDataSet.DataSetMetaData);
}
}
return null;
}
/// <summary>
/// Publish the network message
/// </summary>
public override bool PublishNetworkMessage(UaNetworkMessage networkMessage)
{
if (networkMessage == null || m_publisherMqttClient == null)
{
return false;
}
try
{
lock (Lock)
{
if (m_publisherMqttClient != null && m_publisherMqttClient.IsConnected)
{
// get the encoded bytes
byte[] bytes = networkMessage.Encode(MessageContext);
try
{
string queueName = null;
BrokerTransportQualityOfService qos = BrokerTransportQualityOfService.AtLeastOnce;
// the network messages that have DataSetWriterId are either metaData messages or SingleDataSet messages and
if (networkMessage.DataSetWriterId != null)
{
DataSetWriterDataType dataSetWriter = networkMessage.WriterGroupConfiguration.DataSetWriters
.Find(x => x.DataSetWriterId == networkMessage.DataSetWriterId);
if (dataSetWriter != null)
{
if (ExtensionObject
.ToEncodeable(dataSetWriter.TransportSettings) is BrokerDataSetWriterTransportDataType transportSettings)
{
qos = transportSettings.RequestedDeliveryGuarantee;
queueName = networkMessage.IsMetaDataMessage ? transportSettings.MetaDataQueueName : transportSettings.QueueName;
}
}
}
if (queueName == null || qos == BrokerTransportQualityOfService.NotSpecified)
{
if (ExtensionObject.ToEncodeable(
networkMessage.WriterGroupConfiguration.TransportSettings) is BrokerWriterGroupTransportDataType transportSettings)
{
if (queueName == null)
{
queueName = transportSettings.QueueName;
}
// if the value is not specified and the value of the parent object shall be used
if (qos == BrokerTransportQualityOfService.NotSpecified)
{
qos = transportSettings.RequestedDeliveryGuarantee;
}
}
}
if (!String.IsNullOrEmpty(queueName))
{
var message = new MqttApplicationMessage {
Topic = queueName,
PayloadSegment = new ArraySegment<byte>(bytes),
QualityOfServiceLevel = GetMqttQualityOfServiceLevel(qos),
Retain = networkMessage.IsMetaDataMessage
};
m_publisherMqttClient.PublishAsync(message).GetAwaiter().GetResult();
}
}
catch (Exception ex)
{
Utils.Trace(ex, "MqttPubSubConnection.PublishNetworkMessage");
return false;
}
return true;
}
}
}
catch (Exception ex)
{
Utils.Trace(ex, "MqttPubSubConnection.PublishNetworkMessage");
return false;
}
return false;
}
/// <summary>
/// Get flag that indicates if all the network connections are active and connected
/// </summary>
public override bool AreClientsConnected()
{
// Check if existing clients are connected
return (m_publisherMqttClient == null || m_publisherMqttClient.IsConnected)
&& (m_subscriberMqttClient == null || m_subscriberMqttClient.IsConnected);
}
#endregion Public Methods
#region Protected Methods
/// <summary>
/// Perform specific Start tasks
/// </summary>
protected override async Task InternalStart()
{
//cleanup all existing MQTT connections previously open
await InternalStop().ConfigureAwait(false);
lock (Lock)
{
if (!(ExtensionObject.ToEncodeable(
PubSubConnectionConfiguration.Address) is NetworkAddressUrlDataType networkAddressUrlState))
{
Utils.Trace(
Utils.TraceMasks.Error,
"The configuration for mqttConnection {0} has invalid Address configuration.",
PubSubConnectionConfiguration.Name);
return;
}
Uri connectionUri;
m_urlScheme = null;
if (networkAddressUrlState.Url != null && Uri.TryCreate(networkAddressUrlState.Url, UriKind.Absolute, out connectionUri))
{
if ((connectionUri.Scheme == Utils.UriSchemeMqtt) || (connectionUri.Scheme == Utils.UriSchemeMqtts))
{
if (!String.IsNullOrEmpty(connectionUri.Host))
{
m_brokerHostName = connectionUri.Host;
m_brokerPort = (connectionUri.Port > 0) ? connectionUri.Port : ((connectionUri.Scheme == Utils.UriSchemeMqtt) ? 1883 : 8883);
m_urlScheme = connectionUri.Scheme;
}
}
}
if (m_urlScheme == null)
{
Utils.Trace(
Utils.TraceMasks.Error,
"The configuration for mqttConnection {0} has invalid MQTT URL '{1}'.",
PubSubConnectionConfiguration.Name,
networkAddressUrlState.Url);
return;
}
// create the DataSetMetaData publishers
foreach (WriterGroupDataType writerGroup in PubSubConnectionConfiguration.WriterGroups)
{
foreach (DataSetWriterDataType dataSetWriter in writerGroup.DataSetWriters)
{
if (dataSetWriter.DataSetWriterId == 0)
{
continue;
}
if (!(ExtensionObject.ToEncodeable(dataSetWriter.TransportSettings) is BrokerDataSetWriterTransportDataType transport) || transport.MetaDataUpdateTime == 0)
{
continue;
}
m_metaDataPublishers.Add(new MqttMetadataPublisher(this, writerGroup, dataSetWriter, transport.MetaDataUpdateTime));
}
}
// start the mqtt metadata publishers
foreach (MqttMetadataPublisher metaDataPublisher in m_metaDataPublishers)
{
metaDataPublisher.Start();
}
}
MqttClient publisherClient = null;
MqttClient subscriberClient = null;
if (m_publisherMqttClientOptions == null)
{
m_publisherMqttClientOptions = GetMqttClientOptions();
}
int nrOfPublishers = Publishers.Count;
int nrOfSubscribers = GetAllDataSetReaders().Count;
//publisher initialization
if (nrOfPublishers > 0)
{
publisherClient = (MqttClient)await MqttClientCreator.GetMqttClientAsync(
m_reconnectIntervalSeconds,
m_publisherMqttClientOptions,
null).ConfigureAwait(false);
}
//subscriber initialization
if (nrOfSubscribers > 0)
{
// collect all topics from all ReaderGroups
var topics = new StringCollection();
foreach (ReaderGroupDataType readerGroup in PubSubConnectionConfiguration.ReaderGroups)
{
if (!readerGroup.Enabled)
{
continue;
}
foreach (DataSetReaderDataType dataSetReader in readerGroup.DataSetReaders)
{
if (!dataSetReader.Enabled)
{
continue;
}
if (ExtensionObject.ToEncodeable(dataSetReader.TransportSettings) is BrokerDataSetReaderTransportDataType brokerTransportSettings && !topics.Contains(brokerTransportSettings.QueueName))
{
topics.Add(brokerTransportSettings.QueueName);
if (brokerTransportSettings.MetaDataQueueName != null)
{
topics.Add(brokerTransportSettings.MetaDataQueueName);
}
}
}
}
if (m_subscriberMqttClientOptions == null)
{
m_subscriberMqttClientOptions = GetMqttClientOptions();
}
subscriberClient = (MqttClient)await MqttClientCreator.GetMqttClientAsync(
m_reconnectIntervalSeconds,
m_subscriberMqttClientOptions,
ProcessMqttMessage,
topics).ConfigureAwait(false);
}
lock (Lock)
{
m_publisherMqttClient = publisherClient;
m_subscriberMqttClient = subscriberClient;
}
Utils.Trace("Connection '{0}' started {1} publishers and {2} subscribers.",
PubSubConnectionConfiguration.Name, nrOfPublishers, nrOfSubscribers);
}
/// <summary>
/// Perform specific Stop tasks
/// </summary>
protected override async Task InternalStop()
{
IMqttClient publisherMqttClient = m_publisherMqttClient;
IMqttClient subscriberMqttClient = m_subscriberMqttClient;
void DisposeCerts(X509CertificateCollection certificates)
{
if (certificates != null)
{
// dispose certificates
foreach (X509Certificate cert in certificates)
{
Utils.SilentDispose(cert);
}
}
}
async Task InternalStop(IMqttClient client)
{
if (client != null)
{
X509CertificateCollection certificates = client.Options?.ChannelOptions?.TlsOptions?.ClientCertificatesProvider?.GetCertificates();
if (client.IsConnected)
{
await client.DisconnectAsync().ContinueWith((e) => {
DisposeCerts(certificates);
Utils.SilentDispose(client);
}).ConfigureAwait(false);
}
else
{
DisposeCerts(certificates);
Utils.SilentDispose(client);
}
}
}
await InternalStop(publisherMqttClient).ConfigureAwait(false);
await InternalStop(subscriberMqttClient).ConfigureAwait(false);
if (m_metaDataPublishers != null)
{
foreach (MqttMetadataPublisher metaDataPublisher in m_metaDataPublishers)
{
metaDataPublisher.Stop();
}
m_metaDataPublishers.Clear();
}
lock (Lock)
{
m_publisherMqttClient = null;
m_subscriberMqttClient = null;
m_mqttClientTlsOptions = null;
}
}
#endregion Protected Methods
#region Private Methods
private static bool MatchTopic(string pattern, string topic)
{
if (String.IsNullOrEmpty(pattern) || pattern == "#")
{
return true;
}
string[] fields1 = pattern.Split('/');
string[] fields2 = topic.Split('/');
for (int ii = 0; ii < fields1.Length && ii < fields2.Length; ii++)
{
if (fields1[ii] == "#")
{
return true;
}
if (fields1[ii] != "+" && fields1[ii] != fields2[ii])
{
return false;
}
}
return fields1.Length == fields2.Length;
}
/// <summary>
/// Processes a message from the MQTT broker.
/// </summary>
/// <param name="eventArgs"></param>
private Task ProcessMqttMessage(MqttApplicationMessageReceivedEventArgs eventArgs)
{
string topic = eventArgs.ApplicationMessage.Topic;
Utils.Trace("MQTTConnection - ProcessMqttMessage() received from topic={0}", topic);
// get the datasetreaders for received message topic
var dataSetReaders = new List<DataSetReaderDataType>();
foreach (DataSetReaderDataType dsReader in GetOperationalDataSetReaders())
{
if (dsReader == null)
{
continue;
}
var brokerDataSetReaderTransportDataType =
ExtensionObject.ToEncodeable(dsReader.TransportSettings)
as BrokerDataSetReaderTransportDataType;
string queueName = brokerDataSetReaderTransportDataType.QueueName;
string metadataQueueName = brokerDataSetReaderTransportDataType.MetaDataQueueName;
if (!MatchTopic(queueName, topic))
{
if (String.IsNullOrEmpty(metadataQueueName))
{
continue;
}
if (!MatchTopic(metadataQueueName, topic))
{
continue;
}
}
// At this point the message is accepted
// if ((topic.Length == queueName.Length) && (topic == queueName)) || (queueName == #)
dataSetReaders.Add(dsReader);
}
if (dataSetReaders.Count > 0)
{
// raise RawData received event
var rawDataReceivedEventArgs = new RawDataReceivedEventArgs() {
Message = eventArgs.ApplicationMessage.PayloadSegment.Array,
Source = topic,
TransportProtocol = TransportProtocol,
MessageMapping = m_messageMapping,
PubSubConnectionConfiguration = PubSubConnectionConfiguration
};
// trigger notification for received raw data
Application.RaiseRawDataReceivedEvent(rawDataReceivedEventArgs);
// check if the RawData message is marked as handled
if (rawDataReceivedEventArgs.Handled)
{
Utils.Trace("MqttConnection message from topic={0} is marked as handled and will not be decoded.", topic);
return Task.CompletedTask;
}
// initialize the expected NetworkMessage
UaNetworkMessage networkMessage = m_messageCreator.CreateNewNetworkMessage();
// trigger message decoding
if (networkMessage != null)
{
networkMessage.Decode(MessageContext, eventArgs.ApplicationMessage.PayloadSegment.Array, dataSetReaders);
// Handle the decoded message and raise the necessary event on UaPubSubApplication
ProcessDecodedNetworkMessage(networkMessage, topic);
}
}
else
{
Utils.Trace("MqttConnection - ProcessMqttMessage() No DataSetReader is registered for topic={0}.", topic);
}
return Task.CompletedTask;
}
/// <summary>
/// Transform pub sub setting into MqttNet enum
/// </summary>
/// <param name="brokerTransportQualityOfService"></param>
/// <returns></returns>
private static MqttQualityOfServiceLevel GetMqttQualityOfServiceLevel(BrokerTransportQualityOfService brokerTransportQualityOfService)
{
switch (brokerTransportQualityOfService)
{
case BrokerTransportQualityOfService.AtLeastOnce:
return MqttQualityOfServiceLevel.AtLeastOnce;
case BrokerTransportQualityOfService.AtMostOnce:
return MqttQualityOfServiceLevel.AtMostOnce;
case BrokerTransportQualityOfService.ExactlyOnce:
return MqttQualityOfServiceLevel.ExactlyOnce;
default:
return MqttQualityOfServiceLevel.AtLeastOnce;
}
}
/// <summary>
/// Get appropriate IMqttClientOptions with which to connect to the MQTTBroker
/// </summary>
/// <returns></returns>
private MqttClientOptions GetMqttClientOptions()
{
MqttClientOptions mqttOptions = null;
var mqttKeepAlive = TimeSpan.FromSeconds(GetWriterGroupsMaxKeepAlive() + m_maxKeepAliveIncrement);
if (!(ExtensionObject.ToEncodeable(PubSubConnectionConfiguration.Address) is NetworkAddressUrlDataType networkAddressUrlState))
{
Utils.Trace(Utils.TraceMasks.Error,
"The configuration for mqttConnection {0} has invalid Address configuration.",
PubSubConnectionConfiguration.Name);
return null;
}
Uri connectionUri = null;
if (networkAddressUrlState.Url != null &&
Uri.TryCreate(networkAddressUrlState.Url, UriKind.Absolute, out connectionUri))
{
if ((connectionUri.Scheme != Utils.UriSchemeMqtt) && (connectionUri.Scheme != Utils.UriSchemeMqtts))
{
Utils.Trace(Utils.TraceMasks.Error,
"The configuration for mqttConnection '{0}' has an invalid Url value {1}. The Uri scheme should be either {2}:// or {3}://",
PubSubConnectionConfiguration.Name,
networkAddressUrlState.Url,
Utils.UriSchemeMqtt,
Utils.UriSchemeMqtts);
return null;
}
}
if (connectionUri == null)
{
Utils.Trace(Utils.TraceMasks.Error,
"The configuration for mqttConnection '{0}' has an invalid Url value {1}.",
PubSubConnectionConfiguration.Name,
networkAddressUrlState.Url);
return null;
}
ITransportProtocolConfiguration transportProtocolConfiguration =
new MqttClientProtocolConfiguration(PubSubConnectionConfiguration.ConnectionProperties);
if (transportProtocolConfiguration is MqttClientProtocolConfiguration mqttProtocolConfiguration)
{
var mqttProtocolVersion =
(MqttProtocolVersion)((MqttClientProtocolConfiguration)transportProtocolConfiguration)
.ProtocolVersion;
// create uniques client id
string clientId = $"ClientId_{new Random().Next():D10}";
// MQTTS mqttConnection.
if (connectionUri.Scheme == Utils.UriSchemeMqtts)
{
MqttTlsOptions mqttTlsOptions =
((MqttClientProtocolConfiguration)transportProtocolConfiguration).MqttTlsOptions;
var x509Certificate2s = new List<X509Certificate2>();
if (mqttTlsOptions?.Certificates != null)
{
foreach (X509Certificate x509cert in mqttTlsOptions?.Certificates.X509Certificates)
{
x509Certificate2s.Add(new X509Certificate2(x509cert.Handle));
}
}
MqttClientOptionsBuilder mqttClientOptionsBuilder = new MqttClientOptionsBuilder()
.WithTcpServer(m_brokerHostName, m_brokerPort)
.WithKeepAlivePeriod(mqttKeepAlive)
.WithProtocolVersion(mqttProtocolVersion)
.WithClientId(clientId)
.WithTlsOptions(o => {
o.UseTls(true);
o.WithClientCertificates(x509Certificate2s);
o.WithSslProtocols(mqttTlsOptions?.SslProtocolVersion ??
System.Security.Authentication.SslProtocols.None);// Allow OS to choose best option
o.WithAllowUntrustedCertificates(mqttTlsOptions?.AllowUntrustedCertificates ?? false);
o.WithIgnoreCertificateChainErrors(mqttTlsOptions?.IgnoreCertificateChainErrors ?? false);
o.WithIgnoreCertificateRevocationErrors(mqttTlsOptions?.IgnoreRevocationListErrors ?? false);
o.WithCertificateValidationHandler(ValidateBrokerCertificate);
});
// Set user credentials.
if (mqttProtocolConfiguration.UseCredentials)
{
mqttClientOptionsBuilder.WithCredentials(
new System.Net.NetworkCredential(string.Empty, mqttProtocolConfiguration.UserName)
.Password,
new System.Net.NetworkCredential(string.Empty, mqttProtocolConfiguration.Password)
.Password);
// Set ClientId for Azure.
if (mqttProtocolConfiguration.UseAzureClientId)
{
mqttClientOptionsBuilder.WithClientId(mqttProtocolConfiguration.AzureClientId);
}
}
mqttOptions = mqttClientOptionsBuilder.Build();
// Create the certificate validator for broker certificates.
m_certificateValidator = CreateCertificateValidator(mqttTlsOptions);
m_certificateValidator.CertificateValidation += CertificateValidator_CertificateValidation;
m_mqttClientTlsOptions = mqttOptions?.ChannelOptions?.TlsOptions;
}
// MQTT mqttConnection
else if (connectionUri.Scheme == Utils.UriSchemeMqtt)
{
MqttClientOptionsBuilder mqttClientOptionsBuilder = new MqttClientOptionsBuilder()
.WithTcpServer(m_brokerHostName, m_brokerPort)
.WithKeepAlivePeriod(mqttKeepAlive)
.WithClientId(clientId)
.WithProtocolVersion(mqttProtocolVersion);
// Set user credentials.
if (mqttProtocolConfiguration.UseCredentials)
{
mqttClientOptionsBuilder.WithCredentials(
new System.Net.NetworkCredential(string.Empty, mqttProtocolConfiguration.UserName)
.Password,
new System.Net.NetworkCredential(string.Empty, mqttProtocolConfiguration.Password)
.Password);
}
mqttOptions = mqttClientOptionsBuilder.Build();
}
}
return mqttOptions;
}
/// <summary>
/// Set up a new instance of a certificate validator based on passed in tls options
/// </summary>
/// <param name="mqttTlsOptions"><see cref="MqttTlsOptions"/></param>
/// <returns>A new instance of stack validator <see cref="CertificateValidator"/></returns>
private static CertificateValidator CreateCertificateValidator(MqttTlsOptions mqttTlsOptions)
{
var certificateValidator = new CertificateValidator();
var securityConfiguration = new SecurityConfiguration {
TrustedIssuerCertificates = (CertificateTrustList)mqttTlsOptions.TrustedIssuerCertificates,
TrustedPeerCertificates = (CertificateTrustList)mqttTlsOptions.TrustedPeerCertificates,
RejectedCertificateStore = mqttTlsOptions.RejectedCertificateStore,
RejectSHA1SignedCertificates = true,
AutoAcceptUntrustedCertificates = mqttTlsOptions.AllowUntrustedCertificates,
RejectUnknownRevocationStatus = !mqttTlsOptions.IgnoreRevocationListErrors
};
certificateValidator.UpdateAsync(securityConfiguration).Wait();
return certificateValidator;
}
/// <summary>
/// Validates the broker certificate.
/// </summary>
/// <param name="context">The context of the validation</param>
private bool ValidateBrokerCertificate(MqttClientCertificateValidationEventArgs context)
{
var brokerCertificate = new X509Certificate2(context.Certificate.GetRawCertData());
try
{
// check if the broker certificate validation has been overridden.
if (Application?.OnValidateBrokerCertificate != null)
{
return Application.OnValidateBrokerCertificate(brokerCertificate);
}
else
{
m_certificateValidator?.Validate(brokerCertificate);
}
}
catch (Exception ex)
{
Utils.Trace(ex, "Connection '{0}' - Broker certificate '{1}' rejected.",
PubSubConnectionConfiguration.Name, brokerCertificate.Subject);
return false;
}
Utils.Trace(Utils.TraceMasks.Security, "Connection '{0}' - Broker certificate '{1}' accepted.",
PubSubConnectionConfiguration.Name, brokerCertificate.Subject);
return true;
}
/// <summary>
/// Handler for validation errors of MQTT broker certificate.
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void CertificateValidator_CertificateValidation(CertificateValidator sender, CertificateValidationEventArgs e)
{
try
{
if (((e.Error.StatusCode == StatusCodes.BadCertificateRevocationUnknown) ||
(e.Error.StatusCode == StatusCodes.BadCertificateIssuerRevocationUnknown) ||
(e.Error.StatusCode == StatusCodes.BadCertificateRevoked) ||
(e.Error.StatusCode == StatusCodes.BadCertificateIssuerRevoked)) &&
(m_mqttClientTlsOptions?.IgnoreCertificateRevocationErrors ?? false))
{
// Accept broker certificate with revocation errors.
e.Accept = true;
}
else if ((e.Error.StatusCode == StatusCodes.BadCertificateChainIncomplete) &&
(m_mqttClientTlsOptions?.IgnoreCertificateChainErrors ?? false))
{
// Accept broker certificate with chain errors.
e.Accept = true;
}
else if ((e.Error.StatusCode == StatusCodes.BadCertificateUntrusted) &&
(m_mqttClientTlsOptions?.AllowUntrustedCertificates ?? false))
{
// Accept untrusted broker certificate.
e.Accept = true;
}
}
catch (Exception ex)
{
Utils.Trace(ex, "MqttPubSubConnection.CertificateValidation error.");
}
}
#endregion Private methods
#region MessageCreator innner classes
/// <summary>
/// Base abstract class for MessageCreator
/// </summary>
private abstract class MessageCreator
{
protected readonly MqttPubSubConnection m_mqttConnection;
/// <summary>
/// Create new instance of <see cref="MessageCreator"/>
/// </summary>
protected MessageCreator(MqttPubSubConnection mqttConnection)
{
m_mqttConnection = mqttConnection;
}
/// <summary>
/// Create and return a new instance of the right <see cref="UaNetworkMessage"/> implementation.
/// </summary>
/// <returns></returns>
public abstract UaNetworkMessage CreateNewNetworkMessage();
/// <summary>
/// Create the list of network messages to be published by the publisher
/// </summary>
public abstract IList<UaNetworkMessage> CreateNetworkMessages(WriterGroupDataType writerGroupConfiguration,
WriterGroupPublishState state);
/// <summary>
/// Create and return the Json DataSetMetaData message for a DataSetWriter
/// </summary>
public abstract UaNetworkMessage CreateDataSetMetaDataNetworkMessage(WriterGroupDataType writerGroup, UInt16 dataSetWriterId,
DataSetMetaDataType dataSetMetaData);
}
/// <summary>
/// The Json implementation for the Message creator
/// </summary>
private class JsonMessageCreator : MessageCreator
{
/// <summary>
/// Create new instance of <see cref="JsonMessageCreator"/>
/// </summary>
public JsonMessageCreator(MqttPubSubConnection mqttConnection) : base(mqttConnection)
{
}
/// <summary>
/// Create and return a new instance of the right <see cref="JsonNetworkMessage"/>.
/// </summary>
public override UaNetworkMessage CreateNewNetworkMessage()
{
return new JsonNetworkMessage();
}
/// <summary>
/// The Json implementation of CreateNetworkMessages for MQTT mqttConnection
/// </summary>
public override IList<UaNetworkMessage> CreateNetworkMessages(WriterGroupDataType writerGroupConfiguration,
WriterGroupPublishState state)
{
if (!(ExtensionObject.ToEncodeable(
writerGroupConfiguration.MessageSettings) is JsonWriterGroupMessageDataType jsonMessageSettings))
{
//Wrong configuration of writer group MessageSettings
return null;
}
//Create list of dataSet messages to be sent
var jsonDataSetMessages = new List<JsonDataSetMessage>();
var networkMessages = new List<UaNetworkMessage>();
foreach (DataSetWriterDataType dataSetWriter in writerGroupConfiguration.DataSetWriters)
{
//check if dataSetWriter enabled
if (dataSetWriter.Enabled)
{
DataSet dataSet = m_mqttConnection.CreateDataSet(dataSetWriter, state);
if (dataSet != null)
{
// check if the MetaData version is changed and issue a MetaData message
bool hasMetaDataChanged = state.HasMetaDataChanged(dataSetWriter, dataSet.DataSetMetaData);
if (hasMetaDataChanged)
{
networkMessages.Add(CreateDataSetMetaDataNetworkMessage(writerGroupConfiguration, dataSetWriter.DataSetWriterId, dataSet.DataSetMetaData));
}
if (ExtensionObject.ToEncodeable(dataSetWriter.MessageSettings) is JsonDataSetWriterMessageDataType jsonDataSetMessageSettings)
{
var jsonDataSetMessage = new JsonDataSetMessage(dataSet) {
DataSetMessageContentMask = (JsonDataSetMessageContentMask)jsonDataSetMessageSettings.DataSetMessageContentMask
};