Coverage Report

Created: 2026-01-17 06:42

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
83.6k
AvahiStringList*avahi_string_list_add_anonymous(AvahiStringList *l, size_t size) {
35
83.6k
    AvahiStringList *n;
36
37
83.6k
    if (!(n = avahi_malloc(sizeof(AvahiStringList) + size)))
38
0
        return NULL;
39
40
83.6k
    n->next = l;
41
83.6k
    n->size = size;
42
43
    /* NUL terminate strings, just to make sure */
44
83.6k
    n->text[size] = 0;
45
46
83.6k
    return n;
47
83.6k
}
48
49
83.6k
AvahiStringList *avahi_string_list_add_arbitrary(AvahiStringList *l, const uint8_t*text, size_t size) {
50
83.6k
    AvahiStringList *n;
51
52
83.6k
    assert(size == 0 || text);
53
54
83.6k
    if (!(n = avahi_string_list_add_anonymous(l, size)))
55
0
        return NULL;
56
57
83.6k
    if (size > 0)
58
83.6k
        memcpy(n->text, text, size);
59
60
83.6k
    return n;
61
83.6k
}
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.12k
int avahi_string_list_parse(const void* data, size_t size, AvahiStringList **ret) {
70
1.12k
    const uint8_t *c;
71
1.12k
    AvahiStringList *r = NULL;
72
73
1.12k
    assert(data);
74
1.12k
    assert(ret);
75
76
1.12k
    c = data;
77
127k
    while (size > 0) {
78
126k
        size_t k;
79
80
126k
        k = *(c++);
81
126k
        size--;
82
83
126k
        if (k > size)
84
27
            goto fail; /* Overflow */
85
86
126k
        if (k > 0) { /* Ignore empty strings */
87
83.6k
            AvahiStringList *n;
88
89
83.6k
            if (!(n = avahi_string_list_add_arbitrary(r, c, k)))
90
0
                goto fail; /* OOM */
91
92
83.6k
            r = n;
93
83.6k
        }
94
95
126k
        c += k;
96
126k
        size -= k;
97
126k
    }
98
99
1.09k
    *ret = r;
100
101
1.09k
    return 0;
102
103
27
fail:
104
27
    avahi_string_list_free(r);
105
27
    return -1;
106
1.12k
}
107
108
2.09k
void avahi_string_list_free(AvahiStringList *l) {
109
2.09k
    AvahiStringList *n;
110
111
85.7k
    while (l) {
112
83.6k
        n = l->next;
113
83.6k
        avahi_free(l);
114
83.6k
        l = n;
115
83.6k
    }
116
2.09k
}
117
118
8.04k
AvahiStringList* avahi_string_list_reverse(AvahiStringList *l) {
119
8.04k
    AvahiStringList *r = NULL, *n;
120
121
288k
    while (l) {
122
280k
        n = l->next;
123
280k
        l->next = r;
124
280k
        r = l;
125
280k
        l = n;
126
280k
    }
127
128
8.04k
    return r;
129
8.04k
}
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
2.04k
char* avahi_string_list_to_string(AvahiStringList *l) {
163
2.04k
    AvahiStringList *n;
164
2.04k
    size_t s = 0;
165
2.04k
    uint8_t *p;
166
2.04k
    char *t, *e;
167
168
73.7k
    for (n = l; n; n = n->next) {
169
71.6k
        if (n != l)
170
70.8k
            s ++; /* for the inter-string separating space */
171
172
1.40M
        for (p = n->text; ((size_t) (p - n->text) < n->size); p++) {
173
1.33M
            switch (*p) {
174
26.6k
              case '"':
175
57.7k
              case '\\':
176
57.7k
                  s += 2;
177
57.7k
                  break;
178
1.27M
              default:
179
1.27M
                  if (*p < 32 || *p >= 127) {
180
1.02M
                      s += 4;
181
1.02M
                  } else {
182
246k
                      s ++;
183
246k
                      break;
184
246k
                  }
185
1.33M
            }
186
1.33M
        }
187
71.6k
        s += 2; /* for the leading and trailing double-quotes */
188
71.6k
    }
189
190
2.04k
    if (!(t = e = avahi_new(char, s+1))) /* plus one for the trailing NUL */
191
0
        return NULL;
192
193
2.04k
    l = avahi_string_list_reverse(l);
194
195
73.7k
    for (n = l; n; n = n->next) {
196
71.6k
        if (n != l)
197
70.8k
            *(e++) = ' ';
198
199
71.6k
        *(e++) = '"';
200
1.40M
        for (p = n->text; ((size_t) (p - n->text) < n->size); p++) {
201
1.33M
            switch (*p) {
202
26.6k
              case '"':
203
57.7k
              case '\\':
204
57.7k
                  *(e++) = '\\';
205
                  /* FALL THROUGH */
206
1.33M
              default:
207
1.33M
                  if (*p < 32 || *p >= 127) {
208
1.02M
                      *(e++) = '\\';
209
1.02M
                      *(e++) = '0' + (*p / 100);
210
1.02M
                      *(e++) = '0' + ((*p / 10) % 10);
211
1.02M
                      *(e++) = '0' + (*p % 10);
212
1.02M
                  } else {
213
304k
                      *(e++) = *p;
214
304k
                  }
215
1.33M
            }
216
1.33M
        }
217
71.6k
        *(e++) = '"';
218
219
71.6k
        assert(e);
220
71.6k
    }
221
222
2.04k
    l = avahi_string_list_reverse(l);
223
224
2.04k
    *e = 0;
225
226
2.04k
    return t;
227
2.04k
}
228
229
4.00k
size_t avahi_string_list_serialize(AvahiStringList *l, void *data, size_t size) {
230
4.00k
    size_t used = 0;
231
232
4.00k
    if (data) {
233
1.98k
        AvahiStringList *n;
234
1.98k
        uint8_t *c;
235
236
1.98k
        l = avahi_string_list_reverse(l);
237
1.98k
        c = data;
238
239
70.5k
        for (n = l; size > 1 && n; n = n->next) {
240
68.5k
            size_t k;
241
242
68.5k
            if ((k = n->size) == 0)
243
                /* Skip empty strings */
244
0
                continue;
245
246
68.5k
            if (k > 255)
247
                /* Truncate strings at 255 characters */
248
0
                k = 255;
249
250
68.5k
            if (k > size-1)
251
                /* Make sure this string fits in */
252
0
                k = size-1;
253
254
68.5k
            *(c++) = (uint8_t) k;
255
68.5k
            memcpy(c, n->text, k);
256
68.5k
            c += k;
257
258
68.5k
            used += 1 + k;
259
68.5k
            size -= 1 + k;
260
68.5k
        }
261
262
1.98k
        l = avahi_string_list_reverse(l);
263
264
1.98k
        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
1.22k
            *(uint8_t*) data = 0;
271
1.22k
            used = 1;
272
1.22k
        }
273
274
2.02k
    } else {
275
2.02k
        AvahiStringList *n;
276
277
73.7k
        for (n = l; n; n = n->next) {
278
71.6k
            size_t k;
279
280
71.6k
            if ((k = n->size) == 0)
281
0
                continue;
282
283
71.6k
            if (k > 255)
284
0
                k = 255;
285
286
71.6k
            used += 1+k;
287
71.6k
        }
288
289
2.02k
        if (used == 0)
290
1.23k
            used = 1;
291
2.02k
    }
