mirror of
https://github.com/moparisthebest/curl
synced 2024-11-04 08:35:05 -05:00
1bd4b3f4e2
Removing expired cookies needs to be a fast operation since we want to be able to perform it often and speculatively. By tracking the timestamp of the next known expiration we can exit early in case the timestamp is in the future. Closes: #7172 Reviewed-by: Daniel Stenberg <daniel@haxx.se>
123 lines
4.7 KiB
C
123 lines
4.7 KiB
C
#ifndef HEADER_CURL_COOKIE_H
|
|
#define HEADER_CURL_COOKIE_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
*
|
|
* This software is licensed as described in the file COPYING, which
|
|
* you should have received as part of this distribution. The terms
|
|
* are also available at https://curl.se/docs/copyright.html.
|
|
*
|
|
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
* copies of the Software, and permit persons to whom the Software is
|
|
* furnished to do so, under the terms of the COPYING file.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
***************************************************************************/
|
|
#include "curl_setup.h"
|
|
|
|
#include <curl/curl.h>
|
|
|
|
struct Cookie {
|
|
struct Cookie *next; /* next in the chain */
|
|
char *name; /* <this> = value */
|
|
char *value; /* name = <this> */
|
|
char *path; /* path = <this> which is in Set-Cookie: */
|
|
char *spath; /* sanitized cookie path */
|
|
char *domain; /* domain = <this> */
|
|
curl_off_t expires; /* expires = <this> */
|
|
char *expirestr; /* the plain text version */
|
|
|
|
/* RFC 2109 keywords. Version=1 means 2109-compliant cookie sending */
|
|
char *version; /* Version = <value> */
|
|
char *maxage; /* Max-Age = <value> */
|
|
|
|
bool tailmatch; /* whether we do tail-matching of the domain name */
|
|
bool secure; /* whether the 'secure' keyword was used */
|
|
bool livecookie; /* updated from a server, not a stored file */
|
|
bool httponly; /* true if the httponly directive is present */
|
|
int creationtime; /* time when the cookie was written */
|
|
unsigned char prefix; /* bitmap fields indicating which prefix are set */
|
|
};
|
|
|
|
/*
|
|
* Available cookie prefixes, as defined in
|
|
* draft-ietf-httpbis-rfc6265bis-02
|
|
*/
|
|
#define COOKIE_PREFIX__SECURE (1<<0)
|
|
#define COOKIE_PREFIX__HOST (1<<1)
|
|
|
|
#define COOKIE_HASH_SIZE 256
|
|
|
|
struct CookieInfo {
|
|
/* linked list of cookies we know of */
|
|
struct Cookie *cookies[COOKIE_HASH_SIZE];
|
|
|
|
char *filename; /* file we read from/write to */
|
|
long numcookies; /* number of cookies in the "jar" */
|
|
bool running; /* state info, for cookie adding information */
|
|
bool newsession; /* new session, discard session cookies on load */
|
|
int lastct; /* last creation-time used in the jar */
|
|
curl_off_t next_expiration; /* the next time at which expiration happens */
|
|
};
|
|
|
|
/* This is the maximum line length we accept for a cookie line. RFC 2109
|
|
section 6.3 says:
|
|
|
|
"at least 4096 bytes per cookie (as measured by the size of the characters
|
|
that comprise the cookie non-terminal in the syntax description of the
|
|
Set-Cookie header)"
|
|
|
|
We allow max 5000 bytes cookie header. Max 4095 bytes length per cookie
|
|
name and value. Name + value may not exceed 4096 bytes.
|
|
|
|
*/
|
|
#define MAX_COOKIE_LINE 5000
|
|
|
|
/* This is the maximum length of a cookie name or content we deal with: */
|
|
#define MAX_NAME 4096
|
|
#define MAX_NAME_TXT "4095"
|
|
|
|
struct Curl_easy;
|
|
/*
|
|
* Add a cookie to the internal list of cookies. The domain and path arguments
|
|
* are only used if the header boolean is TRUE.
|
|
*/
|
|
|
|
struct Cookie *Curl_cookie_add(struct Curl_easy *data,
|
|
struct CookieInfo *c, bool header,
|
|
bool noexpiry, char *lineptr,
|
|
const char *domain, const char *path,
|
|
bool secure);
|
|
|
|
struct Cookie *Curl_cookie_getlist(struct CookieInfo *c, const char *host,
|
|
const char *path, bool secure);
|
|
void Curl_cookie_freelist(struct Cookie *cookies);
|
|
void Curl_cookie_clearall(struct CookieInfo *cookies);
|
|
void Curl_cookie_clearsess(struct CookieInfo *cookies);
|
|
|
|
#if defined(CURL_DISABLE_HTTP) || defined(CURL_DISABLE_COOKIES)
|
|
#define Curl_cookie_list(x) NULL
|
|
#define Curl_cookie_loadfiles(x) Curl_nop_stmt
|
|
#define Curl_cookie_init(x,y,z,w) NULL
|
|
#define Curl_cookie_cleanup(x) Curl_nop_stmt
|
|
#define Curl_flush_cookies(x,y) Curl_nop_stmt
|
|
#else
|
|
void Curl_flush_cookies(struct Curl_easy *data, bool cleanup);
|
|
void Curl_cookie_cleanup(struct CookieInfo *c);
|
|
struct CookieInfo *Curl_cookie_init(struct Curl_easy *data,
|
|
const char *file, struct CookieInfo *inc,
|
|
bool newsession);
|
|
struct curl_slist *Curl_cookie_list(struct Curl_easy *data);
|
|
void Curl_cookie_loadfiles(struct Curl_easy *data);
|
|
#endif
|
|
|
|
#endif /* HEADER_CURL_COOKIE_H */
|