Coverage Report

Created: 2026-06-10 06:28

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/avahi/avahi-common/strlst.c
Line
Count
Source
1
/***
2
  This file is part of avahi.
3
4
  avahi is free software; you can redistribute it and/or modify it
5
  under the terms of the GNU Lesser General Public License as
6
  published by the Free Software Foundation; either version 2.1 of the
7
  License, or (at your option) any later version.
8
9
  avahi is distributed in the hope that it will be useful, but WITHOUT
10
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11
  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
12
  Public License for more details.
13
14
  You should have received a copy of the GNU Lesser General Public
15
  License along with avahi; if not, write to the Free Software
16
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
17
  USA.
18
***/
19
20
#ifdef HAVE_CONFIG_H
21
#include <config.h>
22
#endif
23
24
#include <string.h>
25
#include <stdarg.h>
26
#include <assert.h>
27
#include <stdio.h>
28
#include <stdlib.h>
29
30
#include "strlst.h"
31
#include "malloc.h"
32
#include "defs.h"
33
34
4.13M
AvahiStringList*avahi_string_list_add_anonymous(AvahiStringList *l, size_t size) {
35
4.13M
    AvahiStringList *n;
36
37
4.13M
    if (!(n = avahi_malloc(sizeof(AvahiStringList) + size)))
38
0
        return NULL;
39
40
4.13M
    n->next = l;
41
4.13M
    n->size = size;
42
43
    /* NUL terminate strings, just to make sure */
44
4.13M
    n->text[size] = 0;
45
46
4.13M
    return n;
47
4.13M
}
48
49
4.13M
AvahiStringList *avahi_string_list_add_arbitrary(AvahiStringList *l, const uint8_t*text, size_t size) {
50
4.13M
    AvahiStringList *n;
51
52
4.13M
    assert(size == 0 || text);
53
54
4.13M
    if (!(n = avahi_string_list_add_anonymous(l, size)))
55
0
        return NULL;
56
57
4.13M
    if (size > 0)
58
4.13M
        memcpy(n->text, text, size);
59
60
4.13M
    return n;
61
4.13M
}
62
63
0
AvahiStringList *avahi_string_list_add(AvahiStringList *l, const char *text) {
64
0
    assert(text);
65
66
0
    return avahi_string_list_add_arbitrary(l, (const uint8_t*) text, strlen(text));
67
0
}
68
69
1.70k
int avahi_string_list_parse(const void* data, size_t size, AvahiStringList **ret) {
70
1.70k
    const uint8_t *c;
71
1.70k
    AvahiStringList *r = NULL;
72
73
1.70k
    assert(data);
74
1.70k
    assert(ret);
75
76
1.70k
    c = data;
77
7.13M
    while (size > 0) {
78
7.13M
        size_t k;
79
80
7.13M
        k = *(c++);
81
7.13M
        size--;
82
83
7.13M
        if (k > size)
84
77
            goto fail; /* Overflow */
85
86
7.13M
        if (k > 0) { /* Ignore empty strings */
87
2.78M
            AvahiStringList *n;
88
89
2.78M
            if (!(n = avahi_string_list_add_arbitrary(r, c, k)))
90
0
                goto fail; /* OOM */
91
92
2.78M
            r = n;
93
2.78M
        }
94
95
7.13M
        c += k;
96
7.13M
        size -= k;
97
7.13M
    }
98
99
1.62k
    *ret = r;
100
101
1.62k
    return 0;
102
103
77
fail:
104
77
    avahi_string_list_free(r);
105
77
    return -1;
106
1.70k
}
107
108
2.51k
void avahi_string_list_free(AvahiStringList *l) {
109
2.51k
    AvahiStringList *n;
110
111
4.13M
    while (l) {
112
4.13M
        n = l->next;
113
4.13M
        avahi_free(l);
114
4.13M
        l = n;
115
4.13M
    }
116
2.51k
}
117
118
8.48k
AvahiStringList* avahi_string_list_reverse(AvahiStringList *l) {
119
8.48k
    AvahiStringList *r = NULL, *n;
120
121
9.66M
    while (l) {
122
9.65M
        n = l->next;
123
9.65M
        l->next = r;
124
9.65M
        r = l;
125
9.65M
        l = n;
126
9.65M
    }
127
128
8.48k
    return r;
129
8.48k
}
130
131
/**
132
 * This routine is used for both human- and machine-readable output of
133
 * TXT records. As such it must cope with escaping, in order to allow
134
 * machines to reconstruct the original data.
135
 *
136
 * AFAIK no RFC specifies syntax for TXT data other than raw binary,
137
 * though presumably zonefile syntax would make sense:
138
 *
139
 *   - RFC 1035 says that TXT records contain `<character-string>`s, and section
140
 *     5 says:
141
 *
142
 *       <character-string> is expressed in one or two ways: as a contiguous set
143
 *       of characters without interior spaces, or as a string beginning with a "
144
 *       and ending with a ".  Inside a " delimited string any character can
145
 *       occur, except for a " itself, which must be quoted using \ (back slash).
146
 *
147
 *     This omits escaping of backslashes (!).
148
 *
149
 *   - RFC 1034 doesn't say anything relevant.
150
 *
151
 *   - RFC 1464 suggests a specific encoding of information within a TXT
152
 *     record but does not discuss formatting of TXT records in
153
 *     general.
154
 *
155
 * In order to also escape newlines, which interfere with line-by-line
156
 * machine processing of records, this routine:
157
 *
158
 *   - escapes >>> " <<< to >>> \" <<<
159
 *   - escapes >>> \ <<< to >>> \\ <<<
160
 *   - escapes bytes less than 32 or more than 126 to backslash-prefixed 3-digit DECIMAL form
161
 */
