Coverage Report

Created: 2026-10-15 06:17

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/curl/lib/cookie.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
#if !defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_COOKIES)
27
28
#include "urldata.h"
29
#include "cookie.h"
30
#include "psl.h"
31
#include "curl_trc.h"
32
#include "transfer.h"
33
#include "slist.h"
34
#include "curl_share.h"
35
#include "strcase.h"
36
#include "curl_fopen.h"
37
#include "curl_get_line.h"
38
#include "curl_memrchr.h"
39
#include "parsedate.h"
40
#include "curlx/strdup.h"
41
#include "llist.h"
42
#include "curlx/strparse.h"
43
44
/* number of seconds in 400 days */
45
0
#define COOKIES_MAXAGE (400 * 24 * 3600)
46
47
/* Make sure cookies never expire further away in time than 400 days into the
48
   future. (from RFC6265bis draft-19)
49
50
   For the sake of easier testing, align the capped time to an even 60 second
51
   boundary. */
52
static void cap_expires(time_t now, struct Cookie *co)
53
0
{
54
0
  if(co->expires && (TIME_T_MAX - COOKIES_MAXAGE - 30) > now) {
55
0
    timediff_t cap = now + COOKIES_MAXAGE;
56
0
    if(co->expires > cap) {
57
0
      cap += 30;
58
0
      co->expires = (cap / 60) * 60;
59
0
    }
60
0
  }
61
0
}
62
63
static void freecookie(struct Cookie *co, bool maintoo)
64
21.4k
{
65
21.4k
  curlx_free(co->domain);
66
21.4k
  curlx_free(co->path);
67
21.4k
  curlx_free(co->name);
68
21.4k
  curlx_free(co->value);
69
21.4k
  if(maintoo)
70
8.18k
    curlx_free(co);
71
21.4k
}
72
73
static bool cookie_tailmatch(const char *cookie_domain,
74
                             const size_t cookie_domain_len,
75
                             const char *hostname)
76
10.9k
{
77
10.9k
  size_t hostname_len = strlen(hostname);
78
79
10.9k
  if(hostname_len < cookie_domain_len)
80
2.10k
    return FALSE;
81
82
8.87k
  if(!curl_strnequal(cookie_domain,
83
8.87k
                     hostname + hostname_len - cookie_domain_len,
84
8.87k
                     cookie_domain_len))
85
1.58k
    return FALSE;
86
87
  /*
88
   * A lead char of cookie_domain is not '.'.
89
   * RFC6265 4.1.2.3. The Domain Attribute says:
90
   * For example, if the value of the Domain attribute is
91
   * "example.com", the user agent will include the cookie in the Cookie
92
   * header when making HTTP requests to example.com, www.example.com, and
93
   * www.corp.example.com.
94
   */
95
7.29k
  if(hostname_len == cookie_domain_len)
96
5.22k
    return TRUE;
97
2.07k
  if('.' == *(hostname + hostname_len - cookie_domain_len - 1))
98
1.31k
    return TRUE;
99
755
  return FALSE;
100
2.07k
}
101
102
/*
103
 * matching cookie path and URL path
104
 * RFC6265 5.1.4 Paths and Path-Match
105
 */
106
static bool pathmatch(const char *cookie_path, const char *uri_path)
107
0
{
108
0
  size_t cookie_path_len;
109
0
  size_t uri_path_len;
110
0
  bool ret = FALSE;
111
112
  /* cookie_path must not have last '/' separator. ex: /sample */
113
0
  cookie_path_len = strlen(cookie_path);
114
0
  if(cookie_path_len == 1) {
115
    /* cookie_path must be '/' */
116
0
    return TRUE;
117
0
  }
118
119
  /* #-fragments are already cut off! */
120
0
  if(strlen(uri_path) == 0 || uri_path[0] != '/')
121
0
    uri_path = "/";
122
123
  /*
124
   * here, RFC6265 5.1.4 says
125
   *  4. Output the characters of the uri-path from the first character up
126
   *     to, but not including, the right-most %x2F ("/").
127
   *  but URL path /hoge?fuga=xxx means /hoge/index.cgi?fuga=xxx in some site
128
   *  without redirect.
129
   *  Ignore this algorithm because /hoge is uri path for this case
130
   *  (uri path is not /).
131
   */
132
133
0
  uri_path_len = strlen(uri_path);
134
135
0
  if(uri_path_len < cookie_path_len)
136
0
    goto pathmatched;
137
138
  /* not using checkprefix() because matching should be case-sensitive */
139
0
  if(strncmp(cookie_path, uri_path, cookie_path_len))
140
0
    goto pathmatched;
141
142
  /* The cookie-path and the uri-path are identical. */
143
0
  if(cookie_path_len == uri_path_len) {
144
0
    ret = TRUE;
145
0
    goto pathmatched;
146
0
  }
147
148
  /* here, cookie_path_len < uri_path_len */
149
0
  if(uri_path[cookie_path_len] == '/') {
150
0
    ret = TRUE;
151
0
    goto pathmatched;
152
0
  }
153
154
0
pathmatched:
155
0
  return ret;
156
0
}
157
158
/*
159
 * Return the top-level domain, for optimal hashing.
160
 */
161
static const char *get_top_domain(const char * const domain, size_t *outlen)
162
15.4k
{
163
15.4k
  size_t len = 0;
164
15.4k
  const char *first = NULL, *last;
165
166
15.4k
  if(domain) {
167
15.4k
    len = strlen(domain);
168
15.4k
    last = memrchr(domain, '.', len);
169
15.4k
    if(last) {
170
3.45k
      first = memrchr(domain, '.', (last - domain));
171
3.45k
      if(first)
172
1.62k
        len -= (++first - domain);
173
3.45k
    }
174
15.4k
  }
175
176
15.4k
  if(outlen)
177
15.4k
    *outlen = len;
178
179
15.4k
  return first ? first : domain;
180
15.4k
}
181
182
/* Avoid C1001, an "internal error" with MSVC14 */
183
#if defined(_MSC_VER) && (_MSC_VER == 1900)
184
#pragma optimize("", off)
185
#endif
186
187
/*
188
 * A case-insensitive hash for the cookie domains.
189
 */
190
static size_t cookie_hash_domain(const char *domain, const size_t len)
191
15.4k
{
192
15.4k
  const char *end = domain + len;
193
15.4k
  size_t h = 5381;
194
195
45.4k
  while(domain < end) {
196
29.9k
    size_t j = (size_t)Curl_raw_toupper(*domain++);
197
29.9k
    h += h << 5;
198
29.9k
    h ^= j;
199
29.9k
  }
200
201
15.4k
  return (h % COOKIE_HASH_SIZE);
202
15.4k
}
203
204
#if defined(_MSC_VER) && (_MSC_VER == 1900)
205
#pragma optimize("", on)
206
#endif
207
208
/*
209
 * Hash this domain.
210
 */
211
static size_t cookiehash(const char * const domain)
212
16.4k
{
213
16.4k
  const char *top;
214
16.4k
  size_t len;
215
216
16.4k
  if(!domain || Curl_host_is_ipnum(domain))
217
983
    return 0;
218
219
15.4k
  top = get_top_domain(domain, &len);
220
15.4k
  return cookie_hash_domain(top, len);
221
16.4k
}
222
223
/*
224
 * cookie path sanitize
225
 */
226
static char *sanitize_cookie_path(const char *cookie_path, size_t len)
227
1.64k
{
228
  /* some sites send path attribute within '"'. */
229
1.64k
  if(len && (cookie_path[0] == '\"')) {
230
221
    cookie_path++;
231
221
    len--;
232
233
221
    if(len && (cookie_path[len - 1] == '\"'))
234
78
      len--;
235
221
  }
236
237
  /* RFC6265 5.2.4 The Path Attribute */
238
1.64k
  if(!len || (cookie_path[0] != '/'))
239
    /* Let cookie-path be the default-path. */
240
378
    return curlx_strdup("/");
241
242
  /* remove trailing slash when path is non-empty */
243
  /* convert /hoge/ to /hoge */
244
1.26k
  if(len > 1 && cookie_path[len - 1] == '/')
245
69
    len--;
246
247
1.26k
  return curlx_memdup0(cookie_path, len);
248
1.64k
}
249
250
/*
251
 * strstore
252
 *
253
 * A thin wrapper around curlx_memdup0().
254
 */
