lib/cookie.h

   1 #ifndef __COOKIE_H
   2 #define __COOKIE_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2008, Daniel Stenberg, <daniel@haxx.se>, et al.
  11  *
  12  * This software is licensed as described in the file COPYING, which
  13  * you should have received as part of this distribution. The terms
  14  * are also available at http://curl.haxx.se/docs/copyright.html.
  15  *
  16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17  * copies of the Software, and permit persons to whom the Software is
  18  * furnished to do so, under the terms of the COPYING file.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  ***************************************************************************/
  24
  25 #include <stdio.h>
  26 #if defined(WIN32)
  27 #include <time.h>
  28 #else
  29 #ifdef HAVE_SYS_TIME_H
  30 #include <sys/time.h>
  31 #endif
  32 #endif
  33
  34 #include <curl/curl.h>
  35
  36 struct Cookie {
  37   struct Cookie *next; /* next in the chain */
  38   char *name;        /* <this> = value */
  39   char *value;       /* name = <this> */
  40   char *path;         /* path = <this> */
  41   char *domain;      /* domain = <this> */
  42   curl_off_t expires;  /* expires = <this> */
  43   char *expirestr;   /* the plain text version */
  44   bool tailmatch;    /* weather we do tail-matchning of the domain name */
  45
  46   /* RFC 2109 keywords. Version=1 means 2109-compliant cookie sending */
  47   char *version;     /* Version = <value> */
  48   char *maxage;      /* Max-Age = <value> */
  49
  50   bool secure;       /* whether the 'secure' keyword was used */
  51   bool livecookie;   /* updated from a server, not a stored file */
  52   bool httponly;     /* true if the httponly directive is present */
  53 };
  54
  55 struct CookieInfo {
  56   /* linked list of cookies we know of */
  57   struct Cookie *cookies;
  58
  59   char *filename;  /* file we read from/write to */
  60   bool running;    /* state info, for cookie adding information */
  61   long numcookies; /* number of cookies in the "jar" */
  62   bool newsession; /* new session, discard session cookies on load */
  63 };
  64
  65 /* This is the maximum line length we accept for a cookie line. RFC 2109
  66    section 6.3 says:
  67
  68    "at least 4096 bytes per cookie (as measured by the size of the characters
  69    that comprise the cookie non-terminal in the syntax description of the
  70    Set-Cookie header)"
  71
  72 */
  73 #define MAX_COOKIE_LINE 5000
  74 #define MAX_COOKIE_LINE_TXT "4999"
  75
  76 /* This is the maximum length of a cookie name we deal with: */
  77 #define MAX_NAME 1024
  78 #define MAX_NAME_TXT "1023"
  79
  80 struct SessionHandle;
  81 /*
  82  * Add a cookie to the internal list of cookies. The domain and path arguments
  83  * are only used if the header boolean is TRUE.
  84  */
  85
  86 struct Cookie *Curl_cookie_add(struct SessionHandle *data,
  87                                struct CookieInfo *, bool header, char *lineptr,
  88                                const char *domain, const char *path);
  89
  90 struct CookieInfo *Curl_cookie_init(struct SessionHandle *data,
  91                                     const char *, struct CookieInfo *, bool);
  92 struct Cookie *Curl_cookie_getlist(struct CookieInfo *, const char *,
  93                                    const char *, bool);
  94 void Curl_cookie_freelist(struct Cookie *cookies, bool cookiestoo);
  95 void Curl_cookie_clearall(struct CookieInfo *cookies);
  96 void Curl_cookie_clearsess(struct CookieInfo *cookies);
  97 void Curl_cookie_cleanup(struct CookieInfo *);
  98 int Curl_cookie_output(struct CookieInfo *, const char *);
  99
 100 #if defined(CURL_DISABLE_HTTP) || defined(CURL_DISABLE_COOKIES)
 101 #define Curl_cookie_list(x) NULL
 102 #define Curl_cookie_loadfiles(x) do { } while (0)
 103 #else
 104 struct curl_slist *Curl_cookie_list(struct SessionHandle *data);
 105 void Curl_cookie_loadfiles(struct SessionHandle *data);
 106 #endif
 107
 108 #endif