Artifactspublic-v0

curl

master
ply4 git calls298 ms288 KiB2 cachedprotocol v2
88 lines1.9 KiBRaw

NAME

CURLOPT_HTTPSIG_ALGORITHM - RFC 9421 HTTP Message Signatures algorithm

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPSIG_ALGORITHM,
                          long algorithm);

DESCRIPTION

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

Enable RFC 9421 HTTP Message Signatures on outgoing requests. Pass a long set to one of the values below to select the signing algorithm.

CURLHTTPSIG_NONE (0)

Disable HTTP Message Signatures.

CURLHTTPSIG_ED25519 (1)

Sign with Ed25519 (RFC 8032). Requires a TLS backend with Ed25519 support.

CURLHTTPSIG_HMAC_SHA256 (2)

Sign with HMAC-SHA256.

Setting this option to a non-zero value also sets CURLOPT_HTTPAUTH(3) to CURLAUTH_HTTPSIG. The options CURLOPT_HTTPSIG_KEY(3) and CURLOPT_HTTPSIG_KEYID(3) must also be set.

DEFAULT

CURLHTTPSIG_NONE (0)

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();

  if(curl) {
    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_perform(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_HTTPSIG_ALGORITHM
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_HTTPSIG_HEADERS (3)
9 - CURLOPT_HTTPSIG_KEY (3)
10 - CURLOPT_HTTPSIG_KEYID (3)
11 - CURLOPT_HTTPAUTH (3)
12Protocol:
13 - HTTP
14Added-in: 8.22.0
15---
17# NAME
19CURLOPT_HTTPSIG_ALGORITHM - RFC 9421 HTTP Message Signatures algorithm
21# SYNOPSIS
23~~~c
24#include <curl/curl.h>
26CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPSIG_ALGORITHM,
27 long algorithm);
28~~~
30# DESCRIPTION
32This feature is **experimental** and may change before it is considered
33stable. We advise against using it in production.
35Enable RFC 9421 HTTP Message Signatures on outgoing requests. Pass a long
36set to one of the values below to select the signing algorithm.
38## CURLHTTPSIG_NONE (0)
40Disable HTTP Message Signatures.
42## CURLHTTPSIG_ED25519 (1)
44Sign with Ed25519 (RFC 8032). Requires a TLS backend with Ed25519 support.
46## CURLHTTPSIG_HMAC_SHA256 (2)
48Sign with HMAC-SHA256.
50##
52Setting this option to a non-zero value also sets CURLOPT_HTTPAUTH(3) to
53CURLAUTH_HTTPSIG. The options CURLOPT_HTTPSIG_KEY(3) and
54CURLOPT_HTTPSIG_KEYID(3) must also be set.
56# DEFAULT
58CURLHTTPSIG_NONE (0)
60# %PROTOCOLS%
62# EXAMPLE
64~~~c
65int main(void)
67 CURL *curl = curl_easy_init();
69 if(curl) {
70 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/api");
71 curl_easy_setopt(curl, CURLOPT_HTTPSIG_ALGORITHM, CURLHTTPSIG_ED25519);
72 curl_easy_setopt(curl, CURLOPT_HTTPSIG_KEY,
73 "9f8362f87a484a954e6e740c5b4c0e84"
74 "229139a20aa8ab56ff66586f6a7d29c5");
75 curl_easy_setopt(curl, CURLOPT_HTTPSIG_KEYID, "my-key-id");
76 curl_easy_perform(curl);
77 }
79~~~
81# %AVAILABILITY%
83# RETURN VALUE
85curl_easy_setopt(3) returns a CURLcode indicating success or error.
87CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
88libcurl-errors(3).
Diagnostics4 git calls · 298 ms
CallStatusSizeTime0298 ms
discover200152 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=1
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 · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=293
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.0 KiB293 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1037
git.response.cache=MISS
git.response.duration_ms=293
git.fetch.wants=3fa4da378bd078f45ee5ec1ce69a4a25e740d9fb
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=1037
git.pkt.payload.max=1016
git.sideband.band1.bytes=1015
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
a5e361931bdcb86e
Request
7ed63598…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format