292
293
4.00k
    return used;
294
4.00k
}
295
296
0
int avahi_string_list_equal(const AvahiStringList *a, const AvahiStringList *b) {
297
298
0
    for (;;) {
299
0
        if (!a && !b)
300
0
            return 1;
301
302
0
        if (!a || !b)
303
0
            return 0;
304
305
0
        if (a->size != b->size)
306
0
            return 0;
307
308
0
        if (a->size != 0 && memcmp(a->text, b->text, a->size) != 0)
309
0
            return 0;
310
311
0
        a = a->next;
312
0
        b = b->next;
313
0
    }
314
0
}
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
0
AvahiStringList *avahi_string_list_copy(const AvahiStringList *l) {
355
0
    AvahiStringList *r = NULL;
356
357
0
    for (; l; l = l->next)
358
0
        if (!(r = avahi_string_list_add_arbitrary(r, l->text, l->size))) {
359
0
            avahi_string_list_free(r);
360
0
            return NULL;
361
0
        }
362
363
0
    return avahi_string_list_reverse(r);
364
0
}
365
366
0
AvahiStringList *avahi_string_list_new_from_array(const char *array[], int length) {
367
0
    AvahiStringList *r = NULL;
368
0
    int i;
369
370
0
    assert(array);
371
372
0
    for (i = 0; length >= 0 ? i < length : !!array[i]; i++)
373
0
        r = avahi_string_list_add(r, array[i]);
374
375
0
    return r;
376
0
}
377
378
0
unsigned avahi_string_list_length(const AvahiStringList *l) {
379
0
    unsigned n = 0;
380
381
0
    for (; l; l = l->next)
382
0
        n++;
383
384
0
    return n;
385
0
}
386
387
0
AvahiStringList *avahi_string_list_add_vprintf(AvahiStringList *l, const char *format, va_list va) {
388
0
    size_t len = 80;
389
0
    AvahiStringList *r;
390
391
0
    assert(format);
392
393
0
    if (!(r = avahi_malloc(sizeof(AvahiStringList) + len)))
394
0
        return NULL;
395
396
0
    for (;;) {
397
0
        int n;
398
0
        AvahiStringList *nr;
399
0
        va_list va2;
400
401
0
        va_copy(va2, va);
402
0
        n = vsnprintf((char*) r->text, len, format, va2);
403
0
        va_end(va2);
404
405
0
        if (n >= 0 && n < (int) len)
406
0
            break;
407
408
0
        if (n >= 0)
409
0
            len = n+1;
410
0
        else
411
0
            len *= 2;
412
413
0
        if (!(nr = avahi_realloc(r, sizeof(AvahiStringList) + len))) {
414
0
            avahi_free(r);
415
0
            return NULL;
416
0
        }
417
418
0
        r = nr;
419
0
    }
420
421
0
    r->next = l;
422
0
    r->size = strlen((char*) r->text);
423
424
0
    return r;
425
0
}
426
427
0
AvahiStringList *avahi_string_list_add_printf(AvahiStringList *l, const char *format, ...) {
428
0
    va_list va;
429
430
0
    assert(format);
431
432
0
    va_start(va, format);
433
0
    l  = avahi_string_list_add_vprintf(l, format, va);
434
0
    va_end(va);
435
436
0
    return l;
437
0
}
438
439
0
AvahiStringList *avahi_string_list_find(AvahiStringList *l, const char *key) {
440
0
    size_t n;
441
442
0
    assert(key);
443
0
    n = strlen(key);
444
445
0
    for (; l; l = l->next) {
446
0
        if (strcasecmp((char*) l->text, key) == 0)
447
0
            return l;
448
449
0
        if (strncasecmp((char*) l->text, key, n) == 0 && l->text[n] == '=')
450
0
            return l;
451
0
    }
452
453
0
    return NULL;
454
0
}
455
456
0
AvahiStringList *avahi_string_list_add_pair(AvahiStringList *l, const char *key, const char *value) {
457
0
    assert(key);
458
459
0
    if (value)
460
0
        return avahi_string_list_add_printf(l, "%s=%s", key, value);
461
0
    else
462
0
        return avahi_string_list_add(l, key);
463
0
}
464
465
0
AvahiStringList *avahi_string_list_add_pair_arbitrary(AvahiStringList *l, const char *key, const uint8_t *value, size_t size) {
466
0
    size_t n;
467
0
    assert(key);
468
469
0
    if (!value)
470
0
        return avahi_string_list_add(l, key);
471
472
0
    n = strlen(key);
473
474
0
    if (!(l = avahi_string_list_add_anonymous(l, n + 1 + size)))
475
0
        return NULL;
476
477
0
    memcpy(l->text, key, n);
478
0
    l->text[n] = '=';
479
0
    memcpy(l->text + n + 1, value, size);
480
481
0
    return l;
482
0
}
483
484
0
int avahi_string_list_get_pair(AvahiStringList *l, char **key, char **value, size_t *size) {
485
0
    char *e;
486
487
0
    assert(l);
488
489
0
    if (!(e = memchr(l->text, '=', l->size))) {
490
491
0
        if (key)
492
0
            if (!(*key = avahi_strdup((char*) l->text)))
493
0
                return -1;
494
495
0
        if (value)
496
0
            *value = NULL;
497
498
0
        if (size)
499
0
            *size = 0;
500
501
0
    } else {
502
0
        size_t n;
503
504
0
        if (key)
505
0
            if (!(*key = avahi_strndup((char*) l->text, e - (char *) l->text)))
506
0
                return -1;
507
508
0
        e++; /* Advance after '=' */
509
510
0
        n = l->size - (e - (char*) l->text);
511
512
0
        if (value) {
513
514
0
            if (!(*value = avahi_memdup(e, n+1))) {
515
0
                if (key)
516
0
                    avahi_free(*key);
517
0
                return -1;
518
0
            }
519
520
0
            (*value)[n] = 0;
521
0
        }
522
523
0
        if (size)
524
0
            *size = n;
525
0
    }
526
527
0
    return 0;
528
0
}
529
530
0
AvahiStringList *avahi_string_list_get_next(AvahiStringList *l) {
531
0
    assert(l);
532
0
    return l->next;
533
0
}
534
535
0
uint8_t *avahi_string_list_get_text(AvahiStringList *l) {
536
0
    assert(l);
537
0
    return l->text;
538
0
}
539
540
0
size_t avahi_string_list_get_size(AvahiStringList *l) {
541
0
    assert(l);
542
0
    return l->size;
543
0
}
544
545
0
uint32_t avahi_string_list_get_service_cookie(AvahiStringList *l) {
546
0
    AvahiStringList *f;
547
0
    char *value = NULL, *end = NULL;
548
0
    uint32_t ret;
549
550
0
    if (!(f = avahi_string_list_find(l, AVAHI_SERVICE_COOKIE)))
551
0
        return AVAHI_SERVICE_COOKIE_INVALID;
552
553
0
    if (avahi_string_list_get_pair(f, NULL, &value, NULL) < 0 || !value)
554
0
        return AVAHI_SERVICE_COOKIE_INVALID;
555
556
0
    ret = (uint32_t) strtoll(value, &end, 0);
557
558
0
    if (*value && end && *end != 0) {
559
0
        avahi_free(value);
560
0
        return AVAHI_SERVICE_COOKIE_INVALID;
561
0
    }
562
563
0
    avahi_free(value);
564
565
0
    return ret;
566
0
}