Coverage Report

Created: 2026-10-15 06:17

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/curl/lib/dynhds.c
Line
Count
Source
1
/***************************************************************************
2
 *                                  _   _ ____  _
3
 *  Project                     ___| | | |  _ \| |
4
 *                             / __| | | | |_) | |
5
 *                            | (__| |_| |  _ <| |___
6
 *                             \___|\___/|_| \_\_____|
7
 *
8
 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
9
 *
10
 * This software is licensed as described in the file COPYING, which
11
 * you should have received as part of this distribution. The terms
12
 * are also available at https://curl.se/docs/copyright.html.
13
 *
14
 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15
 * copies of the Software, and permit persons to whom the Software is
16
 * furnished to do so, under the terms of the COPYING file.
17
 *
18
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19
 * KIND, either express or implied.
20
 *
21
 * SPDX-License-Identifier: curl
22
 *
23
 ***************************************************************************/
24
#include "curl_setup.h"
25
26
#include "dynhds.h"
27
#include "strcase.h"
28
29
static struct dynhds_entry *entry_new(const char *name, size_t namelen,
30
                                      const char *value, size_t valuelen,
31
                                      int opts)
32
0
{
33
0
  struct dynhds_entry *e;
34
0
  char *p;
35
36
  /* namelen + valuelen <= SIZE_MAX has already been checked by caller */
37
0
  if((SIZE_MAX - namelen - valuelen) < (sizeof(*e) + 2))
38
0
    return NULL;
39
0
  e = curlx_calloc(1, sizeof(*e) + namelen + valuelen + 2);
40
0
  if(!e)
41
0
    return NULL;
42
0
  e->name = p = (char *)e + sizeof(*e);
43
0
  memcpy(p, name, namelen);
44
0
  e->namelen = namelen;
45
0
  e->value = p += namelen + 1; /* leave a \0 at the end of name */
46
0
  if(valuelen) {
47
0
    memcpy(p, value, valuelen);
48
0
    e->valuelen = valuelen;
49
0
  }
50
0
  if(opts & DYNHDS_OPT_LOWERCASE)
51
0
    Curl_strntolower(e->name, e->name, e->namelen);
52
0
  return e;
53
0
}
54
55
static void entry_free(struct dynhds_entry *e)
56
0
{
57
0
  curlx_free(e);
58
0
}
59
60
void Curl_dynhds_init(struct dynhds *dynhds, size_t max_entries,
61
                      size_t max_strs_size)
62
0
{
63
0
  DEBUGASSERT(dynhds);
64
0
  DEBUGASSERT(max_strs_size);
65
0
  dynhds->hds = NULL;
66
0
  dynhds->hds_len = dynhds->hds_allc = dynhds->strs_len = 0;
67
0
  dynhds->max_entries = max_entries;
68
0
  dynhds->max_strs_size = max_strs_size;
69
0
  dynhds->opts = 0;
70
0
}
71
72
void Curl_dynhds_free(struct dynhds *dynhds)
73
0
{
74
0
  DEBUGASSERT(dynhds);
75
0
  if(dynhds->hds && dynhds->hds_len) {
76
0
    size_t i;
77
0
    DEBUGASSERT(dynhds->hds);
78
0
    for(i = 0; i < dynhds->hds_len; ++i) {
79
0
      entry_free(dynhds->hds[i]);
80
0
    }
81
0
  }
82
0
  curlx_safefree(dynhds->hds);
83
0
  dynhds->hds_len = dynhds->hds_allc = dynhds->strs_len = 0;
84
0
}
85
86
void Curl_dynhds_reset(struct dynhds *dynhds)
87
0
{
88
0
  DEBUGASSERT(dynhds);
89
0
  if(dynhds->hds_len) {
90
0
    size_t i;
91
0
    DEBUGASSERT(dynhds->hds);
92
0
    for(i = 0; i < dynhds->hds_len; ++i) {
93
0
      entry_free(dynhds->hds[i]);
94
0
      dynhds->hds[i] = NULL;
95
0
    }
96
0
  }
97
0
  dynhds->hds_len = dynhds->strs_len = 0;
98
0
}
99
100
size_t Curl_dynhds_count(struct dynhds *dynhds)
101
0
{
102
0
  return dynhds->hds_len;
103
0
}
104
105
void Curl_dynhds_set_opts(struct dynhds *dynhds, int opts)
106
0
{
107
0
  dynhds->opts = opts;
108
0
}
109
110
struct dynhds_entry *Curl_dynhds_getn(struct dynhds *dynhds, size_t n)
111
0
{
112
0
  DEBUGASSERT(dynhds);
113
0
  return (n < dynhds->hds_len) ? dynhds->hds[n] : NULL;
114
0
}
115
116
struct dynhds_entry *Curl_dynhds_get(struct dynhds *dynhds, const char *name,
117
                                     size_t namelen)