255
static CURLcode strstore(char **str, const char *newstr, size_t len)
256
0
{
257
0
  DEBUGASSERT(str);
258
0
  *str = curlx_memdup0(newstr, len);
259
0
  if(!*str)
260
0
    return CURLE_OUT_OF_MEMORY;
261
0
  return CURLE_OK;
262
0
}
263
264
/*
265
 * remove_expired
266
 *
267
 * Remove expired cookies from the hash by inspecting the expires timestamp on
268
 * each cookie in the hash, freeing and deleting any where the timestamp is in
269
 * the past. If the cookiejar has recorded the next timestamp at which one or
270
 * more cookies expire, then processing will exit early in case this timestamp
271
 * is in the future.
272
 */
273
static void remove_expired(struct CookieInfo *ci)
274
27.9k
{
275
27.9k
  struct Cookie *co;
276
27.9k
  curl_off_t now = (curl_off_t)time(NULL);
277
27.9k
  unsigned int i;
278
279
  /*
280
   * If the earliest expiration timestamp in the jar is in the future we can
281
   * skip scanning the whole jar and instead exit early as there will not be
282
   * any cookies to evict. If we need to evict, reset the next_expiration
283
   * counter in order to track the next one. In case the recorded first
284
   * expiration is the max offset, then perform the safe fallback of checking
285
   * all cookies.
286
   */
287
27.9k
  if(now < ci->next_expiration &&
288
25.7k
     ci->next_expiration != CURL_OFF_T_MAX)
289
857
    return;
290
27.0k
  else
291
27.0k
    ci->next_expiration = CURL_OFF_T_MAX;
292
293
1.73M
  for(i = 0; i < COOKIE_HASH_SIZE; i++) {
294
1.70M
    struct Curl_llist_node *n;
295
1.70M
    struct Curl_llist_node *e = NULL;
296
297
1.73M
    for(n = Curl_llist_head(&ci->cookielist[i]); n; n = e) {
298
25.8k
      co = Curl_node_elem(n);
299
25.8k
      e = Curl_node_next(n);
300
25.8k
      if(co->expires) {
301
2.58k
        if(co->expires < now) {
302
2.18k
          Curl_node_remove(n);
303
2.18k
          freecookie(co, TRUE);
304
2.18k
          ci->numcookies--;
305
2.18k
        }
306
404
        else if(co->expires < ci->next_expiration)
307
          /*
308
           * If this cookie has an expiration timestamp earlier than what we
309
           * have seen so far then record it for the next round of expirations.
310
           */
311
239
          ci->next_expiration = co->expires;
312
2.58k
      }
313
25.8k
    }
314
1.70M
  }
315
27.0k
}
316
317
#ifndef USE_LIBPSL
318
/* Make sure domain contains a dot or is localhost. */
319
static bool bad_domain(const char *domain, size_t len)
320
0
{
321
0
  if((len == 9) && curl_strnequal(domain, "localhost", 9))
322
0
    return FALSE;
323
0
  else {
324
    /* there must be a dot present, but that dot must not be a trailing dot */
325
0
    const char *dot = memchr(domain, '.', len);
326
0
    if(dot) {
327
0
      size_t i = dot - domain;
328
0
      if((len - i) > 1)
329
        /* the dot is not the last byte */
330
0
        return FALSE;
331
0
    }
332
0
  }
333
0
  return TRUE;
334
0
}
335
#endif
336
337
/* RFC 6265 section 4.1.1 says a server should accept this range:
338
339
   cookie-octet    = %x21 / %x23-2B / %x2D-3A / %x3C-5B / %x5D-7E
340
341
   Yet, Firefox and Chrome as of June 2022 accept space, comma and
342
   double-quotes fine. The prime reason for filtering out control bytes is that
343
   some HTTP servers return 400 for requests that contain such.
344
 */
345
static bool invalid_octets(const char *ptr, size_t len)
346
17.2k
{
347
17.2k
  const unsigned char *p = (const unsigned char *)ptr;
348
  /* Reject all bytes \x01 - \x1f + \x7f */
349
30.4k
  while(len && *p) {
350
13.2k
    if((*p < 0x20) || (*p == 0x7f))
351
146
      return TRUE;
352
13.1k
    p++;
353
13.1k
    len--;
354
13.1k
  }
355
17.1k
  return FALSE;
356
17.2k
}
357
358
/* The maximum length we accept a date string for the 'expire' keyword. The
359
   standard date formats are within the 30 bytes range. This adds an extra
360
   margin to make sure it realistically works with what is used out there. */
361
0
#define MAX_DATE_LENGTH 80
362
363
0
#define COOKIE_NAME   0
364
0
#define COOKIE_VALUE  1
365
0
#define COOKIE_DOMAIN 2
366
0
#define COOKIE_PATH   3
367
368
#define COOKIE_PIECES 4 /* the list above */
369
370
static CURLcode storecookie(struct Cookie *co, const struct Curl_str *cp,
371
                            const char *path, const char *domain)
372
0
{
373
0
  CURLcode result;
374
0
  result = strstore(&co->name, curlx_str(&cp[COOKIE_NAME]),
375
0
                    curlx_strlen(&cp[COOKIE_NAME]));
376
0
  if(!result)
377
0
    result = strstore(&co->value, curlx_str(&cp[COOKIE_VALUE]),
378
0
                      curlx_strlen(&cp[COOKIE_VALUE]));
379
0
  if(!result) {
380
0
    size_t plen = 0;
381
0
    if(curlx_strlen(&cp[COOKIE_PATH])) {
382
0
      path = curlx_str(&cp[COOKIE_PATH]);
383
0
      plen = curlx_strlen(&cp[COOKIE_PATH]);
384
0
    }
385
0
    else if(path) {
386
      /* No path was given in the header line, set the default */
387
0
      const char *endslash = strrchr(path, '/');
388
0
      if(endslash)
389
0
        plen = endslash - path + 1; /* include end slash */
390
0
      else
391
0
        plen = strlen(path);
392
0
    }
393
394
0
    if(path) {
395
0
      co->path = sanitize_cookie_path(path, plen);
396
0
      if(!co->path)
397
0
        result = CURLE_OUT_OF_MEMORY;
398
0
    }
399
0
  }
400
0
  if(!result) {
401
0
    if(curlx_strlen(&cp[COOKIE_DOMAIN]))
402
0
      result = strstore(&co->domain, curlx_str(&cp[COOKIE_DOMAIN]),
403
0
                        curlx_strlen(&cp[COOKIE_DOMAIN]));
404
0
    else if(domain) {
405
      /* no domain was given in the header line, set the default */
406
0
      co->domain = curlx_strdup(domain);
407
0
      if(!co->domain)
408
0
        result = CURLE_OUT_OF_MEMORY;
409
0
    }
410
0
  }
411
0
  return result;
412
0
}
413
414
/*
415
 * Parse the first name/value pair of the cookie header, which is the actual
416
 * cookie name and value.
417
 */
418
static bool parse_first_pair(struct Curl_easy *data, struct Cookie *co,
419
                             struct Curl_str *cookie,
420
                             struct Curl_str *name,
421
                             struct Curl_str *val,
422
                             bool sep)
423
0
{
424
  /* The first name/value pair is the actual cookie name */
425
0
  if(!sep || !curlx_strlen(name)) {
426
0
    infof(data, "invalid cookie, dropped");
427
0
    return FALSE;
428
0
  }
429
430
  /*
431
   * Check for too long individual name or contents. Chrome and Firefox
432
   * support 4095 or 4096 bytes combo
433
   */
434
0
  if((curlx_strlen(name) + curlx_strlen(val)) > MAX_NAME) {
435
0
    infof(data, "oversized cookie dropped, name/val %zu + %zu bytes",
436
0
          curlx_strlen(name), curlx_strlen(val));
437
0
    return FALSE;
438
0
  }
439
440
  /* Check if we have a reserved prefix set. */
441
0
  if(!strncmp("__Secure-", curlx_str(name), 9))
442
0
    co->prefix_secure = TRUE;
443
0
  else if(!strncmp("__Host-", curlx_str(name), 7))
444
0
    co->prefix_host = TRUE;
445
446
0
  cookie[COOKIE_NAME] = *name;
447
0
  cookie[COOKIE_VALUE] = *val;
448
0
  return TRUE;
449
0
}
450
451
static bool parse_domain(struct Curl_easy *data, struct Cookie *co,
452
                         struct Curl_str *cookie_domain,
453
                         struct Curl_str *val,
454
                         const char **domainp)
