Coverage Report

Created: 2026-10-16 06:40

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/wolfmqtt-fuzzers/fuzzer.cpp
Line
Count
Source
1
// Copyright 2026 Google LLC.
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
//     http://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14
15
#include <fuzzing/datasource/datasource.hpp>
16
#include <wolfmqtt/mqtt_client.h>
17
#include <wolfmqtt/mqtt_packet.h>
18
#include <optional>
19
20
38.1k
#define CHECK_EQ(expr, res) if ( (expr) != (res) ) { goto end; }
21
#define CHECK_NE(expr, res) if ( (expr) == (res) ) { goto end; }
22
23
8.21k
#define BADPTR ((void*)0x12)
24
3.26k
#define MAX_TOPICS 50
25
26
493k
#define DEBUG 0
27
28
class Base {
29
    protected:
30
        fuzzing::datasource::Datasource& ds;
31
        MqttQoS GetQoS(void) const;
32
    public:
33
        Base(fuzzing::datasource::Datasource& ds);
34
        ~Base();
35
};
36
37
Base::Base(fuzzing::datasource::Datasource& ds) :
38
14.8k
    ds(ds)
39
14.8k
{ }
40
41
14.8k
Base::~Base() { }
42
43
8.69k
MqttQoS Base::GetQoS(void) const {
44
8.69k
    switch ( ds.Get<uint8_t>() % 3 ) {
45
4.53k
        case    0:
46
4.53k
            return MQTT_QOS_0;
47
2.88k
        case    1:
48
2.88k
            return MQTT_QOS_1;
49
1.23k
        case    2:
50
1.23k
            return MQTT_QOS_2;
51
0
        default:
52
            /* Silence compiler warning */
53
0
            abort();
54
8.69k
    }
55
8.69k
}
56
57
class Topic : public Base {
58
    private:
59
        MqttTopic topic;
60
        std::vector<std::string> strings;
61
    public:
62
        Topic(fuzzing::datasource::Datasource& ds);
63
        ~Topic();
64
        bool Generate(void);
65
        MqttTopic Get(void);
66
};
67
68
Topic::Topic(fuzzing::datasource::Datasource& ds) :
69
7.44k
    Base(ds)
70
7.44k
{ }
71
72
7.44k
Topic::~Topic() { }
73
74
7.44k
bool Topic::Generate(void) {
75
7.44k
    bool ret;
76
77
7.44k
    memset(&topic, 0, sizeof(topic));
78
79
7.44k
    strings.push_back( ds.Get<std::string>() );
80
7.44k
    topic.topic_filter = strings.back().c_str();
81
82
7.44k
    topic.qos = GetQoS();
83
84
7.44k
    ret = true;
85
7.44k
end:
86
6.64k
    return ret;
87
7.44k
}
88
89
6.43k
MqttTopic Topic::Get(void) {
90
6.43k
    return topic;
91
6.43k
}
92
93
class Topics : public Base {
94
    private:
95
        std::vector<Topic*> topics;
96
    public:
97
        Topics(fuzzing::datasource::Datasource& ds);
98
        ~Topics();
99
        bool Generate(void);
100
        MqttTopic* ToArray(void);
101
        size_t Size(void) const;
102
};
103
104
Topics::Topics(fuzzing::datasource::Datasource& ds) :
105
3.26k
    Base(ds)
106
3.26k
{ }
107
108
3.26k
Topics::~Topics() {
109
7.44k
    for (auto& t : topics) {
110
7.44k
        delete t;
111
7.44k
    }
112
3.26k
}
113
        
114
3.26k
bool Topics::Generate(void) {
115
3.26k
    bool ret;
116
117
3.26k
    try {
118
3.26k
        const auto numTopics = ds.Get<uint16_t>() % (MAX_TOPICS+1);
119
120
10.7k
        for (size_t i = 0; i < numTopics; i++) {
121
7.44k
            topics.push_back(new Topic(ds));
122
7.44k
            CHECK_EQ(topics.back()->Generate(), true);
123
7.44k
        }
124
125
3.26k
        ret = true;
126
3.26k
    } catch ( ... ) { }
127
128
3.26k
end:
129
3.26k
    return ret;
130
3.26k
}
131
132
3.08k
MqttTopic* Topics::ToArray(void) {
133
3.08k
    auto ret = new MqttTopic[topics.size()];
134
135
9.52k
    for (size_t i = 0; i < Size(); i++) {
136
6.43k
        ret[i] = topics[i]->Get();
137
6.43k
    }
138
3.08k
    return ret;
139
3.08k
}
140
        