162
1.13k
char* avahi_string_list_to_string(AvahiStringList *l) {
163
1.13k
    AvahiStringList *n;
164
1.13k
    size_t s = 0;
165
1.13k
    uint8_t *p;
166
1.13k
    char *t, *e;
167
168
2.65M
    for (n = l; n; n = n->next) {
169
2.65M
        if (n != l)
170
2.64M
            s ++; /* for the inter-string separating space */
171
172
27.0M
        for (p = n->text; ((size_t) (p - n->text) < n->size); p++) {
173
24.4M
            switch (*p) {
174
285k
              case '"':
175
341k
              case '\\':
176
341k
                  s += 2;
177
341k
                  break;
178
24.0M
              default:
179
24.0M
                  if (*p < 32 || *p >= 127) {
180
21.4M
                      s += 4;
181
21.4M
                  } else {
182
2.64M
                      s ++;
183
2.64M
                      break;
184
2.64M
                  }
185
24.4M
            }
186
24.4M
        }
187
2.65M
        s += 2; /* for the leading and trailing double-quotes */
188
2.65M
    }
189
190
1.13k
    if (!(t = e = avahi_new(char, s+1))) /* plus one for the trailing NUL */
191
0
        return NULL;
192
193
1.13k
    l = avahi_string_list_reverse(l);
194
195
2.65M
    for (n = l; n; n = n->next) {
196
2.65M
        if (n != l)
197
2.64M
            *(e++) = ' ';
198
199
2.65M
        *(e++) = '"';
200
27.0M
        for (p = n->text; ((size_t) (p - n->text) < n->size); p++) {
201
24.4M
            switch (*p) {
202
285k
              case '"':
203
341k
              case '\\':
204
341k
                  *(e++) = '\\';
205
                  /* FALL THROUGH */
206
24.4M
              default:
207
24.4M
                  if (*p < 32 || *p >= 127) {
208
21.4M
                      *(e++) = '\\';
209
21.4M
                      *(e++) = '0' + (*p / 100);
210
21.4M
                      *(e++) = '0' + ((*p / 10) % 10);
211
21.4M
                      *(e++) = '0' + (*p % 10);
212
21.4M
                  } else {
213
2.98M
                      *(e++) = *p;
214
2.98M
                  }
215
24.4M
            }
216
24.4M
        }
217
2.65M
        *(e++) = '"';
218
219
2.65M
        assert(e);
220
2.65M
    }
221
222
1.13k
    l = avahi_string_list_reverse(l);
223
224
1.13k
    *e = 0;
225
226
1.13k
    return t;
227
1.13k
}
228
229
5.84k
size_t avahi_string_list_serialize(AvahiStringList *l, void *data, size_t size) {
230
5.84k
    size_t used = 0;
231
232
5.84k
    if (data) {
233
2.72k
        AvahiStringList *n;
234
2.72k
        uint8_t *c;
235
236
2.72k
        l = avahi_string_list_reverse(l);
237
2.72k
        c = data;
238
239
1.50M
        for (n = l; size > 1 && n; n = n->next) {
240
1.50M
            size_t k;
241
242
1.50M
            if ((k = n->size) == 0)
243
                /* Skip empty strings */
244
0
                continue;
245
246
1.50M
            if (k > 255)
247
                /* Truncate strings at 255 characters */
248
0
                k = 255;
249
250
1.50M
            if (k > size-1)
251
                /* Make sure this string fits in */
252
0
                k = size-1;
253
254
1.50M
            *(c++) = (uint8_t) k;
255
1.50M
            memcpy(c, n->text, k);
256
1.50M
            c += k;
257
258
1.50M
            used += 1 + k;
259
1.50M
            size -= 1 + k;
260
1.50M
        }
261
262
2.72k
        l = avahi_string_list_reverse(l);
263
264
2.72k
        if (used == 0 && size > 0) {
265
266
            /* Empty lists are treated specially. To comply with
267
             * section 6.1 of the DNS-SD spec, we return a single
268
             * empty string (i.e. a NUL byte)*/
269
270
188
            *(uint8_t*) data = 0;
271
188
            used = 1;
272
188
        }
273
274
3.11k
    } else {
275
3.11k
        AvahiStringList *n;
276
277
1.54M
        for (n = l; n; n = n->next) {
278
1.54M
            size_t k;
279
280
1.54M
            if ((k = n->size) == 0)
281
0
                continue;
282
283
1.54M
            if (k > 255)
284
0
                k = 255;
285
286
1.54M
            used += 1+k;
287
1.54M
        }
288
289
3.11k
        if (used == 0)
290
218
            used = 1;
291
3.11k
    }
292
293
5.84k
    return used;
294
5.84k
}
295
296
1.64k
int avahi_string_list_equal(const AvahiStringList *a, const AvahiStringList *b) {
297
298
2.68M
    for (;;) {
299
2.68M
        if (!a && !b)
300
1.51k
            return 1;
301
302
2.68M
        if (!a || !b)
303
19
            return 0;
304
305
2.68M
        if (a->size != b->size)
306
22
            return 0;
307
308
2.68M
        if (a->size != 0 && memcmp(a->text, b->text, a->size) != 0)
309
92
            return 0;
310
311
2.68M
        a = a->next;
312
2.68M
        b = b->next;
313
2.68M
    }
314
1.64k
}
315
316
0
AvahiStringList *avahi_string_list_add_many(AvahiStringList *r, ...) {
317
0
    va_list va;
318
319
0
    va_start(va, r);
320
0
    r = avahi_string_list_add_many_va(r, va);
321
0
    va_end(va);
322
323
0
    return r;
324
0
}
325
326
0
AvahiStringList *avahi_string_list_add_many_va(AvahiStringList *r, va_list va) {
327
0
    const char *txt;
328
329
0
    while ((txt = va_arg(va, const char*)))
330
0
        r = avahi_string_list_add(r, txt);
331
332
0
    return r;
333
0
}
334
335
0
AvahiStringList *avahi_string_list_new(const char *txt, ...) {
336
0
    va_list va;
337
0
    AvahiStringList *r = NULL;
338
339
0
    if (txt) {
340
0
        r = avahi_string_list_add(r, txt);
341
342
0
        va_start(va, txt);
343
0
        r = avahi_string_list_add_many_va(r, va);
344
0
        va_end(va);
345
0
    }
346
347
0
    return r;
348
0
}
349
350
0
AvahiStringList *avahi_string_list_new_va(va_list va) {
351
0
    return avahi_string_list_add_many_va(NULL, va);
352
0
}
353
354
759
AvahiStringList *avahi_string_list_copy(const AvahiStringList *l) {
355
759
    AvahiStringList *r = NULL, *n;
356
357
1.34M
    for (; l; l = l->next) {
358
1.34M
        if (!(n = avahi_string_list_add_arbitrary(r, l->text, l->size))) {
359
0
            avahi_string_list_free(r);
360
0
            return NULL;
361
0
        }
362
1.34M
        r = n;
363
1.34M
    }
364
365
759
    return avahi_string_list_reverse(r);
366
759
}
367
368
0
AvahiStringList *avahi_string_list_new_from_array(const char *array[], int length) {
369
0
    AvahiStringList *r = NULL;
370
0
    int i;
371
372
0
    assert(array);
373
374
0
    for (i = 0; length >= 0 ? i < length : !!array[i]; i++)
375
0
        r = avahi_string_list_add(r, array[i]);
376
377
0
    return r;
378
0
}
379
380
0
unsigned avahi_string_list_length(const AvahiStringList *l) {
381
0
    unsigned n = 0;
382
383
0
    for (; l; l = l->next)
384
0
        n++;
385
386
0
    return n;
387
0
}
388
389
0
AvahiStringList *avahi_string_list_add_vprintf(AvahiStringList *l, const char *format, va_list va) {
390
0
    size_t len = 80;
391
0
    AvahiStringList *r;
392
393
0
    assert(format);
394
395
0
    if (!(r = avahi_malloc(sizeof(AvahiStringList) + len)))
396
0
        return NULL;
397
398
0
    for (;;) {
399
0
        int n;
400
0
        AvahiStringList *nr;
401
0
        va_list va2;
402
403
0
        va_copy(va2, va);
404
0
        n = vsnprintf((char*) r->text, len, format, va2);
405
0
        va_end(va2);
406
407
0
        if (n >= 0 && n < (int) len)
408
0
            break;
409
410
0
        if (n >= 0)
411
0
            len = n+1;
412
0
        else
413
0
            len *= 2;
414
415
0
        if (!(nr = avahi_realloc(r, sizeof(AvahiStringList) + len))) {
416
0
            avahi_free(r);
417
0
            return NULL;
418
0
        }
419
420
0
        r = nr;
421
0
    }
422
423
0
    r->next = l;
424
0
    r->size = strlen((char*) r->text);
425
426
0
    return r;
427
0
}
428
429
0
AvahiStringList *avahi_string_list_add_printf(AvahiStringList *l, const char *format, ...) {
430
0
    va_list va;
431
432
0
    assert(format);
433
434
0
    va_start(va, format);
435
0
    l  = avahi_string_list_add_vprintf(l, format, va);
436
0
    va_end(va);
437
438
0
    return l;
439
0
}
440
441
375
AvahiStringList *avahi_string_list_find(AvahiStringList *l, const char *key) {
442
375
    size_t n;
443
444
375
    assert(key);
445
375
    n = strlen(key);
446
447
1.23M
    for (; l; l = l->next) {
448
1.23M
        if (strcasecmp((char*) l->text, key) == 0)
449
4
            return l;
450
451
1.23M
        if (strncasecmp((char*) l->text, key, n) == 0 && l->text[n] == '=')
452
21
            return l;
453
1.23M
    }
454
455
350
    return NULL;
456
375
}
457
458
0
AvahiStringList *avahi_string_list_add_pair(AvahiStringList *l, const char *key, const char *value) {
459
0
    assert(key);
460
461
0
    if (value)
462
0
        return avahi_string_list_add_printf(l, "%s=%s", key, value);
463
0
    else
464
0
        return avahi_string_list_add(l, key);
465
0
}
466
467
0
AvahiStringList *avahi_string_list_add_pair_arbitrary(AvahiStringList *l, const char *key, const uint8_t *value, size_t size) {
468
0
    size_t n;
469
0
    assert(key);
470
471
0
    if (!value)
472
0
        return avahi_string_list_add(l, key);
473
474
0
    n = strlen(key);
475
476
0
    if (!(l = avahi_string_list_add_anonymous(l, n + 1 + size)))
477
0
        return NULL;
478
479
0
    memcpy(l->text, key, n);
480
0
    l->text[n] = '=';
481
0
    memcpy(l->text + n + 1, value, size);
482
483
0
    return l;
484
0
}
485
486
25
int avahi_string_list_get_pair(AvahiStringList *l, char **key, char **value, size_t *size) {
487
25
    char *e;
488
489
25
    assert(l);
490
491
25
    if (!(e = memchr(l->text, '=', l->size))) {
492
493
1
        if (key)
494
0
            if (!(*key = avahi_strdup((char*) l->text)))
495
0
                return -1;
496
497
1
        if (value)
498
1
            *value = NULL;
499
500
1
        if (size)
501
0
            *size = 0;
502
503
24
    } else {
504
24
        size_t n;
505
506
24
        if (key)
507
0
            if (!(*key = avahi_strndup((char*) l->text, e - (char *) l->text)))
508
0
                return -1;
509
510
24
        e++; /* Advance after '=' */
511
512
24
        n = l->size - (e - (char*) l->text);
513
514
24
        if (value) {
515
516
24
            if (!(*value = avahi_memdup(e, n+1))) {
517
0
                if (key)
518
0
                    avahi_free(*key);
519
0
                return -1;
520
0
            }
521
522
24
            (*value)[n] = 0;
523
24
        }
524
525
24
        if (size)
526
0
            *size = n;
527
24
    }
528
529
25
    return 0;
530
25
}
531
532
0
AvahiStringList *avahi_string_list_get_next(AvahiStringList *l) {
533
0
    assert(l);
534
0
    return l->next;
535
0
}
536
537
0
uint8_t *avahi_string_list_get_text(AvahiStringList *l) {
538
0
    assert(l);
539
0
    return l->text;
540
0
}
541
542
0
size_t avahi_string_list_get_size(AvahiStringList *l) {
543
0
    assert(l);
544
0
    return l->size;
545
0
}
546
547
375
uint32_t avahi_string_list_get_service_cookie(AvahiStringList *l) {
548
375
    AvahiStringList *f;
549
375
    char *value = NULL, *end = NULL;
550
375
    uint32_t ret;
551
552
375
    if (!(f = avahi_string_list_find(l, AVAHI_SERVICE_COOKIE)))
553
350
        return AVAHI_SERVICE_COOKIE_INVALID;
554
555
25
    if (avahi_string_list_get_pair(f, NULL, &value, NULL) < 0 || !value)
556
1
        return AVAHI_SERVICE_COOKIE_INVALID;
557
558
24
    ret = (uint32_t) strtoll(value, &end, 0);
559
560
24
    if (*value && end && *end != 0) {
561
18
        avahi_free(value);
562
18
        return AVAHI_SERVICE_COOKIE_INVALID;
563
18
    }
564
565
6
    avahi_free(value);
566
567
6
    return ret;
568
24
}