80 lines
2.7 KiB
Groff
80 lines
2.7 KiB
Groff
|
.\" generated by cd2nroff 0.1 from CURLOPT_COOKIEFILE.md
|
||
|
|
.TH CURLOPT_COOKIEFILE 3 "2025-07-07" libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_COOKIEFILE \- filename to read cookies from
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEFILE, char *filename);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Pass a pointer to a null\-terminated string as parameter. It should point to
|
||
|
|
the filename of your file holding cookie data to read. The cookie data can be
|
||
|
|
in either the old Netscape / Mozilla cookie data format or just regular HTTP
|
||
|
|
headers (Set\-Cookie style) dumped to a file.
|
||
|
|
|
||
|
|
It also enables the cookie engine, making libcurl parse and send cookies on
|
||
|
|
subsequent requests with this handle.
|
||
|
|
|
||
|
|
By passing the empty string ("") to this option, you enable the cookie engine
|
||
|
|
without reading any initial cookies. If you tell libcurl the filename is "\-"
|
||
|
|
(just a single minus sign), libcurl instead reads from stdin.
|
||
|
|
|
||
|
|
This option only \fBreads\fP cookies. To make libcurl write cookies to file,
|
||
|
|
see \fICURLOPT_COOKIEJAR(3)\fP.
|
||
|
|
|
||
|
|
If you read cookies from a plain HTTP headers file and it does not specify a
|
||
|
|
domain in the Set\-Cookie line, then the cookie is not sent since the cookie
|
||
|
|
domain cannot match the target URL\(aqs. To address this, set a domain in
|
||
|
|
Set\-Cookie line (doing that includes subdomains) or preferably: use the
|
||
|
|
Netscape format.
|
||
|
|
|
||
|
|
The application does not have to keep the string around after setting this
|
||
|
|
option.
|
||
|
|
|
||
|
|
If you use this option multiple times, you add more files to read cookies
|
||
|
|
from. Setting this option to NULL disables the cookie engine and clears the
|
||
|
|
list of files to read cookies from.
|
||
|
|
.SH SECURITY CONCERNS
|
||
|
|
This document previously mentioned how specifying a non\-existing file can also
|
||
|
|
enable the cookie engine. While true, we strongly advise against using that
|
||
|
|
method as it is too hard to be sure that files that stay that way in the long
|
||
|
|
run.
|
||
|
|
.SH DEFAULT
|
||
|
|
NULL
|
||
|
|
.SH PROTOCOLS
|
||
|
|
This functionality affects http only
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
int main(void)
|
||
|
|
{
|
||
|
|
CURL *curl = curl_easy_init();
|
||
|
|
if(curl) {
|
||
|
|
CURLcode res;
|
||
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
|
||
|
|
|
||
|
|
/* get cookies from an existing file */
|
||
|
|
curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "/tmp/cookies.txt");
|
||
|
|
|
||
|
|
res = curl_easy_perform(curl);
|
||
|
|
|
||
|
|
curl_easy_cleanup(curl);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH Cookie file format
|
||
|
|
The cookie file format and general cookie concepts in curl are described
|
||
|
|
online here: https://curl.se/docs/http\-cookies.html
|
||
|
|
.SH AVAILABILITY
|
||
|
|
Added in curl 7.1
|
||
|
|
.SH RETURN VALUE
|
||
|
|
\fIcurl_easy_setopt(3)\fP returns a CURLcode indicating success or error.
|
||
|
|
|
||
|
|
CURLE_OK (0) means everything was OK, non\-zero means an error occurred, see
|
||
|
|
\fIlibcurl\-errors(3)\fP.
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR CURLOPT_COOKIE (3),
|
||
|
|
.BR CURLOPT_COOKIEJAR (3),
|
||
|
|
.BR CURLOPT_COOKIESESSION (3)
|