Coverage Report

Created: 2025-08-26 07:08

/src/PROJ/curl/lib/mqtt.c
Line
Count
Source (jump to first uncovered line)
1
/***************************************************************************
2
 *                                  _   _ ____  _
3
 *  Project                     ___| | | |  _ \| |
4
 *                             / __| | | | |_) | |
5
 *                            | (__| |_| |  _ <| |___
6
 *                             \___|\___/|_| \_\_____|
7
 *
8
 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
9
 * Copyright (C) Björn Stenberg, <bjorn@haxx.se>
10
 *
11
 * This software is licensed as described in the file COPYING, which
12
 * you should have received as part of this distribution. The terms
13
 * are also available at https://curl.se/docs/copyright.html.
14
 *
15
 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
16
 * copies of the Software, and permit persons to whom the Software is
17
 * furnished to do so, under the terms of the COPYING file.
18
 *
19
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
20
 * KIND, either express or implied.
21
 *
22
 * SPDX-License-Identifier: curl
23
 *
24
 ***************************************************************************/
25
26
#include "curl_setup.h"
27
28
#ifndef CURL_DISABLE_MQTT
29
30
#include "urldata.h"
31
#include <curl/curl.h>
32
#include "transfer.h"
33
#include "sendf.h"
34
#include "progress.h"
35
#include "mqtt.h"
36
#include "select.h"
37
#include "strdup.h"
38
#include "url.h"
39
#include "escape.h"
40
#include "curlx/warnless.h"
41
#include "curl_printf.h"
42
#include "curl_memory.h"
43
#include "multiif.h"
44
#include "rand.h"
45
46
/* The last #include file should be: */
47
#include "memdebug.h"
48
49
/* first byte is command.
50
   second byte is for flags. */
51
0
#define MQTT_MSG_CONNECT    0x10
52
/* #define MQTT_MSG_CONNACK    0x20 */
53
0
#define MQTT_MSG_PUBLISH    0x30
54
0
#define MQTT_MSG_SUBSCRIBE  0x82
55
0
#define MQTT_MSG_SUBACK     0x90
56
0
#define MQTT_MSG_DISCONNECT 0xe0
57
#define MQTT_MSG_PINGREQ    0xC0
58
0
#define MQTT_MSG_PINGRESP   0xD0
59
60
0
#define MQTT_CONNACK_LEN 2
61
0
#define MQTT_SUBACK_LEN 3
62
0
#define MQTT_CLIENTID_LEN 12 /* "curl0123abcd" */
63
64
/* meta key for storing protocol meta at easy handle */
65
0
#define CURL_META_MQTT_EASY   "meta:proto:mqtt:easy"
66
/* meta key for storing protocol meta at connection */
67
0
#define CURL_META_MQTT_CONN   "meta:proto:mqtt:conn"
68
69
enum mqttstate {
70
  MQTT_FIRST,             /* 0 */
71
  MQTT_REMAINING_LENGTH,  /* 1 */
72
  MQTT_CONNACK,           /* 2 */
73
  MQTT_SUBACK,            /* 3 */
74
  MQTT_SUBACK_COMING,     /* 4 - the SUBACK remainder */
75
  MQTT_PUBWAIT,    /* 5 - wait for publish */
76
  MQTT_PUB_REMAIN,  /* 6 - wait for the remainder of the publish */
77
78
  MQTT_NOSTATE /* 7 - never used an actual state */
79
};
80
81
struct mqtt_conn {
82
  enum mqttstate state;
83
  enum mqttstate nextstate; /* switch to this after remaining length is
84
                               done */
85
  unsigned int packetid;
86
};
87
88
/* protocol-specific transfer-related data */
89
struct MQTT {
90
  struct dynbuf sendbuf;
91
  /* when receiving */
92
  struct dynbuf recvbuf;
93
  size_t npacket; /* byte counter */
94
  size_t remaining_length;
95
  unsigned char pkt_hd[4]; /* for decoding the arriving packet length */
96
  struct curltime lastTime; /* last time we sent or received data */
97
  unsigned char firstbyte;
98
  BIT(pingsent); /* 1 while we wait for ping response */
99
};
100
101
102
/*
103
 * Forward declarations.
104
 */
105
106
static CURLcode mqtt_do(struct Curl_easy *data, bool *done);
107
static CURLcode mqtt_done(struct Curl_easy *data,
108
                          CURLcode status, bool premature);
109
static CURLcode mqtt_doing(struct Curl_easy *data, bool *done);
110
static CURLcode mqtt_pollset(struct Curl_easy *data,
111
                             struct easy_pollset *ps);
112
static CURLcode mqtt_setup_conn(struct Curl_easy *data,
113
                                struct connectdata *conn);
114
115
/*
116
 * MQTT protocol handler.
117
 */
