aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/curl/lib/cookie.c
blob: 7b5b57126c6bee2c1d8281149e4223158a353fb4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
/*************************************************************************** 
 *                                  _   _ ____  _ 
 *  Project                     ___| | | |  _ \| | 
 *                             / __| | | | |_) | | 
 *                            | (__| |_| |  _ <| |___ 
 *                             \___|\___/|_| \_\_____| 
 * 
 * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
 * 
 * This software is licensed as described in the file COPYING, which 
 * you should have received as part of this distribution. The terms 
 * are also available at https://curl.se/docs/copyright.html.
 * 
 * You may opt to use, copy, modify, merge, publish, distribute and/or sell 
 * copies of the Software, and permit persons to whom the Software is 
 * furnished to do so, under the terms of the COPYING file. 
 * 
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 
 * KIND, either express or implied. 
 * 
 ***************************************************************************/ 
 
/*** 
 
 
RECEIVING COOKIE INFORMATION 
============================ 
 
struct CookieInfo *Curl_cookie_init(struct Curl_easy *data,
                    const char *file, struct CookieInfo *inc, bool newsession);
 
        Inits a cookie struct to store data in a local file. This is always 
        called before any cookies are set. 
 
struct Cookie *Curl_cookie_add(struct Curl_easy *data,
                 struct CookieInfo *c, bool httpheader, char *lineptr,
                 const char *domain, const char *path);
 
        The 'lineptr' parameter is a full "Set-cookie:" line as
        received from a server. 
 
        The function need to replace previously stored lines that this new 
        line supersedes.
 
        It may remove lines that are expired. 
 
        It should return an indication of success/error. 
 
 
SENDING COOKIE INFORMATION 
========================== 
 
struct Cookies *Curl_cookie_getlist(struct CookieInfo *cookie,
                                    char *host, char *path, bool secure);
 
        For a given host and path, return a linked list of cookies that 
        the client should send to the server if used now. The secure 
        boolean informs the cookie if a secure connection is achieved or 
        not. 
 
        It shall only return cookies that haven't expired. 
 
 
Example set of cookies: 
 
    Set-cookie: PRODUCTINFO=webxpress; domain=.fidelity.com; path=/; secure 
    Set-cookie: PERSONALIZE=none;expires=Monday, 13-Jun-1988 03:04:55 GMT; 
    domain=.fidelity.com; path=/ftgw; secure 
    Set-cookie: FidHist=none;expires=Monday, 13-Jun-1988 03:04:55 GMT; 
    domain=.fidelity.com; path=/; secure 
    Set-cookie: FidOrder=none;expires=Monday, 13-Jun-1988 03:04:55 GMT; 
    domain=.fidelity.com; path=/; secure 
    Set-cookie: DisPend=none;expires=Monday, 13-Jun-1988 03:04:55 GMT; 
    domain=.fidelity.com; path=/; secure 
    Set-cookie: FidDis=none;expires=Monday, 13-Jun-1988 03:04:55 GMT; 
    domain=.fidelity.com; path=/; secure 
    Set-cookie: 
    Session_Key@6791a9e0-901a-11d0-a1c8-9b012c88aa77=none;expires=Monday, 
    13-Jun-1988 03:04:55 GMT; domain=.fidelity.com; path=/; secure 
****/ 
 
 
#include "curl_setup.h" 
 
#if !defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_COOKIES) 
 
#include "urldata.h" 
#include "cookie.h" 
#include "psl.h"
#include "strtok.h" 
#include "sendf.h" 
#include "slist.h" 
#include "share.h" 
#include "strtoofft.h" 
#include "strcase.h"
#include "curl_get_line.h"
#include "curl_memrchr.h" 
#include "inet_pton.h"
#include "parsedate.h"
#include "rand.h"
#include "rename.h"
 
/* The last 3 #include files should be in this order */
#include "curl_printf.h"
#include "curl_memory.h"
#include "memdebug.h" 
 
static void freecookie(struct Cookie *co) 
{ 
  free(co->expirestr);
  free(co->domain);
  free(co->path);
  free(co->spath);
  free(co->name);
  free(co->value);
  free(co->maxage);
  free(co->version);
  free(co); 
} 
 
static bool tailmatch(const char *cooke_domain, const char *hostname) 
{ 
  size_t cookie_domain_len = strlen(cooke_domain); 
  size_t hostname_len = strlen(hostname); 
 
  if(hostname_len < cookie_domain_len) 
    return FALSE; 
 
  if(!strcasecompare(cooke_domain, hostname + hostname_len-cookie_domain_len))
    return FALSE; 
 
  /* A lead char of cookie_domain is not '.'. 
     RFC6265 4.1.2.3. The Domain Attribute says: 
       For example, if the value of the Domain attribute is 
       "example.com", the user agent will include the cookie in the Cookie 
       header when making HTTP requests to example.com, www.example.com, and 
       www.corp.example.com. 
   */ 
  if(hostname_len == cookie_domain_len) 
    return TRUE; 
  if('.' == *(hostname + hostname_len - cookie_domain_len - 1)) 
    return TRUE; 
  return FALSE; 
} 
 
/* 
 * Return true if the given string is an IP(v4|v6) address.
 */
static bool isip(const char *domain)
{
  struct in_addr addr;
#ifdef ENABLE_IPV6
  struct in6_addr addr6;
#endif

  if(Curl_inet_pton(AF_INET, domain, &addr)
#ifdef ENABLE_IPV6
     || Curl_inet_pton(AF_INET6, domain, &addr6)
#endif
    ) {
    /* domain name given as IP address */
    return TRUE;
  }

  return FALSE;
}

/*
 * matching cookie path and url path 
 * RFC6265 5.1.4 Paths and Path-Match 
 */ 