118
0
{
119
0
  size_t i;
120
0
  for(i = 0; i < dynhds->hds_len; ++i) {
121
0
    if(dynhds->hds[i]->namelen == namelen &&
122
0
       curl_strnequal(dynhds->hds[i]->name, name, namelen)) {
123
0
      return dynhds->hds[i];
124
0
    }
125
0
  }
126
0
  return NULL;
127
0
}
128
129
struct dynhds_entry *Curl_dynhds_cget(struct dynhds *dynhds, const char *name)
130
0
{
131
0
  return Curl_dynhds_get(dynhds, name, strlen(name));
132
0
}
133
134
CURLcode Curl_dynhds_add(struct dynhds *dynhds,
135
                         const char *name, size_t namelen,
136
                         const char *value, size_t valuelen)
137
0
{
138
0
  struct dynhds_entry *entry = NULL;
139
0
  CURLcode result = CURLE_OUT_OF_MEMORY;
140
141
  /* Accept NULL value with length 0, name must have length */
142
0
  if(!dynhds || !name || !namelen || (!value && valuelen)) {
143
0
    DEBUGASSERT(0);
144
0
    return CURLE_BAD_FUNCTION_ARGUMENT;
145
0
  }
146
  /* Does the new header fit into the limits? */
147
0
  if((dynhds->max_entries && (dynhds->hds_len >= dynhds->max_entries)) ||
148
0
     (dynhds->max_strs_size - dynhds->strs_len < namelen) ||
149
0
     (dynhds->max_strs_size - dynhds->strs_len - namelen < valuelen))
150
0
    return CURLE_OUT_OF_MEMORY;
151
152
0
  entry = entry_new(name, namelen, value, valuelen, dynhds->opts);
153
0
  if(!entry)
154
0
    goto out;
155
156
0
  if(dynhds->hds_len + 1 >= dynhds->hds_allc) {
157
0
    size_t nallc = dynhds->hds_allc ? dynhds->hds_allc * 2 : 16;
158
0
    struct dynhds_entry **nhds;
159
160
0
    if(dynhds->max_entries && nallc > dynhds->max_entries)
161
0
      nallc = dynhds->max_entries;
162
163
0
    nhds = curlx_calloc(nallc, sizeof(struct dynhds_entry *));
164
0
    if(!nhds)
165
0
      goto out;
166
0
    if(dynhds->hds) {
167
0
      memcpy(nhds, dynhds->hds,
168
0
             dynhds->hds_len * sizeof(struct dynhds_entry *));
169
0
      curlx_safefree(dynhds->hds);
170
0
    }
171
0
    dynhds->hds = nhds;
172
0
    dynhds->hds_allc = nallc;
173
0
  }
174
0
  dynhds->hds[dynhds->hds_len++] = entry;
175
0
  entry = NULL;
176
0
  dynhds->strs_len += namelen + valuelen;
177
0
  result = CURLE_OK;
178
179
0
out:
180
0
  if(entry)
181
0
    entry_free(entry);
182
0
  return result;
183
0
}
184
185
CURLcode Curl_dynhds_cadd(struct dynhds *dynhds,
186
                          const char *name, const char *value)
187
0
{
188
0
  if(!name)
189
0
    return CURLE_BAD_FUNCTION_ARGUMENT;
190
0
  return Curl_dynhds_add(dynhds, name, strlen(name),
191
0
                         value, value ? strlen(value) : 0);
192
0
}
193
194
CURLcode Curl_dynhds_h1_add_line(struct dynhds *dynhds,
195
                                 const char *line, size_t line_len)
