1#ifndef HEADER_CURL_COOKIE_H
2#define HEADER_CURL_COOKIE_H
3/***************************************************************************
4 *                                  _   _ ____  _
5 *  Project                     ___| | | |  _ \| |
6 *                             / __| | | | |_) | |
7 *                            | (__| |_| |  _ <| |___
8 *                             \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) 1998 - 2011, 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#include "curl_setup.h"
25
26#include <curl/curl.h>
27
28struct Cookie {
29  struct Cookie *next; /* next in the chain */
30  char *name;        /* <this> = value */
31  char *value;       /* name = <this> */
32  char *path;         /* path = <this> which is in Set-Cookie: */
33  char *spath;        /* sanitized cookie path */
34  char *domain;      /* domain = <this> */
35  curl_off_t expires;  /* expires = <this> */
36  char *expirestr;   /* the plain text version */
37  bool tailmatch;    /* weather we do tail-matchning of the domain name */
38
39  /* RFC 2109 keywords. Version=1 means 2109-compliant cookie sending */
40  char *version;     /* Version = <value> */
41  char *maxage;      /* Max-Age = <value> */
42
43  bool secure;       /* whether the 'secure' keyword was used */
44  bool livecookie;   /* updated from a server, not a stored file */
45  bool httponly;     /* true if the httponly directive is present */
46};
47
48struct CookieInfo {
49  /* linked list of cookies we know of */
50  struct Cookie *cookies;
51
52  char *filename;  /* file we read from/write to */
53  bool running;    /* state info, for cookie adding information */
54  long numcookies; /* number of cookies in the "jar" */
55  bool newsession; /* new session, discard session cookies on load */
56};
57
58/* This is the maximum line length we accept for a cookie line. RFC 2109
59   section 6.3 says:
60
61   "at least 4096 bytes per cookie (as measured by the size of the characters
62   that comprise the cookie non-terminal in the syntax description of the
63   Set-Cookie header)"
64
65*/
66#define MAX_COOKIE_LINE 5000
67#define MAX_COOKIE_LINE_TXT "4999"
68
69/* This is the maximum length of a cookie name we deal with: */
70#define MAX_NAME 1024
71#define MAX_NAME_TXT "1023"
72
73struct SessionHandle;
74/*
75 * Add a cookie to the internal list of cookies. The domain and path arguments
76 * are only used if the header boolean is TRUE.
77 */
78
79struct Cookie *Curl_cookie_add(struct SessionHandle *data,
80                               struct CookieInfo *, bool header, char *lineptr,
81                               const char *domain, const char *path);
82
83struct Cookie *Curl_cookie_getlist(struct CookieInfo *, const char *,
84                                   const char *, bool);
85void Curl_cookie_freelist(struct Cookie *cookies, bool cookiestoo);
86void Curl_cookie_clearall(struct CookieInfo *cookies);
87void Curl_cookie_clearsess(struct CookieInfo *cookies);
88
89#if defined(CURL_DISABLE_HTTP) || defined(CURL_DISABLE_COOKIES)
90#define Curl_cookie_list(x) NULL
91#define Curl_cookie_loadfiles(x) Curl_nop_stmt
92#define Curl_cookie_init(x,y,z,w) NULL
93#define Curl_cookie_cleanup(x) Curl_nop_stmt
94#define Curl_flush_cookies(x,y) Curl_nop_stmt
95#else
96void Curl_flush_cookies(struct SessionHandle *data, int cleanup);
97void Curl_cookie_cleanup(struct CookieInfo *);
98struct CookieInfo *Curl_cookie_init(struct SessionHandle *data,
99                                    const char *, struct CookieInfo *, bool);
100struct curl_slist *Curl_cookie_list(struct SessionHandle *data);
101void Curl_cookie_loadfiles(struct SessionHandle *data);
102#endif
103
104#endif /* HEADER_CURL_COOKIE_H */
105