static bool pathmatch(const char *cookie_path, const char *request_uri)
{ 
  size_t cookie_path_len; 
  size_t uri_path_len; 
  char *uri_path = NULL;
  char *pos;
  bool ret = FALSE; 
 
  /* cookie_path must not have last '/' separator. ex: /sample */ 
  cookie_path_len = strlen(cookie_path); 
  if(1 == cookie_path_len) { 
    /* cookie_path must be '/' */ 
    return TRUE; 
  } 
 
  uri_path = strdup(request_uri); 
  if(!uri_path) 
    return FALSE; 
  pos = strchr(uri_path, '?'); 
  if(pos) 
    *pos = 0x0; 
 
  /* #-fragments are already cut off! */ 
  if(0 == strlen(uri_path) || uri_path[0] != '/') { 
    free(uri_path); 
    uri_path = strdup("/"); 
    if(!uri_path) 
      return FALSE; 
  } 
 
  /* here, RFC6265 5.1.4 says 
     4. Output the characters of the uri-path from the first character up 
        to, but not including, the right-most %x2F ("/"). 
     but URL path /hoge?fuga=xxx means /hoge/index.cgi?fuga=xxx in some site 
     without redirect. 
     Ignore this algorithm because /hoge is uri path for this case 
     (uri path is not /). 
   */ 
 
  uri_path_len = strlen(uri_path); 
 
  if(uri_path_len < cookie_path_len) { 
    ret = FALSE; 
    goto pathmatched; 
  } 
 
  /* not using checkprefix() because matching should be case-sensitive */ 
  if(strncmp(cookie_path, uri_path, cookie_path_len)) { 
    ret = FALSE; 
    goto pathmatched; 
  } 
 
  /* The cookie-path and the uri-path are identical. */ 
  if(cookie_path_len == uri_path_len) { 
    ret = TRUE; 
    goto pathmatched; 
  } 
 
  /* here, cookie_path_len < uri_path_len */
  if(uri_path[cookie_path_len] == '/') { 
    ret = TRUE; 
    goto pathmatched; 
  } 
 
  ret = FALSE; 
 
pathmatched: 
  free(uri_path); 
  return ret; 
} 
 
/* 
 * Return the top-level domain, for optimal hashing.
 */
static const char *get_top_domain(const char * const domain, size_t *outlen)
{
  size_t len = 0;
  const char *first = NULL, *last;

  if(domain) {
    len = strlen(domain);
    last = memrchr(domain, '.', len);
    if(last) {
      first = memrchr(domain, '.', (last - domain));
      if(first)
        len -= (++first - domain);
    }
  }

  if(outlen)
    *outlen = len;

  return first? first: domain;
}

/*
 * A case-insensitive hash for the cookie domains.
 */
static size_t cookie_hash_domain(const char *domain, const size_t len)
{
  const char *end = domain + len;
  size_t h = 5381;

  while(domain < end) {
    h += h << 5;
    h ^= Curl_raw_toupper(*domain++);
  }

  return (h % COOKIE_HASH_SIZE);
}

/*
 * Hash this domain.
 */
static size_t cookiehash(const char * const domain)
{
  const char *top;
  size_t len;

  if(!domain || isip(domain))
    return 0;

  top = get_top_domain(domain, &len);
  return cookie_hash_domain(top, len);
}

/*
 * cookie path sanitize 
 */ 
static char *sanitize_cookie_path(const char *cookie_path) 
{ 
  size_t len; 
  char *new_path = strdup(cookie_path); 
  if(!new_path) 
    return NULL; 
 
  /* some stupid site sends path attribute with '"'. */ 
  len = strlen(new_path);
  if(new_path[0] == '\"') { 
    memmove((void *)new_path, (const void *)(new_path + 1), len);
    len--;
  } 
  if(len && (new_path[len - 1] == '\"')) {
    new_path[len - 1] = 0x0;
    len--;
  } 
 
  /* RFC6265 5.2.4 The Path Attribute */ 
  if(new_path[0] != '/') { 
    /* Let cookie-path be the default-path. */ 
    free(new_path); 
    new_path = strdup("/"); 
    return new_path; 
  } 
 
  /* convert /hoge/ to /hoge */ 
  if(len && new_path[len - 1] == '/') {
    new_path[len - 1] = 0x0; 
  } 
 
  return new_path; 
} 
 
/* 
 * Load cookies from all given cookie files (CURLOPT_COOKIEFILE). 
 *
 * NOTE: OOM or cookie parsing failures are ignored.
 */ 
void Curl_cookie_loadfiles(struct Curl_easy *data)
{ 
  struct curl_slist *list = data->change.cookielist; 
  if(list) { 
    Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE); 
    while(list) { 
      struct CookieInfo *newcookies = Curl_cookie_init(data,
                                        list->data,
                                        data->cookies,
                                        data->set.cookiesession);
      if(!newcookies)
        /* Failure may be due to OOM or a bad cookie; both are ignored
         * but only the first should be
         */
        infof(data, "ignoring failed cookie_init for %s\n", list->data);
      else
        data->cookies = newcookies;
      list = list->next; 
    } 
    curl_slist_free_all(data->change.cookielist); /* clean up list */ 
    data->change.cookielist = NULL; /* don't do this again! */ 
    Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE); 
  } 
} 
 
/* 
 * strstore() makes a strdup() on the 'newstr' and if '*str' is non-NULL 
 * that will be freed before the allocated string is stored there. 
 * 
 * It is meant to easily replace strdup() 
 */ 
static void strstore(char **str, const char *newstr) 
{ 
  free(*str);
  *str = strdup(newstr); 
} 
 
/* 
 * remove_expired() removes expired cookies. 
 */ 
static void remove_expired(struct CookieInfo *cookies) 
{ 
  struct Cookie *co, *nx;
  curl_off_t now = (curl_off_t)time(NULL); 
  unsigned int i;
 
  for(i = 0; i < COOKIE_HASH_SIZE; i++) {
    struct Cookie *pv = NULL;
    co = cookies->cookies[i];
    while(co) {
      nx = co->next;
      if(co->expires && co->expires < now) {
        if(!pv) {
          cookies->cookies[i] = co->next;
        }
        else {
          pv->next = co->next;
        }
        cookies->numcookies--;
        freecookie(co);
      } 
      else { 
        pv = co;
      } 
      co = nx;
    } 
  } 
} 
 
/* Make sure domain contains a dot or is localhost. */
static bool bad_domain(const char *domain)
{
  return !strchr(domain, '.') && !strcasecompare(domain, "localhost");
}

/**************************************************************************** 
 * 
 * Curl_cookie_add() 
 * 
 * Add a single cookie line to the cookie keeping object. 
 * 
 * Be aware that sometimes we get an IP-only host name, and that might also be 
 * a numerical IPv6 address. 
 * 
 * Returns NULL on out of memory or invalid cookie. This is suboptimal,
 * as they should be treated separately.
 ***************************************************************************/ 
 
