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
2.34k
{
65
2.34k
  curlx_free(co->domain);
66
2.34k
  curlx_free(co->path);
67
2.34k
  curlx_free(co->name);
68
2.34k
  curlx_free(co->value);
69
2.34k
  if(maintoo)
70
0
    curlx_free(co);
71
2.34k
}
72
73
static bool cookie_tailmatch(const char *cookie_domain,
74
                             const size_t cookie_domain_len,
75
                             const char *hostname)
76
0
{
77
0
  size_t hostname_len = strlen(hostname);
78
79
0
  if(hostname_len < cookie_domain_len)
80
0
    return FALSE;
81
82
0
  if(!curl_strnequal(cookie_domain,
83
0
                     hostname + hostname_len - cookie_domain_len,
84
0
                     cookie_domain_len))
85
0
    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
0
  if(hostname_len == cookie_domain_len)
96
0
    return TRUE;
97
0
  if('.' == *(hostname + hostname_len - cookie_domain_len - 1))
98
0
    return TRUE;
99
0
  return FALSE;
100
0
}
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
0
{
163
0
  size_t len = 0;
164
0
  const char *first = NULL, *last;
165
166
0
  if(domain) {
167
0
    len = strlen(domain);
168
0
    last = memrchr(domain, '.', len);
169
0
    if(last) {
170
0
      first = memrchr(domain, '.', (last - domain));
171
0
      if(first)
172
0
        len -= (++first - domain);
173
0
    }
174
0
  }
175
176
0
  if(outlen)
177
0
    *outlen = len;
178
179
0
  return first ? first : domain;
180
0
}
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
0
{
192
0
  const char *end = domain + len;
193
0
  size_t h = 5381;
194
195
0
  while(domain < end) {
196
0
    size_t j = (size_t)Curl_raw_toupper(*domain++);
197
0
    h += h << 5;
198
0
    h ^= j;
199
0
  }
200
201
0
  return (h % COOKIE_HASH_SIZE);
202
0
}
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
0
{
213
0
  const char *top;
214
0
  size_t len;
215
216
0
  if(!domain || Curl_host_is_ipnum(domain))
217
0
    return 0;
218
219
0
  top = get_top_domain(domain, &len);
220
0
  return cookie_hash_domain(top, len);
221
0
}
222
223
/*
224
 * cookie path sanitize
225
 */
