1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2005, 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)
95 /* The last #include file should be: */
100 #define my_isspace(x) ((x == ' ') || (x == '\t'))
102 static void freecookie(struct Cookie *co)
122 static bool tailmatch(const char *little, const char *bigone)
124 size_t littlelen = strlen(little);
125 size_t biglen = strlen(bigone);
127 if(littlelen > biglen)
130 return (bool)strequal(little, bigone+biglen-littlelen);
133 /****************************************************************************
137 * Add a single cookie line to the cookie keeping object.
139 ***************************************************************************/
142 Curl_cookie_add(struct SessionHandle *data,
143 /* The 'data' pointer here may be NULL at times, and thus
144 must only be used very carefully for things that can deal
145 with data being NULL. Such as infof() and similar */
147 struct CookieInfo *c,
148 bool httpheader, /* TRUE if HTTP header-style line */
149 char *lineptr, /* first character of the line */
150 char *domain, /* default domain */
151 char *path) /* full path used when this cookie is set,
152 used to get default path for the cookie
155 struct Cookie *clist;
161 struct Cookie *lastc=NULL;
162 time_t now = time(NULL);
163 bool replace_old = FALSE;
164 bool badcookie = FALSE; /* cookies are good by default. mmmmm yummy */
166 /* First, alloc and init a new struct for it */
167 co = (struct Cookie *)calloc(sizeof(struct Cookie), 1);
169 return NULL; /* bail out if we're this low on memory */
172 /* This line was read off a HTTP-header */
175 what = malloc(MAX_COOKIE_LINE);
181 semiptr=strchr(lineptr, ';'); /* first, find a semicolon */
183 while(*lineptr && my_isspace(*lineptr))
188 /* we have a <what>=<this> pair or a 'secure' word here */
189 sep = strchr(ptr, '=');
190 if(sep && (!semiptr || (semiptr>sep)) ) {
192 * There is a = sign and if there was a semicolon too, which make sure
193 * that the semicolon comes _after_ the equal sign.
196 name[0]=what[0]=0; /* init the buffers */
197 if(1 <= sscanf(ptr, "%" MAX_NAME_TXT "[^;=]=%"
198 MAX_COOKIE_LINE_TXT "[^;\r\n]",
200 /* this is a <name>=<what> pair */
204 /* Strip off trailing whitespace from the 'what' */
205 size_t len=strlen(what);
206 while(len && my_isspace(what[len-1])) {
211 /* Skip leading whitespace from the 'what' */
213 while(my_isspace(*whatptr)) {
217 if(strequal("path", name)) {
218 co->path=strdup(whatptr);
220 badcookie = TRUE; /* out of memory bad */
224 else if(strequal("domain", name)) {
225 /* note that this name may or may not have a preceeding dot, but
226 we don't care about that, we treat the names the same anyway */
228 const char *domptr=whatptr;
231 /* Count the dots, we need to make sure that there are enough
234 if('.' == whatptr[0])
235 /* don't count the initial dot, assume it */
239 domptr = strchr(domptr, '.');
246 /* The original Netscape cookie spec defined that this domain name
247 MUST have three dots (or two if one of the seven holy TLDs),
248 but it seems that these kinds of cookies are in use "out there"
249 so we cannot be that strict. I've therefore lowered the check
250 to not allow less than two dots. */
253 /* Received and skipped a cookie with a domain using too few
255 badcookie=TRUE; /* mark this as a bad cookie */
256 infof(data, "skipped cookie with illegal dotcount domain: %s\n",
260 /* Now, we make sure that our host is within the given domain,
261 or the given domain is not valid and thus cannot be set. */
263 if('.' == whatptr[0])
264 whatptr++; /* ignore preceeding dot */
266 if(!domain || tailmatch(whatptr, domain)) {
267 const char *tailptr=whatptr;
268 if(tailptr[0] == '.')
270 co->domain=strdup(tailptr); /* don't prefix w/dots
276 co->tailmatch=TRUE; /* we always do that if the domain name was
280 /* we did not get a tailmatch and then the attempted set domain
281 is not a domain to which the current host belongs. Mark as
284 infof(data, "skipped cookie with bad tailmatch domain: %s\n",
289 else if(strequal("version", name)) {
290 co->version=strdup(whatptr);
296 else if(strequal("max-age", name)) {
297 /* Defined in RFC2109:
299 Optional. The Max-Age attribute defines the lifetime of the
300 cookie, in seconds. The delta-seconds value is a decimal non-
301 negative integer. After delta-seconds seconds elapse, the
302 client should discard the cookie. A value of zero means the
303 cookie should be discarded immediately.
306 co->maxage = strdup(whatptr);
312 atoi((*co->maxage=='\"')?&co->maxage[1]:&co->maxage[0]) + (long)now;
314 else if(strequal("expires", name)) {
315 co->expirestr=strdup(whatptr);
320 co->expires = (long)curl_getdate(what, &now);
323 co->name = strdup(name);
324 co->value = strdup(whatptr);
325 if(!co->name || !co->value) {
331 else this is the second (or more) name we don't know
335 /* this is an "illegal" <what>=<this> pair */
339 if(sscanf(ptr, "%" MAX_COOKIE_LINE_TXT "[^;\r\n]",
341 if(strequal("secure", what))
344 unsupported keyword without assign! */
348 if(!semiptr || !*semiptr) {
349 /* we already know there are no more cookies */
355 while(ptr && *ptr && my_isspace(*ptr))
357 semiptr=strchr(ptr, ';'); /* now, find the next semicolon */
360 /* There are no more semicolons, but there's a final name=value pair
362 semiptr=strchr(ptr, '\0');
365 if(!badcookie && !co->domain) {
367 /* no domain was given in the header line, set the default */
368 co->domain=strdup(domain);
374 if(!badcookie && !co->path && path) {
375 /* no path was given in the header line, set the default */
376 char *endslash = strrchr(path, '/');
378 size_t pathlen = endslash-path+1; /* include the ending slash */
379 co->path=malloc(pathlen+1); /* one extra for the zero byte */
381 memcpy(co->path, path, pathlen);
382 co->path[pathlen]=0; /* zero terminate */
391 if(badcookie || !co->name) {
392 /* we didn't get a cookie name or a bad one,
393 this is an illegal line, bail out */
400 /* This line is NOT a HTTP header style line, we do offer support for
401 reading the odd netscape cookies-file format here */
406 if(lineptr[0]=='#') {
407 /* don't even try the comments */
411 /* strip off the possible end-of-line characters */
412 ptr=strchr(lineptr, '\r');
414 *ptr=0; /* clear it */
415 ptr=strchr(lineptr, '\n');
417 *ptr=0; /* clear it */
419 firstptr=strtok_r(lineptr, "\t", &tok_buf); /* tokenize it on the TAB */
421 /* Here's a quick check to eliminate normal HTTP-headers from this */
422 if(!firstptr || strchr(firstptr, ':')) {
427 /* Now loop through the fields and init the struct we already have
429 for(ptr=firstptr, fields=0; ptr && !badcookie;
430 ptr=strtok_r(NULL, "\t", &tok_buf), fields++) {
433 if(ptr[0]=='.') /* skip preceeding dots */
435 co->domain = strdup(ptr);
440 /* This field got its explanation on the 23rd of May 2001 by
443 flag: A TRUE/FALSE value indicating if all machines within a given
444 domain can access the variable. This value is set automatically by
445 the browser, depending on the value you set for the domain.
447 As far as I can see, it is set to true when the cookie says
448 .domain.com and to false when the domain is complete www.domain.com
450 co->tailmatch=(bool)strequal(ptr, "TRUE"); /* store information */
453 /* It turns out, that sometimes the file format allows the path
454 field to remain not filled in, we try to detect this and work
455 around it! Andrés GarcÃa made us aware of this... */
456 if (strcmp("TRUE", ptr) && strcmp("FALSE", ptr)) {
457 /* only if the path doesn't look like a boolean option! */
458 co->path = strdup(ptr);
463 /* this doesn't look like a path, make one up! */
464 co->path = strdup("/");
467 fields++; /* add a field and fall down to secure */
470 co->secure = (bool)strequal(ptr, "TRUE");
473 co->expires = atoi(ptr);
476 co->name = strdup(ptr);
481 co->value = strdup(ptr);
488 /* we got a cookie with blank contents, fix it */
489 co->value = strdup("");
496 if(!badcookie && (7 != fields))
497 /* we did not find the sufficient number of fields */
507 if(!c->running && /* read from a file */
508 c->newsession && /* clean session cookies */
509 !co->expires) { /* this is a session cookie since it doesn't expire! */
514 co->livecookie = c->running;
516 /* now, we have parsed the incoming line, we must now check if this
517 superceeds an already existing cookie, which it may if the previous have
518 the same domain and path as this */
523 if(strequal(clist->name, co->name)) {
524 /* the names are identical */
526 if(clist->domain && co->domain) {
527 if(strequal(clist->domain, co->domain))
528 /* The domains are identical */
531 else if(!clist->domain && !co->domain)
535 /* the domains were identical */
537 if(clist->path && co->path) {
538 if(strequal(clist->path, co->path)) {
544 else if(!clist->path && !co->path)
551 if(replace_old && !co->livecookie && clist->livecookie) {
552 /* Both cookies matched fine, except that the already present
553 cookie is "live", which means it was set from a header, while
554 the new one isn't "live" and thus only read from a file. We let
555 live cookies stay alive */
557 /* Free the newcomer and get out of here! */
563 co->next = clist->next; /* get the next-pointer first */
565 /* then free all the old pointers */
575 free(clist->expirestr);
578 free(clist->version);
582 *clist = *co; /* then store all the new data */
584 free(co); /* free the newly alloced memory */
585 co = clist; /* point to the previous struct instead */
587 /* We have replaced a cookie, now skip the rest of the list but
588 make sure the 'lastc' pointer is properly set */
601 /* Only show this when NOT reading the cookies from a file */
602 infof(data, "%s cookie %s=\"%s\" for domain %s, path %s, expire %d\n",
603 replace_old?"Replaced":"Added", co->name, co->value,
604 co->domain, co->path, co->expires);
607 /* then make the last item point on this new one */
614 c->numcookies++; /* one more cookie in the jar */
618 /*****************************************************************************
622 * Inits a cookie struct to read data from a local file. This is always
623 * called before any cookies are set. File may be NULL.
625 * If 'newsession' is TRUE, discard all "session cookies" on read from file.
627 ****************************************************************************/
628 struct CookieInfo *Curl_cookie_init(struct SessionHandle *data,
630 struct CookieInfo *inc,
633 struct CookieInfo *c;
638 /* we didn't get a struct, create one */
639 c = (struct CookieInfo *)calloc(1, sizeof(struct CookieInfo));
641 return NULL; /* failed to get memory */
642 c->filename = strdup(file?file:"none"); /* copy the name just in case */
645 /* we got an already existing one, use that */
648 c->running = FALSE; /* this is not running, this is init */
650 if(file && strequal(file, "-")) {
654 else if(file && !*file) {
655 /* points to a "" string */
659 fp = file?fopen(file, "r"):NULL;
661 c->newsession = newsession; /* new session? */
667 char *line = (char *)malloc(MAX_COOKIE_LINE);
669 while(fgets(line, MAX_COOKIE_LINE, fp)) {
670 if(checkprefix("Set-Cookie:", line)) {
671 /* This is a cookie line, get it! */
679 while(*lineptr && my_isspace(*lineptr))
682 Curl_cookie_add(data, c, headerline, lineptr, NULL, NULL);
684 free(line); /* free the line buffer */
690 c->running = TRUE; /* now, we're running */
695 /*****************************************************************************
697 * Curl_cookie_getlist()
699 * For a given host and path, return a linked list of cookies that the
700 * client should send to the server if used now. The secure boolean informs
701 * the cookie if a secure connection is achieved or not.
703 * It shall only return cookies that haven't expired.
705 ****************************************************************************/
707 struct Cookie *Curl_cookie_getlist(struct CookieInfo *c,
708 char *host, char *path, bool secure)
710 struct Cookie *newco;
712 time_t now = time(NULL);
713 struct Cookie *mainco=NULL;
715 if(!c || !c->cookies)
716 return NULL; /* no cookie struct or no cookies in the struct */
721 /* only process this cookie if it is not expired or had no expire
722 date AND that if the cookie requires we're secure we must only
723 continue if we are! */
724 if( (co->expires<=0 || (co->expires> now)) &&
725 (co->secure?secure:TRUE) ) {
727 /* now check if the domain is correct */
729 (co->tailmatch && tailmatch(co->domain, host)) ||
730 (!co->tailmatch && strequal(host, co->domain)) ) {
731 /* the right part of the host matches the domain stuff in the
734 /* now check the left part of the path with the cookies path
737 checkprefix(co->path, path) ) {
739 /* and now, we know this is a match and we should create an
740 entry for the return-linked-list */
742 newco = (struct Cookie *)malloc(sizeof(struct Cookie));
744 /* first, copy the whole source cookie: */
745 memcpy(newco, co, sizeof(struct Cookie));
747 /* then modify our next */
748 newco->next = mainco;
750 /* point the main to us */
754 /* failure, clear up the allocated chain and return NULL */
769 return mainco; /* return the new list */
773 /*****************************************************************************
775 * Curl_cookie_freelist()
777 * Free a list of cookies previously returned by Curl_cookie_getlist();
779 ****************************************************************************/
781 void Curl_cookie_freelist(struct Cookie *co)
787 free(co); /* we only free the struct since the "members" are all
794 /*****************************************************************************
796 * Curl_cookie_cleanup()
798 * Free a "cookie object" previous created with cookie_init().
800 ****************************************************************************/
801 void Curl_cookie_cleanup(struct CookieInfo *c)
815 free(c); /* free the base struct as well */
820 * Curl_cookie_output()
822 * Writes all internally known cookies to the specified file. Specify
823 * "-" as file name to write to stdout.
825 * The function returns non-zero on write failure.
827 int Curl_cookie_output(struct CookieInfo *c, char *dumphere)
831 bool use_stdout=FALSE;
833 if((NULL == c) || (0 == c->numcookies))
834 /* If there are no known cookies, we don't write or even create any
838 if(strequal("-", dumphere)) {
844 out = fopen(dumphere, "w");
846 return 1; /* failure */
850 fputs("# Netscape HTTP Cookie File\n"
851 "# http://www.netscape.com/newsref/std/cookie_spec.html\n"
852 "# This file was generated by libcurl! Edit at your own risk.\n\n",
858 "%s%s\t" /* domain */
859 "%s\t" /* tailmatch */
866 /* Make sure all domains are prefixed with a dot if they allow
867 tailmatching. This is Mozilla-style. */
868 (co->tailmatch && co->domain && co->domain[0] != '.')? ".":"",
869 co->domain?co->domain:"unknown",
870 co->tailmatch?"TRUE":"FALSE",
871 co->path?co->path:"/",
872 co->secure?"TRUE":"FALSE",
873 (unsigned int)co->expires,
875 co->value?co->value:"");
887 #endif /* CURL_DISABLE_HTTP || CURL_DISABLE_COOKIES */