struct Cookie * 
Curl_cookie_add(struct Curl_easy *data,
                /* The 'data' pointer here may be NULL at times, and thus 
                   must only be used very carefully for things that can deal 
                   with data being NULL. Such as infof() and similar */ 
 
                struct CookieInfo *c, 
                bool httpheader, /* TRUE if HTTP header-style line */ 
                bool noexpire, /* if TRUE, skip remove_expired() */
                char *lineptr,   /* first character of the line */ 
                const char *domain, /* default domain */ 
                const char *path,   /* full path used when this cookie is set,
                                       used to get default path for the cookie 
                                       unless set */ 
                bool secure)  /* TRUE if connection is over secure origin */
{ 
  struct Cookie *clist; 
  struct Cookie *co; 
  struct Cookie *lastc = NULL;
  time_t now = time(NULL); 
  bool replace_old = FALSE; 
  bool badcookie = FALSE; /* cookies are good by default. mmmmm yummy */ 
  size_t myhash;
 
#ifdef CURL_DISABLE_VERBOSE_STRINGS 
  (void)data; 
#endif 
 
  /* First, alloc and init a new struct for it */ 
  co = calloc(1, sizeof(struct Cookie)); 
  if(!co) 
    return NULL; /* bail out if we're this low on memory */ 
 
  if(httpheader) { 
    /* This line was read off a HTTP-header */ 
    char name[MAX_NAME];
    char what[MAX_NAME];
    const char *ptr; 
    const char *semiptr; 
 
    size_t linelength = strlen(lineptr);
    if(linelength > MAX_COOKIE_LINE) {
      /* discard overly long lines at once */
      free(co); 
      return NULL; 
    } 
 
    semiptr = strchr(lineptr, ';'); /* first, find a semicolon */
 
    while(*lineptr && ISBLANK(*lineptr)) 
      lineptr++; 
 
    ptr = lineptr; 
    do { 
      /* we have a <what>=<this> pair or a stand-alone word here */ 
      name[0] = what[0] = 0; /* init the buffers */
      if(1 <= sscanf(ptr, "%" MAX_NAME_TXT "[^;\r\n=] =%"
                     MAX_NAME_TXT "[^;\r\n]",
                     name, what)) { 
        /* Use strstore() below to properly deal with received cookie 
           headers that have the same string property set more than once, 
           and then we use the last one. */ 
        const char *whatptr; 
        bool done = FALSE; 
        bool sep; 
        size_t len = strlen(what);
        size_t nlen = strlen(name);
        const char *endofn = &ptr[ nlen ];
 
        if(nlen >= (MAX_NAME-1) || len >= (MAX_NAME-1) ||
           ((nlen + len) > MAX_NAME)) {
          /* too long individual name or contents, or too long combination of
             name + contents. Chrome and Firefox support 4095 or 4096 bytes
             combo. */
          freecookie(co);
          infof(data, "oversized cookie dropped, name/val %zu + %zu bytes\n",
                nlen, len);
          return NULL;
        }
 
        /* name ends with a '=' ? */ 
        sep = (*endofn == '=')?TRUE:FALSE; 
 
        if(nlen) {
          endofn--; /* move to the last character */
          if(ISBLANK(*endofn)) {
            /* skip trailing spaces in name */
            while(*endofn && ISBLANK(*endofn) && nlen) {
              endofn--;
              nlen--;
            }
            name[nlen] = 0; /* new end of name */
          }
        }

        /* Strip off trailing whitespace from the 'what' */ 
        while(len && ISBLANK(what[len-1])) { 
          what[len-1] = 0;
          len--; 
        } 
 
        /* Skip leading whitespace from the 'what' */ 
        whatptr = what;
        while(*whatptr && ISBLANK(*whatptr)) 
          whatptr++; 
 
        /*
         * Check if we have a reserved prefix set before anything else, as we
         * otherwise have to test for the prefix in both the cookie name and
         * "the rest". Prefixes must start with '__' and end with a '-', so
         * only test for names where that can possibly be true.
         */
        if(nlen > 3 && name[0] == '_' && name[1] == '_') {
          if(!strncmp("__Secure-", name, 9))
            co->prefix |= COOKIE_PREFIX__SECURE;
          else if(!strncmp("__Host-", name, 7))
            co->prefix |= COOKIE_PREFIX__HOST;
        }

        if(!co->name) {
          /* The very first name/value pair is the actual cookie name */
          if(!sep) {
            /* Bad name/value pair. */
            badcookie = TRUE;
            break;
          }
          co->name = strdup(name);
          co->value = strdup(whatptr);
          done = TRUE;
          if(!co->name || !co->value) {
            badcookie = TRUE;
            break;
          }
        }
        else if(!len) {
          /* this was a "<name>=" with no content, and we must allow 
             'secure' and 'httponly' specified this weirdly */ 
          done = TRUE; 
          /*
           * secure cookies are only allowed to be set when the connection is
           * using a secure protocol, or when the cookie is being set by
           * reading from file
           */
          if(strcasecompare("secure", name)) {
            if(secure || !c->running) {
              co->secure = TRUE;
            }
            else {
              badcookie = TRUE;
              break;
            }
          }
          else if(strcasecompare("httponly", name))
            co->httponly = TRUE; 
          else if(sep) 
            /* there was a '=' so we're not done parsing this field */ 
            done = FALSE; 
        } 
        if(done) 
          ; 
        else if(strcasecompare("path", name)) {
          strstore(&co->path, whatptr); 
          if(!co->path) { 
            badcookie = TRUE; /* out of memory bad */ 
            break; 
          } 
          free(co->spath); /* if this is set again */
          co->spath = sanitize_cookie_path(co->path); 
          if(!co->spath) { 
            badcookie = TRUE; /* out of memory bad */ 
            break; 
          } 
        } 
        else if(strcasecompare("domain", name)) {
          bool is_ip;

          /* Now, we make sure that our host is within the given domain, 
             or the given domain is not valid and thus cannot be set. */ 
 
          if('.' == whatptr[0]) 
            whatptr++; /* ignore preceding dot */ 
 
#ifndef USE_LIBPSL
          /*
           * Without PSL we don't know when the incoming cookie is set on a
           * TLD or otherwise "protected" suffix. To reduce risk, we require a
           * dot OR the exact host name being "localhost".
           */
          if(bad_domain(whatptr))
            domain = ":";
#endif

          is_ip = isip(domain ? domain : whatptr);

          if(!domain
             || (is_ip && !strcmp(whatptr, domain))
             || (!is_ip && tailmatch(whatptr, domain))) {
            strstore(&co->domain, whatptr);
            if(!co->domain) { 
              badcookie = TRUE; 
              break; 
            } 
            if(!is_ip)
              co->tailmatch = TRUE; /* we always do that if the domain name was
                                       given */
          } 
          else { 
            /* we did not get a tailmatch and then the attempted set domain 
               is not a domain to which the current host belongs. Mark as 
               bad. */ 
            badcookie = TRUE;
            infof(data, "skipped cookie with bad tailmatch domain: %s\n", 
                  whatptr); 
          } 
        } 
        else if(strcasecompare("version", name)) {
          strstore(&co->version, whatptr); 
          if(!co->version) { 
            badcookie = TRUE; 
            break; 
          } 
        } 
        else if(strcasecompare("max-age", name)) {
          /* Defined in RFC2109: 
 
             Optional.  The Max-Age attribute defines the lifetime of the 
             cookie, in seconds.  The delta-seconds value is a decimal non- 
             negative integer.  After delta-seconds seconds elapse, the 
             client should discard the cookie.  A value of zero means the 
             cookie should be discarded immediately. 
 
          */ 
          strstore(&co->maxage, whatptr); 
          if(!co->maxage) { 
            badcookie = TRUE; 
            break; 
          } 
        } 
        else if(strcasecompare("expires", name)) {
          strstore(&co->expirestr, whatptr); 
          if(!co->expirestr) { 
            badcookie = TRUE; 
            break; 
          } 
        } 
        /* 
          else this is the second (or more) name we don't know 
          about! */ 
      } 
      else { 
        /* this is an "illegal" <what>=<this> pair */ 
      } 
 
      if(!semiptr || !*semiptr) { 
        /* we already know there are no more cookies */ 
        semiptr = NULL; 
        continue; 
      } 
 
      ptr = semiptr + 1;
      while(*ptr && ISBLANK(*ptr)) 
        ptr++; 
      semiptr = strchr(ptr, ';'); /* now, find the next semicolon */
 
      if(!semiptr && *ptr) 
        /* There are no more semicolons, but there's a final name=value pair 
           coming up */ 
        semiptr = strchr(ptr, '\0');
    } while(semiptr); 
 
    if(co->maxage) {
      CURLofft offt;
      offt = curlx_strtoofft((*co->maxage == '\"')?
                             &co->maxage[1]:&co->maxage[0], NULL, 10,
                             &co->expires);
      if(offt == CURL_OFFT_FLOW)
        /* overflow, used max value */
        co->expires = CURL_OFF_T_MAX;
      else if(!offt) {
        if(!co->expires)
          /* already expired */
          co->expires = 1;
        else if(CURL_OFF_T_MAX - now < co->expires)
          /* would overflow */
          co->expires = CURL_OFF_T_MAX;
        else
          co->expires += now;
      }
    }
    else if(co->expirestr) {
      /* Note that if the date couldn't get parsed for whatever reason,
         the cookie will be treated as a session cookie */
      co->expires = Curl_getdate_capped(co->expirestr);

      /* Session cookies have expires set to 0 so if we get that back
         from the date parser let's add a second to make it a
         non-session cookie */
      if(co->expires == 0)
        co->expires = 1;
      else if(co->expires < 0)
        co->expires = 0;
    }

    if(!badcookie && !co->domain) { 
      if(domain) { 
        /* no domain was given in the header line, set the default */ 
        co->domain = strdup(domain);
        if(!co->domain) 
          badcookie = TRUE; 
      } 
    } 
 
    if(!badcookie && !co->path && path) { 
      /* No path was given in the header line, set the default. 
         Note that the passed-in path to this function MAY have a '?' and 
         following part that MUST not be stored as part of the path. */ 
      char *queryp = strchr(path, '?'); 
 
      /* queryp is where the interesting part of the path ends, so now we 
         want to the find the last */ 
      char *endslash; 
      if(!queryp) 
        endslash = strrchr(path, '/'); 
      else 
        endslash = memrchr(path, '/', (queryp - path));
      if(endslash) { 
        size_t pathlen = (endslash-path + 1); /* include end slash */
        co->path = malloc(pathlen + 1); /* one extra for the zero byte */
        if(co->path) { 
          memcpy(co->path, path, pathlen); 
          co->path[pathlen] = 0; /* null-terminate */
          co->spath = sanitize_cookie_path(co->path); 
          if(!co->spath) 
            badcookie = TRUE; /* out of memory bad */ 
        } 
        else 
          badcookie = TRUE; 
      } 
    } 
 
    if(badcookie || !co->name) { 
      /* we didn't get a cookie name or a bad one, 
         this is an illegal line, bail out */ 
      freecookie(co); 
      return NULL; 
    } 
 
  } 
  else { 
    /* This line is NOT a HTTP header style line, we do offer support for 
       reading the odd netscape cookies-file format here */ 
    char *ptr; 
    char *firstptr; 
    char *tok_buf = NULL;
    int fields; 
 
    /* IE introduced HTTP-only cookies to prevent XSS attacks. Cookies 
       marked with httpOnly after the domain name are not accessible 
       from javascripts, but since curl does not operate at javascript 
       level, we include them anyway. In Firefox's cookie files, these 
       lines are preceded with #HttpOnly_ and then everything is 
       as usual, so we skip 10 characters of the line.. 
    */ 
    if(strncmp(lineptr, "#HttpOnly_", 10) == 0) { 
      lineptr += 10; 
      co->httponly = TRUE; 
    } 
 
    if(lineptr[0]=='#') { 
      /* don't even try the comments */ 
      free(co); 
      return NULL; 
    } 
    /* strip off the possible end-of-line characters */ 
    ptr = strchr(lineptr, '\r');
    if(ptr) 
      *ptr = 0; /* clear it */
    ptr = strchr(lineptr, '\n');
    if(ptr) 
      *ptr = 0; /* clear it */
 
    firstptr = strtok_r(lineptr, "\t", &tok_buf); /* tokenize it on the TAB */
 
    /* Now loop through the fields and init the struct we already have 
       allocated */ 
    for(ptr = firstptr, fields = 0; ptr && !badcookie;
        ptr = strtok_r(NULL, "\t", &tok_buf), fields++) {
      switch(fields) { 
      case 0: 
        if(ptr[0]=='.') /* skip preceding dots */ 
          ptr++; 
        co->domain = strdup(ptr); 
        if(!co->domain) 
          badcookie = TRUE; 
        break; 
      case 1: 
        /* flag: A TRUE/FALSE value indicating if all machines within a given
           domain can access the variable. Set TRUE when the cookie says
           .domain.com and to false when the domain is complete www.domain.com 
        */ 
        co->tailmatch = strcasecompare(ptr, "TRUE")?TRUE:FALSE;
        break; 
      case 2: 
        /* The file format allows the path field to remain not filled in */
        if(strcmp("TRUE", ptr) && strcmp("FALSE", ptr)) { 
          /* only if the path doesn't look like a boolean option! */ 
          co->path = strdup(ptr); 
          if(!co->path) 
            badcookie = TRUE; 
          else { 
            co->spath = sanitize_cookie_path(co->path); 
            if(!co->spath) { 
              badcookie = TRUE; /* out of memory bad */ 
            } 
          } 
          break; 
        } 
        /* this doesn't look like a path, make one up! */ 
        co->path = strdup("/"); 
        if(!co->path) 
          badcookie = TRUE; 
        co->spath = strdup("/"); 
        if(!co->spath) 
          badcookie = TRUE; 
        fields++; /* add a field and fall down to secure */ 
        /* FALLTHROUGH */ 
      case 3: 
        co->secure = FALSE;
        if(strcasecompare(ptr, "TRUE")) {
          if(secure || c->running)
            co->secure = TRUE;
          else
            badcookie = TRUE;
        }
        break; 
      case 4: 
        if(curlx_strtoofft(ptr, NULL, 10, &co->expires))
          badcookie = TRUE;
        break; 
      case 5: 
        co->name = strdup(ptr); 
        if(!co->name) 
          badcookie = TRUE; 
        else {
          /* For Netscape file format cookies we check prefix on the name */
          if(strncasecompare("__Secure-", co->name, 9))
            co->prefix |= COOKIE_PREFIX__SECURE;
          else if(strncasecompare("__Host-", co->name, 7))
            co->prefix |= COOKIE_PREFIX__HOST;
        }
        break; 
      case 6: 
        co->value = strdup(ptr); 
        if(!co->value) 
          badcookie = TRUE; 
        break; 
      } 
    } 
    if(6 == fields) { 
      /* we got a cookie with blank contents, fix it */ 
      co->value = strdup(""); 
      if(!co->value) 
        badcookie = TRUE; 
      else 
        fields++; 
    } 
 
    if(!badcookie && (7 != fields)) 
      /* we did not find the sufficient number of fields */ 
      badcookie = TRUE; 
 
    if(badcookie) { 
      freecookie(co); 
      return NULL; 
    } 
 
  } 
 
  if(co->prefix & COOKIE_PREFIX__SECURE) {
    /* The __Secure- prefix only requires that the cookie be set secure */
    if(!co->secure) {
      freecookie(co);
      return NULL;
    }
  }
  if(co->prefix & COOKIE_PREFIX__HOST) {
    /*
     * The __Host- prefix requires the cookie to be secure, have a "/" path
     * and not have a domain set.
     */
    if(co->secure && co->path && strcmp(co->path, "/") == 0 && !co->tailmatch)
      ;
    else {
      freecookie(co);
      return NULL;
    }
  }

  if(!c->running &&    /* read from a file */ 
     c->newsession &&  /* clean session cookies */ 
     !co->expires) {   /* this is a session cookie since it doesn't expire! */ 
    freecookie(co); 
    return NULL; 
  } 
 
  co->livecookie = c->running; 
  co->creationtime = ++c->lastct;
 
  /* now, we have parsed the incoming line, we must now check if this 
     supersedes an already existing cookie, which it may if the previous have
     the same domain and path as this */ 
 
  /* at first, remove expired cookies */ 
  if(!noexpire)
    remove_expired(c);
 
#ifdef USE_LIBPSL
  /* Check if the domain is a Public Suffix and if yes, ignore the cookie. */
  if(domain && co->domain && !isip(co->domain)) {
    const psl_ctx_t *psl = Curl_psl_use(data);
    int acceptable;

    if(psl) {
      acceptable = psl_is_cookie_domain_acceptable(psl, domain, co->domain);
      Curl_psl_release(data);
    }
    else
      acceptable = !bad_domain(domain);

    if(!acceptable) {
      infof(data, "cookie '%s' dropped, domain '%s' must not "
                  "set cookies for '%s'\n", co->name, domain, co->domain);
      freecookie(co);
      return NULL;
    }
  }
#endif

  myhash = cookiehash(co->domain);
  clist = c->cookies[myhash];
  replace_old = FALSE; 
  while(clist) { 
    if(strcasecompare(clist->name, co->name)) {
      /* the names are identical */ 
 
      if(clist->domain && co->domain) { 
        if(strcasecompare(clist->domain, co->domain) &&
          (clist->tailmatch == co->tailmatch))
          /* The domains are identical */ 
          replace_old = TRUE;
      } 
      else if(!clist->domain && !co->domain) 
        replace_old = TRUE; 
 
      if(replace_old) { 
        /* the domains were identical */ 
 
        if(clist->spath && co->spath) { 
          if(clist->secure && !co->secure && !secure) {
            size_t cllen;
            const char *sep;

            /*
             * A non-secure cookie may not overlay an existing secure cookie.
             * For an existing cookie "a" with path "/login", refuse a new
             * cookie "a" with for example path "/login/en", while the path
             * "/loginhelper" is ok.
             */

            sep = strchr(clist->spath + 1, '/');

            if(sep)
              cllen = sep - clist->spath;
            else
              cllen = strlen(clist->spath);

            if(strncasecompare(clist->spath, co->spath, cllen)) {
              freecookie(co);
              return NULL;
            }
          }
          else if(strcasecompare(clist->spath, co->spath))
            replace_old = TRUE; 
          else 
            replace_old = FALSE; 
        } 
        else if(!clist->spath && !co->spath) 
          replace_old = TRUE; 
        else 
          replace_old = FALSE; 
 
      } 
 
      if(replace_old && !co->livecookie && clist->livecookie) { 
        /* Both cookies matched fine, except that the already present 
           cookie is "live", which means it was set from a header, while 
           the new one isn't "live" and thus only read from a file. We let 
           live cookies stay alive */ 
 
        /* Free the newcomer and get out of here! */ 
        freecookie(co); 
        return NULL; 
      } 
 
      if(replace_old) { 
        co->next = clist->next; /* get the next-pointer first */ 
 
        /* when replacing, creationtime is kept from old */
        co->creationtime = clist->creationtime;

        /* then free all the old pointers */ 
        free(clist->name); 
        free(clist->value);
        free(clist->domain);
        free(clist->path);
        free(clist->spath);
        free(clist->expirestr);
        free(clist->version);
        free(clist->maxage);
 
        *clist = *co;  /* then store all the new data */ 
 
        free(co);   /* free the newly allocated memory */
        co = clist; /* point to the previous struct instead */ 
 
        /* We have replaced a cookie, now skip the rest of the list but 
           make sure the 'lastc' pointer is properly set */ 
        do { 
          lastc = clist; 
          clist = clist->next; 
        } while(clist); 
        break; 
      } 
    } 
    lastc = clist; 
    clist = clist->next; 
  } 
 
  if(c->running) 
    /* Only show this when NOT reading the cookies from a file */ 
    infof(data, "%s cookie %s=\"%s\" for domain %s, path %s, " 
          "expire %" CURL_FORMAT_CURL_OFF_T "\n",
          replace_old?"Replaced":"Added", co->name, co->value, 
          co->domain, co->path, co->expires); 
 
  if(!replace_old) { 
    /* then make the last item point on this new one */ 
    if(lastc) 
      lastc->next = co; 
    else 
      c->cookies[myhash] = co;
    c->numcookies++; /* one more cookie in the jar */ 
  } 
 
  return co; 
} 
 