455
0
{
456
0
  bool is_ip;
457
0
  const char *domain = *domainp;
458
0
  const char *v = curlx_str(val);
459
  /*
460
   * Now, we make sure that our host is within the given domain, or
461
   * the given domain is not valid and thus cannot be set.
462
   */
463
464
0
  if('.' == *v)
465
0
    curlx_str_nudge(val, 1);
466
467
0
#ifndef USE_LIBPSL
468
  /*
469
   * Without PSL we do not know when the incoming cookie is set on a
470
   * TLD or otherwise "protected" suffix. To reduce risk, we require a
471
   * dot OR the exact hostname being "localhost".
472
   */
473
0
  if(bad_domain(curlx_str(val), curlx_strlen(val))) {
474
0
    *domainp = ":";
475
0
    domain = ":";
476
0
  }
477
0
#endif
478
479
0
  is_ip = Curl_host_is_ipnum(domain ? domain : curlx_str(val));
480
481
0
  if(!domain ||
482
0
     (is_ip &&
483
0
      !strncmp(curlx_str(val), domain, curlx_strlen(val)) &&
484
0
      (curlx_strlen(val) == strlen(domain))) ||
485
0
     (!is_ip && cookie_tailmatch(curlx_str(val),
486
0
                                  curlx_strlen(val), domain))) {
487
0
    *cookie_domain = *val;
488
0
    if(!is_ip)
489
0
      co->tailmatch = TRUE; /* we always do that if the domain name was
490
                               given */
491
0
  }
492
0
  else {
493
    /*
494
     * We did not get a tailmatch and then the attempted set domain is
495
     * not a domain to which the current host belongs. Mark as bad.
496
     */
497
0
    infof(data, "skipped cookie with bad tailmatch domain: %s",
498
0
          curlx_str(val));
499
0
    return FALSE;
500
0
  }
501
0
  return TRUE;
502
0
}
503
504
static void parse_maxage(struct Cookie *co, struct Curl_str *val,
505
                         time_t *nowp)
506
0
{
507
0
  int rc;
508
0
  const char *maxage = curlx_str(val);
509
0
  if(*maxage == '\"')
510
0
    maxage++;
511
0
  rc = curlx_str_number(&maxage, &co->expires, CURL_OFF_T_MAX);
512
0
  if(!*nowp)
513
0
    *nowp = time(NULL);
514
0
  switch(rc) {
515
0
  case STRE_OVERFLOW:
516
    /* overflow, used max value */
517
0
    co->expires = CURL_OFF_T_MAX;
518
0
    break;
519
0
  default:
520
    /* negative or otherwise bad, expire */
521
0
    co->expires = 1;
522
0
    break;
523
0
  case STRE_OK:
524
0
    if(!co->expires)
525
0
      co->expires = 1; /* expire now */
526
0
    else if(CURL_OFF_T_MAX - *nowp < co->expires)
527
      /* would overflow */
528
0
      co->expires = CURL_OFF_T_MAX;
529
0
    else
530
0
      co->expires += *nowp;
531
0
    break;
532
0
  }
533
0
  cap_expires(*nowp, co);
534
0
}
535
536
static void parse_expires(struct Cookie *co, struct Curl_str *val,
537
                          time_t *nowp)
538
0
{
539
  /*
540
   * Let max-age have priority.
541
   *
542
   * If the date cannot get parsed for whatever reason, the cookie
543
   * will be treated as a session cookie
544
   */
545
0
  if(!co->expires && (curlx_strlen(val) < MAX_DATE_LENGTH)) {
546
0
    char dbuf[MAX_DATE_LENGTH + 1];
547
0
    time_t date = 0;
548
0
    memcpy(dbuf, curlx_str(val), curlx_strlen(val));
549
0
    dbuf[curlx_strlen(val)] = 0;
550
0
    if(!Curl_getdate_capped(dbuf, &date)) {
551
0
      if(!date)
552
0
        date++;
553
0
      co->expires = (curl_off_t)date;
554
0
    }
555
0
    else
556
0
      co->expires = 0;
557
0
    if(!*nowp)
558
0
      *nowp = time(NULL);
559
0
    cap_expires(*nowp, co);
560
0
  }
561
0
}
562
563
/* this function returns errors on OOM etc, not for cookie format problems */
564
static CURLcode
565
parse_cookie_header(struct Curl_easy *data,
566
                    struct Cookie *co,
567
                    bool *okay, /* if the cookie was fine */
568
                    const char *ptr, /* the header */
569
                    const char *domain, /* default domain */
570
                    /* full path used when this cookie is set */
571
                    const char *path,
572
                    bool secure_origin)
573
0
{
574
  /* This line was read off an HTTP-header */
575
0
  time_t now = 0;
576
0
  size_t linelength = strlen(ptr);
577
0
  CURLcode result = CURLE_OK;
578
0
  struct Curl_str cookie[COOKIE_PIECES];
579
0
  *okay = FALSE;
580
0
  if(linelength > MAX_COOKIE_LINE)
581
    /* discard overly long lines at once */
582
0
    return CURLE_OK;
583
584
  /* memset instead of initializer because gcc 4.8.1 is silly */
585
0
  memset(cookie, 0, sizeof(cookie));
586
0
  do {
587
0
    struct Curl_str name;
588
589
    /* we have a <name>=<value> pair or a stand-alone word here */
590
0
    int rc = curlx_str_cspn(&ptr, &name, ";\r\n=");
591
0
    if(!rc || (rc == STRE_SHORT)) {
592
0
      struct Curl_str val;
593
0
      bool sep = FALSE;
594
0
      curlx_str_trimblanks(&name);
595
596
0
      if(invalid_octets(curlx_str(&name), curlx_strlen(&name))) {
597
0
        infof(data, "invalid octets in name, cookie dropped");
598
0
        return CURLE_OK;
599
0
      }
600
601
0
      if(!curlx_str_single(&ptr, '=')) {
602
0
        sep = TRUE; /* a '=' was used */
603
0
        if(!curlx_str_cspn(&ptr, &val, ";\r\n"))
604
0
          curlx_str_trimblanks(&val);
605
606
0
        if(invalid_octets(curlx_str(&val), curlx_strlen(&val))) {
607
0
          infof(data, "invalid octets in value, cookie dropped");
608
0
          return CURLE_OK;
609
0
        }
610
0
      }
611
0
      else
612
0
        curlx_str_init(&val);
613
614
0
      if(!curlx_strlen(&cookie[COOKIE_NAME])) {
615
0
        if(!parse_first_pair(data, co, cookie, &name, &val, sep))
616
0
          return CURLE_OK;
617
0
      }
618
619
      /* whether there's separator or not */
620
0
      else if(curlx_str_casecompare(&name, "secure")) {
621
0
        if(secure_origin)
622
0
          co->secure = TRUE;
623
0
        else {
624
0
          infof(data, "skipped cookie because not 'secure'");
625
0
          return CURLE_OK;
626
0
        }
627
0
      }
628
0
      else if(curlx_str_casecompare(&name, "httponly"))
629
0
        co->httponly = TRUE;
630
0
      else if(sep) {
631
        /* only if a separating equals sign is present */
632
0
        if(curlx_str_casecompare(&name, "path"))
633
0
          cookie[COOKIE_PATH] = val;
634
0
        else if(curlx_str_casecompare(&name, "domain")) {
635
0
          if(curlx_strlen(&val) &&
636
0
             !parse_domain(data, co, &cookie[COOKIE_DOMAIN], &val, &domain))
637
0
            return CURLE_OK;
638
0
        }
639
0
        else if(curlx_str_casecompare(&name, "max-age") && curlx_strlen(&val))
640
0
          parse_maxage(co, &val, &now);
641
0
        else if(curlx_str_casecompare(&name, "expires") && curlx_strlen(&val))
642
0
          parse_expires(co, &val, &now);
643
0
      }
644
0
    }
645
0
  } while(!curlx_str_single(&ptr, ';'));
646
647
0
  if(curlx_strlen(&cookie[COOKIE_NAME])) {
648
    /* the header was fine, now store the data */
649
0
    result = storecookie(co, &cookie[0], path, domain);
650
0
    if(!result)
651
0
      *okay = TRUE;
652
0
  }
653
0
  return result;
654
0
}
655
656
static CURLcode parse_netscape(struct Cookie *co,
657
                               const struct CookieInfo *ci,
658
                               bool *okay,
659
                               const char *lineptr,
660
                               bool secure_origin)