196
0
{
197
0
  const char *p;
198
0
  const char *name;
199
0
  size_t namelen;
200
0
  const char *value;
201
0
  size_t valuelen, i;
202
203
0
  if(!line || !line_len)
204
0
    return CURLE_OK;
205
206
0
  p = memchr(line, ':', line_len);
207
0
  if(!p || p == line)
208
0
    return CURLE_BAD_FUNCTION_ARGUMENT;
209
0
  name = line;
210
0
  namelen = p - line;
211
0
  p++; /* move past the colon */
212
0
  for(i = namelen + 1; i < line_len; ++i, ++p) {
213
0
    if(!ISBLANK(*p))
214
0
      break;
215
0
  }
216
0
  value = p;
217
0
  valuelen = line_len - i;
218
219
0
  p = memchr(value, '\r', valuelen);
220
0
  if(!p)
221
0
    p = memchr(value, '\n', valuelen);
222
0
  if(p)
223
0
    valuelen = (size_t)(p - value);
224
225
0
  return Curl_dynhds_add(dynhds, name, namelen, value, valuelen);
226
0
}
227
228
CURLcode Curl_dynhds_h1_cadd_line(struct dynhds *dynhds, const char *line)
229
0
{
230
0
  return Curl_dynhds_h1_add_line(dynhds, line, line ? strlen(line) : 0);
231
0
}
232
233
#ifdef UNITTESTS
234
/* @unittest 2602 */
235
236
/**
237
 * Return TRUE iff one or more headers with the given name exist.
238
 */
239
UNITTEST bool dynhds_contains(struct dynhds *dynhds,
240
                              const char *name, size_t namelen);
241
UNITTEST bool dynhds_contains(struct dynhds *dynhds,
242
                              const char *name, size_t namelen)
243
0
{
244
0
  return !!Curl_dynhds_get(dynhds, name, namelen);
245
0
}
246
247
/* @unittest 2602 */
248
UNITTEST bool dynhds_ccontains(struct dynhds *dynhds, const char *name);
249
UNITTEST bool dynhds_ccontains(struct dynhds *dynhds, const char *name)
250
0
{
251
0
  return dynhds_contains(dynhds, name, strlen(name));
252
0
}
253
254
/**
255
 * Return how often the given name appears in `dynhds`.
256
 * Names are case-insensitive.
257
 *
258
 * @unittest 2602
259
 */
260
UNITTEST size_t dynhds_count_name(struct dynhds *dynhds,
261
                                  const char *name, size_t namelen);
262
UNITTEST size_t dynhds_count_name(struct dynhds *dynhds,
263
                                  const char *name, size_t namelen)
264
0
{
265
0
  size_t n = 0;
266
0
  if(dynhds->hds_len) {
267
0
    size_t i;
268
0
    for(i = 0; i < dynhds->hds_len; ++i) {
269
0
      if((namelen == dynhds->hds[i]->namelen) &&
270
0
         curl_strnequal(name, dynhds->hds[i]->name, namelen))
271
0
        ++n;
272
0
    }
273
0
  }
274
0
  return n;
275
0
}
276
277
/**
278
 * Return how often the given null-terminated name appears in `dynhds`.
279
 * Names are case-insensitive.
280
 *
281
 * @unittest 2602
282
 */
283
UNITTEST size_t dynhds_ccount_name(struct dynhds *dynhds,
284
                                        const char *name);
285
UNITTEST size_t dynhds_ccount_name(struct dynhds *dynhds,
286
                                        const char *name)
287
0
{
288
0
  return dynhds_count_name(dynhds, name, strlen(name));
289
0
}
290
291
/**
292
 * Remove all entries with the given name.
293
 * Returns number of entries removed.
294
 *
295
 * @unittest 2602
296
 */
297
UNITTEST size_t dynhds_remove(struct dynhds *dynhds,
298
                              const char *name, size_t namelen);
299
UNITTEST size_t dynhds_remove(struct dynhds *dynhds,
300
                              const char *name, size_t namelen)