/***************************************************************************** 
 * 
 * Curl_cookie_init() 
 * 
 * Inits a cookie struct to read data from a local file. This is always 
 * called before any cookies are set. File may be NULL. 
 * 
 * If 'newsession' is TRUE, discard all "session cookies" on read from file. 
 * 
 * Note that 'data' might be called as NULL pointer.
 *
 * Returns NULL on out of memory. Invalid cookies are ignored.
 ****************************************************************************/ 
struct CookieInfo *Curl_cookie_init(struct Curl_easy *data,
                                    const char *file, 
                                    struct CookieInfo *inc, 
                                    bool newsession) 
{ 
  struct CookieInfo *c; 
  FILE *fp = NULL;
  bool fromfile = TRUE;
  char *line = NULL;
 
  if(NULL == inc) { 
    /* we didn't get a struct, create one */ 
    c = calloc(1, sizeof(struct CookieInfo)); 
    if(!c) 
      return NULL; /* failed to get memory */ 
    c->filename = strdup(file?file:"none"); /* copy the name just in case */ 
    if(!c->filename)
      goto fail; /* failed to get memory */
  } 
  else { 
    /* we got an already existing one, use that */ 
    c = inc; 
  } 
  c->running = FALSE; /* this is not running, this is init */ 
 
  if(file && !strcmp(file, "-")) {
    fp = stdin; 
    fromfile = FALSE;
  } 
  else if(file && !*file) { 
    /* points to a "" string */ 
    fp = NULL; 
  } 
  else 
    fp = file?fopen(file, FOPEN_READTEXT):NULL;
 
  c->newsession = newsession; /* new session? */ 
 
  if(fp) { 
    char *lineptr; 
    bool headerline; 
 
    line = malloc(MAX_COOKIE_LINE);
    if(!line)
      goto fail;
    while(Curl_get_line(line, MAX_COOKIE_LINE, fp)) {
      if(checkprefix("Set-Cookie:", line)) {
        /* This is a cookie line, get it! */
        lineptr = &line[11];
        headerline = TRUE;
      }
      else {
        lineptr = line;
        headerline = FALSE;
      }
      while(*lineptr && ISBLANK(*lineptr))
        lineptr++;
 
      Curl_cookie_add(data, c, headerline, TRUE, lineptr, NULL, NULL, TRUE);
    } 
    free(line); /* free the line buffer */
    remove_expired(c); /* run this once, not on every cookie */

    if(fromfile) 
      fclose(fp); 
  } 
 
  c->running = TRUE;          /* now, we're running */ 
  if(data)
    data->state.cookie_engine = TRUE;
 
  return c; 

fail:
  free(line);
  if(!inc)
    /* Only clean up if we allocated it here, as the original could still be in
     * use by a share handle */
    Curl_cookie_cleanup(c);
  if(fromfile && fp)
    fclose(fp);
  return NULL; /* out of memory */
} 
 