118
119
const struct Curl_handler Curl_handler_mqtt = {
120
  "mqtt",                             /* scheme */
121
  mqtt_setup_conn,                    /* setup_connection */
122
  mqtt_do,                            /* do_it */
123
  mqtt_done,                          /* done */
124
  ZERO_NULL,                          /* do_more */
125
  ZERO_NULL,                          /* connect_it */
126
  ZERO_NULL,                          /* connecting */
127
  mqtt_doing,                         /* doing */
128
  ZERO_NULL,                          /* proto_pollset */
129
  mqtt_pollset,                       /* doing_pollset */
130
  ZERO_NULL,                          /* domore_pollset */
131
  ZERO_NULL,                          /* perform_pollset */
132
  ZERO_NULL,                          /* disconnect */
133
  ZERO_NULL,                          /* write_resp */
134
  ZERO_NULL,                          /* write_resp_hd */
135
  ZERO_NULL,                          /* connection_check */
136
  ZERO_NULL,                          /* attach connection */
137
  ZERO_NULL,                          /* follow */
138
  PORT_MQTT,                          /* defport */
139
  CURLPROTO_MQTT,                     /* protocol */
140
  CURLPROTO_MQTT,                     /* family */
141
  PROTOPT_NONE                        /* flags */
142
};
143
144
static void mqtt_easy_dtor(void *key, size_t klen, void *entry)
145
0
{
146
0
  struct MQTT *mq = entry;
147
0
  (void)key;
148
0
  (void)klen;
149
0
  curlx_dyn_free(&mq->sendbuf);
150
0
  curlx_dyn_free(&mq->recvbuf);
151
0
  free(mq);
152
0
}
153
154
static void mqtt_conn_dtor(void *key, size_t klen, void *entry)
155
0
{
156
0
  (void)key;
157
0
  (void)klen;
158
0
  free(entry);
159
0
}
160
161
static CURLcode mqtt_setup_conn(struct Curl_easy *data,
162
                                struct connectdata *conn)
163
0
{
164
  /* setup MQTT specific meta data at easy handle and connection */
165
0
  struct mqtt_conn *mqtt;
166
0
  struct MQTT *mq;
167
168
0
  mqtt = calloc(1, sizeof(*mqtt));
169
0
  if(!mqtt ||
170
0
     Curl_conn_meta_set(conn, CURL_META_MQTT_CONN, mqtt, mqtt_conn_dtor))
171
0
    return CURLE_OUT_OF_MEMORY;
172
173
0
  mq = calloc(1, sizeof(struct MQTT));
174
0
  if(!mq)
175
0
    return CURLE_OUT_OF_MEMORY;
176
0
  curlx_dyn_init(&mq->recvbuf, DYN_MQTT_RECV);
177
0
  curlx_dyn_init(&mq->sendbuf, DYN_MQTT_SEND);
178
0
  if(Curl_meta_set(data, CURL_META_MQTT_EASY, mq, mqtt_easy_dtor))
179
0
    return CURLE_OUT_OF_MEMORY;
180
0
  return CURLE_OK;
181
0
}
182
183
static CURLcode mqtt_send(struct Curl_easy *data,
184
                          const char *buf, size_t len)
185
0
{
186
0
  size_t n;
187
0
  CURLcode result;
188
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
189
190
0
  if(!mq)
191
0
    return CURLE_FAILED_INIT;
192
193
0
  result = Curl_xfer_send(data, buf, len, FALSE, &n);
194
0
  if(result)
195
0
    return result;
196
0
  mq->lastTime = curlx_now();
197
0
  Curl_debug(data, CURLINFO_HEADER_OUT, buf, (size_t)n);
198
0
  if(len != n) {
199
0
    size_t nsend = len - n;
200
0
    if(curlx_dyn_len(&mq->sendbuf)) {
201
0
      DEBUGASSERT(curlx_dyn_len(&mq->sendbuf) >= nsend);
202
0
      result = curlx_dyn_tail(&mq->sendbuf, nsend); /* keep this much */
203
0
    }
204
0
    else {
205
0
      result = curlx_dyn_addn(&mq->sendbuf, &buf[n], nsend);
206
0
    }
207
0
  }
208
0
  else
209
0
    curlx_dyn_reset(&mq->sendbuf);
210
0
  return result;
211
0
}
212
213
/* Generic function called by the multi interface to figure out what socket(s)
214
   to wait for and for what actions during the DOING and PROTOCONNECT
215
   states */
216
static CURLcode mqtt_pollset(struct Curl_easy *data,
217
                             struct easy_pollset *ps)
218
0
{
219
0
  return Curl_pollset_add_in(data, ps, data->conn->sock[FIRSTSOCKET]);
220
0
}
221
222
static int mqtt_encode_len(char *buf, size_t len)
223
0
{
224
0
  int i;
225
226
0
  for(i = 0; (len > 0) && (i < 4); i++) {
227
0
    unsigned char encoded;
228
0
    encoded = len % 0x80;
229
0
    len /= 0x80;
230
0
    if(len)
231
0
      encoded |= 0x80;
232
0
    buf[i] = (char)encoded;
233
0
  }
234
235
0
  return i;
236
0
}
237
238
/* add the passwd to the CONNECT packet */
239
static int add_passwd(const char *passwd, const size_t plen,
240
                      char *pkt, const size_t start, int remain_pos)