301
0
{
302
0
  size_t n = 0;
303
0
  if(dynhds->hds_len) {
304
0
    size_t i, len;
305
0
    for(i = 0; i < dynhds->hds_len; ++i) {
306
0
      if((namelen == dynhds->hds[i]->namelen) &&
307
0
         curl_strnequal(name, dynhds->hds[i]->name, namelen)) {
308
0
        ++n;
309
0
        --dynhds->hds_len;
310
0
        dynhds->strs_len -= (dynhds->hds[i]->namelen +
311
0
                             dynhds->hds[i]->valuelen);
312
0
        entry_free(dynhds->hds[i]);
313
0
        len = dynhds->hds_len - i; /* remaining entries */
314
0
        if(len) {
315
0
          memmove(&dynhds->hds[i], &dynhds->hds[i + 1],
316
0
                  len * sizeof(dynhds->hds[i]));
317
0
        }
318
0
        --i; /* do this index again */
319
0
      }
320
0
    }
321
0
  }
322
0
  return n;
323
0
}
324
325
/**
326
 * Set the give header name and value, replacing any entries with
327
 * the same name. The header is added at the end of all (remaining)
328
 * entries.
329
 *
330
 * @unittest 2602
331
 */
332
UNITTEST CURLcode dynhds_set(struct dynhds *dynhds,
333
                             const char *name, size_t namelen,
334
                             const char *value, size_t valuelen);
335
UNITTEST CURLcode dynhds_set(struct dynhds *dynhds,
336
                             const char *name, size_t namelen,
337
                             const char *value, size_t valuelen)
338
0
{
339
0
  dynhds_remove(dynhds, name, namelen);
340
0
  return Curl_dynhds_add(dynhds, name, namelen, value, valuelen);
341
0
}
342
343
/* @unittest 2602 */
344
UNITTEST size_t dynhds_cremove(struct dynhds *dynhds, const char *name);
345
UNITTEST size_t dynhds_cremove(struct dynhds *dynhds, const char *name)
346
0
{
347
0
  return dynhds_remove(dynhds, name, strlen(name));
348
0
}
349
350
#endif /* UNITTESTS */
351
352
CURLcode Curl_dynhds_h1_dprint(struct dynhds *dynhds, struct dynbuf *dbuf)
353
0
{
354
0
  CURLcode result = CURLE_OK;
355
0
  size_t i;
356
357
0
  if(!dynhds->hds_len)
358
0
    return result;
359
360
0
  for(i = 0; i < dynhds->hds_len; ++i) {
361
0
    result = curlx_dyn_addn(dbuf, dynhds->hds[i]->name,
362
0
                            dynhds->hds[i]->namelen);
363
0
    if(!result)
364
0
      result = curlx_dyn_addn(dbuf, STRCONST(": "));
365
0
    if(!result)
366
0
      result = curlx_dyn_addn(dbuf, dynhds->hds[i]->value,
367
0
                              dynhds->hds[i]->valuelen);
368
0
    if(!result)
369
0
      result = curlx_dyn_addn(dbuf, STRCONST("\r\n"));
370
0
    if(result)
371
0
      break;
372
0
  }
373
374
0
  return result;
375
0
}
376
377
#ifdef USE_NGHTTP2
378
379
nghttp2_nv *Curl_dynhds_to_nva(struct dynhds *dynhds, size_t *pcount)
380
0
{
381
0
  nghttp2_nv *nva = curlx_calloc(1, sizeof(nghttp2_nv) * dynhds->hds_len);
382
0
  size_t i;
383
384
0
  *pcount = 0;
385
0
  if(!nva)
386
0
    return NULL;
387
388
0
  for(i = 0; i < dynhds->hds_len; ++i) {
389
0
    struct dynhds_entry *e = dynhds->hds[i];
390
0
    DEBUGASSERT(e);
391
0
    nva[i].name = (unsigned char *)e->name;
392
0
    nva[i].namelen = e->namelen;
393
0
    nva[i].value = (unsigned char *)e->value;
394
0
    nva[i].valuelen = e->valuelen;
395
0
    nva[i].flags = NGHTTP2_NV_FLAG_NONE;
396
0
  }
397
0
  *pcount = dynhds->hds_len;
398
0
  return nva;
399
0
}
400
401
#endif /* USE_NGHTTP2 */