/* sort this so that the longest path gets before the shorter path */ 
static int cookie_sort(const void *p1, const void *p2) 
{ 
  struct Cookie *c1 = *(struct Cookie **)p1; 
  struct Cookie *c2 = *(struct Cookie **)p2; 
  size_t l1, l2; 
 
  /* 1 - compare cookie path lengths */ 
  l1 = c1->path ? strlen(c1->path) : 0; 
  l2 = c2->path ? strlen(c2->path) : 0; 
 
  if(l1 != l2) 
    return (l2 > l1) ? 1 : -1 ; /* avoid size_t <=> int conversions */ 
 
  /* 2 - compare cookie domain lengths */ 
  l1 = c1->domain ? strlen(c1->domain) : 0; 
  l2 = c2->domain ? strlen(c2->domain) : 0; 
 
  if(l1 != l2) 
    return (l2 > l1) ? 1 : -1 ;  /* avoid size_t <=> int conversions */ 
 
  /* 3 - compare cookie name lengths */
  l1 = c1->name ? strlen(c1->name) : 0;
  l2 = c2->name ? strlen(c2->name) : 0;
 
  if(l1 != l2)
    return (l2 > l1) ? 1 : -1;

  /* 4 - compare cookie creation time */
  return (c2->creationtime > c1->creationtime) ? 1 : -1;
} 
 