226
static char *sanitize_cookie_path(const char *cookie_path, size_t len)
227
0
{
228
  /* some sites send path attribute within '"'. */
229
0
  if(len && (cookie_path[0] == '\"')) {
230
0
    cookie_path++;
231
0
    len--;
232
233
0
    if(len && (cookie_path[len - 1] == '\"'))
234
0
      len--;
235
0
  }
236
237
  /* RFC6265 5.2.4 The Path Attribute */
238
0
  if(!len || (cookie_path[0] != '/'))
239
    /* Let cookie-path be the default-path. */
240
0
    return curlx_strdup("/");
241
242
  /* remove trailing slash when path is non-empty */
243
  /* convert /hoge/ to /hoge */
244
0
  if(len > 1 && cookie_path[len - 1] == '/')
245
0
    len--;
246
247
0
  return curlx_memdup0(cookie_path, len);
248
0
}
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
4.69k
{
275
4.69k
  struct Cookie *co;
276
4.69k
  curl_off_t now = (curl_off_t)time(NULL);
277
4.69k
  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
4.69k
  if(now < ci->next_expiration &&
288
4.69k
     ci->next_expiration != CURL_OFF_T_MAX)
289
0
    return;
290
4.69k
  else
291
4.69k
    ci->next_expiration = CURL_OFF_T_MAX;
292
293
300k
  for(i = 0; i < COOKIE_HASH_SIZE; i++) {
294
295k
    struct Curl_llist_node *n;
295
295k
    struct Curl_llist_node *e = NULL;
296
297
295k
    for(n = Curl_llist_head(&ci->cookielist[i]); n; n = e) {
298
0
      co = Curl_node_elem(n);
299
0
      e = Curl_node_next(n);
300
0
      if(co->expires) {
301
0
        if(co->expires < now) {
302
0
          Curl_node_remove(n);
303
0
          freecookie(co, TRUE);
304
0
          ci->numcookies--;
305
0
        }
306
0
        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
0
          ci->next_expiration = co->expires;
312
0
      }
313
0
    }
314
295k
  }
315
4.69k
}
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
0
{
347
0
  const unsigned char *p = (const unsigned char *)ptr;
348
  /* Reject all bytes \x01 - \x1f + \x7f */
349
0
  while(len && *p) {
350
0
    if((*p < 0x20) || (*p == 0x7f))
351
0
      return TRUE;
352
0
    p++;
353
0
    len--;
354
0
  }
355
0
  return FALSE;
356
0
}
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
2.34k
{
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
2.34k
  const char *ptr, *next;
667
2.34k
  int fields;
668
2.34k
  size_t len;
669
2.34k
  *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
2.34k
  if(!strncmp(lineptr, "#HttpOnly_", 10)) {
678
0
    lineptr += 10;
679
0
    co->httponly = TRUE;
680
0
  }
681
682
2.34k
  if(lineptr[0] == '#')
683
    /* do not even try the comments */
684
0
    return CURLE_OK;
685
686
  /*
687
   * Now loop through the fields and init the struct we already have
688
   * allocated
689
   */
690
2.34k
  fields = 0;
691
4.68k
  for(next = lineptr; next; fields++) {
692
2.34k
    ptr = next;
693
2.34k
    len = strcspn(ptr, "\t\r\n");
694
2.34k
    next = (ptr[len] == '\t' ? &ptr[len + 1] : NULL);
695
2.34k
    switch(fields) {
696
2.34k
    case 0:
697
2.34k
      if(ptr[0] == '.') { /* skip preceding dots */
698
0
        ptr++;
699
0
        len--;
700
0
      }
701
2.34k
      co->domain = curlx_memdup0(ptr, len);
702
2.34k
      if(!co->domain)
703
4
        return CURLE_OUT_OF_MEMORY;
704
2.34k
      break;
705
2.34k
    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
0
      co->tailmatch = !!curl_strnequal(ptr, "TRUE", len);
712
0
      break;
713
0
    case 2:
714
      /* The file format allows the path field to remain not filled in */
715
0
      if(strncmp("TRUE", ptr, len) && strncmp("FALSE", ptr, len)) {
716
        /* only if the path does not look like a boolean option! */
717
0
        co->path = sanitize_cookie_path(ptr, len);
718
0
        if(!co->path)
719
0
          return CURLE_OUT_OF_MEMORY;
720
0
        break;
721
0
      }
722
0
      else {
723
        /* this does not look like a path, make one up! */
724
0
        co->path = curlx_strdup("/");
725
0
        if(!co->path)
726
0
          return CURLE_OUT_OF_MEMORY;
727
0
      }
728
0
      fields++; /* add a field and fall down to secure */
729
0
      FALLTHROUGH();
730
0
    case 3:
731
0
      co->secure = FALSE;
732
0
      if(curl_strnequal(ptr, "TRUE", len)) {
733
0
        if(secure_origin || ci->running)
734
0
          co->secure = TRUE;
735
0
        else
736
0
          return CURLE_OK;
737
0
      }
738
0
      break;
739
0
    case 4:
740
0
      if(curlx_str_number(&ptr, &co->expires, CURL_OFF_T_MAX))
741
0
        return CURLE_OK;
742
0
      break;
743
0
    case 5:
744
0
      co->name = curlx_memdup0(ptr, len);
745
0
      if(!co->name)
746
0
        return CURLE_OUT_OF_MEMORY;
747
0
      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
0
        if(!strncmp("__Secure-", co->name, 9))
752
0
          co->prefix_secure = TRUE;
753
0
        else if(!strncmp("__Host-", co->name, 7))
754
0
          co->prefix_host = TRUE;
755
0
      }
756
0
      break;
757
0
    case 6:
758
0
      co->value = curlx_memdup0(ptr, len);
759
0
      if(!co->value)
760
0
        return CURLE_OUT_OF_MEMORY;
761
0
      break;
762
2.34k
    }
763
2.34k
  }
764
2.34k
  if(fields == 6) {
765
    /* we got a cookie with blank contents, fix it */
766
0
    co->value = curlx_strdup("");
767
0
    if(!co->value)
768
0
      return CURLE_OUT_OF_MEMORY;
769
0
    else
770
0
      fields++;
771
0
  }
772
773
2.34k
  if(fields != 7)
774
    /* we did not find the sufficient number of fields */
775
2.34k
    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
0
  if(invalid_octets(co->name, strlen(co->name)) ||
782
0
     invalid_octets(co->value, strlen(co->value)))
783
0
    return CURLE_OK;
