-
Notifications
You must be signed in to change notification settings - Fork 51
/
Copy pathmqtt_client.c
1473 lines (1371 loc) · 56.7 KB
/
mqtt_client.c
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) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
#include <stdlib.h>
#include <stdbool.h>
#include "azure_c_shared_utility/agenttime.h"
#include "azure_c_shared_utility/const_defines.h"
#include "azure_c_shared_utility/crt_abstractions.h"
#include "azure_c_shared_utility/gballoc.h"
#include "azure_c_shared_utility/optimize_size.h"
#include "azure_macro_utils/macro_utils.h"
#include "azure_c_shared_utility/platform.h"
#include "azure_c_shared_utility/strings.h"
#include "azure_c_shared_utility/threadapi.h"
#include "azure_c_shared_utility/tickcounter.h"
#include "azure_c_shared_utility/xlogging.h"
#include "azure_c_shared_utility/safe_math.h"
#include "azure_umqtt_c/mqtt_client.h"
#include "azure_umqtt_c/mqtt_codec.h"
#include <inttypes.h>
#define VARIABLE_HEADER_OFFSET 2
#define RETAIN_FLAG_MASK 0x1
#define QOS_LEAST_ONCE_FLAG_MASK 0x2
#define QOS_EXACTLY_ONCE_FLAG_MASK 0x4
#define DUPLICATE_FLAG_MASK 0x8
#define CONNECT_PACKET_MASK 0xf0
#define TIME_MAX_BUFFER 16
#define DEFAULT_MAX_PING_RESPONSE_TIME 80 // % of time to send pings
#define MAX_CLOSE_RETRIES 20
static const char* const TRUE_CONST = "true";
static const char* const FALSE_CONST = "false";
MU_DEFINE_ENUM_STRINGS_2(QOS_VALUE, QOS_VALUE_VALUES);
#define MQTT_STATUS_INITIAL_STATUS 0x0000
#define MQTT_STATUS_CLIENT_CONNECTED 0x0001
#define MQTT_STATUS_SOCKET_CONNECTED 0x0002
#define MQTT_STATUS_PENDING_CLOSE 0x0004
#define MQTT_FLAGS_LOG_TRACE 0x0001
#define MQTT_FLAGS_RAW_TRACE 0x0002
typedef struct MQTT_CLIENT_TAG
{
XIO_HANDLE xioHandle;
MQTTCODEC_HANDLE codec_handle;
CONTROL_PACKET_TYPE packetState;
TICK_COUNTER_HANDLE packetTickCntr;
tickcounter_ms_t packetSendTimeMs;
ON_MQTT_OPERATION_CALLBACK fnOperationCallback;
ON_MQTT_MESSAGE_RECV_CALLBACK fnMessageRecv;
void* ctx;
ON_MQTT_ERROR_CALLBACK fnOnErrorCallBack;
void* errorCBCtx;
ON_MQTT_DISCONNECTED_CALLBACK disconnect_cb;
void* disconnect_ctx;
QOS_VALUE qosValue;
uint16_t keepAliveInterval;
MQTT_CLIENT_OPTIONS mqttOptions;
uint16_t mqtt_status;
uint16_t mqtt_flags;
tickcounter_ms_t timeSincePing;
uint16_t maxPingRespTime;
} MQTT_CLIENT;
static bool is_trace_enabled(MQTT_CLIENT* mqtt_client)
{
return (mqtt_client->mqtt_flags & MQTT_FLAGS_LOG_TRACE);
}
#ifdef ENABLE_RAW_TRACE
static bool is_raw_trace_enabled(MQTT_CLIENT* mqtt_client)
{
return (mqtt_client->mqtt_flags & MQTT_FLAGS_RAW_TRACE);
}
#endif // ENABLE_RAW_TRACE
static void on_connection_closed(void* context)
{
MQTT_CLIENT* mqtt_client = (MQTT_CLIENT*)context;
if (mqtt_client != NULL)
{
mqtt_client->mqtt_status &= ~MQTT_STATUS_SOCKET_CONNECTED;
if (mqtt_client->disconnect_cb)
{
mqtt_client->disconnect_cb(mqtt_client->disconnect_ctx);
}
}
}
static void close_connection(MQTT_CLIENT* mqtt_client)
{
if (mqtt_client->mqtt_status & MQTT_STATUS_SOCKET_CONNECTED)
{
(void)xio_close(mqtt_client->xioHandle, on_connection_closed, mqtt_client);
if (mqtt_client->disconnect_cb == NULL)
{
size_t counter = 0;
do
{
xio_dowork(mqtt_client->xioHandle);
counter++;
ThreadAPI_Sleep(2);
} while (mqtt_client->mqtt_status & MQTT_STATUS_SOCKET_CONNECTED && counter < MAX_CLOSE_RETRIES);
}
// Clear the handle because we don't use it anymore
mqtt_client->xioHandle = NULL;
}
else
{
mqtt_client->mqtt_status &= ~MQTT_STATUS_SOCKET_CONNECTED;
if (mqtt_client->disconnect_cb)
{
mqtt_client->disconnect_cb(mqtt_client->disconnect_ctx);
}
}
}
static void set_error_callback(MQTT_CLIENT* mqtt_client, MQTT_CLIENT_EVENT_ERROR error_type)
{
if (mqtt_client->fnOnErrorCallBack)
{
mqtt_client->fnOnErrorCallBack(mqtt_client, error_type, mqtt_client->errorCBCtx);
}
close_connection(mqtt_client);
}
static STRING_HANDLE construct_trace_log_handle(MQTT_CLIENT* mqtt_client)
{
STRING_HANDLE trace_log;
if (is_trace_enabled(mqtt_client) )
{
trace_log = STRING_new();
}
else
{
trace_log = NULL;
}
return trace_log;
}
static uint16_t byteutil_read_uint16(uint8_t** buffer, size_t byteLen)
{
uint16_t result = 0;
if (buffer != NULL && *buffer != NULL && byteLen >= 2)
{
result = 256 * (**buffer) + (*(*buffer + 1));
*buffer += 2; // Move the ptr
}
else
{
LogError("byteutil_read_uint16 == NULL or less than 2");
}
return result;
}
static char* byteutil_readUTF(uint8_t** buffer, size_t* byteLen)
{
char* result = NULL;
const uint8_t* bufferInitial = *buffer;
// Get the length of the string
uint16_t stringLen = byteutil_read_uint16(buffer, *byteLen);
// Verify that byteutil_read_uint16 succeeded (by stringLen>0) and that we're
// not being asked to read a string longer than buffer passed in.
if ((stringLen > 0) && ((size_t)(stringLen + (*buffer - bufferInitial)) <= *byteLen))
{
size_t malloc_size = safe_add_size_t((size_t)stringLen, 1);
if (malloc_size != SIZE_MAX &&
(result = (char*)malloc(malloc_size)) != NULL)
{
(void)memcpy(result, *buffer, stringLen);
result[stringLen] = '\0';
*buffer += stringLen;
*byteLen = stringLen;
}
else
{
LogError("Cannot alloc memory, size:%zu", malloc_size);
}
}
else
{
LogError("String passed not a valid UTF.");
}
return result;
}
static uint8_t byteutil_readByte(uint8_t** buffer)
{
uint8_t result = 0;
if (buffer != NULL)
{
result = **buffer;
(*buffer)++;
}
else
{
LogError("readByte buffer == NULL.");
}
return result;
}
static void sendComplete(void* context, IO_SEND_RESULT send_result)
{
MQTT_CLIENT* mqtt_client = (MQTT_CLIENT*)context;
if (mqtt_client != NULL)
{
if (send_result == IO_SEND_OK)
{
if (mqtt_client->packetState == DISCONNECT_TYPE)
{
/*Codes_SRS_MQTT_CLIENT_07_032: [If the actionResult parameter is of type MQTT_CLIENT_ON_DISCONNECT the the msgInfo value shall be NULL.]*/
if (mqtt_client->fnOperationCallback != NULL)
{
mqtt_client->fnOperationCallback(mqtt_client, MQTT_CLIENT_ON_DISCONNECT, NULL, mqtt_client->ctx);
}
// Mark to close
mqtt_client->mqtt_status |= MQTT_STATUS_PENDING_CLOSE;
}
}
else if (send_result == IO_SEND_ERROR)
{
LogError("MQTT Send Complete Failure send_result: %d", (int)send_result);
set_error_callback(mqtt_client, MQTT_CLIENT_COMMUNICATION_ERROR);
}
}
else
{
LogError("MQTT Send Complete Failure with NULL mqtt_client");
}
}
#ifndef NO_LOGGING
static void getLogTime(char* timeResult, size_t len)
{
if (timeResult != NULL)
{
time_t agent_time = get_time(NULL);
if (agent_time == (time_t)-1)
{
timeResult[0] = '\0';
}
else
{
struct tm* tmInfo = localtime(&agent_time);
if (tmInfo == NULL)
{
timeResult[0] = '\0';
}
else
{
if (strftime(timeResult, len, "%H:%M:%S", tmInfo) == 0)
{
timeResult[0] = '\0';
}
}
}
}
}
#ifdef ENABLE_RAW_TRACE
static const char* retrievePacketType(CONTROL_PACKET_TYPE packet)
{
switch (packet&CONNECT_PACKET_MASK)
{
case CONNECT_TYPE: return "CONNECT";
case CONNACK_TYPE: return "CONNACK";
case PUBLISH_TYPE: return "PUBLISH";
case PUBACK_TYPE: return "PUBACK";
case PUBREC_TYPE: return "PUBREC";
case PUBREL_TYPE: return "PUBREL";
case SUBSCRIBE_TYPE: return "SUBSCRIBE";
case SUBACK_TYPE: return "SUBACK";
case UNSUBSCRIBE_TYPE: return "UNSUBSCRIBE";
case UNSUBACK_TYPE: return "UNSUBACK";
case PINGREQ_TYPE: return "PINGREQ";
case PINGRESP_TYPE: return "PINGRESP";
case DISCONNECT_TYPE: return "DISCONNECT";
default:
case PACKET_TYPE_ERROR:
case UNKNOWN_TYPE:
return "UNKNOWN";
}
}
static void logOutgoingRawTrace(MQTT_CLIENT* mqtt_client, const uint8_t* data, size_t length)
{
if (mqtt_client != NULL && data != NULL && length > 0 && is_raw_trace_enabled(mqtt_client))
{
char tmBuffer[TIME_MAX_BUFFER];
getLogTime(tmBuffer, TIME_MAX_BUFFER);
LOG(AZ_LOG_TRACE, 0, "-> %s %s: ", tmBuffer, retrievePacketType((unsigned char)data[0]));
size_t index = 0;
for (index = 0; index < length; index++)
{
LOG(AZ_LOG_TRACE, 0, "0x%02x ", data[index]);
}
LOG(AZ_LOG_TRACE, LOG_LINE, " ");
}
}
static void logIncomingRawTrace(MQTT_CLIENT* mqtt_client, CONTROL_PACKET_TYPE packet, uint8_t flags, const uint8_t* data, size_t length)
{
if (mqtt_client != NULL && is_raw_trace_enabled(mqtt_client))
{
if (data != NULL && length > 0)
{
char tmBuffer[TIME_MAX_BUFFER];
getLogTime(tmBuffer, TIME_MAX_BUFFER);
LOG(AZ_LOG_TRACE, 0, "<- %s %s: 0x%02x 0x%02x ", tmBuffer, retrievePacketType((CONTROL_PACKET_TYPE)packet), (unsigned int)(packet | flags), (unsigned int)length);
size_t index = 0;
for (index = 0; index < length; index++)
{
LOG(AZ_LOG_TRACE, 0, "0x%02x ", data[index]);
}
LOG(AZ_LOG_TRACE, LOG_LINE, " ");
}
else if (packet == PINGRESP_TYPE)
{
char tmBuffer[TIME_MAX_BUFFER];
getLogTime(tmBuffer, TIME_MAX_BUFFER);
LOG(AZ_LOG_TRACE, LOG_LINE, "<- %s %s: 0x%02x 0x%02x ", tmBuffer, retrievePacketType((CONTROL_PACKET_TYPE)packet), (unsigned int)(packet | flags), (unsigned int)length);
}
}
}
#endif // ENABLE_RAW_TRACE
static void log_outgoing_trace(MQTT_CLIENT* mqtt_client, STRING_HANDLE trace_log)
{
if (mqtt_client != NULL && is_trace_enabled(mqtt_client) && trace_log != NULL)
{
char tmBuffer[TIME_MAX_BUFFER];
getLogTime(tmBuffer, TIME_MAX_BUFFER);
LOG(AZ_LOG_TRACE, LOG_LINE, "-> %s %s", tmBuffer, STRING_c_str(trace_log));
}
}
static void log_incoming_trace(MQTT_CLIENT* mqtt_client, STRING_HANDLE trace_log)
{
if (mqtt_client != NULL && is_trace_enabled(mqtt_client) && trace_log != NULL)
{
char tmBuffer[TIME_MAX_BUFFER];
getLogTime(tmBuffer, TIME_MAX_BUFFER);
LOG(AZ_LOG_TRACE, LOG_LINE, "<- %s %s", tmBuffer, STRING_c_str(trace_log) );
}
}
#else // NO_LOGGING
static void logOutgoingRawTrace(MQTT_CLIENT* mqtt_client, const uint8_t* data, size_t length)
{
AZURE_UNREFERENCED_PARAMETER(mqtt_client);
AZURE_UNREFERENCED_PARAMETER(data);
AZURE_UNREFERENCED_PARAMETER(length);
}
static void log_outgoing_trace(MQTT_CLIENT* mqtt_client, STRING_HANDLE trace_log)
{
AZURE_UNREFERENCED_PARAMETER(mqtt_client);
AZURE_UNREFERENCED_PARAMETER(trace_log);
}
static void log_incoming_trace(MQTT_CLIENT* mqtt_client, STRING_HANDLE trace_log)
{
AZURE_UNREFERENCED_PARAMETER(mqtt_client);
AZURE_UNREFERENCED_PARAMETER(trace_log);
}
static void logIncomingRawTrace(MQTT_CLIENT* mqtt_client, CONTROL_PACKET_TYPE packet, uint8_t flags, const uint8_t* data, size_t length)
{
AZURE_UNREFERENCED_PARAMETER(mqtt_client);
AZURE_UNREFERENCED_PARAMETER(packet);
AZURE_UNREFERENCED_PARAMETER(flags);
AZURE_UNREFERENCED_PARAMETER(data);
AZURE_UNREFERENCED_PARAMETER(length);
}
#endif // NO_LOGGING
static int sendPacketItem(MQTT_CLIENT* mqtt_client, const unsigned char* data, size_t length)
{
int result = xio_send(mqtt_client->xioHandle, (const void*)data, length, sendComplete, mqtt_client);
if (result != 0)
{
LogError("Failure sending control packet data");
result = MU_FAILURE;
}
else
{
#ifdef ENABLE_RAW_TRACE
logOutgoingRawTrace(mqtt_client, (const uint8_t*)data, length);
#endif
if (tickcounter_get_current_ms(mqtt_client->packetTickCntr, &mqtt_client->packetSendTimeMs) != 0)
{
LogError("Failure getting current ms tickcounter");
result = MU_FAILURE;
}
}
return result;
}
static void onOpenComplete(void* context, IO_OPEN_RESULT open_result)
{
MQTT_CLIENT* mqtt_client = (MQTT_CLIENT*)context;
if (mqtt_client != NULL)
{
if (open_result == IO_OPEN_OK && !(mqtt_client->mqtt_status & MQTT_STATUS_SOCKET_CONNECTED))
{
mqtt_client->packetState = CONNECT_TYPE;
mqtt_client->mqtt_status |= MQTT_STATUS_SOCKET_CONNECTED;
STRING_HANDLE trace_log = construct_trace_log_handle(mqtt_client);
// Send the Connect packet
BUFFER_HANDLE connPacket = mqtt_codec_connect(&mqtt_client->mqttOptions, trace_log);
if (connPacket == NULL)
{
LogError("Error: mqtt_codec_connect failed");
}
else
{
size_t size = BUFFER_length(connPacket);
/*Codes_SRS_MQTT_CLIENT_07_009: [On success mqtt_client_connect shall send the MQTT CONNECT to the endpoint.]*/
if (sendPacketItem(mqtt_client, BUFFER_u_char(connPacket), size) != 0)
{
LogError("Error: failure sending connect packet");
// Set the status to pending close because we connot continue
// with CONN failing to send
if (mqtt_client->fnOnErrorCallBack)
{
mqtt_client->fnOnErrorCallBack(mqtt_client, MQTT_CLIENT_CONNECTION_ERROR, mqtt_client->errorCBCtx);
}
mqtt_client->mqtt_status |= MQTT_STATUS_PENDING_CLOSE;
}
else
{
log_outgoing_trace(mqtt_client, trace_log);
}
BUFFER_delete(connPacket);
}
if (trace_log != NULL)
{
STRING_delete(trace_log);
}
}
else
{
LogError("Error: failure opening connection to endpoint");
if (!(mqtt_client->mqtt_status & MQTT_STATUS_SOCKET_CONNECTED) && mqtt_client->fnOnErrorCallBack)
{
mqtt_client->fnOnErrorCallBack(mqtt_client, MQTT_CLIENT_CONNECTION_ERROR, mqtt_client->errorCBCtx);
}
mqtt_client->mqtt_status |= MQTT_STATUS_PENDING_CLOSE;
}
}
else
{
LogError("Error: mqtt_client is NULL");
}
}
static void onBytesReceived(void* context, const unsigned char* buffer, size_t size)
{
MQTT_CLIENT* mqtt_client = (MQTT_CLIENT*)context;
if (mqtt_client != NULL)
{
if (mqtt_codec_bytesReceived(mqtt_client->codec_handle, buffer, size) != 0)
{
mqtt_codec_reset(mqtt_client->codec_handle);
set_error_callback(mqtt_client, MQTT_CLIENT_PARSE_ERROR);
}
}
else
{
LogError("Error: mqtt_client is NULL");
}
}
static void onIoError(void* context)
{
MQTT_CLIENT* mqtt_client = (MQTT_CLIENT*)context;
if (mqtt_client != NULL && mqtt_client->fnOperationCallback)
{
/*Codes_SRS_MQTT_CLIENT_07_032: [If the actionResult parameter is of type MQTT_CLIENT_ON_DISCONNECT the the msgInfo value shall be NULL.]*/
/* Codes_SRS_MQTT_CLIENT_07_036: [ If an error is encountered by the ioHandle the mqtt_client shall call xio_close. ] */
set_error_callback(mqtt_client, MQTT_CLIENT_CONNECTION_ERROR);
}
else
{
LogError("Error invalid parameter: mqtt_client: %p", mqtt_client);
}
}
static void clear_mqtt_options(MQTT_CLIENT* mqtt_client)
{
if (mqtt_client->mqttOptions.clientId != NULL)
{
free(mqtt_client->mqttOptions.clientId);
mqtt_client->mqttOptions.clientId = NULL;
}
if (mqtt_client->mqttOptions.willTopic != NULL)
{
free(mqtt_client->mqttOptions.willTopic);
mqtt_client->mqttOptions.willTopic = NULL;
}
if (mqtt_client->mqttOptions.willMessage != NULL)
{
free(mqtt_client->mqttOptions.willMessage);
mqtt_client->mqttOptions.willMessage = NULL;
}
if (mqtt_client->mqttOptions.username != NULL)
{
free(mqtt_client->mqttOptions.username);
mqtt_client->mqttOptions.username = NULL;
}
if (mqtt_client->mqttOptions.password != NULL)
{
free(mqtt_client->mqttOptions.password);
mqtt_client->mqttOptions.password = NULL;
}
}
static int cloneMqttOptions(MQTT_CLIENT* mqtt_client, const MQTT_CLIENT_OPTIONS* mqttOptions)
{
int result = 0;
char* temp_option;
if (mqttOptions->clientId != NULL)
{
if (mallocAndStrcpy_s(&temp_option, mqttOptions->clientId) != 0)
{
result = MU_FAILURE;
LogError("mallocAndStrcpy_s clientId");
}
else
{
if (mqtt_client->mqttOptions.clientId != NULL)
{
free(mqtt_client->mqttOptions.clientId);
}
mqtt_client->mqttOptions.clientId = temp_option;
}
}
if (result == 0 && mqttOptions->willTopic != NULL)
{
temp_option = NULL;
if (mallocAndStrcpy_s(&temp_option, mqttOptions->willTopic) != 0)
{
result = MU_FAILURE;
LogError("mallocAndStrcpy_s willTopic");
}
else
{
if (mqtt_client->mqttOptions.willTopic != NULL)
{
free(mqtt_client->mqttOptions.willTopic);
}
mqtt_client->mqttOptions.willTopic = temp_option;
}
}
if (result == 0 && mqttOptions->willMessage != NULL)
{
temp_option = NULL;
if (mallocAndStrcpy_s(&temp_option, mqttOptions->willMessage) != 0)
{
LogError("mallocAndStrcpy_s willMessage");
result = MU_FAILURE;
}
else
{
if (mqtt_client->mqttOptions.willMessage != NULL)
{
free(mqtt_client->mqttOptions.willMessage);
}
mqtt_client->mqttOptions.willMessage = temp_option;
}
}
if (result == 0 && mqttOptions->username != NULL)
{
temp_option = NULL;
if (mallocAndStrcpy_s(&temp_option, mqttOptions->username) != 0)
{
LogError("mallocAndStrcpy_s username");
result = MU_FAILURE;
}
else
{
if (mqtt_client->mqttOptions.username != NULL)
{
free(mqtt_client->mqttOptions.username);
}
mqtt_client->mqttOptions.username = temp_option;
}
}
if (result == 0 && mqttOptions->password != NULL)
{
temp_option = NULL;
if (mallocAndStrcpy_s(&temp_option, mqttOptions->password) != 0)
{
LogError("mallocAndStrcpy_s password");
result = MU_FAILURE;
}
else
{
if (mqtt_client->mqttOptions.password != NULL)
{
free(mqtt_client->mqttOptions.password);
}
mqtt_client->mqttOptions.password = temp_option;
}
}
if (result == 0)
{
mqtt_client->mqttOptions.keepAliveInterval = mqttOptions->keepAliveInterval;
mqtt_client->mqttOptions.messageRetain = mqttOptions->messageRetain;
mqtt_client->mqttOptions.useCleanSession = mqttOptions->useCleanSession;
mqtt_client->mqttOptions.qualityOfServiceValue = mqttOptions->qualityOfServiceValue;
}
else
{
clear_mqtt_options(mqtt_client);
}
return result;
}
static void SendMessageAck(MQTT_CLIENT* mqtt_client, uint16_t packetId, QOS_VALUE qosValue)
{
CONTROL_PACKET_TYPE response_packet_type = UNKNOWN_TYPE;
BUFFER_HANDLE pubRel = NULL;
if (qosValue == DELIVER_EXACTLY_ONCE)
{
pubRel = mqtt_codec_publishReceived(packetId);
if (pubRel == NULL)
{
LogError("Failed to allocate publish receive message.");
set_error_callback(mqtt_client, MQTT_CLIENT_MEMORY_ERROR);
}
response_packet_type = PUBREC_TYPE;
}
else if (qosValue == DELIVER_AT_LEAST_ONCE)
{
pubRel = mqtt_codec_publishAck(packetId);
if (pubRel == NULL)
{
LogError("Failed to allocate publish ack message.");
set_error_callback(mqtt_client, MQTT_CLIENT_MEMORY_ERROR);
}
response_packet_type = PUBACK_TYPE;
}
if (pubRel != NULL)
{
size_t size = BUFFER_length(pubRel);
if (sendPacketItem(mqtt_client, BUFFER_u_char(pubRel), size) != 0)
{
LogError("Failed sending publish reply.");
set_error_callback(mqtt_client, MQTT_CLIENT_COMMUNICATION_ERROR);
}
#ifndef NO_LOGGING
else if (is_trace_enabled(mqtt_client))
{
STRING_HANDLE ack_trace_log = STRING_construct_sprintf("%s | PACKET_ID: %"PRIu16,
response_packet_type == PUBACK_TYPE ? "PUBACK" : ((response_packet_type == PUBREC_TYPE) ? "PUBREC" : "UNDEFINED"),
packetId);
log_outgoing_trace(mqtt_client, ack_trace_log);
STRING_delete(ack_trace_log);
}
#endif
BUFFER_delete(pubRel);
}
}
static void ProcessPublishMessage(MQTT_CLIENT* mqtt_client, uint8_t* initialPos, size_t packetLength, int flags)
{
bool isDuplicateMsg = (flags & DUPLICATE_FLAG_MASK) ? true : false;
bool isRetainMsg = (flags & RETAIN_FLAG_MASK) ? true : false;
QOS_VALUE qosValue = (flags == 0) ? DELIVER_AT_MOST_ONCE : (flags & QOS_LEAST_ONCE_FLAG_MASK) ? DELIVER_AT_LEAST_ONCE : DELIVER_EXACTLY_ONCE;
uint8_t* iterator = initialPos;
size_t numberOfBytesToBeRead = packetLength;
size_t lengthOfTopicName = numberOfBytesToBeRead;
char* topicName = byteutil_readUTF(&iterator, &lengthOfTopicName);
if (topicName == NULL)
{
LogError("Publish MSG: failure reading topic name");
set_error_callback(mqtt_client, MQTT_CLIENT_PARSE_ERROR);
}
else
{
STRING_HANDLE trace_log = NULL;
#ifndef NO_LOGGING
if (is_trace_enabled(mqtt_client))
{
trace_log = STRING_construct_sprintf("PUBLISH | IS_DUP: %s | RETAIN: %d | QOS: %s | TOPIC_NAME: %s", isDuplicateMsg ? TRUE_CONST : FALSE_CONST,
isRetainMsg ? 1 : 0, MU_ENUM_TO_STRING_2(QOS_VALUE, qosValue), topicName);
}
#endif
uint16_t packetId = 0;
numberOfBytesToBeRead = packetLength - (iterator - initialPos);
if (qosValue != DELIVER_AT_MOST_ONCE)
{
packetId = byteutil_read_uint16(&iterator, numberOfBytesToBeRead);
#ifndef NO_LOGGING
if (is_trace_enabled(mqtt_client))
{
STRING_sprintf(trace_log, " | PACKET_ID: %"PRIu16, packetId);
}
#endif
}
if ((qosValue != DELIVER_AT_MOST_ONCE) && (packetId == 0))
{
LogError("Publish MSG: packetId=0, invalid");
set_error_callback(mqtt_client, MQTT_CLIENT_PARSE_ERROR);
}
else
{
numberOfBytesToBeRead = packetLength - (iterator - initialPos);
MQTT_MESSAGE_HANDLE msgHandle = mqttmessage_create_in_place(packetId, topicName, qosValue, iterator, numberOfBytesToBeRead);
if (msgHandle == NULL)
{
LogError("failure in mqttmessage_create");
set_error_callback(mqtt_client, MQTT_CLIENT_MEMORY_ERROR);
}
else if (mqttmessage_setIsDuplicateMsg(msgHandle, isDuplicateMsg) != 0 ||
mqttmessage_setIsRetained(msgHandle, isRetainMsg) != 0)
{
LogError("failure setting mqtt message property");
set_error_callback(mqtt_client, MQTT_CLIENT_MEMORY_ERROR);
}
else
{
#ifndef NO_LOGGING
if (is_trace_enabled(mqtt_client))
{
STRING_sprintf(trace_log, " | PAYLOAD_LEN: %lu", (unsigned long)numberOfBytesToBeRead);
log_incoming_trace(mqtt_client, trace_log);
}
#endif
MQTT_CLIENT_ACK_OPTION ack_option = mqtt_client->fnMessageRecv(msgHandle, mqtt_client->ctx);
if (ack_option == MQTT_CLIENT_ACK_SYNC)
{
SendMessageAck(mqtt_client, packetId, qosValue);
}
}
mqttmessage_destroy(msgHandle);
}
if (trace_log != NULL)
{
STRING_delete(trace_log);
}
free(topicName);
}
}
static void recvCompleteCallback(void* context, CONTROL_PACKET_TYPE packet, int flags, BUFFER_HANDLE headerData)
{
MQTT_CLIENT* mqtt_client = (MQTT_CLIENT*)context;
if (mqtt_client != NULL)
{
size_t packetLength = 0;
uint8_t* iterator = NULL;
if (headerData != NULL)
{
packetLength = BUFFER_length(headerData);
iterator = BUFFER_u_char(headerData);
}
#ifdef ENABLE_RAW_TRACE
logIncomingRawTrace(mqtt_client, packet, (uint8_t)flags, iterator, packetLength);
#endif
if ((iterator != NULL && packetLength > 0) || packet == PINGRESP_TYPE)
{
switch (packet)
{
case CONNACK_TYPE:
{
/*Codes_SRS_MQTT_CLIENT_07_028: [If the actionResult parameter is of type CONNECT_ACK then the msgInfo value shall be a CONNECT_ACK structure.]*/
CONNECT_ACK connack = { 0 };
if (packetLength != 2) // CONNACK payload must be only 2 bytes
{
LogError("Invalid CONNACK packet.");
set_error_callback(mqtt_client, MQTT_CLIENT_COMMUNICATION_ERROR);
break;
}
uint8_t connect_acknowledge_flags = byteutil_readByte(&iterator);
if (connect_acknowledge_flags & 0xFE) // bits 7-1 must be zero
{
LogError("Invalid CONNACK packet.");
set_error_callback(mqtt_client, MQTT_CLIENT_COMMUNICATION_ERROR);
break;
}
connack.isSessionPresent = (connect_acknowledge_flags == 0x1) ? true : false;
uint8_t rc = byteutil_readByte(&iterator);
connack.returnCode =
(rc < ((uint8_t)CONN_REFUSED_UNKNOWN)) ?
(CONNECT_RETURN_CODE)rc : CONN_REFUSED_UNKNOWN;
#ifndef NO_LOGGING
if (is_trace_enabled(mqtt_client))
{
STRING_HANDLE trace_log = STRING_construct_sprintf("CONNACK | SESSION_PRESENT: %s | RETURN_CODE: 0x%x", connack.isSessionPresent ? TRUE_CONST : FALSE_CONST, connack.returnCode);
log_incoming_trace(mqtt_client, trace_log);
STRING_delete(trace_log);
}
#endif
mqtt_client->fnOperationCallback(mqtt_client, MQTT_CLIENT_ON_CONNACK, (void*)&connack, mqtt_client->ctx);
if (connack.returnCode == CONNECTION_ACCEPTED)
{
mqtt_client->mqtt_status |= MQTT_STATUS_CLIENT_CONNECTED;
}
break;
}
case PUBLISH_TYPE:
{
ProcessPublishMessage(mqtt_client, iterator, packetLength, flags);
break;
}
case PUBACK_TYPE:
case PUBREC_TYPE:
case PUBREL_TYPE:
case PUBCOMP_TYPE:
{
if (packetLength != 2) // PUBXXX payload must be only 2 bytes
{
LogError("Invalid packet length.");
set_error_callback(mqtt_client, MQTT_CLIENT_COMMUNICATION_ERROR);
break;
}
/*Codes_SRS_MQTT_CLIENT_07_029: [If the actionResult parameter are of types PUBACK_TYPE, PUBREC_TYPE, PUBREL_TYPE or PUBCOMP_TYPE then the msgInfo value shall be a PUBLISH_ACK structure.]*/
MQTT_CLIENT_EVENT_RESULT action = (packet == PUBACK_TYPE) ? MQTT_CLIENT_ON_PUBLISH_ACK :
(packet == PUBREC_TYPE) ? MQTT_CLIENT_ON_PUBLISH_RECV :
(packet == PUBREL_TYPE) ? MQTT_CLIENT_ON_PUBLISH_REL : MQTT_CLIENT_ON_PUBLISH_COMP;
PUBLISH_ACK publish_ack = { 0 };
publish_ack.packetId = byteutil_read_uint16(&iterator, packetLength);
#ifndef NO_LOGGING
if (is_trace_enabled(mqtt_client))
{
STRING_HANDLE trace_log = STRING_construct_sprintf("%s | PACKET_ID: %"PRIu16, packet == PUBACK_TYPE ? "PUBACK" : (packet == PUBREC_TYPE) ? "PUBREC" : (packet == PUBREL_TYPE) ? "PUBREL" : "PUBCOMP",
publish_ack.packetId);
log_incoming_trace(mqtt_client, trace_log);
STRING_delete(trace_log);
}
#endif
BUFFER_HANDLE pubRel = NULL;
mqtt_client->fnOperationCallback(mqtt_client, action, (void*)&publish_ack, mqtt_client->ctx);
if (packet == PUBREC_TYPE)
{
pubRel = mqtt_codec_publishRelease(publish_ack.packetId);
if (pubRel == NULL)
{
LogError("Failed to allocate publish release message.");
set_error_callback(mqtt_client, MQTT_CLIENT_MEMORY_ERROR);
}
}
else if (packet == PUBREL_TYPE)
{
pubRel = mqtt_codec_publishComplete(publish_ack.packetId);
if (pubRel == NULL)
{
LogError("Failed to allocate publish complete message.");
set_error_callback(mqtt_client, MQTT_CLIENT_MEMORY_ERROR);
}
}
if (pubRel != NULL)
{
size_t size = BUFFER_length(pubRel);
if (sendPacketItem(mqtt_client, BUFFER_u_char(pubRel), size) != 0)
{
LogError("Failed sending publish reply.");
set_error_callback(mqtt_client, MQTT_CLIENT_COMMUNICATION_ERROR);
}
BUFFER_delete(pubRel);
}
break;
}
case SUBACK_TYPE:
{
/*Codes_SRS_MQTT_CLIENT_07_030: [If the actionResult parameter is of type SUBACK_TYPE then the msgInfo value shall be a SUBSCRIBE_ACK structure.]*/
SUBSCRIBE_ACK suback = { 0 };
size_t remainLen = packetLength;
suback.packetId = byteutil_read_uint16(&iterator, packetLength);
remainLen -= 2;
#ifndef NO_LOGGING
STRING_HANDLE trace_log = NULL;
if (is_trace_enabled(mqtt_client))
{
trace_log = STRING_construct_sprintf("SUBACK | PACKET_ID: %"PRIu16, suback.packetId);
}
#endif
// Allocate the remaining len
size_t malloc_size = safe_multiply_size_t(sizeof(QOS_VALUE), remainLen);
if (malloc_size != SIZE_MAX &&
(suback.qosReturn = (QOS_VALUE*)malloc(malloc_size)) != NULL)
{
while (remainLen > 0)
{
uint8_t qosRet = byteutil_readByte(&iterator);
if (qosRet & 0x7C) // SUBACK QOS bits 6-2 must be zero
{
LogError("Invalid SUBACK_TYPE packet.");
set_error_callback(mqtt_client, MQTT_CLIENT_COMMUNICATION_ERROR);
break;
}
suback.qosReturn[suback.qosCount++] =
(qosRet <= ((uint8_t)DELIVER_EXACTLY_ONCE)) ?
(QOS_VALUE)qosRet : DELIVER_FAILURE;
remainLen--;
#ifndef NO_LOGGING
if (is_trace_enabled(mqtt_client))
{
STRING_sprintf(trace_log, " | RETURN_CODE: %"PRIu16, suback.qosReturn[suback.qosCount-1]);
}
#endif
}
#ifndef NO_LOGGING
if (is_trace_enabled(mqtt_client))
{
log_incoming_trace(mqtt_client, trace_log);
STRING_delete(trace_log);
}
#endif
mqtt_client->fnOperationCallback(mqtt_client, MQTT_CLIENT_ON_SUBSCRIBE_ACK, (void*)&suback, mqtt_client->ctx);
free(suback.qosReturn);
}
else
{
LogError("allocation of quality of service value failed, size:%zu", malloc_size);
set_error_callback(mqtt_client, MQTT_CLIENT_MEMORY_ERROR);
}
break;
}
case UNSUBACK_TYPE:
{
/*Codes_SRS_MQTT_CLIENT_07_031: [If the actionResult parameter is of type UNSUBACK_TYPE then the msgInfo value shall be a UNSUBSCRIBE_ACK structure.]*/
UNSUBSCRIBE_ACK unsuback = { 0 };
if (packetLength != 2) // UNSUBACK_TYPE payload must be only 2 bytes
{
LogError("Invalid UNSUBACK packet length.");
set_error_callback(mqtt_client, MQTT_CLIENT_COMMUNICATION_ERROR);
break;
}
unsuback.packetId = byteutil_read_uint16(&iterator, packetLength);
#ifndef NO_LOGGING
if (is_trace_enabled(mqtt_client))
{
STRING_HANDLE trace_log = STRING_construct_sprintf("UNSUBACK | PACKET_ID: %"PRIu16, unsuback.packetId);
log_incoming_trace(mqtt_client, trace_log);
STRING_delete(trace_log);
}
#endif
mqtt_client->fnOperationCallback(mqtt_client, MQTT_CLIENT_ON_UNSUBSCRIBE_ACK, (void*)&unsuback, mqtt_client->ctx);
break;
}
case PINGRESP_TYPE:
mqtt_client->timeSincePing = 0;
#ifndef NO_LOGGING
if (is_trace_enabled(mqtt_client))
{
STRING_HANDLE trace_log = STRING_construct_sprintf("PINGRESP");
log_incoming_trace(mqtt_client, trace_log);
STRING_delete(trace_log);
}
#endif
// Forward ping response to operation callback
mqtt_client->fnOperationCallback(mqtt_client, MQTT_CLIENT_ON_PING_RESPONSE, NULL, mqtt_client->ctx);