cookie.c 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777
  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. /***
  25. RECEIVING COOKIE INFORMATION
  26. ============================
  27. struct CookieInfo *Curl_cookie_init(struct Curl_easy *data,
  28. const char *file, struct CookieInfo *inc, bool newsession);
  29. Inits a cookie struct to store data in a local file. This is always
  30. called before any cookies are set.
  31. struct Cookie *Curl_cookie_add(struct Curl_easy *data,
  32. struct CookieInfo *c, bool httpheader, bool noexpire,
  33. char *lineptr, const char *domain, const char *path,
  34. bool secure);
  35. The 'lineptr' parameter is a full "Set-cookie:" line as
  36. received from a server.
  37. The function need to replace previously stored lines that this new
  38. line supersedes.
  39. It may remove lines that are expired.
  40. It should return an indication of success/error.
  41. SENDING COOKIE INFORMATION
  42. ==========================
  43. struct Cookies *Curl_cookie_getlist(struct CookieInfo *cookie,
  44. char *host, char *path, bool secure);
  45. For a given host and path, return a linked list of cookies that
  46. the client should send to the server if used now. The secure
  47. boolean informs the cookie if a secure connection is achieved or
  48. not.
  49. It shall only return cookies that have not expired.
  50. Example set of cookies:
  51. Set-cookie: PRODUCTINFO=webxpress; domain=.fidelity.com; path=/; secure
  52. Set-cookie: PERSONALIZE=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
  53. domain=.fidelity.com; path=/ftgw; secure
  54. Set-cookie: FidHist=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
  55. domain=.fidelity.com; path=/; secure
  56. Set-cookie: FidOrder=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
  57. domain=.fidelity.com; path=/; secure
  58. Set-cookie: DisPend=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
  59. domain=.fidelity.com; path=/; secure
  60. Set-cookie: FidDis=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
  61. domain=.fidelity.com; path=/; secure
  62. Set-cookie:
  63. Session_Key@6791a9e0-901a-11d0-a1c8-9b012c88aa77=none;expires=Monday,
  64. 13-Jun-1988 03:04:55 GMT; domain=.fidelity.com; path=/; secure
  65. ****/
  66. #include "curl_setup.h"
  67. #if !defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_COOKIES)
  68. #include "urldata.h"
  69. #include "cookie.h"
  70. #include "psl.h"
  71. #include "strtok.h"
  72. #include "sendf.h"
  73. #include "slist.h"
  74. #include "share.h"
  75. #include "strtoofft.h"
  76. #include "strcase.h"
  77. #include "curl_get_line.h"
  78. #include "curl_memrchr.h"
  79. #include "parsedate.h"
  80. #include "rename.h"
  81. #include "fopen.h"
  82. #include "strdup.h"
  83. /* The last 3 #include files should be in this order */
  84. #include "curl_printf.h"
  85. #include "curl_memory.h"
  86. #include "memdebug.h"
  87. static void strstore(char **str, const char *newstr, size_t len);
  88. static void freecookie(struct Cookie *co)
  89. {
  90. free(co->domain);
  91. free(co->path);
  92. free(co->spath);
  93. free(co->name);
  94. free(co->value);
  95. free(co);
  96. }
  97. static bool cookie_tailmatch(const char *cookie_domain,
  98. size_t cookie_domain_len,
  99. const char *hostname)
  100. {
  101. size_t hostname_len = strlen(hostname);
  102. if(hostname_len < cookie_domain_len)
  103. return FALSE;
  104. if(!strncasecompare(cookie_domain,
  105. hostname + hostname_len-cookie_domain_len,
  106. cookie_domain_len))
  107. return FALSE;
  108. /*
  109. * A lead char of cookie_domain is not '.'.
  110. * RFC6265 4.1.2.3. The Domain Attribute says:
  111. * For example, if the value of the Domain attribute is
  112. * "example.com", the user agent will include the cookie in the Cookie
  113. * header when making HTTP requests to example.com, www.example.com, and
  114. * www.corp.example.com.
  115. */
  116. if(hostname_len == cookie_domain_len)
  117. return TRUE;
  118. if('.' == *(hostname + hostname_len - cookie_domain_len - 1))
  119. return TRUE;
  120. return FALSE;
  121. }
  122. /*
  123. * matching cookie path and URL path
  124. * RFC6265 5.1.4 Paths and Path-Match
  125. */
  126. static bool pathmatch(const char *cookie_path, const char *request_uri)
  127. {
  128. size_t cookie_path_len;
  129. size_t uri_path_len;
  130. char *uri_path = NULL;
  131. char *pos;
  132. bool ret = FALSE;
  133. /* cookie_path must not have last '/' separator. ex: /sample */
  134. cookie_path_len = strlen(cookie_path);
  135. if(1 == cookie_path_len) {
  136. /* cookie_path must be '/' */
  137. return TRUE;
  138. }
  139. uri_path = strdup(request_uri);
  140. if(!uri_path)
  141. return FALSE;
  142. pos = strchr(uri_path, '?');
  143. if(pos)
  144. *pos = 0x0;
  145. /* #-fragments are already cut off! */
  146. if(0 == strlen(uri_path) || uri_path[0] != '/') {
  147. strstore(&uri_path, "/", 1);
  148. if(!uri_path)
  149. return FALSE;
  150. }
  151. /*
  152. * here, RFC6265 5.1.4 says
  153. * 4. Output the characters of the uri-path from the first character up
  154. * to, but not including, the right-most %x2F ("/").
  155. * but URL path /hoge?fuga=xxx means /hoge/index.cgi?fuga=xxx in some site
  156. * without redirect.
  157. * Ignore this algorithm because /hoge is uri path for this case
  158. * (uri path is not /).
  159. */
  160. uri_path_len = strlen(uri_path);
  161. if(uri_path_len < cookie_path_len) {
  162. ret = FALSE;
  163. goto pathmatched;
  164. }
  165. /* not using checkprefix() because matching should be case-sensitive */
  166. if(strncmp(cookie_path, uri_path, cookie_path_len)) {
  167. ret = FALSE;
  168. goto pathmatched;
  169. }
  170. /* The cookie-path and the uri-path are identical. */
  171. if(cookie_path_len == uri_path_len) {
  172. ret = TRUE;
  173. goto pathmatched;
  174. }
  175. /* here, cookie_path_len < uri_path_len */
  176. if(uri_path[cookie_path_len] == '/') {
  177. ret = TRUE;
  178. goto pathmatched;
  179. }
  180. ret = FALSE;
  181. pathmatched:
  182. free(uri_path);
  183. return ret;
  184. }
  185. /*
  186. * Return the top-level domain, for optimal hashing.
  187. */
  188. static const char *get_top_domain(const char * const domain, size_t *outlen)
  189. {
  190. size_t len = 0;
  191. const char *first = NULL, *last;
  192. if(domain) {
  193. len = strlen(domain);
  194. last = memrchr(domain, '.', len);
  195. if(last) {
  196. first = memrchr(domain, '.', (last - domain));
  197. if(first)
  198. len -= (++first - domain);
  199. }
  200. }
  201. if(outlen)
  202. *outlen = len;
  203. return first? first: domain;
  204. }
  205. /* Avoid C1001, an "internal error" with MSVC14 */
  206. #if defined(_MSC_VER) && (_MSC_VER == 1900)
  207. #pragma optimize("", off)
  208. #endif
  209. /*
  210. * A case-insensitive hash for the cookie domains.
  211. */
  212. static size_t cookie_hash_domain(const char *domain, const size_t len)
  213. {
  214. const char *end = domain + len;
  215. size_t h = 5381;
  216. while(domain < end) {
  217. size_t j = (size_t)Curl_raw_toupper(*domain++);
  218. h += h << 5;
  219. h ^= j;
  220. }
  221. return (h % COOKIE_HASH_SIZE);
  222. }
  223. #if defined(_MSC_VER) && (_MSC_VER == 1900)
  224. #pragma optimize("", on)
  225. #endif
  226. /*
  227. * Hash this domain.
  228. */
  229. static size_t cookiehash(const char * const domain)
  230. {
  231. const char *top;
  232. size_t len;
  233. if(!domain || Curl_host_is_ipnum(domain))
  234. return 0;
  235. top = get_top_domain(domain, &len);
  236. return cookie_hash_domain(top, len);
  237. }
  238. /*
  239. * cookie path sanitize
  240. */
  241. static char *sanitize_cookie_path(const char *cookie_path)
  242. {
  243. size_t len;
  244. char *new_path = strdup(cookie_path);
  245. if(!new_path)
  246. return NULL;
  247. /* some stupid site sends path attribute with '"'. */
  248. len = strlen(new_path);
  249. if(new_path[0] == '\"') {
  250. memmove(new_path, new_path + 1, len);
  251. len--;
  252. }
  253. if(len && (new_path[len - 1] == '\"')) {
  254. new_path[--len] = 0x0;
  255. }
  256. /* RFC6265 5.2.4 The Path Attribute */
  257. if(new_path[0] != '/') {
  258. /* Let cookie-path be the default-path. */
  259. strstore(&new_path, "/", 1);
  260. return new_path;
  261. }
  262. /* convert /hoge/ to /hoge */
  263. if(len && new_path[len - 1] == '/') {
  264. new_path[len - 1] = 0x0;
  265. }
  266. return new_path;
  267. }
  268. /*
  269. * Load cookies from all given cookie files (CURLOPT_COOKIEFILE).
  270. *
  271. * NOTE: OOM or cookie parsing failures are ignored.
  272. */
  273. void Curl_cookie_loadfiles(struct Curl_easy *data)
  274. {
  275. struct curl_slist *list = data->state.cookielist;
  276. if(list) {
  277. Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
  278. while(list) {
  279. struct CookieInfo *newcookies =
  280. Curl_cookie_init(data, list->data, data->cookies,
  281. data->set.cookiesession);
  282. if(!newcookies)
  283. /*
  284. * Failure may be due to OOM or a bad cookie; both are ignored
  285. * but only the first should be
  286. */
  287. infof(data, "ignoring failed cookie_init for %s", list->data);
  288. else
  289. data->cookies = newcookies;
  290. list = list->next;
  291. }
  292. Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
  293. }
  294. }
  295. /*
  296. * strstore
  297. *
  298. * A thin wrapper around strdup which ensures that any memory allocated at
  299. * *str will be freed before the string allocated by strdup is stored there.
  300. * The intended usecase is repeated assignments to the same variable during
  301. * parsing in a last-wins scenario. The caller is responsible for checking
  302. * for OOM errors.
  303. */
  304. static void strstore(char **str, const char *newstr, size_t len)
  305. {
  306. DEBUGASSERT(newstr);
  307. DEBUGASSERT(str);
  308. free(*str);
  309. *str = Curl_memdup0(newstr, len);
  310. }
  311. /*
  312. * remove_expired
  313. *
  314. * Remove expired cookies from the hash by inspecting the expires timestamp on
  315. * each cookie in the hash, freeing and deleting any where the timestamp is in
  316. * the past. If the cookiejar has recorded the next timestamp at which one or
  317. * more cookies expire, then processing will exit early in case this timestamp
  318. * is in the future.
  319. */
  320. static void remove_expired(struct CookieInfo *cookies)
  321. {
  322. struct Cookie *co, *nx;
  323. curl_off_t now = (curl_off_t)time(NULL);
  324. unsigned int i;
  325. /*
  326. * If the earliest expiration timestamp in the jar is in the future we can
  327. * skip scanning the whole jar and instead exit early as there will not be
  328. * any cookies to evict. If we need to evict however, reset the
  329. * next_expiration counter in order to track the next one. In case the
  330. * recorded first expiration is the max offset, then perform the safe
  331. * fallback of checking all cookies.
  332. */
  333. if(now < cookies->next_expiration &&
  334. cookies->next_expiration != CURL_OFF_T_MAX)
  335. return;
  336. else
  337. cookies->next_expiration = CURL_OFF_T_MAX;
  338. for(i = 0; i < COOKIE_HASH_SIZE; i++) {
  339. struct Cookie *pv = NULL;
  340. co = cookies->cookies[i];
  341. while(co) {
  342. nx = co->next;
  343. if(co->expires && co->expires < now) {
  344. if(!pv) {
  345. cookies->cookies[i] = co->next;
  346. }
  347. else {
  348. pv->next = co->next;
  349. }
  350. cookies->numcookies--;
  351. freecookie(co);
  352. }
  353. else {
  354. /*
  355. * If this cookie has an expiration timestamp earlier than what we have
  356. * seen so far then record it for the next round of expirations.
  357. */
  358. if(co->expires && co->expires < cookies->next_expiration)
  359. cookies->next_expiration = co->expires;
  360. pv = co;
  361. }
  362. co = nx;
  363. }
  364. }
  365. }
  366. #ifndef USE_LIBPSL
  367. /* Make sure domain contains a dot or is localhost. */
  368. static bool bad_domain(const char *domain, size_t len)
  369. {
  370. if((len == 9) && strncasecompare(domain, "localhost", 9))
  371. return FALSE;
  372. else {
  373. /* there must be a dot present, but that dot must not be a trailing dot */
  374. char *dot = memchr(domain, '.', len);
  375. if(dot) {
  376. size_t i = dot - domain;
  377. if((len - i) > 1)
  378. /* the dot is not the last byte */
  379. return FALSE;
  380. }
  381. }
  382. return TRUE;
  383. }
  384. #endif
  385. /*
  386. RFC 6265 section 4.1.1 says a server should accept this range:
  387. cookie-octet = %x21 / %x23-2B / %x2D-3A / %x3C-5B / %x5D-7E
  388. But Firefox and Chrome as of June 2022 accept space, comma and double-quotes
  389. fine. The prime reason for filtering out control bytes is that some HTTP
  390. servers return 400 for requests that contain such.
  391. */
  392. static int invalid_octets(const char *p)
  393. {
  394. /* Reject all bytes \x01 - \x1f (*except* \x09, TAB) + \x7f */
  395. static const char badoctets[] = {
  396. "\x01\x02\x03\x04\x05\x06\x07\x08\x0a"
  397. "\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14"
  398. "\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f\x7f"
  399. };
  400. size_t len;
  401. /* scan for all the octets that are *not* in cookie-octet */
  402. len = strcspn(p, badoctets);
  403. return (p[len] != '\0');
  404. }
  405. /*
  406. * Curl_cookie_add
  407. *
  408. * Add a single cookie line to the cookie keeping object. Be aware that
  409. * sometimes we get an IP-only hostname, and that might also be a numerical
  410. * IPv6 address.
  411. *
  412. * Returns NULL on out of memory or invalid cookie. This is suboptimal,
  413. * as they should be treated separately.
  414. */
  415. struct Cookie *
  416. Curl_cookie_add(struct Curl_easy *data,
  417. struct CookieInfo *c,
  418. bool httpheader, /* TRUE if HTTP header-style line */
  419. bool noexpire, /* if TRUE, skip remove_expired() */
  420. const char *lineptr, /* first character of the line */
  421. const char *domain, /* default domain */
  422. const char *path, /* full path used when this cookie is set,
  423. used to get default path for the cookie
  424. unless set */
  425. bool secure) /* TRUE if connection is over secure origin */
  426. {
  427. struct Cookie *clist;
  428. struct Cookie *co;
  429. struct Cookie *lastc = NULL;
  430. struct Cookie *replace_co = NULL;
  431. struct Cookie *replace_clist = NULL;
  432. time_t now = time(NULL);
  433. bool replace_old = FALSE;
  434. bool badcookie = FALSE; /* cookies are good by default. mmmmm yummy */
  435. size_t myhash;
  436. DEBUGASSERT(data);
  437. DEBUGASSERT(MAX_SET_COOKIE_AMOUNT <= 255); /* counter is an unsigned char */
  438. if(data->req.setcookies >= MAX_SET_COOKIE_AMOUNT)
  439. return NULL;
  440. /* First, alloc and init a new struct for it */
  441. co = calloc(1, sizeof(struct Cookie));
  442. if(!co)
  443. return NULL; /* bail out if we are this low on memory */
  444. if(httpheader) {
  445. /* This line was read off an HTTP-header */
  446. const char *ptr;
  447. size_t linelength = strlen(lineptr);
  448. if(linelength > MAX_COOKIE_LINE) {
  449. /* discard overly long lines at once */
  450. free(co);
  451. return NULL;
  452. }
  453. ptr = lineptr;
  454. do {
  455. size_t vlen;
  456. size_t nlen;
  457. while(*ptr && ISBLANK(*ptr))
  458. ptr++;
  459. /* we have a <name>=<value> pair or a stand-alone word here */
  460. nlen = strcspn(ptr, ";\t\r\n=");
  461. if(nlen) {
  462. bool done = FALSE;
  463. bool sep = FALSE;
  464. const char *namep = ptr;
  465. const char *valuep;
  466. ptr += nlen;
  467. /* trim trailing spaces and tabs after name */
  468. while(nlen && ISBLANK(namep[nlen - 1]))
  469. nlen--;
  470. if(*ptr == '=') {
  471. vlen = strcspn(++ptr, ";\r\n");
  472. valuep = ptr;
  473. sep = TRUE;
  474. ptr = &valuep[vlen];
  475. /* Strip off trailing whitespace from the value */
  476. while(vlen && ISBLANK(valuep[vlen-1]))
  477. vlen--;
  478. /* Skip leading whitespace from the value */
  479. while(vlen && ISBLANK(*valuep)) {
  480. valuep++;
  481. vlen--;
  482. }
  483. /* Reject cookies with a TAB inside the value */
  484. if(memchr(valuep, '\t', vlen)) {
  485. freecookie(co);
  486. infof(data, "cookie contains TAB, dropping");
  487. return NULL;
  488. }
  489. }
  490. else {
  491. valuep = NULL;
  492. vlen = 0;
  493. }
  494. /*
  495. * Check for too long individual name or contents, or too long
  496. * combination of name + contents. Chrome and Firefox support 4095 or
  497. * 4096 bytes combo
  498. */
  499. if(nlen >= (MAX_NAME-1) || vlen >= (MAX_NAME-1) ||
  500. ((nlen + vlen) > MAX_NAME)) {
  501. freecookie(co);
  502. infof(data, "oversized cookie dropped, name/val %zu + %zu bytes",
  503. nlen, vlen);
  504. return NULL;
  505. }
  506. /*
  507. * Check if we have a reserved prefix set before anything else, as we
  508. * otherwise have to test for the prefix in both the cookie name and
  509. * "the rest". Prefixes must start with '__' and end with a '-', so
  510. * only test for names where that can possibly be true.
  511. */
  512. if(nlen >= 7 && namep[0] == '_' && namep[1] == '_') {
  513. if(strncasecompare("__Secure-", namep, 9))
  514. co->prefix |= COOKIE_PREFIX__SECURE;
  515. else if(strncasecompare("__Host-", namep, 7))
  516. co->prefix |= COOKIE_PREFIX__HOST;
  517. }
  518. /*
  519. * Use strstore() below to properly deal with received cookie
  520. * headers that have the same string property set more than once,
  521. * and then we use the last one.
  522. */
  523. if(!co->name) {
  524. /* The very first name/value pair is the actual cookie name */
  525. if(!sep) {
  526. /* Bad name/value pair. */
  527. badcookie = TRUE;
  528. break;
  529. }
  530. strstore(&co->name, namep, nlen);
  531. strstore(&co->value, valuep, vlen);
  532. done = TRUE;
  533. if(!co->name || !co->value) {
  534. badcookie = TRUE;
  535. break;
  536. }
  537. if(invalid_octets(co->value) || invalid_octets(co->name)) {
  538. infof(data, "invalid octets in name/value, cookie dropped");
  539. badcookie = TRUE;
  540. break;
  541. }
  542. }
  543. else if(!vlen) {
  544. /*
  545. * this was a "<name>=" with no content, and we must allow
  546. * 'secure' and 'httponly' specified this weirdly
  547. */
  548. done = TRUE;
  549. /*
  550. * secure cookies are only allowed to be set when the connection is
  551. * using a secure protocol, or when the cookie is being set by
  552. * reading from file
  553. */
  554. if((nlen == 6) && strncasecompare("secure", namep, 6)) {
  555. if(secure || !c->running) {
  556. co->secure = TRUE;
  557. }
  558. else {
  559. badcookie = TRUE;
  560. break;
  561. }
  562. }
  563. else if((nlen == 8) && strncasecompare("httponly", namep, 8))
  564. co->httponly = TRUE;
  565. else if(sep)
  566. /* there was a '=' so we are not done parsing this field */
  567. done = FALSE;
  568. }
  569. if(done)
  570. ;
  571. else if((nlen == 4) && strncasecompare("path", namep, 4)) {
  572. strstore(&co->path, valuep, vlen);
  573. if(!co->path) {
  574. badcookie = TRUE; /* out of memory bad */
  575. break;
  576. }
  577. free(co->spath); /* if this is set again */
  578. co->spath = sanitize_cookie_path(co->path);
  579. if(!co->spath) {
  580. badcookie = TRUE; /* out of memory bad */
  581. break;
  582. }
  583. }
  584. else if((nlen == 6) &&
  585. strncasecompare("domain", namep, 6) && vlen) {
  586. bool is_ip;
  587. /*
  588. * Now, we make sure that our host is within the given domain, or
  589. * the given domain is not valid and thus cannot be set.
  590. */
  591. if('.' == valuep[0]) {
  592. valuep++; /* ignore preceding dot */
  593. vlen--;
  594. }
  595. #ifndef USE_LIBPSL
  596. /*
  597. * Without PSL we do not know when the incoming cookie is set on a
  598. * TLD or otherwise "protected" suffix. To reduce risk, we require a
  599. * dot OR the exact hostname being "localhost".
  600. */
  601. if(bad_domain(valuep, vlen))
  602. domain = ":";
  603. #endif
  604. is_ip = Curl_host_is_ipnum(domain ? domain : valuep);
  605. if(!domain
  606. || (is_ip && !strncmp(valuep, domain, vlen) &&
  607. (vlen == strlen(domain)))
  608. || (!is_ip && cookie_tailmatch(valuep, vlen, domain))) {
  609. strstore(&co->domain, valuep, vlen);
  610. if(!co->domain) {
  611. badcookie = TRUE;
  612. break;
  613. }
  614. if(!is_ip)
  615. co->tailmatch = TRUE; /* we always do that if the domain name was
  616. given */
  617. }
  618. else {
  619. /*
  620. * We did not get a tailmatch and then the attempted set domain is
  621. * not a domain to which the current host belongs. Mark as bad.
  622. */
  623. badcookie = TRUE;
  624. infof(data, "skipped cookie with bad tailmatch domain: %s",
  625. valuep);
  626. }
  627. }
  628. else if((nlen == 7) && strncasecompare("version", namep, 7)) {
  629. /* just ignore */
  630. }
  631. else if((nlen == 7) && strncasecompare("max-age", namep, 7)) {
  632. /*
  633. * Defined in RFC2109:
  634. *
  635. * Optional. The Max-Age attribute defines the lifetime of the
  636. * cookie, in seconds. The delta-seconds value is a decimal non-
  637. * negative integer. After delta-seconds seconds elapse, the
  638. * client should discard the cookie. A value of zero means the
  639. * cookie should be discarded immediately.
  640. */
  641. CURLofft offt;
  642. const char *maxage = valuep;
  643. offt = curlx_strtoofft((*maxage == '\"')?
  644. &maxage[1]:&maxage[0], NULL, 10,
  645. &co->expires);
  646. switch(offt) {
  647. case CURL_OFFT_FLOW:
  648. /* overflow, used max value */
  649. co->expires = CURL_OFF_T_MAX;
  650. break;
  651. case CURL_OFFT_INVAL:
  652. /* negative or otherwise bad, expire */
  653. co->expires = 1;
  654. break;
  655. case CURL_OFFT_OK:
  656. if(!co->expires)
  657. /* already expired */
  658. co->expires = 1;
  659. else if(CURL_OFF_T_MAX - now < co->expires)
  660. /* would overflow */
  661. co->expires = CURL_OFF_T_MAX;
  662. else
  663. co->expires += now;
  664. break;
  665. }
  666. }
  667. else if((nlen == 7) && strncasecompare("expires", namep, 7)) {
  668. char date[128];
  669. if(!co->expires && (vlen < sizeof(date))) {
  670. /* copy the date so that it can be null terminated */
  671. memcpy(date, valuep, vlen);
  672. date[vlen] = 0;
  673. /*
  674. * Let max-age have priority.
  675. *
  676. * If the date cannot get parsed for whatever reason, the cookie
  677. * will be treated as a session cookie
  678. */
  679. co->expires = Curl_getdate_capped(date);
  680. /*
  681. * Session cookies have expires set to 0 so if we get that back
  682. * from the date parser let's add a second to make it a
  683. * non-session cookie
  684. */
  685. if(co->expires == 0)
  686. co->expires = 1;
  687. else if(co->expires < 0)
  688. co->expires = 0;
  689. }
  690. }
  691. /*
  692. * Else, this is the second (or more) name we do not know about!
  693. */
  694. }
  695. else {
  696. /* this is an "illegal" <what>=<this> pair */
  697. }
  698. while(*ptr && ISBLANK(*ptr))
  699. ptr++;
  700. if(*ptr == ';')
  701. ptr++;
  702. else
  703. break;
  704. } while(1);
  705. if(!badcookie && !co->domain) {
  706. if(domain) {
  707. /* no domain was given in the header line, set the default */
  708. co->domain = strdup(domain);
  709. if(!co->domain)
  710. badcookie = TRUE;
  711. }
  712. }
  713. if(!badcookie && !co->path && path) {
  714. /*
  715. * No path was given in the header line, set the default. Note that the
  716. * passed-in path to this function MAY have a '?' and following part that
  717. * MUST NOT be stored as part of the path.
  718. */
  719. char *queryp = strchr(path, '?');
  720. /*
  721. * queryp is where the interesting part of the path ends, so now we
  722. * want to the find the last
  723. */
  724. char *endslash;
  725. if(!queryp)
  726. endslash = strrchr(path, '/');
  727. else
  728. endslash = memrchr(path, '/', (queryp - path));
  729. if(endslash) {
  730. size_t pathlen = (endslash-path + 1); /* include end slash */
  731. co->path = Curl_memdup0(path, pathlen);
  732. if(co->path) {
  733. co->spath = sanitize_cookie_path(co->path);
  734. if(!co->spath)
  735. badcookie = TRUE; /* out of memory bad */
  736. }
  737. else
  738. badcookie = TRUE;
  739. }
  740. }
  741. /*
  742. * If we did not get a cookie name, or a bad one, the this is an illegal
  743. * line so bail out.
  744. */
  745. if(badcookie || !co->name) {
  746. freecookie(co);
  747. return NULL;
  748. }
  749. data->req.setcookies++;
  750. }
  751. else {
  752. /*
  753. * This line is NOT an HTTP header style line, we do offer support for
  754. * reading the odd netscape cookies-file format here
  755. */
  756. char *ptr;
  757. char *firstptr;
  758. char *tok_buf = NULL;
  759. int fields;
  760. /*
  761. * IE introduced HTTP-only cookies to prevent XSS attacks. Cookies marked
  762. * with httpOnly after the domain name are not accessible from javascripts,
  763. * but since curl does not operate at javascript level, we include them
  764. * anyway. In Firefox's cookie files, these lines are preceded with
  765. * #HttpOnly_ and then everything is as usual, so we skip 10 characters of
  766. * the line..
  767. */
  768. if(strncmp(lineptr, "#HttpOnly_", 10) == 0) {
  769. lineptr += 10;
  770. co->httponly = TRUE;
  771. }
  772. if(lineptr[0]=='#') {
  773. /* do not even try the comments */
  774. free(co);
  775. return NULL;
  776. }
  777. /* strip off the possible end-of-line characters */
  778. ptr = strchr(lineptr, '\r');
  779. if(ptr)
  780. *ptr = 0; /* clear it */
  781. ptr = strchr(lineptr, '\n');
  782. if(ptr)
  783. *ptr = 0; /* clear it */
  784. firstptr = strtok_r((char *)lineptr, "\t", &tok_buf); /* tokenize on TAB */
  785. /*
  786. * Now loop through the fields and init the struct we already have
  787. * allocated
  788. */
  789. fields = 0;
  790. for(ptr = firstptr; ptr && !badcookie;
  791. ptr = strtok_r(NULL, "\t", &tok_buf), fields++) {
  792. switch(fields) {
  793. case 0:
  794. if(ptr[0]=='.') /* skip preceding dots */
  795. ptr++;
  796. co->domain = strdup(ptr);
  797. if(!co->domain)
  798. badcookie = TRUE;
  799. break;
  800. case 1:
  801. /*
  802. * flag: A TRUE/FALSE value indicating if all machines within a given
  803. * domain can access the variable. Set TRUE when the cookie says
  804. * .domain.com and to false when the domain is complete www.domain.com
  805. */
  806. co->tailmatch = strcasecompare(ptr, "TRUE") ? TRUE : FALSE;
  807. break;
  808. case 2:
  809. /* The file format allows the path field to remain not filled in */
  810. if(strcmp("TRUE", ptr) && strcmp("FALSE", ptr)) {
  811. /* only if the path does not look like a boolean option! */
  812. co->path = strdup(ptr);
  813. if(!co->path)
  814. badcookie = TRUE;
  815. else {
  816. co->spath = sanitize_cookie_path(co->path);
  817. if(!co->spath) {
  818. badcookie = TRUE; /* out of memory bad */
  819. }
  820. }
  821. break;
  822. }
  823. /* this does not look like a path, make one up! */
  824. co->path = strdup("/");
  825. if(!co->path)
  826. badcookie = TRUE;
  827. co->spath = strdup("/");
  828. if(!co->spath)
  829. badcookie = TRUE;
  830. fields++; /* add a field and fall down to secure */
  831. FALLTHROUGH();
  832. case 3:
  833. co->secure = FALSE;
  834. if(strcasecompare(ptr, "TRUE")) {
  835. if(secure || c->running)
  836. co->secure = TRUE;
  837. else
  838. badcookie = TRUE;
  839. }
  840. break;
  841. case 4:
  842. if(curlx_strtoofft(ptr, NULL, 10, &co->expires))
  843. badcookie = TRUE;
  844. break;
  845. case 5:
  846. co->name = strdup(ptr);
  847. if(!co->name)
  848. badcookie = TRUE;
  849. else {
  850. /* For Netscape file format cookies we check prefix on the name */
  851. if(strncasecompare("__Secure-", co->name, 9))
  852. co->prefix |= COOKIE_PREFIX__SECURE;
  853. else if(strncasecompare("__Host-", co->name, 7))
  854. co->prefix |= COOKIE_PREFIX__HOST;
  855. }
  856. break;
  857. case 6:
  858. co->value = strdup(ptr);
  859. if(!co->value)
  860. badcookie = TRUE;
  861. break;
  862. }
  863. }
  864. if(6 == fields) {
  865. /* we got a cookie with blank contents, fix it */
  866. co->value = strdup("");
  867. if(!co->value)
  868. badcookie = TRUE;
  869. else
  870. fields++;
  871. }
  872. if(!badcookie && (7 != fields))
  873. /* we did not find the sufficient number of fields */
  874. badcookie = TRUE;
  875. if(badcookie) {
  876. freecookie(co);
  877. return NULL;
  878. }
  879. }
  880. if(co->prefix & COOKIE_PREFIX__SECURE) {
  881. /* The __Secure- prefix only requires that the cookie be set secure */
  882. if(!co->secure) {
  883. freecookie(co);
  884. return NULL;
  885. }
  886. }
  887. if(co->prefix & COOKIE_PREFIX__HOST) {
  888. /*
  889. * The __Host- prefix requires the cookie to be secure, have a "/" path
  890. * and not have a domain set.
  891. */
  892. if(co->secure && co->path && strcmp(co->path, "/") == 0 && !co->tailmatch)
  893. ;
  894. else {
  895. freecookie(co);
  896. return NULL;
  897. }
  898. }
  899. if(!c->running && /* read from a file */
  900. c->newsession && /* clean session cookies */
  901. !co->expires) { /* this is a session cookie since it does not expire! */
  902. freecookie(co);
  903. return NULL;
  904. }
  905. co->livecookie = c->running;
  906. co->creationtime = ++c->lastct;
  907. /*
  908. * Now we have parsed the incoming line, we must now check if this supersedes
  909. * an already existing cookie, which it may if the previous have the same
  910. * domain and path as this.
  911. */
  912. /* at first, remove expired cookies */
  913. if(!noexpire)
  914. remove_expired(c);
  915. #ifdef USE_LIBPSL
  916. /*
  917. * Check if the domain is a Public Suffix and if yes, ignore the cookie. We
  918. * must also check that the data handle is not NULL since the psl code will
  919. * dereference it.
  920. */
  921. DEBUGF(infof(data, "PSL check set-cookie '%s' for domain=%s in %s",
  922. co->name, co->domain, domain));
  923. if(data && (domain && co->domain && !Curl_host_is_ipnum(co->domain))) {
  924. bool acceptable = FALSE;
  925. char lcase[256];
  926. char lcookie[256];
  927. size_t dlen = strlen(domain);
  928. size_t clen = strlen(co->domain);
  929. if((dlen < sizeof(lcase)) && (clen < sizeof(lcookie))) {
  930. const psl_ctx_t *psl = Curl_psl_use(data);
  931. if(psl) {
  932. /* the PSL check requires lowercase domain name and pattern */
  933. Curl_strntolower(lcase, domain, dlen + 1);
  934. Curl_strntolower(lcookie, co->domain, clen + 1);
  935. acceptable = psl_is_cookie_domain_acceptable(psl, lcase, lcookie);
  936. Curl_psl_release(data);
  937. }
  938. else
  939. infof(data, "libpsl problem, rejecting cookie for satety");
  940. }
  941. if(!acceptable) {
  942. infof(data, "cookie '%s' dropped, domain '%s' must not "
  943. "set cookies for '%s'", co->name, domain, co->domain);
  944. freecookie(co);
  945. return NULL;
  946. }
  947. }
  948. #else
  949. DEBUGF(infof(data, "NO PSL to check set-cookie '%s' for domain=%s in %s",
  950. co->name, co->domain, domain));
  951. #endif
  952. /* A non-secure cookie may not overlay an existing secure cookie. */
  953. myhash = cookiehash(co->domain);
  954. clist = c->cookies[myhash];
  955. while(clist) {
  956. if(strcasecompare(clist->name, co->name)) {
  957. /* the names are identical */
  958. bool matching_domains = FALSE;
  959. if(clist->domain && co->domain) {
  960. if(strcasecompare(clist->domain, co->domain))
  961. /* The domains are identical */
  962. matching_domains = TRUE;
  963. }
  964. else if(!clist->domain && !co->domain)
  965. matching_domains = TRUE;
  966. if(matching_domains && /* the domains were identical */
  967. clist->spath && co->spath && /* both have paths */
  968. clist->secure && !co->secure && !secure) {
  969. size_t cllen;
  970. const char *sep;
  971. /*
  972. * A non-secure cookie may not overlay an existing secure cookie.
  973. * For an existing cookie "a" with path "/login", refuse a new
  974. * cookie "a" with for example path "/login/en", while the path
  975. * "/loginhelper" is ok.
  976. */
  977. sep = strchr(clist->spath + 1, '/');
  978. if(sep)
  979. cllen = sep - clist->spath;
  980. else
  981. cllen = strlen(clist->spath);
  982. if(strncasecompare(clist->spath, co->spath, cllen)) {
  983. infof(data, "cookie '%s' for domain '%s' dropped, would "
  984. "overlay an existing cookie", co->name, co->domain);
  985. freecookie(co);
  986. return NULL;
  987. }
  988. }
  989. }
  990. if(!replace_co && strcasecompare(clist->name, co->name)) {
  991. /* the names are identical */
  992. if(clist->domain && co->domain) {
  993. if(strcasecompare(clist->domain, co->domain) &&
  994. (clist->tailmatch == co->tailmatch))
  995. /* The domains are identical */
  996. replace_old = TRUE;
  997. }
  998. else if(!clist->domain && !co->domain)
  999. replace_old = TRUE;
  1000. if(replace_old) {
  1001. /* the domains were identical */
  1002. if(clist->spath && co->spath &&
  1003. !strcasecompare(clist->spath, co->spath))
  1004. replace_old = FALSE;
  1005. else if(!clist->spath != !co->spath)
  1006. replace_old = FALSE;
  1007. }
  1008. if(replace_old && !co->livecookie && clist->livecookie) {
  1009. /*
  1010. * Both cookies matched fine, except that the already present cookie
  1011. * is "live", which means it was set from a header, while the new one
  1012. * was read from a file and thus is not "live". "live" cookies are
  1013. * preferred so the new cookie is freed.
  1014. */
  1015. freecookie(co);
  1016. return NULL;
  1017. }
  1018. if(replace_old) {
  1019. replace_co = co;
  1020. replace_clist = clist;
  1021. }
  1022. }
  1023. lastc = clist;
  1024. clist = clist->next;
  1025. }
  1026. if(replace_co) {
  1027. co = replace_co;
  1028. clist = replace_clist;
  1029. co->next = clist->next; /* get the next-pointer first */
  1030. /* when replacing, creationtime is kept from old */
  1031. co->creationtime = clist->creationtime;
  1032. /* then free all the old pointers */
  1033. free(clist->name);
  1034. free(clist->value);
  1035. free(clist->domain);
  1036. free(clist->path);
  1037. free(clist->spath);
  1038. *clist = *co; /* then store all the new data */
  1039. free(co); /* free the newly allocated memory */
  1040. co = clist;
  1041. }
  1042. if(c->running)
  1043. /* Only show this when NOT reading the cookies from a file */
  1044. infof(data, "%s cookie %s=\"%s\" for domain %s, path %s, "
  1045. "expire %" FMT_OFF_T,
  1046. replace_old?"Replaced":"Added", co->name, co->value,
  1047. co->domain, co->path, co->expires);
  1048. if(!replace_old) {
  1049. /* then make the last item point on this new one */
  1050. if(lastc)
  1051. lastc->next = co;
  1052. else
  1053. c->cookies[myhash] = co;
  1054. c->numcookies++; /* one more cookie in the jar */
  1055. }
  1056. /*
  1057. * Now that we have added a new cookie to the jar, update the expiration
  1058. * tracker in case it is the next one to expire.
  1059. */
  1060. if(co->expires && (co->expires < c->next_expiration))
  1061. c->next_expiration = co->expires;
  1062. return co;
  1063. }
  1064. /*
  1065. * Curl_cookie_init()
  1066. *
  1067. * Inits a cookie struct to read data from a local file. This is always
  1068. * called before any cookies are set. File may be NULL in which case only the
  1069. * struct is initialized. Is file is "-" then STDIN is read.
  1070. *
  1071. * If 'newsession' is TRUE, discard all "session cookies" on read from file.
  1072. *
  1073. * Note that 'data' might be called as NULL pointer. If data is NULL, 'file'
  1074. * will be ignored.
  1075. *
  1076. * Returns NULL on out of memory. Invalid cookies are ignored.
  1077. */
  1078. struct CookieInfo *Curl_cookie_init(struct Curl_easy *data,
  1079. const char *file,
  1080. struct CookieInfo *inc,
  1081. bool newsession)
  1082. {
  1083. struct CookieInfo *c;
  1084. FILE *handle = NULL;
  1085. if(!inc) {
  1086. /* we did not get a struct, create one */
  1087. c = calloc(1, sizeof(struct CookieInfo));
  1088. if(!c)
  1089. return NULL; /* failed to get memory */
  1090. /*
  1091. * Initialize the next_expiration time to signal that we do not have enough
  1092. * information yet.
  1093. */
  1094. c->next_expiration = CURL_OFF_T_MAX;
  1095. }
  1096. else {
  1097. /* we got an already existing one, use that */
  1098. c = inc;
  1099. }
  1100. c->newsession = newsession; /* new session? */
  1101. if(data) {
  1102. FILE *fp = NULL;
  1103. if(file && *file) {
  1104. if(!strcmp(file, "-"))
  1105. fp = stdin;
  1106. else {
  1107. fp = fopen(file, "rb");
  1108. if(!fp)
  1109. infof(data, "WARNING: failed to open cookie file \"%s\"", file);
  1110. else
  1111. handle = fp;
  1112. }
  1113. }
  1114. c->running = FALSE; /* this is not running, this is init */
  1115. if(fp) {
  1116. struct dynbuf buf;
  1117. Curl_dyn_init(&buf, MAX_COOKIE_LINE);
  1118. while(Curl_get_line(&buf, fp)) {
  1119. char *lineptr = Curl_dyn_ptr(&buf);
  1120. bool headerline = FALSE;
  1121. if(checkprefix("Set-Cookie:", lineptr)) {
  1122. /* This is a cookie line, get it! */
  1123. lineptr += 11;
  1124. headerline = TRUE;
  1125. while(*lineptr && ISBLANK(*lineptr))
  1126. lineptr++;
  1127. }
  1128. Curl_cookie_add(data, c, headerline, TRUE, lineptr, NULL, NULL, TRUE);
  1129. }
  1130. Curl_dyn_free(&buf); /* free the line buffer */
  1131. /*
  1132. * Remove expired cookies from the hash. We must make sure to run this
  1133. * after reading the file, and not on every cookie.
  1134. */
  1135. remove_expired(c);
  1136. if(handle)
  1137. fclose(handle);
  1138. }
  1139. data->state.cookie_engine = TRUE;
  1140. }
  1141. c->running = TRUE; /* now, we are running */
  1142. return c;
  1143. }
  1144. /*
  1145. * cookie_sort
  1146. *
  1147. * Helper function to sort cookies such that the longest path gets before the
  1148. * shorter path. Path, domain and name lengths are considered in that order,
  1149. * with the creationtime as the tiebreaker. The creationtime is guaranteed to
  1150. * be unique per cookie, so we know we will get an ordering at that point.
  1151. */
  1152. static int cookie_sort(const void *p1, const void *p2)
  1153. {
  1154. struct Cookie *c1 = *(struct Cookie **)p1;
  1155. struct Cookie *c2 = *(struct Cookie **)p2;
  1156. size_t l1, l2;
  1157. /* 1 - compare cookie path lengths */
  1158. l1 = c1->path ? strlen(c1->path) : 0;
  1159. l2 = c2->path ? strlen(c2->path) : 0;
  1160. if(l1 != l2)
  1161. return (l2 > l1) ? 1 : -1 ; /* avoid size_t <=> int conversions */
  1162. /* 2 - compare cookie domain lengths */
  1163. l1 = c1->domain ? strlen(c1->domain) : 0;
  1164. l2 = c2->domain ? strlen(c2->domain) : 0;
  1165. if(l1 != l2)
  1166. return (l2 > l1) ? 1 : -1 ; /* avoid size_t <=> int conversions */
  1167. /* 3 - compare cookie name lengths */
  1168. l1 = c1->name ? strlen(c1->name) : 0;
  1169. l2 = c2->name ? strlen(c2->name) : 0;
  1170. if(l1 != l2)
  1171. return (l2 > l1) ? 1 : -1;
  1172. /* 4 - compare cookie creation time */
  1173. return (c2->creationtime > c1->creationtime) ? 1 : -1;
  1174. }
  1175. /*
  1176. * cookie_sort_ct
  1177. *
  1178. * Helper function to sort cookies according to creation time.
  1179. */
  1180. static int cookie_sort_ct(const void *p1, const void *p2)
  1181. {
  1182. struct Cookie *c1 = *(struct Cookie **)p1;
  1183. struct Cookie *c2 = *(struct Cookie **)p2;
  1184. return (c2->creationtime > c1->creationtime) ? 1 : -1;
  1185. }
  1186. #define CLONE(field) \
  1187. do { \
  1188. if(src->field) { \
  1189. d->field = strdup(src->field); \
  1190. if(!d->field) \
  1191. goto fail; \
  1192. } \
  1193. } while(0)
  1194. static struct Cookie *dup_cookie(struct Cookie *src)
  1195. {
  1196. struct Cookie *d = calloc(1, sizeof(struct Cookie));
  1197. if(d) {
  1198. CLONE(domain);
  1199. CLONE(path);
  1200. CLONE(spath);
  1201. CLONE(name);
  1202. CLONE(value);
  1203. d->expires = src->expires;
  1204. d->tailmatch = src->tailmatch;
  1205. d->secure = src->secure;
  1206. d->livecookie = src->livecookie;
  1207. d->httponly = src->httponly;
  1208. d->creationtime = src->creationtime;
  1209. }
  1210. return d;
  1211. fail:
  1212. freecookie(d);
  1213. return NULL;
  1214. }
  1215. /*
  1216. * Curl_cookie_getlist
  1217. *
  1218. * For a given host and path, return a linked list of cookies that the client
  1219. * should send to the server if used now. The secure boolean informs the cookie
  1220. * if a secure connection is achieved or not.
  1221. *
  1222. * It shall only return cookies that have not expired.
  1223. */
  1224. struct Cookie *Curl_cookie_getlist(struct Curl_easy *data,
  1225. struct CookieInfo *c,
  1226. const char *host, const char *path,
  1227. bool secure)
  1228. {
  1229. struct Cookie *newco;
  1230. struct Cookie *co;
  1231. struct Cookie *mainco = NULL;
  1232. size_t matches = 0;
  1233. bool is_ip;
  1234. const size_t myhash = cookiehash(host);
  1235. if(!c || !c->cookies[myhash])
  1236. return NULL; /* no cookie struct or no cookies in the struct */
  1237. /* at first, remove expired cookies */
  1238. remove_expired(c);
  1239. /* check if host is an IP(v4|v6) address */
  1240. is_ip = Curl_host_is_ipnum(host);
  1241. co = c->cookies[myhash];
  1242. while(co) {
  1243. /* if the cookie requires we are secure we must only continue if we are! */
  1244. if(co->secure ? secure : TRUE) {
  1245. /* now check if the domain is correct */
  1246. if(!co->domain ||
  1247. (co->tailmatch && !is_ip &&
  1248. cookie_tailmatch(co->domain, strlen(co->domain), host)) ||
  1249. ((!co->tailmatch || is_ip) && strcasecompare(host, co->domain)) ) {
  1250. /*
  1251. * the right part of the host matches the domain stuff in the
  1252. * cookie data
  1253. */
  1254. /*
  1255. * now check the left part of the path with the cookies path
  1256. * requirement
  1257. */
  1258. if(!co->spath || pathmatch(co->spath, path) ) {
  1259. /*
  1260. * and now, we know this is a match and we should create an
  1261. * entry for the return-linked-list
  1262. */
  1263. newco = dup_cookie(co);
  1264. if(newco) {
  1265. /* then modify our next */
  1266. newco->next = mainco;
  1267. /* point the main to us */
  1268. mainco = newco;
  1269. matches++;
  1270. if(matches >= MAX_COOKIE_SEND_AMOUNT) {
  1271. infof(data, "Included max number of cookies (%zu) in request!",
  1272. matches);
  1273. break;
  1274. }
  1275. }
  1276. else
  1277. goto fail;
  1278. }
  1279. }
  1280. }
  1281. co = co->next;
  1282. }
  1283. if(matches) {
  1284. /*
  1285. * Now we need to make sure that if there is a name appearing more than
  1286. * once, the longest specified path version comes first. To make this
  1287. * the swiftest way, we just sort them all based on path length.
  1288. */
  1289. struct Cookie **array;
  1290. size_t i;
  1291. /* alloc an array and store all cookie pointers */
  1292. array = malloc(sizeof(struct Cookie *) * matches);
  1293. if(!array)
  1294. goto fail;
  1295. co = mainco;
  1296. for(i = 0; co; co = co->next)
  1297. array[i++] = co;
  1298. /* now sort the cookie pointers in path length order */
  1299. qsort(array, matches, sizeof(struct Cookie *), cookie_sort);
  1300. /* remake the linked list order according to the new order */
  1301. mainco = array[0]; /* start here */
  1302. for(i = 0; i<matches-1; i++)
  1303. array[i]->next = array[i + 1];
  1304. array[matches-1]->next = NULL; /* terminate the list */
  1305. free(array); /* remove the temporary data again */
  1306. }
  1307. return mainco; /* return the new list */
  1308. fail:
  1309. /* failure, clear up the allocated chain and return NULL */
  1310. Curl_cookie_freelist(mainco);
  1311. return NULL;
  1312. }
  1313. /*
  1314. * Curl_cookie_clearall
  1315. *
  1316. * Clear all existing cookies and reset the counter.
  1317. */
  1318. void Curl_cookie_clearall(struct CookieInfo *cookies)
  1319. {
  1320. if(cookies) {
  1321. unsigned int i;
  1322. for(i = 0; i < COOKIE_HASH_SIZE; i++) {
  1323. Curl_cookie_freelist(cookies->cookies[i]);
  1324. cookies->cookies[i] = NULL;
  1325. }
  1326. cookies->numcookies = 0;
  1327. }
  1328. }
  1329. /*
  1330. * Curl_cookie_freelist
  1331. *
  1332. * Free a list of cookies previously returned by Curl_cookie_getlist();
  1333. */
  1334. void Curl_cookie_freelist(struct Cookie *co)
  1335. {
  1336. struct Cookie *next;
  1337. while(co) {
  1338. next = co->next;
  1339. freecookie(co);
  1340. co = next;
  1341. }
  1342. }
  1343. /*
  1344. * Curl_cookie_clearsess
  1345. *
  1346. * Free all session cookies in the cookies list.
  1347. */
  1348. void Curl_cookie_clearsess(struct CookieInfo *cookies)
  1349. {
  1350. struct Cookie *first, *curr, *next, *prev = NULL;
  1351. unsigned int i;
  1352. if(!cookies)
  1353. return;
  1354. for(i = 0; i < COOKIE_HASH_SIZE; i++) {
  1355. if(!cookies->cookies[i])
  1356. continue;
  1357. first = curr = prev = cookies->cookies[i];
  1358. for(; curr; curr = next) {
  1359. next = curr->next;
  1360. if(!curr->expires) {
  1361. if(first == curr)
  1362. first = next;
  1363. if(prev == curr)
  1364. prev = next;
  1365. else
  1366. prev->next = next;
  1367. freecookie(curr);
  1368. cookies->numcookies--;
  1369. }
  1370. else
  1371. prev = curr;
  1372. }
  1373. cookies->cookies[i] = first;
  1374. }
  1375. }
  1376. /*
  1377. * Curl_cookie_cleanup()
  1378. *
  1379. * Free a "cookie object" previous created with Curl_cookie_init().
  1380. */
  1381. void Curl_cookie_cleanup(struct CookieInfo *c)
  1382. {
  1383. if(c) {
  1384. unsigned int i;
  1385. for(i = 0; i < COOKIE_HASH_SIZE; i++)
  1386. Curl_cookie_freelist(c->cookies[i]);
  1387. free(c); /* free the base struct as well */
  1388. }
  1389. }
  1390. /*
  1391. * get_netscape_format()
  1392. *
  1393. * Formats a string for Netscape output file, w/o a newline at the end.
  1394. * Function returns a char * to a formatted line. The caller is responsible
  1395. * for freeing the returned pointer.
  1396. */
  1397. static char *get_netscape_format(const struct Cookie *co)
  1398. {
  1399. return aprintf(
  1400. "%s" /* httponly preamble */
  1401. "%s%s\t" /* domain */
  1402. "%s\t" /* tailmatch */
  1403. "%s\t" /* path */
  1404. "%s\t" /* secure */
  1405. "%" FMT_OFF_T "\t" /* expires */
  1406. "%s\t" /* name */
  1407. "%s", /* value */
  1408. co->httponly?"#HttpOnly_":"",
  1409. /*
  1410. * Make sure all domains are prefixed with a dot if they allow
  1411. * tailmatching. This is Mozilla-style.
  1412. */
  1413. (co->tailmatch && co->domain && co->domain[0] != '.')? ".":"",
  1414. co->domain?co->domain:"unknown",
  1415. co->tailmatch?"TRUE":"FALSE",
  1416. co->path?co->path:"/",
  1417. co->secure?"TRUE":"FALSE",
  1418. co->expires,
  1419. co->name,
  1420. co->value?co->value:"");
  1421. }
  1422. /*
  1423. * cookie_output()
  1424. *
  1425. * Writes all internally known cookies to the specified file. Specify
  1426. * "-" as filename to write to stdout.
  1427. *
  1428. * The function returns non-zero on write failure.
  1429. */
  1430. static CURLcode cookie_output(struct Curl_easy *data,
  1431. struct CookieInfo *c, const char *filename)
  1432. {
  1433. struct Cookie *co;
  1434. FILE *out = NULL;
  1435. bool use_stdout = FALSE;
  1436. char *tempstore = NULL;
  1437. CURLcode error = CURLE_OK;
  1438. if(!c)
  1439. /* no cookie engine alive */
  1440. return CURLE_OK;
  1441. /* at first, remove expired cookies */
  1442. remove_expired(c);
  1443. if(!strcmp("-", filename)) {
  1444. /* use stdout */
  1445. out = stdout;
  1446. use_stdout = TRUE;
  1447. }
  1448. else {
  1449. error = Curl_fopen(data, filename, &out, &tempstore);
  1450. if(error)
  1451. goto error;
  1452. }
  1453. fputs("# Netscape HTTP Cookie File\n"
  1454. "# https://curl.se/docs/http-cookies.html\n"
  1455. "# This file was generated by libcurl! Edit at your own risk.\n\n",
  1456. out);
  1457. if(c->numcookies) {
  1458. unsigned int i;
  1459. size_t nvalid = 0;
  1460. struct Cookie **array;
  1461. array = calloc(1, sizeof(struct Cookie *) * c->numcookies);
  1462. if(!array) {
  1463. error = CURLE_OUT_OF_MEMORY;
  1464. goto error;
  1465. }
  1466. /* only sort the cookies with a domain property */
  1467. for(i = 0; i < COOKIE_HASH_SIZE; i++) {
  1468. for(co = c->cookies[i]; co; co = co->next) {
  1469. if(!co->domain)
  1470. continue;
  1471. array[nvalid++] = co;
  1472. }
  1473. }
  1474. qsort(array, nvalid, sizeof(struct Cookie *), cookie_sort_ct);
  1475. for(i = 0; i < nvalid; i++) {
  1476. char *format_ptr = get_netscape_format(array[i]);
  1477. if(!format_ptr) {
  1478. free(array);
  1479. error = CURLE_OUT_OF_MEMORY;
  1480. goto error;
  1481. }
  1482. fprintf(out, "%s\n", format_ptr);
  1483. free(format_ptr);
  1484. }
  1485. free(array);
  1486. }
  1487. if(!use_stdout) {
  1488. fclose(out);
  1489. out = NULL;
  1490. if(tempstore && Curl_rename(tempstore, filename)) {
  1491. unlink(tempstore);
  1492. error = CURLE_WRITE_ERROR;
  1493. goto error;
  1494. }
  1495. }
  1496. /*
  1497. * If we reach here we have successfully written a cookie file so there is
  1498. * no need to inspect the error, any error case should have jumped into the
  1499. * error block below.
  1500. */
  1501. free(tempstore);
  1502. return CURLE_OK;
  1503. error:
  1504. if(out && !use_stdout)
  1505. fclose(out);
  1506. free(tempstore);
  1507. return error;
  1508. }
  1509. static struct curl_slist *cookie_list(struct Curl_easy *data)
  1510. {
  1511. struct curl_slist *list = NULL;
  1512. struct curl_slist *beg;
  1513. struct Cookie *c;
  1514. char *line;
  1515. unsigned int i;
  1516. if(!data->cookies || (data->cookies->numcookies == 0))
  1517. return NULL;
  1518. for(i = 0; i < COOKIE_HASH_SIZE; i++) {
  1519. for(c = data->cookies->cookies[i]; c; c = c->next) {
  1520. if(!c->domain)
  1521. continue;
  1522. line = get_netscape_format(c);
  1523. if(!line) {
  1524. curl_slist_free_all(list);
  1525. return NULL;
  1526. }
  1527. beg = Curl_slist_append_nodup(list, line);
  1528. if(!beg) {
  1529. free(line);
  1530. curl_slist_free_all(list);
  1531. return NULL;
  1532. }
  1533. list = beg;
  1534. }
  1535. }
  1536. return list;
  1537. }
  1538. struct curl_slist *Curl_cookie_list(struct Curl_easy *data)
  1539. {
  1540. struct curl_slist *list;
  1541. Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
  1542. list = cookie_list(data);
  1543. Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
  1544. return list;
  1545. }
  1546. void Curl_flush_cookies(struct Curl_easy *data, bool cleanup)
  1547. {
  1548. CURLcode res;
  1549. if(data->set.str[STRING_COOKIEJAR]) {
  1550. Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
  1551. /* if we have a destination file for all the cookies to get dumped to */
  1552. res = cookie_output(data, data->cookies, data->set.str[STRING_COOKIEJAR]);
  1553. if(res)
  1554. infof(data, "WARNING: failed to save cookies in %s: %s",
  1555. data->set.str[STRING_COOKIEJAR], curl_easy_strerror(res));
  1556. }
  1557. else {
  1558. Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
  1559. }
  1560. if(cleanup && (!data->share || (data->cookies != data->share->cookies))) {
  1561. Curl_cookie_cleanup(data->cookies);
  1562. data->cookies = NULL;
  1563. }
  1564. Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
  1565. }
  1566. #endif /* CURL_DISABLE_HTTP || CURL_DISABLE_COOKIES */