784
785
0
  *okay = TRUE;
786
0
  return CURLE_OK;
787
0
}
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
0
{
875
0
  bool replace_old = FALSE;
876
0
  struct Curl_llist_node *replace_n = NULL;
877
0
  struct Curl_llist_node *n;
878
0
  size_t myhash = cookiehash(co->domain);
879
0
  for(n = Curl_llist_head(&ci->cookielist[myhash]); n; n = Curl_node_next(n)) {
880
0
    struct Cookie *clist = Curl_node_elem(n);
881
0
    if(!strcmp(clist->name, co->name)) {
882
      /* the names are identical */
883
0
      bool matching_domains = FALSE;
884
885
0
      if(clist->domain && co->domain) {
886
0
        if(cookie_tailmatch(clist->domain, strlen(clist->domain),
887
0
                            co->domain) ||
888
0
           cookie_tailmatch(co->domain, strlen(co->domain), clist->domain))
889
          /* The existing one is a tail of the new or vice versa */
890
0
          matching_domains = TRUE;
891
0
      }
892
0
      else if(!clist->domain && !co->domain)
893
0
        matching_domains = TRUE;
894
895
0
      if(matching_domains && /* the domains were identical */
896
0
         clist->path && co->path && /* both have paths */
897
0
         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
0
    }
923
924
0
    if(!replace_n && !strcmp(clist->name, co->name)) {
925
      /* the names are identical */
926
927
0
      if(clist->domain && co->domain) {
928
0
        if(curl_strequal(clist->domain, co->domain) &&
929
0
           (clist->tailmatch == co->tailmatch))
930
          /* The domains are identical */
931
0
          replace_old = TRUE;
932
0
      }
933
0
      else if(!clist->domain && !co->domain)
934
0
        replace_old = TRUE;
935
936
0
      if(replace_old) {
937
        /* the domains were identical */
938
939
0
        if(clist->path && co->path &&
940
0
           strcmp(clist->path, co->path))
941
0
          replace_old = FALSE;
942
0
        else if(!clist->path != !co->path)
943
0
          replace_old = FALSE;
944
0
      }
945
946
0
      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
0
      if(replace_old)
956
0
        replace_n = n;
957
0
    }
958
0
  }
959
0
  if(replace_n) {
960
0
    struct Cookie *repl = Curl_node_elem(replace_n);
961
962
    /* when replacing, creationtime is kept from old */
963
0
    co->creationtime = repl->creationtime;
964
965
    /* unlink the old */
966
0
    Curl_node_remove(replace_n);
967
968
    /* free the old cookie */
969
0
    freecookie(repl, TRUE);
970
0
  }
971
0
  *replacep = replace_old;
972
0
  return TRUE;
973
0
}
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
2.34k
{
993
2.34k
  struct Cookie comem;
994
2.34k
  struct Cookie *co;
995
2.34k
  size_t myhash;
996
2.34k
  CURLcode result;
997
2.34k
  bool replaces = FALSE;
998
2.34k
  bool okay;
999
1000
2.34k
  DEBUGASSERT(data);
1001
2.34k
  DEBUGASSERT(MAX_SET_COOKIE_AMOUNT <= 255); /* counter is an unsigned char */
1002
2.34k
  if(data->req.setcookies >= MAX_SET_COOKIE_AMOUNT)
1003
0
    return CURLE_OK; /* silently ignore */
1004
1005
2.34k
  co = &comem;
1006
2.34k
  memset(co, 0, sizeof(comem));
1007
1008
2.34k
  if(flags & COOKIE_HTTPHEADER)
1009
0
    result = parse_cookie_header(data, co, &okay,
1010
0
                                 lineptr, domain, path, flags & COOKIE_SECURE);
1011
2.34k
  else
1012
2.34k
    result = parse_netscape(co, ci, &okay, lineptr, flags & COOKIE_SECURE);
1013
1014
2.34k
  if(result || !okay)
1015
2.34k
    goto fail;
1016
1017
0
  if(co->prefix_secure && !co->secure)
1018
    /* The __Secure- prefix only requires that the cookie be set secure */
1019
0
    goto fail;
1020
1021
0
  if(!(flags & COOKIE_NOPSL) && is_public_suffix(data, co, domain))
1022
0
    goto fail;
1023
1024
0
  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
0
    if(co->secure && co->path && !strcmp(co->path, "/") && !co->tailmatch)
1030
0
      ;
1031
0
    else
1032
0
      goto fail;
1033
0
  }
1034
1035
0
  if(!ci->running &&    /* read from a file */
1036
0
     ci->newsession &&  /* clean session cookies */
1037
0
     !co->expires)      /* this is a session cookie */
1038
0
    goto fail;
1039
1040
0
  co->livecookie = ci->running;
1041
0
  co->creationtime = ++ci->lastct;
1042
1043
0
  if(!(flags & COOKIE_NOEXPIRE))
1044
0
    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
0
  if(!replace_existing(data, co, ci, flags & COOKIE_SECURE, &replaces))
1052
0
    goto fail;
1053
1054
  /* clone the stack struct into heap */
1055
0
  co = curlx_memdup(&comem, sizeof(comem));
1056
0
  if(!co) {
1057
0
    co = &comem;
1058
0
    result = CURLE_OUT_OF_MEMORY;
1059
0
    goto fail; /* bail out if we are this low on memory */
1060
0
  }
1061
1062
  /* add this cookie to the list */
1063
0
  myhash = cookiehash(co->domain);
1064
0
  Curl_llist_append(&ci->cookielist[myhash], co, &co->node);
1065
1066
0
  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
0
          "expire %" FMT_OFF_T,
1070
0
          replaces ? "Replaced" : "Added", co->name, co->value,
1071
0
          co->domain, co->path, co->expires);
