Artifactspublic-v0

curl

master
ply4 git calls168 ms288 KiB2 cachedprotocol v2
107 lines3.1 KiBRaw

NAME

CURLOPT_HTTPSIG_HEADERS - components to sign for HTTP Message Signatures

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPSIG_HEADERS,
                          char *components);

DESCRIPTION

This feature is experimental and may change before it is considered stable. We advise against using it in production.

Pass a space-separated list of component identifiers to include in the RFC 9421 HTTP Message Signature.

Derived components are given as bare names:

  • method - the HTTP method (GET, POST, etc.)
  • authority - the host and optional port
  • path - the request path
  • query - the query string including the leading ?

HTTP header fields are given with a trailing colon, for example content-type: or content-digest:. This mirrors how a header looks and keeps a leading @ free for its usual curl meaning (read the value from a file).

If this option is not set, the default components are method, authority, path (plus query when a query string is present).

Signing request headers

Header components are resolved from the list set with CURLOPT_HTTPHEADER(3) only. Headers that libcurl adds later (such as the default User-Agent) are not visible to the signer unless the application supplies them explicitly.

To sign User-Agent, supply it via CURLOPT_HTTPHEADER(3) together with this option before the transfer; see EXAMPLE.

Each component identifier may appear at most once (RFC 9421 Section 2). Listing the same component twice returns CURLE_BAD_FUNCTION_ARGUMENT.

At most 16 components are accepted; supplying more returns CURLE_BAD_FUNCTION_ARGUMENT.

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

DEFAULT

NULL (uses the default component set)

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  struct curl_slist *headers = NULL;

  if(curl) {
    headers = curl_slist_append(headers, "User-Agent: MyApp/1.0");
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/api");
    curl_easy_setopt(curl, CURLOPT_HTTPSIG_ALGORITHM, CURLHTTPSIG_ED25519);
    curl_easy_setopt(curl, CURLOPT_HTTPSIG_KEY,
                     "9f8362f87a484a954e6e740c5b4c0e84"
                     "229139a20aa8ab56ff66586f6a7d29c5");
    curl_easy_setopt(curl, CURLOPT_HTTPSIG_KEYID, "my-key-id");
    curl_easy_setopt(curl, CURLOPT_HTTPSIG_HEADERS,
                     "method authority path content-type: user-agent:");
    curl_easy_perform(curl);
    curl_slist_free_all(headers);
  }
}

%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_HTTPSIG_HEADERS
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_HTTPSIG_ALGORITHM (3)
9 - CURLOPT_HTTPSIG_KEY (3)
10 - CURLOPT_HTTPSIG_KEYID (3)
11Protocol:
12 - HTTP
13Added-in: 8.22.0
14---
16# NAME
18CURLOPT_HTTPSIG_HEADERS - components to sign for HTTP Message Signatures
20# SYNOPSIS
22~~~c
23#include <curl/curl.h>
25CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPSIG_HEADERS,
26 char *components);
27~~~
29# DESCRIPTION
31This feature is **experimental** and may change before it is considered
32stable. We advise against using it in production.
34Pass a space-separated list of component identifiers to include in the
35RFC 9421 HTTP Message Signature.
37Derived components are given as bare names:
39- **method** - the HTTP method (GET, POST, etc.)
40- **authority** - the host and optional port
41- **path** - the request path
42- **query** - the query string including the leading `?`
44HTTP header fields are given with a trailing colon, for example `content-type:`
45or `content-digest:`. This mirrors how a header looks and keeps a leading `@`
46free for its usual curl meaning (read the value from a file).
48If this option is not set, the default components are **method**, **authority**,
49**path** (plus **query** when a query string is present).
51## Signing request headers
53Header components are resolved from the list set with CURLOPT_HTTPHEADER(3)
54only. Headers that libcurl adds later (such as the default `User-Agent`) are
55**not** visible to the signer unless the application supplies them explicitly.
57To sign `User-Agent`, supply it via CURLOPT_HTTPHEADER(3) together with this
58option before the transfer; see EXAMPLE.
60Each component identifier may appear at most once (RFC 9421 Section 2).
61Listing the same component twice returns `CURLE_BAD_FUNCTION_ARGUMENT`.
63At most 16 components are accepted; supplying more returns
64`CURLE_BAD_FUNCTION_ARGUMENT`.
66The application does not have to keep the string around after setting this
67option.
69# DEFAULT
71NULL (uses the default component set)
73# %PROTOCOLS%
75# EXAMPLE
77~~~c
78int main(void)
80 CURL *curl = curl_easy_init();
81 struct curl_slist *headers = NULL;
83 if(curl) {
84 headers = curl_slist_append(headers, "User-Agent: MyApp/1.0");
85 curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
86 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/api");
87 curl_easy_setopt(curl, CURLOPT_HTTPSIG_ALGORITHM, CURLHTTPSIG_ED25519);
88 curl_easy_setopt(curl, CURLOPT_HTTPSIG_KEY,
89 "9f8362f87a484a954e6e740c5b4c0e84"
90 "229139a20aa8ab56ff66586f6a7d29c5");
91 curl_easy_setopt(curl, CURLOPT_HTTPSIG_KEYID, "my-key-id");
92 curl_easy_setopt(curl, CURLOPT_HTTPSIG_HEADERS,
93 "method authority path content-type: user-agent:");
94 curl_easy_perform(curl);
95 curl_slist_free_all(headers);
96 }
98~~~
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 · 168 ms
CallStatusSizeTime0168 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 · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=2
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 · hit3 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=3
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 KiB163 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=162
git.response.bytes=1535
git.response.cache=MISS
git.response.duration_ms=163
git.fetch.wants=ef56d2f9bb65f3f8c335797da45b54791b30c471
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=1535
git.pkt.payload.max=1514
git.sideband.band1.bytes=1513
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
a5e392e58f8c5751
Request
41dec67e…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format