241
0
{
242
  /* magic number that need to be set properly */
243
0
  const size_t conn_flags_pos = remain_pos + 8;
244
0
  if(plen > 0xffff)
245
0
    return 1;
246
247
  /* set password flag */
248
0
  pkt[conn_flags_pos] |= 0x40;
249
250
  /* length of password provided */
251
0
  pkt[start] = (char)((plen >> 8) & 0xFF);
252
0
  pkt[start + 1] = (char)(plen & 0xFF);
253
0
  memcpy(&pkt[start + 2], passwd, plen);
254
0
  return 0;
255
0
}
256
257
/* add user to the CONNECT packet */
258
static int add_user(const char *username, const size_t ulen,
259
                    unsigned char *pkt, const size_t start, int remain_pos)
260
0
{
261
  /* magic number that need to be set properly */
262
0
  const size_t conn_flags_pos = remain_pos + 8;
263
0
  if(ulen > 0xffff)
264
0
    return 1;
265
266
  /* set username flag */
267
0
  pkt[conn_flags_pos] |= 0x80;
268
  /* length of username provided */
269
0
  pkt[start] = (unsigned char)((ulen >> 8) & 0xFF);
270
0
  pkt[start + 1] = (unsigned char)(ulen & 0xFF);
271
0
  memcpy(&pkt[start + 2], username, ulen);
272
0
  return 0;
273
0
}
274
275
/* add client ID to the CONNECT packet */
276
static int add_client_id(const char *client_id, const size_t client_id_len,
277
                         char *pkt, const size_t start)