661
21.4k
{
662
  /*
663
   * This line is NOT an HTTP header style line, we do offer support for
664
   * reading the odd netscape cookies-file format here
665
   */
666
21.4k
  const char *ptr, *next;
667
21.4k
  int fields;
668
21.4k
  size_t len;
669
21.4k
  *okay = FALSE;
670
671
  /*
672
   * In 2008, Internet Explorer introduced HTTP-only cookies to prevent XSS
673
   * attacks. Cookies marked httpOnly are not accessible to JavaScript. In
674
   * Firefox's cookie files, they are prefixed #HttpOnly_ and the rest
675
   * remains as usual, so we skip 10 characters of the line.
676
   */
677
21.4k
  if(!strncmp(lineptr, "#HttpOnly_", 10)) {
678
67
    lineptr += 10;
679
67
    co->httponly = TRUE;
680
67
  }
681
682
21.4k
  if(lineptr[0] == '#')
683
    /* do not even try the comments */
684
130
    return CURLE_OK;
685
686
  /*
687
   * Now loop through the fields and init the struct we already have
688
   * allocated
689
   */
690
21.2k
  fields = 0;
691
90.7k
  for(next = lineptr; next; fields++) {
692
69.7k
    ptr = next;
693
69.7k
    len = strcspn(ptr, "\t\r\n");
694
69.7k
    next = (ptr[len] == '\t' ? &ptr[len + 1] : NULL);
695
69.7k
    switch(fields) {
696
21.2k
    case 0:
697
21.2k
      if(ptr[0] == '.') { /* skip preceding dots */
698
442
        ptr++;
699
442
        len--;
700
442
      }
701
21.2k
      co->domain = curlx_memdup0(ptr, len);
702
21.2k
      if(!co->domain)
703
25
        return CURLE_OUT_OF_MEMORY;
704
21.2k
      break;
705
21.2k
    case 1:
706
      /*
707
       * flag: A TRUE/FALSE value indicating if all machines within a given
708
       * domain can access the variable. Set TRUE when the cookie says
709
       * .example.com and to false when the domain is complete www.example.com
710
       */
711
9.95k
      co->tailmatch = !!curl_strnequal(ptr, "TRUE", len);
712
9.95k
      break;
713
9.88k
    case 2:
714
      /* The file format allows the path field to remain not filled in */
715
9.88k
      if(strncmp("TRUE", ptr, len) && strncmp("FALSE", ptr, len)) {
716
        /* only if the path does not look like a boolean option! */
717
1.64k
        co->path = sanitize_cookie_path(ptr, len);
718
1.64k
        if(!co->path)
719
10
          return CURLE_OUT_OF_MEMORY;
720
1.63k
        break;
721
1.64k
      }
722
8.24k
      else {
723
        /* this does not look like a path, make one up! */
724
8.24k
        co->path = curlx_strdup("/");
725
8.24k
        if(!co->path)
726
13
          return CURLE_OUT_OF_MEMORY;
727
8.24k
      }
728
8.22k
      fields++; /* add a field and fall down to secure */
729
8.22k
      FALLTHROUGH();
730
9.36k
    case 3:
731
9.36k
      co->secure = FALSE;
732
9.36k
      if(curl_strnequal(ptr, "TRUE", len)) {
733
8.63k
        if(secure_origin || ci->running)
734
8.63k
          co->secure = TRUE;
735
0
        else
736
0
          return CURLE_OK;
737
8.63k
      }
738
9.36k
      break;
739
9.36k
    case 4:
740
9.14k
      if(curlx_str_number(&ptr, &co->expires, CURL_OFF_T_MAX))
741
237
        return CURLE_OK;
742
8.90k
      break;
743
8.90k
    case 5:
744
8.71k
      co->name = curlx_memdup0(ptr, len);
745
8.71k
      if(!co->name)
746
9
        return CURLE_OUT_OF_MEMORY;
747
8.70k
      else {
748
        /* For Netscape file format cookies we check prefix on the name.
749
           These prefixes are matched case sensitively, same as on the
750
           header path and as the 6265bis document specifies. */
751
8.70k
        if(!strncmp("__Secure-", co->name, 9))
752
163
          co->prefix_secure = TRUE;
753
8.54k
        else if(!strncmp("__Host-", co->name, 7))
754
279
          co->prefix_host = TRUE;
755
8.70k
      }
756
8.70k
      break;
757
8.70k
    case 6:
758
636
      co->value = curlx_memdup0(ptr, len);
759
636
      if(!co->value)
760
3
        return CURLE_OUT_OF_MEMORY;
761
633
      break;
762
69.7k
    }
763
69.7k
  }
764
20.9k
  if(fields == 6) {
765
    /* we got a cookie with blank contents, fix it */
766
8.06k
    co->value = curlx_strdup("");
767
8.06k
    if(!co->value)
768
14
      return CURLE_OUT_OF_MEMORY;
769
8.05k
    else
770
8.05k
      fields++;
771
8.06k
  }
772
773
20.9k
  if(fields != 7)
774
    /* we did not find the sufficient number of fields */
775
12.3k
    return CURLE_OK;
776
777
  /* Reject control octets in the name or value, matching the filtering done
778
     for cookies set over HTTP. A cookie loaded from a file is later sent in
779
     request headers, so the same bytes that make a server reject a request
780
     must not slip in through the file. */
781
8.66k
  if(invalid_octets(co->name, strlen(co->name)) ||
782
8.59k
     invalid_octets(co->value, strlen(co->value)))
783
146
    return CURLE_OK;
784
785
8.52k
  *okay = TRUE;
786
8.52k
  return CURLE_OK;
787
8.66k
}
788
789
static bool is_public_suffix(struct Curl_easy *data,
790
                             struct Cookie *co,
791
                             const char *domain)
792
0
{
793
#ifdef USE_LIBPSL
794
  /*
795
   * Check if the domain is a Public Suffix and if yes, ignore the cookie.
796
   * 'domain' is NULL when the cookie is loaded from file or
797
   * CURLOPT_COOKIELIST.
798
   */
799
  DEBUGASSERT(data);
800
  DEBUGASSERT(co);
801
  DEBUGF(infof(data, "PSL check set-cookie '%s' for domain=%s in %s",
802
               co->name, co->domain ? co->domain : "[blank]",
803
               domain ? domain : "[file]"));
804
  if(!co->domain || Curl_host_is_ipnum(co->domain))
805
    return FALSE;
806
807
  else {
808
    bool acceptable = FALSE;
809
    char lcase[256];
810
    char lcookie[256];
811
    size_t dlen = domain ? strlen(domain) : 0;
812
    size_t clen = strlen(co->domain);
813
814
    /* trim trailing dots */
815
    if(dlen && (domain[dlen - 1] == '.'))
816
      dlen--;
817
    if(clen && (co->domain[clen - 1] == '.'))
818
      clen--;
819
820
    if((dlen < sizeof(lcase)) && (clen < sizeof(lcookie))) {
821
      const psl_ctx_t *psl = Curl_psl_use(data);
822
      if(psl) {
823
        /* the PSL check requires lowercase domain name and pattern */
824
        Curl_strntolower(lcookie, co->domain, clen);
825
        lcookie[clen] = 0;
826
        if(domain) {
827
          Curl_strntolower(lcase, domain, dlen);
828
          lcase[dlen] = 0;
829
          acceptable = psl_is_cookie_domain_acceptable(psl, lcase, lcookie);
830
831
          /* if the cookie is acceptable, but is set for a PSL domain, then it
832
             cannot be tailmatching */
833
          if(acceptable && co->tailmatch &&
834
             curl_strequal(co->domain, domain) &&
835
             psl_is_public_suffix(psl, lcookie))
836
            co->tailmatch = FALSE;
837
        }
838
        else {
839
          bool suffix = psl_is_public_suffix(psl, lcookie);
840
          acceptable = TRUE;
841
          if(suffix)
842
            /* switch off tailmatching when set for a PSL domain */
843
            co->tailmatch = FALSE;
844
        }
845
        Curl_psl_release(data);
846
      }
847
      else
848
        infof(data, "libpsl problem, rejecting cookie for safety");
849
    }
850
851
    if(!acceptable) {
852
      infof(data, "cookie '%s' dropped, domain '%s' must not "
853
            "set cookies for '%s'", co->name,
854
            domain ? domain : "[file]", co->domain);
855
      return TRUE;
856
    }
857
  }
858
#else
859
0
  (void)data;
860
0
  (void)co;
861
0
  (void)domain;
862
0
  DEBUGF(infof(data, "NO PSL to check set-cookie '%s' for domain=%s in %s",
863
0
               co->name, co->domain, domain ? domain : "[file]"));
864
0
#endif
865
0
  return FALSE;
866
0
}
867
868
/* returns TRUE when replaced */
869
static bool replace_existing(struct Curl_easy *data,
870
                             struct Cookie *co,
871
                             const struct CookieInfo *ci,
872
                             bool secure,
873
                             bool *replacep)