/* sort cookies only according to creation time */
static int cookie_sort_ct(const void *p1, const void *p2)
{
  struct Cookie *c1 = *(struct Cookie **)p1;
  struct Cookie *c2 = *(struct Cookie **)p2;

  return (c2->creationtime > c1->creationtime) ? 1 : -1;
}

#define CLONE(field)                     \
  do {                                   \
    if(src->field) {                     \
      d->field = strdup(src->field);     \
      if(!d->field)                      \
        goto fail;                       \
    }                                    \
  } while(0)

static struct Cookie *dup_cookie(struct Cookie *src)
{
  struct Cookie *d = calloc(sizeof(struct Cookie), 1);
  if(d) {
    CLONE(expirestr);
    CLONE(domain);
    CLONE(path);
    CLONE(spath);
    CLONE(name);
    CLONE(value);
    CLONE(maxage);
    CLONE(version);
    d->expires = src->expires;
    d->tailmatch = src->tailmatch;
    d->secure = src->secure;
    d->livecookie = src->livecookie;
    d->httponly = src->httponly;
    d->creationtime = src->creationtime;
  }
  return d;

  fail:
  freecookie(d);
  return NULL;
}

/***************************************************************************** 
 * 
 * Curl_cookie_getlist() 
 * 
 * For a given host and path, return a linked list of cookies that the 
 * client should send to the server if used now. The secure boolean informs 
 * the cookie if a secure connection is achieved or not. 
 * 
 * It shall only return cookies that haven't expired. 
 * 
 ****************************************************************************/ 
 