278
0
{
279
0
  if(client_id_len != MQTT_CLIENTID_LEN)
280
0
    return 1;
281
0
  pkt[start] = 0x00;
282
0
  pkt[start + 1] = MQTT_CLIENTID_LEN;
283
0
  memcpy(&pkt[start + 2], client_id, MQTT_CLIENTID_LEN);
284
0
  return 0;
285
0
}
286
287
/* Set initial values of CONNECT packet */
288
static int init_connpack(char *packet, char *remain, int remain_pos)
289
0
{
290
  /* Fixed header starts */
291
  /* packet type */
292
0
  packet[0] = MQTT_MSG_CONNECT;
293
  /* remaining length field */
294
0
  memcpy(&packet[1], remain, remain_pos);
295
  /* Fixed header ends */
296
297
  /* Variable header starts */
298
  /* protocol length */
299
0
  packet[remain_pos + 1] = 0x00;
300
0
  packet[remain_pos + 2] = 0x04;
301
  /* protocol name */
302
0
  packet[remain_pos + 3] = 'M';
303
0
  packet[remain_pos + 4] = 'Q';
304
0
  packet[remain_pos + 5] = 'T';
305
0
  packet[remain_pos + 6] = 'T';
306
  /* protocol level */
307
0
  packet[remain_pos + 7] = 0x04;
308
  /* CONNECT flag: CleanSession */
309
0
  packet[remain_pos + 8] = 0x02;
310
  /* keep-alive 0 = disabled */
311
0
  packet[remain_pos + 9] = 0x00;
312
0
  packet[remain_pos + 10] = 0x3c;
313
  /* end of variable header */
314
0
  return remain_pos + 10;
315
0
}
316
317
static CURLcode mqtt_connect(struct Curl_easy *data)
318
0
{
319
0
  CURLcode result = CURLE_OK;
320
0
  int pos = 0;
321
0
  int rc = 0;
322
  /* remain length */
323
0
  int remain_pos = 0;
324
0
  char remain[4] = {0};
325
0
  size_t packetlen = 0;
326
0
  size_t start_user = 0;
327
0
  size_t start_pwd = 0;
328
0
  char client_id[MQTT_CLIENTID_LEN + 1] = "curl";
329
0
  const size_t clen = strlen("curl");
330
0
  char *packet = NULL;
331
332
  /* extracting username from request */
333
0
  const char *username = data->state.aptr.user ?
334
0
    data->state.aptr.user : "";
335
0
  const size_t ulen = strlen(username);
336
  /* extracting password from request */
337
0
  const char *passwd = data->state.aptr.passwd ?
338
0
    data->state.aptr.passwd : "";
339
0
  const size_t plen = strlen(passwd);
340
0
  const size_t payloadlen = ulen + plen + MQTT_CLIENTID_LEN + 2 +
341
  /* The plus 2s below are for the MSB and LSB describing the length of the
342
     string to be added on the payload. Refer to spec 1.5.2 and 1.5.4 */
343
0
    (ulen ? 2 : 0) +
344
0
    (plen ? 2 : 0);
345
346
  /* getting how much occupy the remain length */
347
0
  remain_pos = mqtt_encode_len(remain, payloadlen + 10);
348
349
  /* 10 length of variable header and 1 the first byte of the fixed header */
350
0
  packetlen = payloadlen + 10 + remain_pos + 1;
351
352
  /* allocating packet */
353
0
  if(packetlen > 0xFFFFFFF)
354
0
    return CURLE_WEIRD_SERVER_REPLY;
355
0
  packet = calloc(1, packetlen);
356
0
  if(!packet)
357
0
    return CURLE_OUT_OF_MEMORY;
358
359
  /* set initial values for the CONNECT packet */
360
0
  pos = init_connpack(packet, remain, remain_pos);
361
362
0
  result = Curl_rand_alnum(data, (unsigned char *)&client_id[clen],
363
0
                           MQTT_CLIENTID_LEN - clen + 1);
364
  /* add client id */
365
0
  rc = add_client_id(client_id, strlen(client_id), packet, pos + 1);
366
0
  if(rc) {
367
0
    failf(data, "Client ID length mismatched: [%zu]", strlen(client_id));
368
0
    result = CURLE_WEIRD_SERVER_REPLY;
369
0
    goto end;
370
0
  }
371
0
  infof(data, "Using client id '%s'", client_id);
372
373
  /* position where the user payload starts */
374
0
  start_user = pos + 3 + MQTT_CLIENTID_LEN;
375
  /* position where the password payload starts */
376
0
  start_pwd = start_user + ulen;
377
  /* if username was provided, add it to the packet */
378
0
  if(ulen) {
379
0
    start_pwd += 2;
380
381
0
    rc = add_user(username, ulen,
382
0
                  (unsigned char *)packet, start_user, remain_pos);
383
0
    if(rc) {
384
0
      failf(data, "Username too long: [%zu]", ulen);
385
0
      result = CURLE_WEIRD_SERVER_REPLY;
386
0
      goto end;
387
0
    }
388
0
  }
389
390
  /* if passwd was provided, add it to the packet */
391
0
  if(plen) {
392
0
    rc = add_passwd(passwd, plen, packet, start_pwd, remain_pos);
393
0
    if(rc) {
394
0
      failf(data, "Password too long: [%zu]", plen);
395
0
      result = CURLE_WEIRD_SERVER_REPLY;
396
0
      goto end;
397
0
    }
398
0
  }
399
400
0
  if(!result)
401
0
    result = mqtt_send(data, packet, packetlen);
402
403
0
end:
404
0
  if(packet)
405
0
    free(packet);
406
0
  Curl_safefree(data->state.aptr.user);
407
0
  Curl_safefree(data->state.aptr.passwd);
408
0
  return result;
409
0
}
410
411
static CURLcode mqtt_disconnect(struct Curl_easy *data)
412
0
{
413
0
  return mqtt_send(data, "\xe0\x00", 2);
414
0
}
415
416
static CURLcode mqtt_recv_atleast(struct Curl_easy *data, size_t nbytes)
417
0
{
418
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
419
0
  size_t rlen;
420
0
  CURLcode result;
421
422
0
  if(!mq)
423
0
    return CURLE_FAILED_INIT;
424
0
  rlen = curlx_dyn_len(&mq->recvbuf);
425
426
0
  if(rlen < nbytes) {
427
0
    unsigned char readbuf[1024];
428
0
    size_t nread;
429
430
0
    DEBUGASSERT(nbytes - rlen < sizeof(readbuf));
431
0
    result = Curl_xfer_recv(data, (char *)readbuf, nbytes - rlen, &nread);
432
0
    if(result)
433
0
      return result;
434
0
    if(curlx_dyn_addn(&mq->recvbuf, readbuf, nread))
435
0
      return CURLE_OUT_OF_MEMORY;
436
0
    rlen = curlx_dyn_len(&mq->recvbuf);
437
0
  }
438
0
  return (rlen >= nbytes) ? CURLE_OK : CURLE_AGAIN;
439
0
}
440
441
static void mqtt_recv_consume(struct Curl_easy *data, size_t nbytes)
442
0
{
443
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
444
0
  DEBUGASSERT(mq);
445
0
  if(mq) {
446
0
    size_t rlen = curlx_dyn_len(&mq->recvbuf);
447
0
    if(rlen <= nbytes)
448
0
      curlx_dyn_reset(&mq->recvbuf);
449
0
    else
450
0
      curlx_dyn_tail(&mq->recvbuf, rlen - nbytes);
451
0
  }
452
0
}
453
454
static CURLcode mqtt_verify_connack(struct Curl_easy *data)
455
0
{
456
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
457
0
  CURLcode result;
458
0
  char *ptr;
459
460
0
  DEBUGASSERT(mq);
461
0
  if(!mq)
462
0
    return CURLE_FAILED_INIT;
463
464
0
  result = mqtt_recv_atleast(data, MQTT_CONNACK_LEN);
465
0
  if(result)
466
0
    goto fail;
467
468
  /* verify CONNACK */
469
0
  DEBUGASSERT(curlx_dyn_len(&mq->recvbuf) >= MQTT_CONNACK_LEN);
470
0
  ptr = curlx_dyn_ptr(&mq->recvbuf);
471
0
  Curl_debug(data, CURLINFO_HEADER_IN, ptr, MQTT_CONNACK_LEN);
472
473
0
  if(ptr[0] != 0x00 || ptr[1] != 0x00) {
474
0
    failf(data, "Expected %02x%02x but got %02x%02x",
475
0
          0x00, 0x00, ptr[0], ptr[1]);
476
0
    curlx_dyn_reset(&mq->recvbuf);
477
0
    result = CURLE_WEIRD_SERVER_REPLY;
478
0
    goto fail;
479
0
  }
480
0
  mqtt_recv_consume(data, MQTT_CONNACK_LEN);
481
0
fail:
482
0
  return result;
483
0
}
484
485
static CURLcode mqtt_get_topic(struct Curl_easy *data,
486
                               char **topic, size_t *topiclen)