874
8.25k
{
875
8.25k
  bool replace_old = FALSE;
876
8.25k
  struct Curl_llist_node *replace_n = NULL;
877
8.25k
  struct Curl_llist_node *n;
878
8.25k
  size_t myhash = cookiehash(co->domain);
879
19.4k
  for(n = Curl_llist_head(&ci->cookielist[myhash]); n; n = Curl_node_next(n)) {
880
11.1k
    struct Cookie *clist = Curl_node_elem(n);
881
11.1k
    if(!strcmp(clist->name, co->name)) {
882
      /* the names are identical */
883
8.27k
      bool matching_domains = FALSE;
884
885
8.27k
      if(clist->domain && co->domain) {
886
8.27k
        if(cookie_tailmatch(clist->domain, strlen(clist->domain),
887
8.27k
                            co->domain) ||
888
2.71k
           cookie_tailmatch(co->domain, strlen(co->domain), clist->domain))
889
          /* The existing one is a tail of the new or vice versa */
890
6.54k
          matching_domains = TRUE;
891
8.27k
      }
892
0
      else if(!clist->domain && !co->domain)
893
0
        matching_domains = TRUE;
894
895
8.27k
      if(matching_domains && /* the domains were identical */
896
6.54k
         clist->path && co->path && /* both have paths */
897
6.54k
         clist->secure && !co->secure && !secure) {
898
0
        size_t cllen;
899
0
        const char *sep = NULL;
900
901
        /*
902
         * A non-secure cookie may not overlay an existing secure cookie.
903
         * For an existing cookie "a" with path "/login", refuse a new
904
         * cookie "a" with for example path "/login/en", while the path
905
         * "/loginhelper" is ok.
906
         */
907
908
0
        DEBUGASSERT(clist->path[0]);
909
0
        if(clist->path[0])
910
0
          sep = strchr(clist->path + 1, '/');
911
0
        if(sep)
912
0
          cllen = sep - clist->path;
913
0
        else
914
0
          cllen = strlen(clist->path);
915
916
0
        if(!strncmp(clist->path, co->path, cllen)) {
917
0
          infof(data, "cookie '%s' for domain '%s' dropped, would "
918
0
                "overlay an existing cookie", co->name, co->domain);
919
0
          return FALSE;
920
0
        }
921
0
      }
922
8.27k
    }
923
924
11.1k
    if(!replace_n && !strcmp(clist->name, co->name)) {
925
      /* the names are identical */
926
927
8.04k
      if(clist->domain && co->domain) {
928
8.04k
        if(curl_strequal(clist->domain, co->domain) &&
929
5.17k
           (clist->tailmatch == co->tailmatch))
930
          /* The domains are identical */
931
4.50k
          replace_old = TRUE;
932
8.04k
      }
933
0
      else if(!clist->domain && !co->domain)
934
0
        replace_old = TRUE;
935
936
8.04k
      if(replace_old) {
937
        /* the domains were identical */
938
939
4.50k
        if(clist->path && co->path &&
940
4.50k
           strcmp(clist->path, co->path))
941
1.46k
          replace_old = FALSE;
942
3.04k
        else if(!clist->path != !co->path)
943
0
          replace_old = FALSE;
944
4.50k
      }
945
946
8.04k
      if(replace_old && !co->livecookie && clist->livecookie) {
947
        /*
948
         * Both cookies matched fine, except that the already present cookie
949
         * is "live", which means it was set from a header, while the new one
950
         * was read from a file and thus is not "live". "live" cookies are
951
         * preferred so the new cookie is freed.
952
         */
953
0
        return FALSE;
954
0
      }
955
8.04k
      if(replace_old)
956
3.04k
        replace_n = n;
957
8.04k
    }
958
11.1k
  }
959
8.25k
  if(replace_n) {
960
3.04k
    struct Cookie *repl = Curl_node_elem(replace_n);
961
962
    /* when replacing, creationtime is kept from old */
963
3.04k
    co->creationtime = repl->creationtime;
964
965
    /* unlink the old */
966
3.04k
    Curl_node_remove(replace_n);
967
968
    /* free the old cookie */
969
3.04k
    freecookie(repl, TRUE);
970
3.04k
  }
971
8.25k
  *replacep = replace_old;
972
8.25k
  return TRUE;
973
8.25k
}
974
975
/*
976
 * Curl_cookie_add
977
 *
978
 * Add a single cookie line to the cookie keeping object. Be aware that
979
 * sometimes we get an IP-only hostname, and that might also be a numerical
980
 * IPv6 address.
981
 *
982
 */
983
CURLcode Curl_cookie_add(struct Curl_easy *data,
984
                         struct CookieInfo *ci,
985
                         const char *lineptr, /* first character of the line */
986
                         const char *domain,  /* default domain */
987
                         const char *path,    /* full path used when this
988
                                                 cookie is set, used to get
989
                                                 default path for the cookie
990
                                                 unless set */
991
                         const int flags)
992
21.4k
{
993
21.4k
  struct Cookie comem;
994
21.4k
  struct Cookie *co;
995
21.4k
  size_t myhash;
996
21.4k
  CURLcode result;
997
21.4k
  bool replaces = FALSE;
998
21.4k
  bool okay;
999
1000
21.4k
  DEBUGASSERT(data);
1001
21.4k
  DEBUGASSERT(MAX_SET_COOKIE_AMOUNT <= 255); /* counter is an unsigned char */
1002
21.4k
  if(data->req.setcookies >= MAX_SET_COOKIE_AMOUNT)
1003
0
    return CURLE_OK; /* silently ignore */
1004
1005
21.4k
  co = &comem;
1006
21.4k
  memset(co, 0, sizeof(comem));
1007
1008
21.4k
  if(flags & COOKIE_HTTPHEADER)
1009
0
    result = parse_cookie_header(data, co, &okay,
1010
0
                                 lineptr, domain, path, flags & COOKIE_SECURE);
1011
21.4k
  else
1012
21.4k
    result = parse_netscape(co, ci, &okay, lineptr, flags & COOKIE_SECURE);
1013
1014
21.4k
  if(result || !okay)
1015
12.8k
    goto fail;
1016
1017
8.52k
  if(co->prefix_secure && !co->secure)
1018
    /* The __Secure- prefix only requires that the cookie be set secure */
1019
66
    goto fail;
1020
1021
8.45k
  if(!(flags & COOKIE_NOPSL) && is_public_suffix(data, co, domain))
1022
0
    goto fail;
1023
1024
8.45k
  if(co->prefix_host) {
1025
    /*
1026
     * The __Host- prefix requires the cookie to be secure, have a "/" path
1027
     * and not have a domain set.
1028
     */
1029
279
    if(co->secure && co->path && !strcmp(co->path, "/") && !co->tailmatch)
1030
79
      ;
1031
200
    else
1032
200
      goto fail;
1033
279
  }
1034
1035
8.25k
  if(!ci->running &&    /* read from a file */
1036
8.25k
     ci->newsession &&  /* clean session cookies */
1037
0
     !co->expires)      /* this is a session cookie */
1038
0
    goto fail;
1039
1040
8.25k
  co->livecookie = ci->running;
1041
8.25k
  co->creationtime = ++ci->lastct;
1042
1043
8.25k
  if(!(flags & COOKIE_NOEXPIRE))
1044
8.25k
    remove_expired(ci);
1045
1046
  /*
1047
   * Now we have parsed the incoming line, we must now check if this supersedes
1048
   * an already existing cookie, which it may if the previous have the same
1049
   * domain and path as this.
1050
   */
1051
8.25k
  if(!replace_existing(data, co, ci, flags & COOKIE_SECURE, &replaces))
1052
0
    goto fail;
1053
1054
  /* clone the stack struct into heap */
1055
8.25k
  co = curlx_memdup(&comem, sizeof(comem));
1056
8.25k
  if(!co) {
1057
75
    co = &comem;
1058
75
    result = CURLE_OUT_OF_MEMORY;
1059
75
    goto fail; /* bail out if we are this low on memory */
1060
75
  }
1061
1062
  /* add this cookie to the list */
1063
8.18k
  myhash = cookiehash(co->domain);
1064
8.18k
  Curl_llist_append(&ci->cookielist[myhash], co, &co->node);
1065
1066
8.18k
  if(ci->running)
1067
    /* Only show this when NOT reading the cookies from a file */
1068
0
    infof(data, "%s cookie %s=\"%s\" for domain %s, path %s, "
1069
8.18k
          "expire %" FMT_OFF_T,
1070
8.18k
          replaces ? "Replaced" : "Added", co->name, co->value,
1071
8.18k
          co->domain, co->path, co->expires);
1072
1073
8.18k
  if(!replaces)
1074
5.14k
    ci->numcookies++; /* one more cookie in the jar */
1075
1076
  /*
1077
   * Now that we have added a new cookie to the jar, update the expiration
1078
   * tracker in case it is the next one to expire.
1079
   */
1080
8.18k
  if(co->expires && (co->expires < ci->next_expiration))
1081
2.51k
    ci->next_expiration = co->expires;
1082
1083
8.18k
  if(flags & COOKIE_HTTPHEADER)
1084
0
    data->req.setcookies++;
1085
1086
8.18k
  return result;
1087
13.2k
fail:
1088
13.2k
  freecookie(co, FALSE);
1089
13.2k
  return result;
1090
8.25k
}
1091
1092
/*
1093
 * Curl_cookie_init()
1094
 *
1095
 * Inits a cookie struct to read data from a local file. This is always
1096
 * called before any cookies are set. File may be NULL in which case only the
1097
 * struct is initialized. Is file is "-" then STDIN is read.
1098
 *
1099
 * If 'newsession' is TRUE, discard all "session cookies" on read from file.
1100
 *
1101
 * Note that 'data' might be called as NULL pointer. If data is NULL, 'file'
1102
 * will be ignored.
1103
 *
1104
 * Returns NULL on out of memory.
1105
 */