141
12.6k
size_t Topics::Size(void) const {
142
12.6k
    return topics.size();
143
12.6k
}
144
145
class wolfMQTTFuzzer : public Base {
146
        MqttClient client;
147
        MqttNet net;
148
        MqttConnect connect;
149
150
        uint8_t* tx_buf = nullptr, *rx_buf = nullptr;
151
        size_t tx_size = 0, rx_size = 0;
152
153
        std::string client_id;
154
155
        void* malloc(const size_t n);
156
        void free(void* ptr);
157
158
        word16 GetPacketId(void) const;
159
        std::optional<Topic> GetTopic(void) const;
160
161
        bool subscribe(void);
162
        bool unsubscribe(void);
163
        bool publish(void);
164
        bool ping(void);
165
        bool wait(void);
166
    public:
167
        wolfMQTTFuzzer(fuzzing::datasource::Datasource& ds);
168
        ~wolfMQTTFuzzer();
169
        bool Initialize(void);
170
        void Run(void);
171
        int recv(byte* buf, const int buf_len);
172
        int write(const int buf_len);
173
174
};
175
176
static int mqtt_connect(void *context, const char* host, word16 port, int timeout_ms)
177
3.94k
{
178
3.94k
    (void)context;
179
3.94k
    (void)host;
180
3.94k
    (void)port;
181
3.94k
    (void)timeout_ms;
182
183
3.94k
    return MQTT_CODE_SUCCESS;
184
3.94k
}
185
186
static int mqtt_recv(void *context, byte* buf, int buf_len, int timeout_ms)
187
474k
{
188
474k
    (void)context;
189
474k
    (void)timeout_ms;
190
191
474k
    auto fuzzer = static_cast<wolfMQTTFuzzer*>(context);
192
474k
    return fuzzer->recv(buf, buf_len);
193
474k
}
194
195
static int mqtt_write(void *context, const byte* buf, int buf_len, int timeout_ms)
196
15.3k
{
197
15.3k
    (void)context;
198
15.3k
    (void)timeout_ms;
199
15.3k
    (void)buf;
200
201
15.3k
    auto fuzzer = static_cast<wolfMQTTFuzzer*>(context);
202
15.3k
    return fuzzer->write(buf_len);
203
15.3k
}
204
205
static int mqtt_disconnect(void *context)
206
158
{
207
158
    (void)context;
208
209
158
    return MQTT_CODE_SUCCESS;
210
158
}
211
212
static int mqtt_message_cb(MqttClient *client, MqttMessage *msg, byte msg_new, byte msg_done)
213
177k
{
214
177k
    return MQTT_CODE_SUCCESS;
215
177k
}
216
217
8.12k
void* wolfMQTTFuzzer::malloc(const size_t n) {
218
8.12k
    return n == 0 ? BADPTR : ::malloc(n);
219
8.12k
}
220
221
8.21k
void wolfMQTTFuzzer::free(void* ptr) {
222
8.21k
    if ( ptr == BADPTR ) {
223
0
        return;
224
0
    }
225
226
8.21k
    ::free(ptr);
227
8.21k
}
228
229
0
std::optional<Topic> wolfMQTTFuzzer::GetTopic(void) const {
230
0
    Topic topic(ds);
231
232
0
    if ( topic.Generate() == false ) {
233
0
        return std::nullopt;
234
0
    }
235
236
0
    return topic;
237
0
}
238
239
4.96k
word16 wolfMQTTFuzzer::GetPacketId(void) const {
240
4.96k
    return ds.Get<word16>();
241
4.96k
}
242
243
2.10k
bool wolfMQTTFuzzer::subscribe(void) {
244
2.10k
    MqttTopic* topicsArray = nullptr;
245
246
2.10k
    bool ret = false;
247
248
2.10k
    try {
249
2.10k
        Topics topics(ds);
250
2.10k
        CHECK_EQ(topics.Generate(), true);
251
252
2.10k
        MqttSubscribe subscribe;
253
254
2.10k
        memset(&subscribe, 0, sizeof(subscribe));
255
256
2.10k
        subscribe.packet_id = GetPacketId();
257
2.10k
        topicsArray = topics.ToArray();
258
2.10k
        subscribe.topic_count = topics.Size();
259
2.10k
        subscribe.topics = topicsArray;
260
261
2.10k
        CHECK_EQ(MqttClient_Subscribe(&client, &subscribe), MQTT_CODE_SUCCESS);
262
263
231
        ret = true;
264
231
    } catch ( ... ) { }
265
266
2.10k
end:
267
2.10k
    if ( topicsArray ) {
268
1.96k
        delete[] topicsArray;
269
1.96k
    }
270
2.10k
    return ret;
271
2.10k
}
272
273
1.16k
bool wolfMQTTFuzzer::unsubscribe(void) {
274
1.16k
    MqttTopic* topicsArray = nullptr;
275
276
1.16k
    bool ret = false;
277
278
1.16k
    try {
279
1.16k
        Topics topics(ds);
280
1.16k
        CHECK_EQ(topics.Generate(), true);
281
282
1.16k
        MqttUnsubscribe unsubscribe;
283
284
1.16k
        memset(&unsubscribe, 0, sizeof(unsubscribe));
285
286
1.16k
        unsubscribe.packet_id = GetPacketId();
287
1.16k
        topicsArray = topics.ToArray();
288
1.16k
        unsubscribe.topic_count = topics.Size();
289
1.16k
        unsubscribe.topics = topicsArray;
290
291
1.16k
        CHECK_EQ(MqttClient_Unsubscribe(&client, &unsubscribe), MQTT_CODE_SUCCESS);
292
293
97
        ret = true;
294
97
    } catch ( ... ) { }
295
296
1.16k
end:
297
1.16k
    if ( topicsArray ) {
298
1.12k
        delete[] topicsArray;
299
1.12k
    }
300
1.16k
    return ret;
301
1.16k
}
302
303
1.91k
bool wolfMQTTFuzzer::publish(void) {
304
1.91k
    bool ret = false;
305
306
1.91k
    try {
307
1.91k
        MqttPublish publish;
308
309
1.91k
        memset(&publish, 0, sizeof(publish));
310
311
1.91k
        publish.retain = ds.Get<bool>() ? 1 : 0;
312
1.91k
        publish.qos = GetQoS();
313
1.91k
        publish.duplicate = ds.Get<bool>() ? 1 : 0;
314
315
1.91k
        const auto topic_str = ds.Get<std::string>();
316
1.91k
        publish.topic_name = topic_str.c_str();
317
318
1.91k
        publish.packet_id = GetPacketId();
319
320
1.91k
        auto buffer = ds.GetData(0);
321
1.91k
        publish.buffer = buffer.data();
322
1.91k
        publish.total_len = buffer.size();
323
324
1.91k
        if ( DEBUG ) {
325
0
            printf("publish: topic name size: %zu\n", strlen(topic_str.c_str()));
326
0
        }
327
328
1.91k
        CHECK_EQ(MqttClient_Publish(&client, &publish), MQTT_CODE_SUCCESS);
329
330
475
        ret = true;
331
475
    } catch ( ... ) { }
332
333
1.91k
end:
334
1.91k
    return ret;
335
1.91k
}
336
337
1.25k
bool wolfMQTTFuzzer::ping(void) {
338
1.25k
    bool ret = false;
339
340
1.25k
    MqttPing ping;
341
342
1.25k
    memset(&ping, 0, sizeof(ping));
343
344
1.25k
    CHECK_EQ(MqttClient_Ping_ex(&client, &ping), true);
345
346
0
    ret = true;
347
348
1.25k
end:
349
1.25k
    return ret;
350
0
}
351
352
4.56k
bool wolfMQTTFuzzer::wait(void) {
353
4.56k
    bool ret = false;
354
355
4.56k
    CHECK_EQ(MqttClient_WaitMessage(&client, 1000), MQTT_CODE_SUCCESS);
356
357
955
    ret = true;
358
359
4.56k
end:
360
4.56k
    return ret;
361
955
}
362
363
wolfMQTTFuzzer::wolfMQTTFuzzer(fuzzing::datasource::Datasource& ds) :
364
4.10k
    Base(ds)