struct Cookie *Curl_cookie_getlist(struct CookieInfo *c, 
                                   const char *host, const char *path, 
                                   bool secure) 
{ 
  struct Cookie *newco; 
  struct Cookie *co; 
  struct Cookie *mainco = NULL;
  size_t matches = 0; 
  bool is_ip;
  const size_t myhash = cookiehash(host);
 
  if(!c || !c->cookies[myhash])
    return NULL; /* no cookie struct or no cookies in the struct */ 
 
  /* at first, remove expired cookies */ 
  remove_expired(c); 
 
  /* check if host is an IP(v4|v6) address */
  is_ip = isip(host);
 
  co = c->cookies[myhash];

  while(co) { 
    /* if the cookie requires we're secure we must only continue if we are! */
    if(co->secure?secure:TRUE) {
 
      /* now check if the domain is correct */ 
      if(!co->domain || 
         (co->tailmatch && !is_ip && tailmatch(co->domain, host)) ||
         ((!co->tailmatch || is_ip) && strcasecompare(host, co->domain)) ) {
        /* the right part of the host matches the domain stuff in the 
           cookie data */ 
 
        /* now check the left part of the path with the cookies path 
           requirement */ 
        if(!co->spath || pathmatch(co->spath, path) ) { 
 
          /* and now, we know this is a match and we should create an 
             entry for the return-linked-list */ 
 
          newco = dup_cookie(co);
          if(newco) { 
            /* then modify our next */ 
            newco->next = mainco; 
 
            /* point the main to us */ 
            mainco = newco; 
 
            matches++; 
          } 
          else
            goto fail;
        } 
      } 
    } 
    co = co->next; 
  } 
 
  if(matches) { 
    /* Now we need to make sure that if there is a name appearing more than 
       once, the longest specified path version comes first. To make this 
       the swiftest way, we just sort them all based on path length. */ 
    struct Cookie **array; 
    size_t i; 
 
    /* alloc an array and store all cookie pointers */ 
    array = malloc(sizeof(struct Cookie *) * matches); 
    if(!array) 
      goto fail; 
 
    co = mainco; 
 
    for(i = 0; co; co = co->next)
      array[i++] = co; 
 
    /* now sort the cookie pointers in path length order */ 
    qsort(array, matches, sizeof(struct Cookie *), cookie_sort); 
 
    /* remake the linked list order according to the new order */ 
 
    mainco = array[0]; /* start here */ 
    for(i = 0; i<matches-1; i++)
      array[i]->next = array[i + 1];
    array[matches-1]->next = NULL; /* terminate the list */ 
 
    free(array); /* remove the temporary data again */ 
  } 
 
  return mainco; /* return the new list */ 

fail:
  /* failure, clear up the allocated chain and return NULL */
  Curl_cookie_freelist(mainco);
  return NULL;
} 
 
/***************************************************************************** 
 * 
 * Curl_cookie_clearall() 
 * 
 * Clear all existing cookies and reset the counter. 
 * 
 ****************************************************************************/ 
void Curl_cookie_clearall(struct CookieInfo *cookies) 
{ 
  if(cookies) { 
    unsigned int i;
    for(i = 0; i < COOKIE_HASH_SIZE; i++) {
      Curl_cookie_freelist(cookies->cookies[i]);
      cookies->cookies[i] = NULL;
    }
    cookies->numcookies = 0; 
  } 
} 
 
/***************************************************************************** 
 * 
 * Curl_cookie_freelist() 
 * 
 * Free a list of cookies previously returned by Curl_cookie_getlist(); 
 * 
 ****************************************************************************/ 
 
void Curl_cookie_freelist(struct Cookie *co)
{ 
  struct Cookie *next; 
  while(co) {
    next = co->next;
    freecookie(co);
    co = next;
  } 
} 
 
 
/***************************************************************************** 
 * 
 * Curl_cookie_clearsess() 
 * 
 * Free all session cookies in the cookies list. 
 * 
 ****************************************************************************/ 
void Curl_cookie_clearsess(struct CookieInfo *cookies) 
{ 
  struct Cookie *first, *curr, *next, *prev = NULL; 
  unsigned int i;
 
  if(!cookies)
    return; 
 
  for(i = 0; i < COOKIE_HASH_SIZE; i++) {
    if(!cookies->cookies[i])
      continue;
 
    first = curr = prev = cookies->cookies[i];
 
    for(; curr; curr = next) {
      next = curr->next;
      if(!curr->expires) {
        if(first == curr)
          first = next;

        if(prev == curr)
          prev = next;
        else
          prev->next = next;

        freecookie(curr);
        cookies->numcookies--;
      }
      else 
        prev = curr;
    }
 
    cookies->cookies[i] = first;
  } 
} 
 
 
/***************************************************************************** 
 * 
 * Curl_cookie_cleanup() 
 * 
 * Free a "cookie object" previous created with Curl_cookie_init().
 * 
 ****************************************************************************/ 
void Curl_cookie_cleanup(struct CookieInfo *c) 
{ 
  if(c) { 
    unsigned int i;
    free(c->filename);
    for(i = 0; i < COOKIE_HASH_SIZE; i++)
      Curl_cookie_freelist(c->cookies[i]);
    free(c); /* free the base struct as well */ 
  } 
} 
 
