Artifactspublic-v0

curl

master
ply4 git calls220 ms288 KiB2 cachedprotocol v2
107 lines2.9 KiBRaw

NAME

CURLOPT_COOKIEFILE - filename to read cookies from

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEFILE, char *filename);

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 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 "-" (a single minus sign), libcurl instead reads from stdin.

This option only reads cookies. To make libcurl write cookies to file, see CURLOPT_COOKIEJAR(3).

If you read cookies from a plain HTTP headers file, make sure each Set-Cookie line specifies a Domain attribute. Without an explicit domain, libcurl cannot reliably associate the cookie with a host and it may be applied in unexpected ways. We suggest using the Netscape file format instead.

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.

The cookies are loaded from the specified file(s) when the transfer starts, not when this option is set.

libcurl ignores filenames which do not exist or point to a directory.

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.

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    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");

    result = curl_easy_perform(curl);

    curl_easy_cleanup(curl);
  }
}

The cookie file format and general cookie concepts in curl are described online here: https://curl.se/docs/http-cookies.html

%AVAILABILITY%

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_COOKIEFILE
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_COOKIE (3)
9 - CURLOPT_COOKIEJAR (3)
10 - CURLOPT_COOKIESESSION (3)
11Protocol:
12 - HTTP
13Added-in: 7.1
14---
16# NAME
18CURLOPT_COOKIEFILE - filename to read cookies from
20# SYNOPSIS
22~~~c
23#include <curl/curl.h>
25CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEFILE, char *filename);
26~~~
28# DESCRIPTION
30Pass a pointer to a null-terminated string as parameter. It should point to
31the filename of your file holding cookie data to read. The cookie data can be
32in either the old Netscape / Mozilla cookie data format or regular HTTP
33headers (Set-Cookie style) dumped to a file.
35It also enables the cookie engine, making libcurl parse and send cookies on
36subsequent requests with this handle.
38By passing the empty string ("") to this option, you enable the cookie engine
39without reading any initial cookies. If you tell libcurl the filename is "-"
40(a single minus sign), libcurl instead reads from stdin.
42This option only **reads** cookies. To make libcurl write cookies to file, see
43CURLOPT_COOKIEJAR(3).
45If you read cookies from a plain HTTP headers file, make sure each
46`Set-Cookie` line specifies a `Domain` attribute. Without an explicit domain,
47libcurl cannot reliably associate the cookie with a host and it may be applied
48in unexpected ways. We suggest using the Netscape file format instead.
50The application does not have to keep the string around after setting this
51option.
53If you use this option multiple times, you add more files to read cookies
54from. Setting this option to NULL disables the cookie engine and clears the
55list of files to read cookies from.
57The cookies are loaded from the specified file(s) when the transfer starts,
58not when this option is set.
60libcurl ignores filenames which do not exist or point to a directory.
62# SECURITY CONCERNS
64This document previously mentioned how specifying a non-existing file can also
65enable the cookie engine. While true, we strongly advise against using that
66method as it is too hard to be sure that files that stay that way in the long
67run.
69# DEFAULT
71NULL
73# %PROTOCOLS%
75# EXAMPLE
77~~~c
78int main(void)
80 CURL *curl = curl_easy_init();
81 if(curl) {
82 CURLcode result;
83 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
85 /* get cookies from an existing file */
86 curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "/tmp/cookies.txt");
88 result = curl_easy_perform(curl);
90 curl_easy_cleanup(curl);
91 }
93~~~
95# Cookie file format
97The cookie file format and general cookie concepts in curl are described
98online here: https://curl.se/docs/http-cookies.html
100# %AVAILABILITY%
102# RETURN VALUE
104curl_easy_setopt(3) returns a CURLcode indicating success or error.
106CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
107libcurl-errors(3).
Diagnostics4 git calls · 220 ms
CallStatusSizeTime0220 ms
discover200152 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=152
git.server.agent=gitty/1.0
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch object-format
git.server.fetch=shallow filter sideband-all
git.protocol.version=2
git.pkt.frames=8
git.pkt.data=6
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=152
git.pkt.payload.max=34
ls-refs200149 B · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=149
git.pkt.payload.max=78
git.ls_refs.count=2
git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=blob:none
git.fetch.filter.requested=tree:0
git.fetch.filter.fallback=blob:none
git.fetch.filter.learned=false
git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=10
git.pkt.data=8
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=293470
git.pkt.payload.max=65516
git.sideband.band1.bytes=293354
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=87
git.pack.bytes=293354
git.pack.ofs_delta=0
git.pack.ref_delta=1
git.pack.chain.max=1
git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0
git.pack.full=86
Open pack map
fetch2001.5 KiB215 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=215
git.response.bytes=1525
git.response.cache=MISS
git.response.duration_ms=215
git.fetch.wants=ccccba5fe325fd04da07cbffed86d54aabf464e2
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1525
git.pkt.payload.max=1504
git.sideband.band1.bytes=1503
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
Ref
refs/heads/master
Commit
31c911efe5652725e930f4d2e60c9060e5f6646d
cf-ray
a5e313324c773e6e
Request
fe96335b…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format