1072
1073
0
  if(!replaces)
1074
0
    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
0
  if(co->expires && (co->expires < ci->next_expiration))
1081
0
    ci->next_expiration = co->expires;
1082
1083
0
  if(flags & COOKIE_HTTPHEADER)
1084
0
    data->req.setcookies++;
1085
1086
0
  return result;
1087
2.34k
fail:
1088
2.34k
  freecookie(co, FALSE);
1089
2.34k
  return result;
1090
0
}
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
2.46k
{
1108
2.46k
  int i;
1109
2.46k
  struct CookieInfo *ci = curlx_calloc(1, sizeof(struct CookieInfo));
1110
2.46k
  if(!ci)
1111
16
    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
156k
  for(i = 0; i < COOKIE_HASH_SIZE; i++)
1116
154k
    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
2.44k
  ci->next_expiration = CURL_OFF_T_MAX;
1122
1123
2.44k
  return ci;
1124
2.46k
}
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
2.35k
{
1138
2.35k
  FILE *handle = NULL;
1139
2.35k
  CURLcode result = CURLE_OK;
1140
2.35k
  FILE *fp = NULL;
1141
2.35k
  DEBUGASSERT(ci);
1142
2.35k
  DEBUGASSERT(data);
1143
2.35k
  DEBUGASSERT(file);
1144
1145
2.35k
  ci->newsession = !!(flags & COOKIE_NOSESSION); /* new session? */
1146
2.35k
  ci->running = FALSE; /* this is not running, this is init */
1147
1148
2.35k
  if(file && *file) {
1149
2.35k
    if(!strcmp(file, "-"))
1150
0
      fp = stdin;
1151
2.35k
    else {
1152
2.35k
      fp = curlx_fopen(file, "rb");
1153
2.35k
      if(!fp)
1154
0
        infof(data, "WARNING: failed to open cookie file \"%s\"", file);
1155
2.35k
      else {
1156
2.35k
        curlx_struct_stat stat;
1157
2.35k
        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
2.35k
        else
1164
2.35k
          handle = fp;
1165
2.35k
      }
1166
2.35k
    }
1167
2.35k
  }
1168
1169
2.35k
  if(fp) {
1170
2.35k
    struct dynbuf buf;
1171
2.35k
    bool eof = FALSE;
1172
    /* accept a little longer lines so that a full cookie fits and does not
1173
       abort the file read */
1174
2.35k
    curlx_dyn_init(&buf, MAX_COOKIE_LINE + 48);
1175
2.35k
    do {
1176
2.35k
      result = Curl_get_line(&buf, fp, &eof);
1177
2.35k
      if(!result) {
1178
2.34k
        const char *lineptr = curlx_dyn_ptr(&buf);
1179
2.34k
        bool headerline = FALSE;
1180
2.34k
        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
2.34k
        result = Curl_cookie_add(data, ci, lineptr, NULL, NULL,
1188
2.34k
                                 (headerline ? COOKIE_HTTPHEADER : 0) |
1189
2.34k
                                 COOKIE_NOEXPIRE | COOKIE_SECURE |
1190
2.34k
                                 (flags & COOKIE_NOPSL));
1191
        /* Ignore individual cookie problems unless we ran out of memory */
1192
2.34k
        if(result != CURLE_OUT_OF_MEMORY)
1193
2.34k
          result = CURLE_OK;
1194
2.34k
      }
1195
2.35k
    } while(!result && !eof);
1196
2.35k
    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
2.35k
    remove_expired(ci);
1203
1204
2.35k
    if(handle)
1205
2.35k
      curlx_fclose(handle);
1206
2.35k
  }
1207
2.35k
  data->state.cookie_engine = TRUE;
1208
2.35k
  ci->running = TRUE; /* now, we are running */
1209
1210
2.35k
  return result;
1211
2.35k
}
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
2.38k
{
1219
2.38k
  CURLcode result = CURLE_OK;
1220
2.38k
  struct curl_slist *list = data->state.cookielist;
1221
2.38k
  if(list) {
1222
2.35k
    Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
1223
2.35k
    if(!data->cookies)
1224
26
      data->cookies = Curl_cookie_init();
1225
2.35k
    if(!data->cookies)
1226
4
      result = CURLE_OUT_OF_MEMORY;
1227
2.35k
    else {
1228
2.35k
      data->state.cookie_engine = TRUE;
1229
4.69k
      while(list) {
1230
2.35k
        result = cookie_load(data, list->data, data->cookies, flags);
1231
2.35k
        if(result)
1232
8
          break;
1233
2.34k
        list = list->next;
1234
2.34k
      }
1235
2.35k
    }
1236
2.35k
    Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
1237
2.35k
  }
1238
2.38k
  return result;
1239
2.38k
}
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
0
{
1287
0
  const struct Cookie *c1 = *(const struct Cookie * const *)p1;
1288
0
  const struct Cookie *c2 = *(const struct Cookie * const *)p2;
1289
1290
0
  return (c2->creationtime > c1->creationtime) ? 1 : -1;
1291
0
}
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
2.44k
{
1420
2.44k
  if(ci) {
1421
2.44k
    unsigned int i;
1422
156k
    for(i = 0; i < COOKIE_HASH_SIZE; i++) {
1423
154k
      struct Curl_llist_node *n;
1424
154k
      for(n = Curl_llist_head(&ci->cookielist[i]); n;) {
1425
0
        struct Cookie *c = Curl_node_elem(n);
1426
0
        struct Curl_llist_node *e = Curl_node_next(n);
1427
0
        Curl_node_remove(n);
1428
0
        freecookie(c, TRUE);
1429
0
        n = e;
1430
0
      }
1431
154k
    }
1432
2.44k
    ci->numcookies = 0;
1433
2.44k
  }
1434
2.44k
}
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
2.44k
{
1471
2.44k
  if(ci) {
1472
2.44k
    Curl_cookie_clearall(ci);
1473
2.44k
    curlx_free(ci); /* free the base struct as well */
1474
2.44k
  }
1475
2.44k
}
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
0
{
1486
0
  return curl_maprintf(
1487
0
    "%s"               /* httponly preamble */
1488
0
    "%s%s\t"           /* domain */
1489
0
    "%s\t"             /* tailmatch */
1490
0
    "%s\t"             /* path */
1491
0
    "%s\t"             /* secure */
1492
0
    "%" FMT_OFF_T "\t" /* expires */
1493
0
    "%s\t"             /* name */
1494
0
    "%s",              /* value */
1495
0
    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
0
    (co->tailmatch && co->domain && co->domain[0] != '.') ? "." : "",
1501
0
    co->domain ? co->domain : "unknown",
1502
0
    co->tailmatch ? "TRUE" : "FALSE",
1503
0
    co->path ? co->path : "/",
1504
0
    co->secure ? "TRUE" : "FALSE",
1505
0
    co->expires,
1506
0
    co->name,
1507
0
    co->value ? co->value : "");
1508
0
}
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
2.34k
{
1522
2.34k
  FILE *out = NULL;
1523
2.34k
  bool use_stdout = FALSE;
1524
2.34k
  char *tempstore = NULL;
1525
2.34k
  CURLcode result = CURLE_OK;
1526
1527
2.34k
  if(!ci)
1528
    /* no cookie engine alive */
1529
0
    return CURLE_OK;
1530
1531
  /* at first, remove expired cookies */
1532
2.34k
  remove_expired(ci);
1533
1534
2.34k
  if(!strcmp("-", filename)) {
1535
    /* use stdout */
1536
0
    out = stdout;
1537
0
    use_stdout = TRUE;
1538
0
  }
1539
2.34k
  else {
1540
2.34k
    result = Curl_fopen(data, filename, &out, &tempstore);
1541
2.34k
    if(result)
1542
0
      goto error;
1543
2.34k
  }
1544
1545
2.34k
  fputs("# Netscape HTTP Cookie File\n"
1546
2.34k
        "# https://curl.se/docs/http-cookies.html\n"
1547
2.34k
        "# This file was generated by libcurl! Edit at your own risk.\n\n",
1548
2.34k
        out);
1549
1550
2.34k
  if(ci->numcookies) {
1551
0
    unsigned int i;
1552
0
    size_t nvalid = 0;
1553
0
    struct Cookie **array;
1554
0
    struct Curl_llist_node *n;
1555
1556
0
    array = curlx_calloc(1, sizeof(struct Cookie *) * ci->numcookies);
1557
0
    if(!array) {
1558
0
      result = CURLE_OUT_OF_MEMORY;
1559
0
      goto error;
1560
0
    }
1561
1562
    /* only sort the cookies with a domain property */
1563
0
    for(i = 0; i < COOKIE_HASH_SIZE; i++) {
1564
0
      for(n = Curl_llist_head(&ci->cookielist[i]); n; n = Curl_node_next(n)) {
1565
0
        struct Cookie *co = Curl_node_elem(n);
1566
0
        if(!co->domain)
1567
0
          continue;
1568
0
        array[nvalid++] = co;
1569
0
      }
1570
0
    }
1571
1572
0
    qsort(array, nvalid, sizeof(struct Cookie *), cookie_sort_ct);
1573
1574
0
    for(i = 0; i < nvalid; i++) {
1575
0
      char *format_ptr = get_netscape_format(array[i]);
1576
0
      if(!format_ptr) {
1577
0
        curlx_free(array);
1578
0
        result = CURLE_OUT_OF_MEMORY;
1579
0
        goto error;
1580
0
      }
1581
0
      curl_mfprintf(out, "%s\n", format_ptr);
1582
0
      curlx_free(format_ptr);
1583
0
    }
1584
1585
0
    curlx_free(array);
1586
0
  }
1587
1588
2.34k
  if(!use_stdout) {
1589
2.34k
    curlx_fclose(out);
1590
2.34k
    out = NULL;
1591
2.34k
    if(tempstore && curlx_rename(tempstore, filename)) {
1592
0
      result = CURLE_WRITE_ERROR;
1593
0
      goto error;
1594
0
    }
1595
2.34k
  }
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
2.34k
  curlx_free(tempstore);
1603
2.34k
  return CURLE_OK;
1604
1605
0
error:
1606
0
  if(out && !use_stdout)
1607
0
    curlx_fclose(out);
1608
0
  if(tempstore) {
1609
0
    unlink(tempstore);
1610
0
    curlx_free(tempstore);
1611
0
  }
1612
0
  return result;
1613
2.34k
}
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
4.92k
{
1666
4.92k
  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
4.92k
  if(data->cookies) {
1672
2.44k
    const char *cookiejar = CURL_EASY_STR(data, STRING_COOKIEJAR);
1673
2.44k
    if(cookiejar && data->cookies->running) {
1674
      /* if we have a destination file for all the cookies to get dumped to */
1675
2.34k
      CURLcode result = cookie_output(data, data->cookies, cookiejar);
1676
2.34k
      if(result)
1677
0
        infof(data, "WARNING: failed to save cookies in %s: %s",
1678
2.34k
              cookiejar, curl_easy_strerror(result));
1679
2.34k
    }
1680
1681
2.44k
    if(cleanup && (!data->share || (data->cookies != data->share->cookies))) {
1682
2.44k
      Curl_cookie_cleanup(data->cookies);
1683
2.44k
      data->cookies = NULL;
1684
2.44k
    }
1685
2.44k
  }
1686
4.92k
  Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
1687
4.92k
}
1688
1689
void Curl_cookie_run(struct Curl_easy *data)
1690
2.36k
{
1691
2.36k
  Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
1692
2.36k
  if(data->cookies)
1693
2.35k
    data->cookies->running = TRUE;
1694
2.36k
  Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
1695
2.36k
}
1696
1697
#endif /* CURL_DISABLE_HTTP || CURL_DISABLE_COOKIES */