/* get_netscape_format() 
 * 
 * Formats a string for Netscape output file, w/o a newline at the end. 
 * 
 * Function returns a char * to a formatted line. Has to be free()d 
*/ 
static char *get_netscape_format(const struct Cookie *co) 
{ 
  return aprintf( 
    "%s"     /* httponly preamble */ 
    "%s%s\t" /* domain */ 
    "%s\t"   /* tailmatch */ 
    "%s\t"   /* path */ 
    "%s\t"   /* secure */ 
    "%" CURL_FORMAT_CURL_OFF_T "\t"   /* expires */
    "%s\t"   /* name */ 
    "%s",    /* value */ 
    co->httponly?"#HttpOnly_":"", 
    /* Make sure all domains are prefixed with a dot if they allow 
       tailmatching. This is Mozilla-style. */ 
    (co->tailmatch && co->domain && co->domain[0] != '.')? ".":"", 
    co->domain?co->domain:"unknown", 
    co->tailmatch?"TRUE":"FALSE", 
    co->path?co->path:"/", 
    co->secure?"TRUE":"FALSE", 
    co->expires, 
    co->name, 
    co->value?co->value:""); 
} 
 
/* 
 * cookie_output() 
 * 
 * Writes all internally known cookies to the specified file. Specify 
 * "-" as file name to write to stdout. 
 * 
 * The function returns non-zero on write failure. 
 */ 
static int cookie_output(struct Curl_easy *data,
                         struct CookieInfo *c, const char *filename)
{ 
  struct Cookie *co; 
  FILE *out = NULL;
  bool use_stdout = FALSE;
  char *tempstore = NULL;
  bool error = false;
 
  if(!c)
    /* no cookie engine alive */
    return 0;

  /* at first, remove expired cookies */ 
  remove_expired(c); 
 
  if(!strcmp("-", filename)) {
    /* use stdout */ 
    out = stdout; 
    use_stdout = TRUE;
  } 
  else { 
    unsigned char randsuffix[9];

    if(Curl_rand_hex(data, randsuffix, sizeof(randsuffix)))
      return 2;

    tempstore = aprintf("%s.%s.tmp", filename, randsuffix);
    if(!tempstore)
      return 1;

    out = fopen(tempstore, FOPEN_WRITETEXT);
    if(!out)
      goto error;
  } 
 
  fputs("# Netscape HTTP Cookie File\n"
        "# https://curl.se/docs/http-cookies.html\n"
        "# This file was generated by libcurl! Edit at your own risk.\n\n",
        out);
 
  if(c->numcookies) {
    unsigned int i;
    size_t nvalid = 0;
    struct Cookie **array;

    array = calloc(1, sizeof(struct Cookie *) * c->numcookies);
    if(!array) {
      goto error;
    }
 
    /* only sort the cookies with a domain property */
    for(i = 0; i < COOKIE_HASH_SIZE; i++) {
      for(co = c->cookies[i]; co; co = co->next) {
        if(!co->domain)
          continue;
        array[nvalid++] = co;
      }
    }

    qsort(array, nvalid, sizeof(struct Cookie *), cookie_sort_ct);

    for(i = 0; i < nvalid; i++) {
      char *format_ptr = get_netscape_format(array[i]);
      if(format_ptr == NULL) { 
        fprintf(out, "#\n# Fatal libcurl error\n"); 
        free(array);
        goto error;
      } 
      fprintf(out, "%s\n", format_ptr); 
      free(format_ptr); 
    } 

    free(array);
  } 

  if(!use_stdout) {
    fclose(out); 
    out = NULL;
    if(Curl_rename(tempstore, filename)) {
      unlink(tempstore);
      goto error;
    }
  }
 
  goto cleanup;
error:
  error = true;
cleanup:
  if(out && !use_stdout)
    fclose(out);
  free(tempstore);
  return error ? 1 : 0;
} 
 
static struct curl_slist *cookie_list(struct Curl_easy *data)
{ 
  struct curl_slist *list = NULL; 
  struct curl_slist *beg; 
  struct Cookie *c; 
  char *line; 
  unsigned int i;
 
  if((data->cookies == NULL) || 
      (data->cookies->numcookies == 0)) 
    return NULL; 
 
  for(i = 0; i < COOKIE_HASH_SIZE; i++) {
    for(c = data->cookies->cookies[i]; c; c = c->next) {
      if(!c->domain)
        continue;
      line = get_netscape_format(c);
      if(!line) {
        curl_slist_free_all(list);
        return NULL;
      }
      beg = Curl_slist_append_nodup(list, line);
      if(!beg) {
        free(line);
        curl_slist_free_all(list);
        return NULL;
      }
      list = beg;
    } 
  } 
 
  return list; 
} 
 
struct curl_slist *Curl_cookie_list(struct Curl_easy *data)
{ 
  struct curl_slist *list;
  Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
  list = cookie_list(data);
  Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
  return list;
}

void Curl_flush_cookies(struct Curl_easy *data, bool cleanup)
{
  if(data->set.str[STRING_COOKIEJAR]) { 
    if(data->change.cookielist) { 
      /* If there is a list of cookie files to read, do it first so that 
         we have all the told files read before we write the new jar. 
         Curl_cookie_loadfiles() LOCKS and UNLOCKS the share itself! */ 
      Curl_cookie_loadfiles(data); 
    } 
 
    Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE); 
 
    /* if we have a destination file for all the cookies to get dumped to */ 
    if(cookie_output(data, data->cookies, data->set.str[STRING_COOKIEJAR]))
      infof(data, "WARNING: failed to save cookies in %s\n", 
            data->set.str[STRING_COOKIEJAR]); 
  } 
  else { 
    if(cleanup && data->change.cookielist) { 
      /* since nothing is written, we can just free the list of cookie file 
         names */ 
      curl_slist_free_all(data->change.cookielist); /* clean up list */ 
      data->change.cookielist = NULL; 
    } 
    Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE); 
  } 
 
  if(cleanup && (!data->share || (data->cookies != data->share->cookies))) { 
    Curl_cookie_cleanup(data->cookies); 
    data->cookies = NULL;
  } 
  Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE); 
} 
 
#endif /* CURL_DISABLE_HTTP || CURL_DISABLE_COOKIES */