1106
struct CookieInfo *Curl_cookie_init(void)
1107
10.0k
{
1108
10.0k
  int i;
1109
10.0k
  struct CookieInfo *ci = curlx_calloc(1, sizeof(struct CookieInfo));
1110
10.0k
  if(!ci)
1111
17
    return NULL;
1112
1113
  /* This does not use the destructor callback since we want to add
1114
     and remove to lists while keeping the cookie struct intact */
1115
642k
  for(i = 0; i < COOKIE_HASH_SIZE; i++)
1116
632k
    Curl_llist_init(&ci->cookielist[i], NULL);
1117
  /*
1118
   * Initialize the next_expiration time to signal that we do not have enough
1119
   * information yet.
1120
   */
1121
10.0k
  ci->next_expiration = CURL_OFF_T_MAX;
1122
1123
10.0k
  return ci;
1124
10.0k
}
1125
1126
/*
1127
 * cookie_load()
1128
 *
1129
 * Reads cookies from a local file. This is always called before any cookies
1130
 * are set. If file is "-" then STDIN is read.
1131
 *
1132
 * If 'flags' has the COOKIE_NOSESSION bit set, discard all "session cookies"
1133
 * read from file.
1134
 */
1135
static CURLcode cookie_load(struct Curl_easy *data, const char *file,
1136
                            struct CookieInfo *ci, int flags)
1137
9.84k
{
1138
9.84k
  FILE *handle = NULL;
1139
9.84k
  CURLcode result = CURLE_OK;
1140
9.84k
  FILE *fp = NULL;
1141
9.84k
  DEBUGASSERT(ci);
1142
9.84k
  DEBUGASSERT(data);
1143
9.84k
  DEBUGASSERT(file);
1144
1145
9.84k
  ci->newsession = !!(flags & COOKIE_NOSESSION); /* new session? */
1146
9.84k
  ci->running = FALSE; /* this is not running, this is init */
1147
1148
9.84k
  if(file && *file) {
1149
9.84k
    if(!strcmp(file, "-"))
1150
0
      fp = stdin;
1151
9.84k
    else {
1152
9.84k
      fp = curlx_fopen(file, "rb");
1153
9.84k
      if(!fp)
1154
0
        infof(data, "WARNING: failed to open cookie file \"%s\"", file);
1155
9.84k
      else {
1156
9.84k
        curlx_struct_stat stat;
1157
9.84k
        if((curlx_fstat(fileno(fp), &stat) != -1) && S_ISDIR(stat.st_mode)) {
1158
0
          curlx_fclose(fp);
1159
0
          fp = NULL;
1160
0
          infof(data, "WARNING: cookie filename points to a directory: \"%s\"",
1161
0
                file);
1162
0
        }
1163
9.84k
        else
1164
9.84k
          handle = fp;
1165
9.84k
      }
1166
9.84k
    }
1167
9.84k
  }
1168
1169
9.84k
  if(fp) {
1170
9.84k
    struct dynbuf buf;
1171
9.84k
    bool eof = FALSE;
1172
    /* accept a little longer lines so that a full cookie fits and does not
1173
       abort the file read */
1174
9.84k
    curlx_dyn_init(&buf, MAX_COOKIE_LINE + 48);
1175
9.84k
    do {
1176
9.84k
      result = Curl_get_line(&buf, fp, &eof);
1177
9.84k
      if(!result) {
1178
9.83k
        const char *lineptr = curlx_dyn_ptr(&buf);
1179
9.83k
        bool headerline = FALSE;
1180
9.83k
        if(checkprefix("Set-Cookie:", lineptr)) {
1181
          /* This is a cookie line, get it! */
1182
0
          lineptr += 11;
1183
0
          headerline = TRUE;
1184
0
          curlx_str_passblanks(&lineptr);
1185
0
        }
1186
1187
9.83k
        result = Curl_cookie_add(data, ci, lineptr, NULL, NULL,
1188
9.83k
                                 (headerline ? COOKIE_HTTPHEADER : 0) |
1189
9.83k
                                 COOKIE_NOEXPIRE | COOKIE_SECURE |
1190
9.83k
                                 (flags & COOKIE_NOPSL));
1191
        /* Ignore individual cookie problems unless we ran out of memory */
1192
9.83k
        if(result != CURLE_OUT_OF_MEMORY)
1193
9.83k
          result = CURLE_OK;
1194
9.83k
      }
1195
9.84k
    } while(!result && !eof);
1196
9.84k
    curlx_dyn_free(&buf); /* free the line buffer */
1197
1198
    /*
1199
     * Remove expired cookies from the hash. We must make sure to run this
1200
     * after reading the file, and not on every cookie.
1201
     */
1202
9.84k
    remove_expired(ci);
1203
1204
9.84k
    if(handle)
1205
9.84k
      curlx_fclose(handle);
1206
9.84k
  }
1207
9.84k
  data->state.cookie_engine = TRUE;
1208
9.84k
  ci->running = TRUE; /* now, we are running */
1209
1210
9.84k
  return result;
1211
9.84k
}
1212
1213
/*
1214
 * Load cookies from all given cookie files (CURLOPT_COOKIEFILE).
1215
 */
1216
CURLcode Curl_cookie_loadfiles(struct Curl_easy *data,
1217
                               int flags)
1218
9.87k
{
1219
9.87k
  CURLcode result = CURLE_OK;
1220
9.87k
  struct curl_slist *list = data->state.cookielist;
1221
9.87k
  if(list) {
1222
9.84k
    Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
1223
9.84k
    if(!data->cookies)
1224
29
      data->cookies = Curl_cookie_init();
1225
9.84k
    if(!data->cookies)
1226
1
      result = CURLE_OUT_OF_MEMORY;
1227
9.84k
    else {
1228
9.84k
      data->state.cookie_engine = TRUE;
1229
19.6k
      while(list) {
1230
9.84k
        result = cookie_load(data, list->data, data->cookies, flags);
1231
9.84k
        if(result)
1232
10
          break;
1233
9.83k
        list = list->next;
1234
9.83k
      }
1235
9.84k
    }
1236
9.84k
    Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
1237
9.84k
  }
1238
9.87k
  return result;
1239
9.87k
}
1240
1241
/*
1242
 * cookie_sort
1243
 *
1244
 * Helper function to sort cookies such that the longest path gets before the
1245
 * shorter path. Path, domain and name lengths are considered in that order,
1246
 * with the creationtime as the tiebreaker. The creationtime is guaranteed to
1247
 * be unique per cookie, so we know we will get an ordering at that point.
1248
 */
1249
static int cookie_sort(const void *p1, const void *p2)
1250
0
{
1251
0
  const struct Cookie *c1 = *(const struct Cookie * const *)p1;
1252
0
  const struct Cookie *c2 = *(const struct Cookie * const *)p2;
1253
0
  size_t l1, l2;
1254
1255
  /* 1 - compare cookie path lengths */
1256
0
  l1 = c1->path ? strlen(c1->path) : 0;
1257
0
  l2 = c2->path ? strlen(c2->path) : 0;
1258
1259
0
  if(l1 != l2)
1260
0
    return (l2 > l1) ? 1 : -1; /* avoid size_t <=> int conversions */
1261
1262
  /* 2 - compare cookie domain lengths */
1263
0
  l1 = c1->domain ? strlen(c1->domain) : 0;
1264
0
  l2 = c2->domain ? strlen(c2->domain) : 0;
1265
1266
0
  if(l1 != l2)
1267
0
    return (l2 > l1) ? 1 : -1; /* avoid size_t <=> int conversions */
1268
1269
  /* 3 - compare cookie name lengths */
1270
0
  l1 = c1->name ? strlen(c1->name) : 0;
1271
0
  l2 = c2->name ? strlen(c2->name) : 0;
1272
1273
0
  if(l1 != l2)
1274
0
    return (l2 > l1) ? 1 : -1;
1275
1276
  /* 4 - compare cookie creation time */
1277
0
  return (c2->creationtime > c1->creationtime) ? 1 : -1;
1278
0
}
1279
1280
/*
1281
 * cookie_sort_ct
1282
 *
1283
 * Helper function to sort cookies according to creation time.
1284
 */
