Artifactspublic-v0

curl

master
ply4 git calls307 ms288 KiB2 cachedprotocol v2
97 lines2.8 KiBRaw

NAME

CURLOPT_COOKIE - HTTP Cookie header

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIE, char *cookie);

DESCRIPTION

Pass a pointer to a null-terminated string as parameter. It is used to set one or more cookies in the HTTP request. The format of the string should be NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie should contain.

To set multiple cookies, set them all using a single option concatenated like this: "name1=content1; name2=content2;" etc. libcurl does not syntax check the data but assumes the application gives it what it needs to send.

This option sets the cookie header explicitly in the outgoing request(s). If multiple requests are done due to authentication, followed redirections or similar, they all get this cookie passed on.

The cookies set by this option are separate from the internal cookie storage held by the cookie engine and they are not modified by it. If you enable the cookie engine and either you have imported a cookie of the same name (e.g. 'foo') or the server has set one, it has no effect on the cookies you set here. A request to the server sends both the 'foo' held by the cookie engine and the 'foo' held by this option. To set a cookie that is instead held by the cookie engine and can be modified by the server, use CURLOPT_COOKIELIST(3).

Since this custom cookie is appended to the Cookie: header in addition to any cookies set by the cookie engine, there is a risk that the header ends up too long and thereby getting the entire request rejected by the server.

The application does not have to keep the string around after setting this option.

Using this option multiple times makes the last set string override the previous ones. Set it to NULL to disable its use again.

This option does not enable the cookie engine. Use CURLOPT_COOKIEFILE(3) or CURLOPT_COOKIEJAR(3) to enable parsing and sending cookies automatically.

DEFAULT

NULL, no cookies

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    curl_easy_setopt(curl, CURLOPT_COOKIE, "tool=curl; fun=yes;");

    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

%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_COOKIE
5Section: 3
6Source: libcurl
7See-also:
8 - CURLINFO_COOKIELIST (3)
9 - CURLOPT_COOKIEFILE (3)
10 - CURLOPT_COOKIEJAR (3)
11 - CURLOPT_COOKIELIST (3)
12 - CURLOPT_HTTPHEADER (3)
13Protocol:
14 - HTTP
15Added-in: 7.1
16---
18# NAME
20CURLOPT_COOKIE - HTTP Cookie header
22# SYNOPSIS
24~~~c
25#include <curl/curl.h>
27CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIE, char *cookie);
28~~~
30# DESCRIPTION
32Pass a pointer to a null-terminated string as parameter. It is used to set one
33or more cookies in the HTTP request. The format of the string should be
34NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie
35should contain.
37To set multiple cookies, set them all using a single option concatenated like
38this: "name1=content1; name2=content2;" etc. libcurl does not syntax check the
39data but assumes the application gives it what it needs to send.
41This option sets the cookie header explicitly in the outgoing request(s). If
42multiple requests are done due to authentication, followed redirections or
43similar, they all get this cookie passed on.
45The cookies set by this option are separate from the internal cookie storage
46held by the cookie engine and they are not modified by it. If you enable
47the cookie engine and either you have imported a cookie of the same name (e.g.
48'foo') or the server has set one, it has no effect on the cookies you set
49here. A request to the server sends both the 'foo' held by the cookie engine
50and the 'foo' held by this option. To set a cookie that is instead held by the
51cookie engine and can be modified by the server, use CURLOPT_COOKIELIST(3).
53Since this custom cookie is appended to the Cookie: header in addition to any
54cookies set by the cookie engine, there is a risk that the header ends up too
55long and thereby getting the entire request rejected by the server.
57The application does not have to keep the string around after setting this
58option.
60Using this option multiple times makes the last set string override the
61previous ones. Set it to NULL to disable its use again.
63This option does not enable the cookie engine. Use CURLOPT_COOKIEFILE(3) or
64CURLOPT_COOKIEJAR(3) to enable parsing and sending cookies automatically.
66# DEFAULT
68NULL, no cookies
70# %PROTOCOLS%
72# EXAMPLE
74~~~c
75int main(void)
77 CURL *curl = curl_easy_init();
78 if(curl) {
79 CURLcode result;
80 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
82 curl_easy_setopt(curl, CURLOPT_COOKIE, "tool=curl; fun=yes;");
84 result = curl_easy_perform(curl);
85 curl_easy_cleanup(curl);
86 }
88~~~
90# %AVAILABILITY%
92# RETURN VALUE
94curl_easy_setopt(3) returns a CURLcode indicating success or error.
96CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
97libcurl-errors(3).
Diagnostics4 git calls · 307 ms
CallStatusSizeTime0307 ms
discover200152 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
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 · hit23 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=23
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.4 KiB281 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=281
git.response.bytes=1453
git.response.cache=MISS
git.response.duration_ms=281
git.fetch.wants=1e363cf7ea7b68f8b718a0c37d77949efaec2e11
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=1453
git.pkt.payload.max=1432
git.sideband.band1.bytes=1431
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
a5e349c05af24652
Request
5211ee45…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format