cookie.c 49 KB

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