| 1 | #ifndef HEADER_CURL_COOKIE_H
|
|---|
| 2 | #define HEADER_CURL_COOKIE_H
|
|---|
| 3 | /***************************************************************************
|
|---|
| 4 | * _ _ ____ _
|
|---|
| 5 | * Project ___| | | | _ \| |
|
|---|
| 6 | * / __| | | | |_) | |
|
|---|
| 7 | * | (__| |_| | _ <| |___
|
|---|
| 8 | * \___|\___/|_| \_\_____|
|
|---|
| 9 | *
|
|---|
| 10 | * Copyright (C) 1998 - 2021, Daniel Stenberg, <[email protected]>, 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 https://curl.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 |
|
|---|
| 28 | struct 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 |
|
|---|
| 38 | /* RFC 2109 keywords. Version=1 means 2109-compliant cookie sending */
|
|---|
| 39 | char *version; /* Version = <value> */
|
|---|
| 40 | char *maxage; /* Max-Age = <value> */
|
|---|
| 41 |
|
|---|
| 42 | bool tailmatch; /* whether we do tail-matching of the domain name */
|
|---|
| 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 | int creationtime; /* time when the cookie was written */
|
|---|
| 47 | unsigned char prefix; /* bitmap fields indicating which prefix are set */
|
|---|
| 48 | };
|
|---|
| 49 |
|
|---|
| 50 | /*
|
|---|
| 51 | * Available cookie prefixes, as defined in
|
|---|
| 52 | * draft-ietf-httpbis-rfc6265bis-02
|
|---|
| 53 | */
|
|---|
| 54 | #define COOKIE_PREFIX__SECURE (1<<0)
|
|---|
| 55 | #define COOKIE_PREFIX__HOST (1<<1)
|
|---|
| 56 |
|
|---|
| 57 | #define COOKIE_HASH_SIZE 256
|
|---|
| 58 |
|
|---|
| 59 | struct CookieInfo {
|
|---|
| 60 | /* linked list of cookies we know of */
|
|---|
| 61 | struct Cookie *cookies[COOKIE_HASH_SIZE];
|
|---|
| 62 |
|
|---|
| 63 | char *filename; /* file we read from/write to */
|
|---|
| 64 | long numcookies; /* number of cookies in the "jar" */
|
|---|
| 65 | bool running; /* state info, for cookie adding information */
|
|---|
| 66 | bool newsession; /* new session, discard session cookies on load */
|
|---|
| 67 | int lastct; /* last creation-time used in the jar */
|
|---|
| 68 | curl_off_t next_expiration; /* the next time at which expiration happens */
|
|---|
| 69 | };
|
|---|
| 70 |
|
|---|
| 71 | /* This is the maximum line length we accept for a cookie line. RFC 2109
|
|---|
| 72 | section 6.3 says:
|
|---|
| 73 |
|
|---|
| 74 | "at least 4096 bytes per cookie (as measured by the size of the characters
|
|---|
| 75 | that comprise the cookie non-terminal in the syntax description of the
|
|---|
| 76 | Set-Cookie header)"
|
|---|
| 77 |
|
|---|
| 78 | We allow max 5000 bytes cookie header. Max 4095 bytes length per cookie
|
|---|
| 79 | name and value. Name + value may not exceed 4096 bytes.
|
|---|
| 80 |
|
|---|
| 81 | */
|
|---|
| 82 | #define MAX_COOKIE_LINE 5000
|
|---|
| 83 |
|
|---|
| 84 | /* This is the maximum length of a cookie name or content we deal with: */
|
|---|
| 85 | #define MAX_NAME 4096
|
|---|
| 86 | #define MAX_NAME_TXT "4095"
|
|---|
| 87 |
|
|---|
| 88 | struct Curl_easy;
|
|---|
| 89 | /*
|
|---|
| 90 | * Add a cookie to the internal list of cookies. The domain and path arguments
|
|---|
| 91 | * are only used if the header boolean is TRUE.
|
|---|
| 92 | */
|
|---|
| 93 |
|
|---|
| 94 | struct Cookie *Curl_cookie_add(struct Curl_easy *data,
|
|---|
| 95 | struct CookieInfo *c, bool header,
|
|---|
| 96 | bool noexpiry, char *lineptr,
|
|---|
| 97 | const char *domain, const char *path,
|
|---|
| 98 | bool secure);
|
|---|
| 99 |
|
|---|
| 100 | struct Cookie *Curl_cookie_getlist(struct CookieInfo *c, const char *host,
|
|---|
| 101 | const char *path, bool secure);
|
|---|
| 102 | void Curl_cookie_freelist(struct Cookie *cookies);
|
|---|
| 103 | void Curl_cookie_clearall(struct CookieInfo *cookies);
|
|---|
| 104 | void Curl_cookie_clearsess(struct CookieInfo *cookies);
|
|---|
| 105 |
|
|---|
| 106 | #if defined(CURL_DISABLE_HTTP) || defined(CURL_DISABLE_COOKIES)
|
|---|
| 107 | #define Curl_cookie_list(x) NULL
|
|---|
| 108 | #define Curl_cookie_loadfiles(x) Curl_nop_stmt
|
|---|
| 109 | #define Curl_cookie_init(x,y,z,w) NULL
|
|---|
| 110 | #define Curl_cookie_cleanup(x) Curl_nop_stmt
|
|---|
| 111 | #define Curl_flush_cookies(x,y) Curl_nop_stmt
|
|---|
| 112 | #else
|
|---|
| 113 | void Curl_flush_cookies(struct Curl_easy *data, bool cleanup);
|
|---|
| 114 | void Curl_cookie_cleanup(struct CookieInfo *c);
|
|---|
| 115 | struct CookieInfo *Curl_cookie_init(struct Curl_easy *data,
|
|---|
| 116 | const char *file, struct CookieInfo *inc,
|
|---|
| 117 | bool newsession);
|
|---|
| 118 | struct curl_slist *Curl_cookie_list(struct Curl_easy *data);
|
|---|
| 119 | void Curl_cookie_loadfiles(struct Curl_easy *data);
|
|---|
| 120 | #endif
|
|---|
| 121 |
|
|---|
| 122 | #endif /* HEADER_CURL_COOKIE_H */
|
|---|