487
0
{
488
0
  char *path = data->state.up.path;
489
0
  CURLcode result = CURLE_URL_MALFORMAT;
490
0
  if(strlen(path) > 1) {
491
0
    result = Curl_urldecode(path + 1, 0, topic, topiclen, REJECT_NADA);
492
0
    if(!result && (*topiclen > 0xffff)) {
493
0
      failf(data, "Too long MQTT topic");
494
0
      result = CURLE_URL_MALFORMAT;
495
0
    }
496
0
  }
497
0
  else
498
0
    failf(data, "No MQTT topic found. Forgot to URL encode it?");
499
500
0
  return result;
501
0
}
502
503
static CURLcode mqtt_subscribe(struct Curl_easy *data)
504
0
{
505
0
  CURLcode result = CURLE_OK;
506
0
  char *topic = NULL;
507
0
  size_t topiclen;
508
0
  unsigned char *packet = NULL;
509
0
  size_t packetlen;
510
0
  char encodedsize[4];
511
0
  size_t n;
512
0
  struct connectdata *conn = data->conn;
513
0
  struct mqtt_conn *mqtt = Curl_conn_meta_get(conn, CURL_META_MQTT_CONN);
514
515
0
  if(!mqtt)
516
0
    return CURLE_FAILED_INIT;
517
518
0
  result = mqtt_get_topic(data, &topic, &topiclen);
519
0
  if(result)
520
0
    goto fail;
521
522
0
  mqtt->packetid++;
523
524
0
  packetlen = topiclen + 5; /* packetid + topic (has a two byte length field)
525
                               + 2 bytes topic length + QoS byte */
526
0
  n = mqtt_encode_len((char *)encodedsize, packetlen);
527
0
  packetlen += n + 1; /* add one for the control packet type byte */
528
529
0
  packet = malloc(packetlen);
530
0
  if(!packet) {
531
0
    result = CURLE_OUT_OF_MEMORY;
532
0
    goto fail;
533
0
  }
534
535
0
  packet[0] = MQTT_MSG_SUBSCRIBE;
536
0
  memcpy(&packet[1], encodedsize, n);
537
0
  packet[1 + n] = (mqtt->packetid >> 8) & 0xff;
538
0
  packet[2 + n] = mqtt->packetid & 0xff;
539
0
  packet[3 + n] = (topiclen >> 8) & 0xff;
540
0
  packet[4 + n ] = topiclen & 0xff;
541
0
  memcpy(&packet[5 + n], topic, topiclen);
542
0
  packet[5 + n + topiclen] = 0; /* QoS zero */
543
544
0
  result = mqtt_send(data, (const char *)packet, packetlen);
545
546
0
fail:
547
0
  free(topic);
548
0
  free(packet);
549
0
  return result;
550
0
}
551
552
/*
553
 * Called when the first byte was already read.
554
 */
555
static CURLcode mqtt_verify_suback(struct Curl_easy *data)
556
0
{
557
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
558
0
  struct connectdata *conn = data->conn;
559
0
  struct mqtt_conn *mqtt = Curl_conn_meta_get(conn, CURL_META_MQTT_CONN);
560
0
  CURLcode result;
561
0
  char *ptr;
562
563
0
  if(!mqtt || !mq)
564
0
    return CURLE_FAILED_INIT;
565
566
0
  result = mqtt_recv_atleast(data, MQTT_SUBACK_LEN);
567
0
  if(result)
568
0
    goto fail;
569
570
  /* verify SUBACK */
571
0
  DEBUGASSERT(curlx_dyn_len(&mq->recvbuf) >= MQTT_SUBACK_LEN);
572
0
  ptr = curlx_dyn_ptr(&mq->recvbuf);
573
0
  Curl_debug(data, CURLINFO_HEADER_IN, ptr, MQTT_SUBACK_LEN);
574
575
0
  if(((unsigned char)ptr[0]) != ((mqtt->packetid >> 8) & 0xff) ||
576
0
     ((unsigned char)ptr[1]) != (mqtt->packetid & 0xff) ||
577
0
     ptr[2] != 0x00) {
578
0
    curlx_dyn_reset(&mq->recvbuf);
579
0
    result = CURLE_WEIRD_SERVER_REPLY;
580
0
    goto fail;
581
0
  }
582
0
  mqtt_recv_consume(data, MQTT_SUBACK_LEN);
583
0
fail:
584
0
  return result;
585
0
}
586
587
static CURLcode mqtt_publish(struct Curl_easy *data)
588
0
{
589
0
  CURLcode result;
590
0
  char *payload = data->set.postfields;
591
0
  size_t payloadlen;
592
0
  char *topic = NULL;
593
0
  size_t topiclen;
594
0
  unsigned char *pkt = NULL;
595
0
  size_t i = 0;
596
0
  size_t remaininglength;
597
0
  size_t encodelen;
598
0
  char encodedbytes[4];
599
0
  curl_off_t postfieldsize = data->set.postfieldsize;
600
601
0
  if(!payload) {
602
0
    DEBUGF(infof(data, "mqtt_publish without payload, return bad arg"));
603
0
    return CURLE_BAD_FUNCTION_ARGUMENT;
604
0
  }
605
0
  if(postfieldsize < 0)
606
0
    payloadlen = strlen(payload);
607
0
  else
608
0
    payloadlen = (size_t)postfieldsize;
609
610
0
  result = mqtt_get_topic(data, &topic, &topiclen);
611
0
  if(result)
612
0
    goto fail;
613
614
0
  remaininglength = payloadlen + 2 + topiclen;
615
0
  encodelen = mqtt_encode_len(encodedbytes, remaininglength);
616
617
  /* add the control byte and the encoded remaining length */
618
0
  pkt = malloc(remaininglength + 1 + encodelen);
619
0
  if(!pkt) {
620
0
    result = CURLE_OUT_OF_MEMORY;
621
0
    goto fail;
622
0
  }
623
624
  /* assemble packet */
625
0
  pkt[i++] = MQTT_MSG_PUBLISH;
626
0
  memcpy(&pkt[i], encodedbytes, encodelen);
627
0
  i += encodelen;
628
0
  pkt[i++] = (topiclen >> 8) & 0xff;
629
0
  pkt[i++] = (topiclen & 0xff);
630
0
  memcpy(&pkt[i], topic, topiclen);
631
0
  i += topiclen;
632
0
  memcpy(&pkt[i], payload, payloadlen);
633
0
  i += payloadlen;
634
0
  result = mqtt_send(data, (const char *)pkt, i);
635
636
0
fail:
637
0
  free(pkt);
638
0
  free(topic);
639
0
  return result;
640
0
}
641
642
static size_t mqtt_decode_len(unsigned char *buf,
643
                              size_t buflen, size_t *lenbytes)
