mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-02-11 14:50:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

HTTP-COOKIES.md: describe the cookie file format

Browse Source 
... and refer to that file from from CURLOPT_COOKIEFILE.3 and
CURLOPT_COOKIELIST.3

Assisted-by: Jay Satiro
Reported-by: bsammon on github
Fixes #4805
Closes #4806
This commit is contained in:
Daniel Stenberg 2020-01-10 22:53:05 +01:00
parent 4ccf7622db
commit 9d1a0922b7
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
3 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/HTTP-COOKIES.md
View File

@ -43,6 +43,24 @@
When libcurl saves a cookiejar, it creates a file header of its own in which
there is a URL mention that will link to the web version of this document.
## Cookie file format
The cookie file format is text based and stores one cookie per line. Lines
that start with `#` are treated as comments.
Each line that each specifies a single cookie consists of seven text fields
separated with TAB characters.
|Field| Type | Example | Meaning |
|---|---------|-------------|-----------------------------------------------|
| 0 | string | example.com | Domain name |
| 1 | boolean | FALSE | Include subdomains |
| 2 | string | /foobar/ | Path |
| 3 | boolean | TRUE | Send/receive over HTTPS only |
| 4 | number | 1462299217 | Expires at – seconds since Jan 1st 1970, or 0 |
| 5 | string | person | Name of the cookie |
| 6 | string | daniel | Value of the cookie |
## Cookies with curl the command line tool
curl has a full cookie "engine" built in. If you just activate it, you can

6
docs/libcurl/opts/CURLOPT_COOKIEFILE.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2020, 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
@ -75,6 +75,10 @@ if(curl) {
curl_easy_cleanup(curl);
}
.fi
.SH "Cookie file format"
The cookie file format and general cookie concepts in curl are described in
the HTTP-COOKIES.md file, also hosted online here:
https://curl.haxx.se/docs/http-cookies.html
.SH AVAILABILITY
As long as HTTP is supported
.SH RETURN VALUE

6
docs/libcurl/opts/CURLOPT_COOKIELIST.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2020, 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
@ -104,6 +104,10 @@ curl_easy_perform(curl); /* cookies imported from cookies.txt */
curl_easy_cleanup(curl); /* cookies exported to cookies.txt */
.fi
.SH "Cookie file format"
The cookie file format and general cookie concepts in curl are described in
the HTTP-COOKIES.md file, also hosted online here:
https://curl.haxx.se/docs/http-cookies.html
.SH AVAILABILITY
ALL was added in 7.14.1