1285
static int cookie_sort_ct(const void *p1, const void *p2)
1286
4.07k
{
1287
4.07k
  const struct Cookie *c1 = *(const struct Cookie * const *)p1;
1288
4.07k
  const struct Cookie *c2 = *(const struct Cookie * const *)p2;
1289
1290
4.07k
  return (c2->creationtime > c1->creationtime) ? 1 : -1;
1291
4.07k
}
1292
1293
bool Curl_secure_context(struct Curl_easy *data, const char *host)
1294
0
{
1295
0
  return Curl_xfer_is_secure(data) ||
1296
0
    curl_strequal("localhost", host) ||
1297
0
    !strcmp(host, "127.0.0.1") ||
1298
0
    !strcmp(host, "::1");
1299
0
}
1300
1301
/*
1302
 * Curl_cookie_getlist
1303
 *
1304
 * For a given host and path, return a linked list of cookies that the client
1305
 * should send to the server if used now.
1306
 *
1307
 * It shall only return cookies that have not expired.
1308
 *
1309
 * 'okay' is TRUE when there is a list returned.
1310
 */
1311
CURLcode Curl_cookie_getlist(struct Curl_easy *data,
1312
                             bool *okay,
1313
                             const char *host,
1314
                             struct Curl_llist *list)
1315
0
{
1316
0
  size_t matches = 0;
1317
0
  const bool is_ip = Curl_host_is_ipnum(host);
1318
0
  const size_t myhash = cookiehash(host);
1319
0
  struct Curl_llist_node *n;
1320
0
  const bool secure = Curl_secure_context(data, host);
1321
0
  struct CookieInfo *ci = data->cookies;
1322
0
  const char *path = data->state.up.path;
1323
0
  CURLcode result = CURLE_OK;
1324
0
  *okay = FALSE;
1325
1326
0
  Curl_llist_init(list, NULL);
1327
1328
0
  if(!ci || !Curl_llist_count(&ci->cookielist[myhash]))
1329
0
    return CURLE_OK; /* no cookie struct or no cookies in the struct */
1330
1331
  /* at first, remove expired cookies */
1332
0
  remove_expired(ci);
1333
1334
0
  for(n = Curl_llist_head(&ci->cookielist[myhash]); n; n = Curl_node_next(n)) {
1335
0
    struct Cookie *co = Curl_node_elem(n);
1336
1337
    /* if the cookie requires we are secure we must only continue if we are! */
1338
0
    if(co->secure ? secure : TRUE) {
1339
1340
      /* now check if the domain is correct */
1341
0
      if(!co->domain ||
1342
0
         (co->tailmatch && !is_ip &&
1343
0
          cookie_tailmatch(co->domain, strlen(co->domain), host)) ||
1344
0
         ((!co->tailmatch || is_ip) && curl_strequal(host, co->domain))) {
1345
        /*
1346
         * the right part of the host matches the domain stuff in the
1347
         * cookie data
1348
         */
1349
1350
        /*
1351
         * now check the left part of the path with the cookies path
1352
         * requirement
1353
         */
1354
0
        if(!co->path || pathmatch(co->path, path)) {
1355
1356
          /*
1357
           * This is a match and we add it to the return-linked-list
1358
           */
1359
0
          Curl_llist_append(list, co, &co->getnode);
1360
0
          matches++;
1361
0
          if(matches >= MAX_COOKIE_SEND_AMOUNT) {
1362
0
            infof(data, "Included max number of cookies (%zu) in request!",
1363
0
                  matches);
1364
0
            break;
1365
0
          }
1366
0
        }
1367
0
      }
1368
0
    }
1369
0
  }
1370
1371
0
  if(matches) {
1372
    /*
1373
     * Now we need to make sure that if there is a name appearing more than
1374
     * once, the longest specified path version comes first. To make this the
1375
     * swiftest way, we sort them all based on path length.
1376
     */
1377
0
    struct Cookie **array;
1378
0
    size_t i;
1379
1380
    /* alloc an array and store all cookie pointers */
1381
0
    array = curlx_malloc(sizeof(struct Cookie *) * matches);
1382
0
    if(!array) {
1383
0
      result = CURLE_OUT_OF_MEMORY;
1384
0
      goto fail;
1385
0
    }
1386
1387
0
    n = Curl_llist_head(list);
1388
1389
0
    for(i = 0; n; n = Curl_node_next(n))
1390
0
      array[i++] = Curl_node_elem(n);
1391
1392
    /* now sort the cookie pointers in path length order */
1393
0
    qsort(array, matches, sizeof(struct Cookie *), cookie_sort);
1394
1395
    /* remake the linked list order according to the new order */
1396
0
    Curl_llist_destroy(list, NULL);
1397
1398
0
    for(i = 0; i < matches; i++)
1399
0
      Curl_llist_append(list, array[i], &array[i]->getnode);
1400
1401
0
    curlx_free(array); /* remove the temporary data again */
1402
0
  }
1403
1404
0
  *okay = TRUE;
1405
0
  return CURLE_OK; /* success */
1406
1407
0
fail:
1408
  /* failure, clear up the allocated chain and return NULL */
1409
0
  Curl_llist_destroy(list, NULL);
1410
0
  return result; /* error */
1411
0
}
1412
1413
/*
1414
 * Curl_cookie_clearall
1415
 *
1416
 * Clear all existing cookies and reset the counter.
1417
 */
1418
void Curl_cookie_clearall(struct CookieInfo *ci)
1419
10.5k
{
1420
10.5k
  if(ci) {
1421
10.4k
    unsigned int i;
1422
671k
    for(i = 0; i < COOKIE_HASH_SIZE; i++) {
1423
661k
      struct Curl_llist_node *n;
1424
664k
      for(n = Curl_llist_head(&ci->cookielist[i]); n;) {
1425
2.95k
        struct Cookie *c = Curl_node_elem(n);
1426
2.95k
        struct Curl_llist_node *e = Curl_node_next(n);
1427
2.95k
        Curl_node_remove(n);
1428
2.95k
        freecookie(c, TRUE);
1429
2.95k
        n = e;
1430
2.95k
      }
1431
661k
    }
1432
10.4k
    ci->numcookies = 0;
1433
10.4k
  }
1434
10.5k
}
1435
1436
/*
1437
 * Curl_cookie_clearsess
1438
 *
1439
 * Free all session cookies in the cookies list.
1440
 */
1441
void Curl_cookie_clearsess(struct CookieInfo *ci)
1442
0
{
1443
0
  unsigned int i;
1444
1445
0
  if(!ci)
1446
0
    return;
1447
1448
0
  for(i = 0; i < COOKIE_HASH_SIZE; i++) {
1449
0
    struct Curl_llist_node *n = Curl_llist_head(&ci->cookielist[i]);
1450
0
    struct Curl_llist_node *e = NULL;
1451
1452
0
    for(; n; n = e) {
1453
0
      struct Cookie *curr = Curl_node_elem(n);
1454
0
      e = Curl_node_next(n); /* in case the node is removed, get it early */
1455
0
      if(!curr->expires) {
1456
0
        Curl_node_remove(n);
1457
0
        freecookie(curr, TRUE);
1458
0
        ci->numcookies--;
1459
0
      }
1460
0
    }
1461
0
  }
1462
0
}
1463
1464
/*
1465
 * Curl_cookie_cleanup()
1466
 *
1467
 * Free a "cookie object" previous created with Curl_cookie_init().
1468
 */
1469
void Curl_cookie_cleanup(struct CookieInfo *ci)
1470
10.0k
{
1471
10.0k
  if(ci) {
1472
10.0k
    Curl_cookie_clearall(ci);
1473
10.0k
    curlx_free(ci); /* free the base struct as well */
1474
10.0k
  }
1475
10.0k
}
1476
1477
/*
1478
 * get_netscape_format()
1479
 *
1480
 * Formats a string for Netscape output file, w/o a newline at the end.
1481
 * Function returns a char * to a formatted line. The caller is responsible
1482
 * for freeing the returned pointer.
1483
 */