644
0
{
645
0
  size_t len = 0;
646
0
  size_t mult = 1;
647
0
  size_t i;
648
0
  unsigned char encoded = 128;
649
650
0
  for(i = 0; (i < buflen) && (encoded & 128); i++) {
651
0
    encoded = buf[i];
652
0
    len += (encoded & 127) * mult;
653
0
    mult *= 128;
654
0
  }
655
656
0
  if(lenbytes)
657
0
    *lenbytes = i;
658
659
0
  return len;
660
0
}
661
662
#ifdef DEBUGBUILD
663
static const char *statenames[]={
664
  "MQTT_FIRST",
665
  "MQTT_REMAINING_LENGTH",
666
  "MQTT_CONNACK",
667
  "MQTT_SUBACK",
668
  "MQTT_SUBACK_COMING",
669
  "MQTT_PUBWAIT",
670
  "MQTT_PUB_REMAIN",
671
672
  "NOT A STATE"
673
};
674
#endif
675
676
/* The only way to change state */
677
static void mqstate(struct Curl_easy *data,
678
                    enum mqttstate state,
679
                    enum mqttstate nextstate) /* used if state == FIRST */
680
0
{
681
0
  struct connectdata *conn = data->conn;
682
0
  struct mqtt_conn *mqtt = Curl_conn_meta_get(conn, CURL_META_MQTT_CONN);
683
0
  DEBUGASSERT(mqtt);
684
0
  if(!mqtt)
685
0
    return;
686
#ifdef DEBUGBUILD
687
  infof(data, "%s (from %s) (next is %s)",
688
        statenames[state],
689
        statenames[mqtt->state],
690
        (state == MQTT_FIRST) ? statenames[nextstate] : "");
691
#endif
692
0
  mqtt->state = state;
693
0
  if(state == MQTT_FIRST)
694
0
    mqtt->nextstate = nextstate;
695
0
}
696
697
698
static CURLcode mqtt_read_publish(struct Curl_easy *data, bool *done)
699
0
{
700
0
  CURLcode result = CURLE_OK;
701
0
  struct connectdata *conn = data->conn;
702
0
  size_t nread;
703
0
  size_t remlen;
704
0
  struct mqtt_conn *mqtt = Curl_conn_meta_get(conn, CURL_META_MQTT_CONN);
705
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
706
0
  unsigned char packet;
707
708
0
  DEBUGASSERT(mqtt);
709
0
  if(!mqtt || !mq)
710
0
    return CURLE_FAILED_INIT;
711
712
0
  switch(mqtt->state) {
713
0
MQTT_SUBACK_COMING:
714
0
  case MQTT_SUBACK_COMING:
715
0
    result = mqtt_verify_suback(data);
716
0
    if(result)
717
0
      break;
718
719
0
    mqstate(data, MQTT_FIRST, MQTT_PUBWAIT);
720
0
    break;
721
722
0
  case MQTT_SUBACK:
723
0
  case MQTT_PUBWAIT:
724
    /* we are expecting PUBLISH or SUBACK */
725
0
    packet = mq->firstbyte & 0xf0;
726
0
    if(packet == MQTT_MSG_PUBLISH)
727
0
      mqstate(data, MQTT_PUB_REMAIN, MQTT_NOSTATE);
728
0
    else if(packet == MQTT_MSG_SUBACK) {
729
0
      mqstate(data, MQTT_SUBACK_COMING, MQTT_NOSTATE);
730
0
      goto MQTT_SUBACK_COMING;
731
0
    }
732
0
    else if(packet == MQTT_MSG_DISCONNECT) {
733
0
      infof(data, "Got DISCONNECT");
734
0
      *done = TRUE;
735
0
      goto end;
736
0
    }
737
0
    else {
738
0
      result = CURLE_WEIRD_SERVER_REPLY;
739
0
      goto end;
740
0
    }
741
742
    /* -- switched state -- */
743
0
    remlen = mq->remaining_length;
744
0
    infof(data, "Remaining length: %zu bytes", remlen);
745
0
    if(data->set.max_filesize &&
746
0
       (curl_off_t)remlen > data->set.max_filesize) {
747
0
      failf(data, "Maximum file size exceeded");
748
0
      result = CURLE_FILESIZE_EXCEEDED;
749
0
      goto end;
750
0
    }
751
0
    Curl_pgrsSetDownloadSize(data, remlen);
752
0
    data->req.bytecount = 0;
753
0
    data->req.size = remlen;
754
0
    mq->npacket = remlen; /* get this many bytes */
755
0
    FALLTHROUGH();
756
0
  case MQTT_PUB_REMAIN: {
757
    /* read rest of packet, but no more. Cap to buffer size */
758
0
    char buffer[4*1024];
759
0
    size_t rest = mq->npacket;
760
0
    if(rest > sizeof(buffer))
761
0
      rest = sizeof(buffer);
762
0
    result = Curl_xfer_recv(data, buffer, rest, &nread);
763
0
    if(result) {
764
0
      if(CURLE_AGAIN == result) {
765
0
        infof(data, "EEEE AAAAGAIN");
766
0
      }
767
0
      goto end;
768
0
    }
769
0
    if(!nread) {
770
0
      infof(data, "server disconnected");
771
0
      result = CURLE_PARTIAL_FILE;
772
0
      goto end;
773
0
    }
774
775
    /* we received something */
776
0
    mq->lastTime = curlx_now();
777
778
    /* if QoS is set, message contains packet id */
779
0
    result = Curl_client_write(data, CLIENTWRITE_BODY, buffer, nread);
780
0
    if(result)
781
0
      goto end;
782
783
0
    mq->npacket -= nread;
784
0
    if(!mq->npacket)
785
      /* no more PUBLISH payload, back to subscribe wait state */
786
0
      mqstate(data, MQTT_FIRST, MQTT_PUBWAIT);
787
0
    break;
788
0
  }
789
0
  default:
790
0
    DEBUGASSERT(NULL); /* illegal state */
791
0
    result = CURLE_WEIRD_SERVER_REPLY;
792
0
    goto end;
793
0
  }
794
0
end:
795
0
  return result;
796
0
}
797
798
static CURLcode mqtt_do(struct Curl_easy *data, bool *done)
799
0
{
800
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
801
0
  CURLcode result = CURLE_OK;
802
0
  *done = FALSE; /* unconditionally */
803
804
0
  if(!mq)
805
0
    return CURLE_FAILED_INIT;
806
0
  mq->lastTime = curlx_now();
807
0
  mq->pingsent = FALSE;
808
809
0
  result = mqtt_connect(data);
810
0
  if(result) {
811
0
    failf(data, "Error %d sending MQTT CONNECT request", result);
812
0
    return result;
813
0
  }
814
0
  mqstate(data, MQTT_FIRST, MQTT_CONNACK);
815
0
  return CURLE_OK;
816
0
}
817
818
static CURLcode mqtt_done(struct Curl_easy *data,
819
                          CURLcode status, bool premature)
