Coverage Report

Created: 2025-10-10 06:31

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