1484
static char *get_netscape_format(const struct Cookie *co)
1485
2.91k
{
1486
2.91k
  return curl_maprintf(
1487
2.91k
    "%s"               /* httponly preamble */
1488
2.91k
    "%s%s\t"           /* domain */
1489
2.91k
    "%s\t"             /* tailmatch */
1490
2.91k
    "%s\t"             /* path */
1491
2.91k
    "%s\t"             /* secure */
1492
2.91k
    "%" FMT_OFF_T "\t" /* expires */
1493
2.91k
    "%s\t"             /* name */
1494
2.91k
    "%s",              /* value */
1495
2.91k
    co->httponly ? "#HttpOnly_" : "",
1496
    /*
1497
     * Make sure all domains are prefixed with a dot if they allow
1498
     * tailmatching. This is Mozilla-style.
1499
     */
1500
2.91k
    (co->tailmatch && co->domain && co->domain[0] != '.') ? "." : "",
1501
2.91k
    co->domain ? co->domain : "unknown",
1502
2.91k
    co->tailmatch ? "TRUE" : "FALSE",
1503
2.91k
    co->path ? co->path : "/",
1504
2.91k
    co->secure ? "TRUE" : "FALSE",
1505
2.91k
    co->expires,
1506
2.91k
    co->name,
1507
2.91k
    co->value ? co->value : "");
1508
2.91k
}
1509
1510
/*
1511
 * cookie_output()
1512
 *
1513
 * Writes all internally known cookies to the specified file. Specify
1514
 * "-" as filename to write to stdout.
1515
 *
1516
 * The function returns non-zero on write failure.
1517
 */
1518
static CURLcode cookie_output(struct Curl_easy *data,
1519
                              struct CookieInfo *ci,
1520
                              const char *filename)
1521
9.83k
{
1522
9.83k
  FILE *out = NULL;
1523
9.83k
  bool use_stdout = FALSE;
1524
9.83k
  char *tempstore = NULL;
1525
9.83k
  CURLcode result = CURLE_OK;
1526
1527
9.83k
  if(!ci)
1528
    /* no cookie engine alive */
1529
0
    return CURLE_OK;
1530
1531
  /* at first, remove expired cookies */
1532
9.83k
  remove_expired(ci);
1533
1534
9.83k
  if(!strcmp("-", filename)) {
1535
    /* use stdout */
1536
0
    out = stdout;
1537
0
    use_stdout = TRUE;
1538
0
  }
1539
9.83k
  else {
1540
9.83k
    result = Curl_fopen(data, filename, &out, &tempstore);
1541
9.83k
    if(result)
1542
0
      goto error;
1543
9.83k
  }
1544
1545
9.83k
  fputs("# Netscape HTTP Cookie File\n"
1546
9.83k
        "# https://curl.se/docs/http-cookies.html\n"
1547
9.83k
        "# This file was generated by libcurl! Edit at your own risk.\n\n",
1548
9.83k
        out);
1549
1550
9.83k
  if(ci->numcookies) {
1551
1.07k
    unsigned int i;
1552
1.07k
    size_t nvalid = 0;
1553
1.07k
    struct Cookie **array;
1554
1.07k
    struct Curl_llist_node *n;
1555
1556
1.07k
    array = curlx_calloc(1, sizeof(struct Cookie *) * ci->numcookies);
1557
1.07k
    if(!array) {
1558
2
      result = CURLE_OUT_OF_MEMORY;
1559
2
      goto error;
1560
2
    }
1561
1562
    /* only sort the cookies with a domain property */
1563
68.4k
    for(i = 0; i < COOKIE_HASH_SIZE; i++) {
1564
70.2k
      for(n = Curl_llist_head(&ci->cookielist[i]); n; n = Curl_node_next(n)) {
1565
2.91k
        struct Cookie *co = Curl_node_elem(n);
1566
2.91k
        if(!co->domain)
1567
0
          continue;
1568
2.91k
        array[nvalid++] = co;
1569
2.91k
      }
1570
67.3k
    }
1571
1572
1.06k
    qsort(array, nvalid, sizeof(struct Cookie *), cookie_sort_ct);
1573
1574
3.97k
    for(i = 0; i < nvalid; i++) {
1575
2.91k
      char *format_ptr = get_netscape_format(array[i]);
1576
2.91k
      if(!format_ptr) {
1577
4
        curlx_free(array);
1578
4
        result = CURLE_OUT_OF_MEMORY;
1579
4
        goto error;
1580
4
      }
1581
2.90k
      curl_mfprintf(out, "%s\n", format_ptr);
1582
2.90k
      curlx_free(format_ptr);
1583
2.90k
    }
1584
1585
1.06k
    curlx_free(array);
1586
1.06k
  }
1587
1588
9.83k
  if(!use_stdout) {
1589
9.83k
    curlx_fclose(out);
1590
9.83k
    out = NULL;
1591
9.83k
    if(tempstore && curlx_rename(tempstore, filename)) {
1592
0
      result = CURLE_WRITE_ERROR;
1593
0
      goto error;
1594
0
    }
1595
9.83k
  }
1596
1597
  /*
1598
   * If we reach here we have successfully written a cookie file so there is
1599
   * no need to inspect the error, any error case should have jumped into the
1600
   * error block below.
1601
   */
1602
9.83k
  curlx_free(tempstore);
1603
9.83k
  return CURLE_OK;
1604
1605
6
error:
1606
6
  if(out && !use_stdout)
1607
6
    curlx_fclose(out);
1608
6
  if(tempstore) {
1609
0
    unlink(tempstore);
1610
0
    curlx_free(tempstore);
1611
0
  }
1612
6
  return result;
1613
9.83k
}
1614
1615
static struct curl_slist *cookie_list(const struct Curl_easy *data)
1616
0
{
1617
0
  struct curl_slist *list = NULL;
1618
0
  struct curl_slist *beg;
1619
0
  struct curl_slist **tail = &list;
1620
0
  unsigned int i;
1621
0
  struct Curl_llist_node *n;
1622
1623
0
  if(!data->cookies || (data->cookies->numcookies == 0))
1624
0
    return NULL;
1625
1626
  /* at first, remove expired cookies */
1627
0
  remove_expired(data->cookies);
1628
1629
0
  for(i = 0; i < COOKIE_HASH_SIZE; i++) {
1630
0
    for(n = Curl_llist_head(&data->cookies->cookielist[i]); n;
1631
0
        n = Curl_node_next(n)) {
1632
0
      struct Cookie *c = Curl_node_elem(n);
1633
0
      char *line;
1634
0
      if(!c->domain)
1635
0
        continue;
1636
0
      line = get_netscape_format(c);
1637
0
      if(!line) {
1638
0
        curl_slist_free_all(list);
1639
0
        return NULL;
1640
0
      }
1641
0
      beg = Curl_slist_append_nodup(NULL, line);
1642
0
      if(!beg) {
1643
0
        curlx_free(line);
1644
0
        curl_slist_free_all(list);
1645
0
        return NULL;
1646
0
      }
1647
0
      *tail = beg;
1648
0
      tail = &beg->next;
1649
0
    }
1650
0
  }
1651
1652
0
  return list;
1653
0
}
1654
1655
struct curl_slist *Curl_cookie_list(struct Curl_easy *data)
1656
0
{
1657
0
  struct curl_slist *list;
1658
0
  Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
1659
0
  list = cookie_list(data);
1660
0
  Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
1661
0
  return list;
1662
0
}
1663
1664
void Curl_flush_cookies(struct Curl_easy *data, bool cleanup)
1665
20.0k
{
1666
20.0k
  Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
1667
  /* only save the cookie file if a transfer was started (cookies->running is
1668
     set), as otherwise the cookies were not completely initialized and there
1669
     might be cookie files that were not loaded so saving the file is the
1670
     wrong thing. */
1671
20.0k
  if(data->cookies) {
1672
10.0k
    const char *cookiejar = CURL_EASY_STR(data, STRING_COOKIEJAR);
1673
10.0k
    if(cookiejar && data->cookies->running) {
1674
      /* if we have a destination file for all the cookies to get dumped to */
1675
9.83k
      CURLcode result = cookie_output(data, data->cookies, cookiejar);
1676
9.83k
      if(result)
1677
6
        infof(data, "WARNING: failed to save cookies in %s: %s",
1678
9.83k
              cookiejar, curl_easy_strerror(result));
1679
9.83k
    }
1680
1681
10.0k
    if(cleanup && (!data->share || (data->cookies != data->share->cookies))) {
1682
10.0k
      Curl_cookie_cleanup(data->cookies);
1683
10.0k
      data->cookies = NULL;
1684
10.0k
    }
1685
10.0k
  }
1686
20.0k
  Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
1687
20.0k
}
1688
1689
void Curl_cookie_run(struct Curl_easy *data)
1690
9.86k
{
1691
9.86k
  Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
1692
9.86k
  if(data->cookies)
1693
9.85k
    data->cookies->running = TRUE;
1694
9.86k
  Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
1695
9.86k
}
1696
1697
#endif /* CURL_DISABLE_HTTP || CURL_DISABLE_COOKIES */