820
0
{
821
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
822
0
  (void)status;
823
0
  (void)premature;
824
0
  if(mq) {
825
0
    curlx_dyn_free(&mq->sendbuf);
826
0
    curlx_dyn_free(&mq->recvbuf);
827
0
  }
828
0
  return CURLE_OK;
829
0
}
830
831
/* we ping regularly to avoid being disconnected by the server */
832
static CURLcode mqtt_ping(struct Curl_easy *data)
833
0
{
834
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
835
0
  CURLcode result = CURLE_OK;
836
0
  struct connectdata *conn = data->conn;
837
0
  struct mqtt_conn *mqtt = Curl_conn_meta_get(conn, CURL_META_MQTT_CONN);
838
839
0
  if(!mqtt || !mq)
840
0
    return CURLE_FAILED_INIT;
841
842
0
  if(mqtt->state == MQTT_FIRST &&
843
0
     !mq->pingsent &&
844
0
     data->set.upkeep_interval_ms > 0) {
845
0
    struct curltime t = curlx_now();
846
0
    timediff_t diff = curlx_timediff(t, mq->lastTime);
847
848
0
    if(diff > data->set.upkeep_interval_ms) {
849
      /* 0xC0 is PINGREQ, and 0x00 is remaining length */
850
0
      unsigned char packet[2] = { 0xC0, 0x00 };
851
0
      size_t packetlen = sizeof(packet);
852
853
0
      result = mqtt_send(data, (char *)packet, packetlen);
854
0
      if(!result) {
855
0
        mq->pingsent = TRUE;
856
0
      }
857
0
      infof(data, "mqtt_ping: sent ping request.");
858
0
    }
859
0
  }
860
0
  return result;
861
0
}
862
863
static CURLcode mqtt_doing(struct Curl_easy *data, bool *done)
864
0
{
865
0
  struct MQTT *mq = Curl_meta_get(data, CURL_META_MQTT_EASY);
866
0
  CURLcode result = CURLE_OK;
867
0
  size_t nread;
868
0
  unsigned char recvbyte;
869
0
  struct mqtt_conn *mqtt = Curl_conn_meta_get(data->conn, CURL_META_MQTT_CONN);
870
871
0
  if(!mqtt || !mq)
872
0
    return CURLE_FAILED_INIT;
873
874
0
  *done = FALSE;
875
876
0
  if(curlx_dyn_len(&mq->sendbuf)) {
877
    /* send the remainder of an outgoing packet */
878
0
    result = mqtt_send(data, curlx_dyn_ptr(&mq->sendbuf),
879
0
                       curlx_dyn_len(&mq->sendbuf));
880
0
    if(result)
881
0
      return result;
882
0
  }
883
884
0
  result = mqtt_ping(data);
885
0
  if(result)
886
0
    return result;
887
888
0
  infof(data, "mqtt_doing: state [%d]", (int) mqtt->state);
889
0
  switch(mqtt->state) {
890
0
  case MQTT_FIRST:
891
    /* Read the initial byte only */
892
0
    result = Curl_xfer_recv(data, (char *)&mq->firstbyte, 1, &nread);
893
0
    if(result)
894
0
      break;
895
0
    else if(!nread) {
896
0
      failf(data, "Connection disconnected");
897
0
      *done = TRUE;
898
0
      result = CURLE_RECV_ERROR;
899
0
      break;
900
0
    }
901
0
    Curl_debug(data, CURLINFO_HEADER_IN, (const char *)&mq->firstbyte, 1);
902
903
    /* we received something */
904
0
    mq->lastTime = curlx_now();
905
906
    /* remember the first byte */
907
0
    mq->npacket = 0;
908
0
    mqstate(data, MQTT_REMAINING_LENGTH, MQTT_NOSTATE);
909
0
    FALLTHROUGH();
910
0
  case MQTT_REMAINING_LENGTH:
911
0
    do {
912
0
      result = Curl_xfer_recv(data, (char *)&recvbyte, 1, &nread);
913
0
      if(result || !nread)
914
0
        break;
915
0
      Curl_debug(data, CURLINFO_HEADER_IN, (const char *)&recvbyte, 1);
916
0
      mq->pkt_hd[mq->npacket++] = recvbyte;
917
0
    } while((recvbyte & 0x80) && (mq->npacket < 4));
918
0
    if(!result && nread && (recvbyte & 0x80))
919
      /* MQTT supports up to 127 * 128^0 + 127 * 128^1 + 127 * 128^2 +
920
         127 * 128^3 bytes. server tried to send more */
921
0
      result = CURLE_WEIRD_SERVER_REPLY;
922
0
    if(result)
923
0
      break;
924
0
    mq->remaining_length = mqtt_decode_len(mq->pkt_hd, mq->npacket, NULL);
925
0
    mq->npacket = 0;
926
0
    if(mq->remaining_length) {
927
0
      mqstate(data, mqtt->nextstate, MQTT_NOSTATE);
928
0
      break;
929
0
    }
930
0
    mqstate(data, MQTT_FIRST, MQTT_FIRST);
931
932
0
    if(mq->firstbyte == MQTT_MSG_DISCONNECT) {
933
0
      infof(data, "Got DISCONNECT");
934
0
      *done = TRUE;
935
0
    }
936
937
    /* ping response */
938
0
    if(mq->firstbyte == MQTT_MSG_PINGRESP) {
939
0
      infof(data, "Received ping response.");
940
0
      mq->pingsent = FALSE;
941
0
      mqstate(data, MQTT_FIRST, MQTT_PUBWAIT);
942
0
    }
943
0
    break;
944
0
  case MQTT_CONNACK:
945
0
    result = mqtt_verify_connack(data);
946
0
    if(result)
947
0
      break;
948
949
0
    if(data->state.httpreq == HTTPREQ_POST) {
950
0
      result = mqtt_publish(data);
951
0
      if(!result) {
952
0
        result = mqtt_disconnect(data);
953
0
        *done = TRUE;
954
0
      }
955
0
      mqtt->nextstate = MQTT_FIRST;
956
0
    }
957
0
    else {
958
0
      result = mqtt_subscribe(data);
959
0
      if(!result) {
960
0
        mqstate(data, MQTT_FIRST, MQTT_SUBACK);
961
0
      }
962
0
    }
963
0
    break;
964
965
0
  case MQTT_SUBACK:
966
0
  case MQTT_PUBWAIT:
967
0
  case MQTT_PUB_REMAIN:
968
0
    result = mqtt_read_publish(data, done);
969
0
    break;
970
971
0
  default:
972
0
    failf(data, "State not handled yet");
973
0
    *done = TRUE;
974
0
    break;
975
0
  }
976
977
0
  if(result == CURLE_AGAIN)
978
0
    result = CURLE_OK;
979
0
  return result;
980
0
}
981
982
#endif /* CURL_DISABLE_MQTT */