365
4.10k
{ }
366
367
4.10k
wolfMQTTFuzzer::~wolfMQTTFuzzer() {
368
4.10k
    this->free(tx_buf);
369
4.10k
    this->free(rx_buf);
370
4.10k
}
371
372
4.10k
bool wolfMQTTFuzzer::Initialize(void) {
373
4.10k
    bool ret = false;
374
375
4.10k
    try {
376
        /* net */
377
4.10k
        {
378
4.10k
            memset(&net, 0, sizeof(net));
379
380
4.10k
            net.connect = mqtt_connect;
381
4.10k
            net.read = mqtt_recv;
382
4.10k
            net.write = mqtt_write;
383
4.10k
            net.disconnect = mqtt_disconnect;
384
4.10k
            net.context = this;
385
4.10k
        }
386
387
        /* client */
388
4.10k
        {
389
4.10k
            memset(&client, 0, sizeof(client));
390
391
4.10k
            tx_size = ds.Get<uint16_t>();
392
4.10k
            tx_size = 4096;
393
4.10k
            tx_buf = (uint8_t*)this->malloc(tx_size);
394
4.10k
            rx_size = ds.Get<uint16_t>();
395
4.10k
            rx_size = 4096;
396
4.10k
            rx_buf = (uint8_t*)this->malloc(rx_size);
397
4.10k
            memset(tx_buf, 0, tx_size);
398
4.10k
            memset(rx_buf, 0, rx_size);
399
400
4.10k
            client.msg_cb = mqtt_message_cb;
401
4.10k
            client.tx_buf = tx_buf;
402
4.10k
            client.tx_buf_len = tx_size;
403
4.10k
            client.rx_buf = rx_buf;
404
4.10k
            client.rx_buf_len = rx_size;
405
4.10k
            client.cmd_timeout_ms = 1000;
406
4.10k
        }
407
408
        /* connect */
409
        /* Zero-initialize: only a subset of lwt_msg's fields are set below when
410
         * LWT is enabled, and the MQTT v5 encoder in MqttEncode_Connect reads
411
         * other members (e.g. props). Leaving them uninitialized is a harness
412
         * bug that MSAN reports as a use-of-uninitialized-value inside
413
         * MqttEncode_Connect. */
414
4.10k
        MqttMessage lwt_msg;
415
4.10k
        memset(&lwt_msg, 0, sizeof(lwt_msg));
416
4.10k
        {
417
4.10k
            memset(&connect, 0, sizeof(connect));
418
419
4.10k
            connect.keep_alive_sec = 1;
420
4.10k
            connect.clean_session = ds.Get<bool>() ? 1 : 0;
421
4.10k
            client_id = ds.Get<std::string>();
422
4.10k
            connect.client_id = client_id.c_str();
423
4.10k
            connect.enable_lwt = ds.Get<bool>() ? 1 : 0;
424
4.10k
        }
425
            
426
4.10k
        std::string lwt_topic_name;
427
4.10k
        std::vector<uint8_t> lwt_buffer;
428
429
4.10k
        if ( connect.enable_lwt ) {
430
121
            lwt_topic_name = ds.Get<std::string>();
431
121
            lwt_buffer = ds.GetData(0);
432
433
121
            connect.lwt_msg = &lwt_msg;
434
121
            lwt_msg.qos = GetQoS();
435
121
            lwt_msg.retain = ds.Get<bool>() ? 1 : 0;
436
121
            lwt_msg.topic_name = lwt_topic_name.c_str();
437
121
            lwt_msg.buffer = lwt_buffer.data();
438
121
            lwt_msg.total_len = lwt_buffer.size();
439
121
        }
440
441
4.10k
        CHECK_EQ(MqttSocket_Init(&client, &net), MQTT_CODE_SUCCESS);
442
443
#if 0
444
        if ( ds.Get<bool>() ) {
445
            //CHECK_EQ(MqttClient_SetPropertyCallback(&client, mqtt_property_cb, NULL);
446
        }
447
#endif
448
449
4.10k
        CHECK_EQ(MqttClient_NetConnect(&client, "dummy", 12345, 1000, 0, NULL), MQTT_CODE_SUCCESS);
450
4.10k
        CHECK_EQ(MqttClient_Connect(&client, &connect), MQTT_CODE_SUCCESS);
451
452
2.81k
        ret = true;
453
454
2.81k
    } catch ( ... ) {
455
161
        return false;
456
161
    }
457
458
3.94k
end:
459
3.94k
    return ret;
460
4.10k
}
461
462
2.65k
void wolfMQTTFuzzer::Run(void) {
463
2.65k
    try {
464
2.65k
        const auto numActions = ds.Get<uint8_t>() % 20;
465
466
15.0k
        for (size_t i = 0; i < numActions; i++) {
467
14.8k
            switch ( ds.Get<uint8_t>() ) {
468
2.10k
                case    0:
469
2.10k
                    subscribe();
470
2.10k
                    break;
471
1.16k
                case    1:
472
1.16k
                    unsubscribe();
473
1.16k
                    break;
474
1.91k
                case    2:
475
1.91k
                    publish();
476
1.91k
                    break;
477
1.25k
                case    3:
478
1.25k
                    ping();
479
1.25k
                    break;
480
4.56k
                case    4:
481
4.56k
                    wait();
482
4.56k
                    break;
483
14.8k
            }
484
14.8k
        }
485
486
193
        MqttClient_NetDisconnect(&client);
487
2.49k
    } catch ( ... ) { }
488
2.65k
}
489
490
474k
int wolfMQTTFuzzer::recv(byte* buf, const int buf_len) {
491
474k
    try {
492
474k
        const auto data = ds.GetData(0);
493
474k
        const size_t copySize = buf_len > data.size() ? data.size() : buf_len;
494
474k
        if ( copySize ) {
495
29.5k
            memcpy(buf, data.data(), copySize);
496
29.5k
        }
497
474k
        if ( DEBUG )
498
0
        {
499
0
            printf("Recv: %zu bytes (%d requested)\n", copySize, buf_len);
500
0
            for (size_t i = 0; i < copySize; i++) {
501
0
                printf("%02X ", data[i]);
502
0
            }
503
0
            printf("\n");
504
0
        }
505
474k
        return copySize;
506
474k
    } catch ( ... ) {
507
2.30k
        if ( DEBUG ) printf("Recv: -1\n");
508
2.30k
        return -1;
509
2.30k
    }
510
474k
}
511
512
15.3k
int wolfMQTTFuzzer::write(const int buf_len) {
513
15.3k
    try {
514
15.3k
        if ( ds.Get<bool>() == true ) {
515
1.26k
            if ( DEBUG ) printf("write: -1\n");
516
1.26k
            return -1;
517
1.26k
        }
518
519
14.1k
        const auto ret = (int)(ds.Get<uint32_t>() % (buf_len+1));
520
14.1k
        if ( DEBUG ) printf("write: %d bytes (%d requested)\n", ret, buf_len);
521
14.1k
        return ret;
522
15.3k
    } catch ( ... ) {
523
1.00k
        return -1;
524
1.00k
    }
525
15.3k
}
526
527
4.10k
extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
528
4.10k
    fuzzing::datasource::Datasource ds(data, size);
529
4.10k
    wolfMQTTFuzzer fuzzer(ds);
530
531
4.10k
    CHECK_EQ(fuzzer.Initialize(), true);
532
533
2.65k
    fuzzer.Run();
534
535
4.10k
end:
536
4.10k
    return 0;
537
2.65k
}