1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2009, Daniel Stenberg, <daniel@haxx.se>, et al.
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 http://curl.haxx.se/docs/copyright.html.
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.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
22 ***************************************************************************/
27 RECEIVING COOKIE INFORMATION
28 ============================
30 struct CookieInfo *cookie_init(char *file);
32 Inits a cookie struct to store data in a local file. This is always
33 called before any cookies are set.
35 int cookies_set(struct CookieInfo *cookie, char *cookie_line);
37 The 'cookie_line' parameter is a full "Set-cookie:" line as
38 received from a server.
40 The function need to replace previously stored lines that this new
43 It may remove lines that are expired.
45 It should return an indication of success/error.
48 SENDING COOKIE INFORMATION
49 ==========================
51 struct Cookies *cookie_getlist(struct CookieInfo *cookie,
52 char *host, char *path, bool secure);
54 For a given host and path, return a linked list of cookies that
55 the client should send to the server if used now. The secure
56 boolean informs the cookie if a secure connection is achieved or
59 It shall only return cookies that haven't expired.
62 Example set of cookies:
64 Set-cookie: PRODUCTINFO=webxpress; domain=.fidelity.com; path=/; secure
65 Set-cookie: PERSONALIZE=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
66 domain=.fidelity.com; path=/ftgw; secure
67 Set-cookie: FidHist=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
68 domain=.fidelity.com; path=/; secure
69 Set-cookie: FidOrder=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
70 domain=.fidelity.com; path=/; secure
71 Set-cookie: DisPend=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
72 domain=.fidelity.com; path=/; secure
73 Set-cookie: FidDis=none;expires=Monday, 13-Jun-1988 03:04:55 GMT;
74 domain=.fidelity.com; path=/; secure
76 Session_Key@6791a9e0-901a-11d0-a1c8-9b012c88aa77=none;expires=Monday,
77 13-Jun-1988 03:04:55 GMT; domain=.fidelity.com; path=/; secure
83 #if !defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_COOKIES)
88 #define _MPRINTF_REPLACE /* without this on windows OS we get undefined reference to snprintf */
89 #include <curl/mprintf.h>
96 #include "curl_memory.h"
98 #include "strtoofft.h"
101 /* The last #include file should be: */
102 #include "memdebug.h"
105 static void freecookie(struct Cookie *co)
125 static bool tailmatch(const char *little, const char *bigone)
127 size_t littlelen = strlen(little);
128 size_t biglen = strlen(bigone);
130 if(littlelen > biglen)
133 return (bool)Curl_raw_equal(little, bigone+biglen-littlelen);
137 * Load cookies from all given cookie files (CURLOPT_COOKIEFILE).
139 void Curl_cookie_loadfiles(struct SessionHandle *data)
141 struct curl_slist *list = data->change.cookielist;
143 Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
145 data->cookies = Curl_cookie_init(data,
148 data->set.cookiesession);
151 Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
152 curl_slist_free_all(data->change.cookielist); /* clean up list */
153 data->change.cookielist = NULL; /* don't do this again! */
158 * strstore() makes a strdup() on the 'newstr' and if '*str' is non-NULL
159 * that will be freed before the allocated string is stored there.
161 * It is meant to easily replace strdup()
163 static void strstore(char **str, const char *newstr)
167 *str = strdup(newstr);
170 /****************************************************************************
174 * Add a single cookie line to the cookie keeping object.
176 ***************************************************************************/
179 Curl_cookie_add(struct SessionHandle *data,
180 /* The 'data' pointer here may be NULL at times, and thus
181 must only be used very carefully for things that can deal
182 with data being NULL. Such as infof() and similar */
184 struct CookieInfo *c,
185 bool httpheader, /* TRUE if HTTP header-style line */
186 char *lineptr, /* first character of the line */
187 const char *domain, /* default domain */
188 const char *path) /* full path used when this cookie is set,
189 used to get default path for the cookie
192 struct Cookie *clist;
195 struct Cookie *lastc=NULL;
196 time_t now = time(NULL);
197 bool replace_old = FALSE;
198 bool badcookie = FALSE; /* cookies are good by default. mmmmm yummy */
200 #ifdef CURL_DISABLE_VERBOSE_STRINGS
204 /* First, alloc and init a new struct for it */
205 co = calloc(sizeof(struct Cookie), 1);
207 return NULL; /* bail out if we're this low on memory */
210 /* This line was read off a HTTP-header */
216 what = malloc(MAX_COOKIE_LINE);
222 semiptr=strchr(lineptr, ';'); /* first, find a semicolon */
224 while(*lineptr && ISBLANK(*lineptr))
229 /* we have a <what>=<this> pair or a 'secure' word here */
230 sep = strchr(ptr, '=');
231 if(sep && (!semiptr || (semiptr>sep)) ) {
233 * There is a = sign and if there was a semicolon too, which make sure
234 * that the semicolon comes _after_ the equal sign.
237 name[0]=what[0]=0; /* init the buffers */
238 if(1 <= sscanf(ptr, "%" MAX_NAME_TXT "[^;=]=%"
239 MAX_COOKIE_LINE_TXT "[^;\r\n]",
241 /* this is a <name>=<what> pair. We use strstore() below to properly
242 deal with received cookie headers that have the same string
243 property set more than once, and then we use the last one. */
247 /* Strip off trailing whitespace from the 'what' */
248 size_t len=strlen(what);
249 while(len && ISBLANK(what[len-1])) {
254 /* Skip leading whitespace from the 'what' */
256 while(*whatptr && ISBLANK(*whatptr)) {
260 if(Curl_raw_equal("path", name)) {
261 strstore(&co->path, whatptr);
263 badcookie = TRUE; /* out of memory bad */
267 else if(Curl_raw_equal("domain", name)) {
268 /* note that this name may or may not have a preceeding dot, but
269 we don't care about that, we treat the names the same anyway */
271 const char *domptr=whatptr;
274 /* Count the dots, we need to make sure that there are enough
277 if('.' == whatptr[0])
278 /* don't count the initial dot, assume it */
282 domptr = strchr(domptr, '.');
289 /* The original Netscape cookie spec defined that this domain name
290 MUST have three dots (or two if one of the seven holy TLDs),
291 but it seems that these kinds of cookies are in use "out there"
292 so we cannot be that strict. I've therefore lowered the check
293 to not allow less than two dots. */
296 /* Received and skipped a cookie with a domain using too few
298 badcookie=TRUE; /* mark this as a bad cookie */
299 infof(data, "skipped cookie with illegal dotcount domain: %s\n",
303 /* Now, we make sure that our host is within the given domain,
304 or the given domain is not valid and thus cannot be set. */
306 if('.' == whatptr[0])
307 whatptr++; /* ignore preceeding dot */
309 if(!domain || tailmatch(whatptr, domain)) {
310 const char *tailptr=whatptr;
311 if(tailptr[0] == '.')
313 strstore(&co->domain, tailptr); /* don't prefix w/dots
319 co->tailmatch=TRUE; /* we always do that if the domain name was
323 /* we did not get a tailmatch and then the attempted set domain
324 is not a domain to which the current host belongs. Mark as
327 infof(data, "skipped cookie with bad tailmatch domain: %s\n",
332 else if(Curl_raw_equal("version", name)) {
333 strstore(&co->version, whatptr);
339 else if(Curl_raw_equal("max-age", name)) {
340 /* Defined in RFC2109:
342 Optional. The Max-Age attribute defines the lifetime of the
343 cookie, in seconds. The delta-seconds value is a decimal non-
344 negative integer. After delta-seconds seconds elapse, the
345 client should discard the cookie. A value of zero means the
346 cookie should be discarded immediately.
349 strstore(&co->maxage, whatptr);
355 atoi((*co->maxage=='\"')?&co->maxage[1]:&co->maxage[0]) +
358 else if(Curl_raw_equal("expires", name)) {
359 strstore(&co->expirestr, whatptr);
364 /* Note that we store -1 in 'expires' here if the date couldn't
365 get parsed for whatever reason. This will have the effect that
366 the cookie won't match. */
367 co->expires = curl_getdate(what, &now);
369 /* Session cookies have expires set to 0 so if we get that back
370 from the date parser let's add a second to make it a
371 non-session cookie */
372 if (co->expires == 0)
376 co->name = strdup(name);
377 co->value = strdup(whatptr);
378 if(!co->name || !co->value) {
384 else this is the second (or more) name we don't know
388 /* this is an "illegal" <what>=<this> pair */
392 if(sscanf(ptr, "%" MAX_COOKIE_LINE_TXT "[^;\r\n]",
394 if(Curl_raw_equal("secure", what)) {
397 else if (Curl_raw_equal("httponly", what)) {
401 unsupported keyword without assign! */
405 if(!semiptr || !*semiptr) {
406 /* we already know there are no more cookies */
412 while(*ptr && ISBLANK(*ptr))
414 semiptr=strchr(ptr, ';'); /* now, find the next semicolon */
417 /* There are no more semicolons, but there's a final name=value pair
419 semiptr=strchr(ptr, '\0');
422 if(!badcookie && !co->domain) {
424 /* no domain was given in the header line, set the default */
425 co->domain=strdup(domain);
431 if(!badcookie && !co->path && path) {
432 /* no path was given in the header line, set the default */
433 char *endslash = strrchr(path, '/');
435 size_t pathlen = endslash-path+1; /* include the ending slash */
436 co->path=malloc(pathlen+1); /* one extra for the zero byte */
438 memcpy(co->path, path, pathlen);
439 co->path[pathlen]=0; /* zero terminate */
448 if(badcookie || !co->name) {
449 /* we didn't get a cookie name or a bad one,
450 this is an illegal line, bail out */
457 /* This line is NOT a HTTP header style line, we do offer support for
458 reading the odd netscape cookies-file format here */
464 /* IE introduced HTTP-only cookies to prevent XSS attacks. Cookies
465 marked with httpOnly after the domain name are not accessible
466 from javascripts, but since curl does not operate at javascript
467 level, we include them anyway. In Firefox's cookie files, these
468 lines are preceeded with #HttpOnly_ and then everything is
469 as usual, so we skip 10 characters of the line..
471 if (strncmp(lineptr, "#HttpOnly_", 10) == 0) {
476 if(lineptr[0]=='#') {
477 /* don't even try the comments */
481 /* strip off the possible end-of-line characters */
482 ptr=strchr(lineptr, '\r');
484 *ptr=0; /* clear it */
485 ptr=strchr(lineptr, '\n');
487 *ptr=0; /* clear it */
489 firstptr=strtok_r(lineptr, "\t", &tok_buf); /* tokenize it on the TAB */
491 /* Here's a quick check to eliminate normal HTTP-headers from this */
492 if(!firstptr || strchr(firstptr, ':')) {
497 /* Now loop through the fields and init the struct we already have
499 for(ptr=firstptr, fields=0; ptr && !badcookie;
500 ptr=strtok_r(NULL, "\t", &tok_buf), fields++) {
503 if(ptr[0]=='.') /* skip preceeding dots */
505 co->domain = strdup(ptr);
510 /* This field got its explanation on the 23rd of May 2001 by
513 flag: A TRUE/FALSE value indicating if all machines within a given
514 domain can access the variable. This value is set automatically by
515 the browser, depending on the value you set for the domain.
517 As far as I can see, it is set to true when the cookie says
518 .domain.com and to false when the domain is complete www.domain.com
520 co->tailmatch=(bool)Curl_raw_equal(ptr, "TRUE"); /* store information */
523 /* It turns out, that sometimes the file format allows the path
524 field to remain not filled in, we try to detect this and work
525 around it! Andrés GarcÃa made us aware of this... */
526 if(strcmp("TRUE", ptr) && strcmp("FALSE", ptr)) {
527 /* only if the path doesn't look like a boolean option! */
528 co->path = strdup(ptr);
533 /* this doesn't look like a path, make one up! */
534 co->path = strdup("/");
537 fields++; /* add a field and fall down to secure */
540 co->secure = (bool)Curl_raw_equal(ptr, "TRUE");
543 co->expires = curlx_strtoofft(ptr, NULL, 10);
546 co->name = strdup(ptr);
551 co->value = strdup(ptr);
558 /* we got a cookie with blank contents, fix it */
559 co->value = strdup("");
566 if(!badcookie && (7 != fields))
567 /* we did not find the sufficient number of fields */
577 if(!c->running && /* read from a file */
578 c->newsession && /* clean session cookies */
579 !co->expires) { /* this is a session cookie since it doesn't expire! */
584 co->livecookie = c->running;
586 /* now, we have parsed the incoming line, we must now check if this
587 superceeds an already existing cookie, which it may if the previous have
588 the same domain and path as this */
593 if(Curl_raw_equal(clist->name, co->name)) {
594 /* the names are identical */
596 if(clist->domain && co->domain) {
597 if(Curl_raw_equal(clist->domain, co->domain))
598 /* The domains are identical */
601 else if(!clist->domain && !co->domain)
605 /* the domains were identical */
607 if(clist->path && co->path) {
608 if(Curl_raw_equal(clist->path, co->path)) {
614 else if(!clist->path && !co->path)
621 if(replace_old && !co->livecookie && clist->livecookie) {
622 /* Both cookies matched fine, except that the already present
623 cookie is "live", which means it was set from a header, while
624 the new one isn't "live" and thus only read from a file. We let
625 live cookies stay alive */
627 /* Free the newcomer and get out of here! */
633 co->next = clist->next; /* get the next-pointer first */
635 /* then free all the old pointers */
644 free(clist->expirestr);
647 free(clist->version);
651 *clist = *co; /* then store all the new data */
653 free(co); /* free the newly alloced memory */
654 co = clist; /* point to the previous struct instead */
656 /* We have replaced a cookie, now skip the rest of the list but
657 make sure the 'lastc' pointer is properly set */
670 /* Only show this when NOT reading the cookies from a file */
671 infof(data, "%s cookie %s=\"%s\" for domain %s, path %s, expire %d\n",
672 replace_old?"Replaced":"Added", co->name, co->value,
673 co->domain, co->path, co->expires);
676 /* then make the last item point on this new one */
683 c->numcookies++; /* one more cookie in the jar */
687 /*****************************************************************************
691 * Inits a cookie struct to read data from a local file. This is always
692 * called before any cookies are set. File may be NULL.
694 * If 'newsession' is TRUE, discard all "session cookies" on read from file.
696 ****************************************************************************/
697 struct CookieInfo *Curl_cookie_init(struct SessionHandle *data,
699 struct CookieInfo *inc,
702 struct CookieInfo *c;
707 /* we didn't get a struct, create one */
708 c = calloc(1, sizeof(struct CookieInfo));
710 return NULL; /* failed to get memory */
711 c->filename = strdup(file?file:"none"); /* copy the name just in case */
714 /* we got an already existing one, use that */
717 c->running = FALSE; /* this is not running, this is init */
719 if(file && strequal(file, "-")) {
723 else if(file && !*file) {
724 /* points to a "" string */
728 fp = file?fopen(file, "r"):NULL;
730 c->newsession = newsession; /* new session? */
736 char *line = malloc(MAX_COOKIE_LINE);
738 while(fgets(line, MAX_COOKIE_LINE, fp)) {
739 if(checkprefix("Set-Cookie:", line)) {
740 /* This is a cookie line, get it! */
748 while(*lineptr && ISBLANK(*lineptr))
751 Curl_cookie_add(data, c, headerline, lineptr, NULL, NULL);
753 free(line); /* free the line buffer */
759 c->running = TRUE; /* now, we're running */
764 /*****************************************************************************
766 * Curl_cookie_getlist()
768 * For a given host and path, return a linked list of cookies that the
769 * client should send to the server if used now. The secure boolean informs
770 * the cookie if a secure connection is achieved or not.
772 * It shall only return cookies that haven't expired.
774 ****************************************************************************/
776 struct Cookie *Curl_cookie_getlist(struct CookieInfo *c,
777 const char *host, const char *path,
780 struct Cookie *newco;
782 time_t now = time(NULL);
783 struct Cookie *mainco=NULL;
785 if(!c || !c->cookies)
786 return NULL; /* no cookie struct or no cookies in the struct */
791 /* only process this cookie if it is not expired or had no expire
792 date AND that if the cookie requires we're secure we must only
793 continue if we are! */
794 if( (!co->expires || (co->expires > now)) &&
795 (co->secure?secure:TRUE) ) {
797 /* now check if the domain is correct */
799 (co->tailmatch && tailmatch(co->domain, host)) ||
800 (!co->tailmatch && Curl_raw_equal(host, co->domain)) ) {
801 /* the right part of the host matches the domain stuff in the
804 /* now check the left part of the path with the cookies path
807 /* not using checkprefix() because matching should be
809 !strncmp(co->path, path, strlen(co->path)) ) {
811 /* and now, we know this is a match and we should create an
812 entry for the return-linked-list */
814 newco = malloc(sizeof(struct Cookie));
816 /* first, copy the whole source cookie: */
817 memcpy(newco, co, sizeof(struct Cookie));
819 /* then modify our next */
820 newco->next = mainco;
822 /* point the main to us */
826 /* failure, clear up the allocated chain and return NULL */
841 return mainco; /* return the new list */
844 /*****************************************************************************
846 * Curl_cookie_clearall()
848 * Clear all existing cookies and reset the counter.
850 ****************************************************************************/
851 void Curl_cookie_clearall(struct CookieInfo *cookies)
854 Curl_cookie_freelist(cookies->cookies, TRUE);
855 cookies->cookies = NULL;
856 cookies->numcookies = 0;
860 /*****************************************************************************
862 * Curl_cookie_freelist()
864 * Free a list of cookies previously returned by Curl_cookie_getlist();
866 * The 'cookiestoo' argument tells this function whether to just free the
867 * list or actually also free all cookies within the list as well.
869 ****************************************************************************/
871 void Curl_cookie_freelist(struct Cookie *co, bool cookiestoo)
880 free(co); /* we only free the struct since the "members" are all just
881 pointed out in the main cookie list! */
888 /*****************************************************************************
890 * Curl_cookie_clearsess()
892 * Free all session cookies in the cookies list.
894 ****************************************************************************/
895 void Curl_cookie_clearsess(struct CookieInfo *cookies)
897 struct Cookie *first, *curr, *next, *prev = NULL;
899 if(!cookies->cookies || !cookies->cookies)
902 first = curr = prev = cookies->cookies;
904 for(; curr; curr = next) {
916 cookies->numcookies--;
922 cookies->cookies = first;
926 /*****************************************************************************
928 * Curl_cookie_cleanup()
930 * Free a "cookie object" previous created with cookie_init().
932 ****************************************************************************/
933 void Curl_cookie_cleanup(struct CookieInfo *c)
947 free(c); /* free the base struct as well */
951 /* get_netscape_format()
953 * Formats a string for Netscape output file, w/o a newline at the end.
955 * Function returns a char * to a formatted line. Has to be free()d
957 static char *get_netscape_format(const struct Cookie *co)
960 "%s" /* httponly preamble */
961 "%s%s\t" /* domain */
962 "%s\t" /* tailmatch */
965 "%" FORMAT_OFF_T "\t" /* expires */
968 co->httponly?"#HttpOnly_":"",
969 /* Make sure all domains are prefixed with a dot if they allow
970 tailmatching. This is Mozilla-style. */
971 (co->tailmatch && co->domain && co->domain[0] != '.')? ".":"",
972 co->domain?co->domain:"unknown",
973 co->tailmatch?"TRUE":"FALSE",
974 co->path?co->path:"/",
975 co->secure?"TRUE":"FALSE",
978 co->value?co->value:"");
982 * Curl_cookie_output()
984 * Writes all internally known cookies to the specified file. Specify
985 * "-" as file name to write to stdout.
987 * The function returns non-zero on write failure.
989 int Curl_cookie_output(struct CookieInfo *c, const char *dumphere)
993 bool use_stdout=FALSE;
995 if((NULL == c) || (0 == c->numcookies))
996 /* If there are no known cookies, we don't write or even create any
1000 if(strequal("-", dumphere)) {
1006 out = fopen(dumphere, "w");
1008 return 1; /* failure */
1014 fputs("# Netscape HTTP Cookie File\n"
1015 "# http://curl.haxx.se/rfc/cookie_spec.html\n"
1016 "# This file was generated by libcurl! Edit at your own risk.\n\n",
1021 format_ptr = get_netscape_format(co);
1022 if(format_ptr == NULL) {
1023 fprintf(out, "#\n# Fatal libcurl error\n");
1028 fprintf(out, "%s\n", format_ptr);
1040 struct curl_slist *Curl_cookie_list(struct SessionHandle *data)
1042 struct curl_slist *list = NULL;
1043 struct curl_slist *beg;
1047 if((data->cookies == NULL) ||
1048 (data->cookies->numcookies == 0))
1051 c = data->cookies->cookies;
1055 /* fill the list with _all_ the cookies we know */
1056 line = get_netscape_format(c);
1058 curl_slist_free_all(beg);
1061 list = curl_slist_append(list, line);
1064 curl_slist_free_all(beg);
1067 else if(beg == NULL) {
1076 #endif /* CURL_DISABLE_HTTP || CURL_DISABLE_COOKIES */