Artifactspublic-v0

curl

master
ply4 git calls295 ms288 KiB2 cachedprotocol v2
91 lines2.2 KiBRaw

NAME

CURLOPT_HTTPSIG_KEY - hex-encoded key for HTTP Message Signatures

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPSIG_KEY, char *key);

DESCRIPTION

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

Pass a null-terminated string containing the hex-encoded private key or shared secret used for RFC 9421 HTTP Message Signatures.

For ed25519, this is the 32-byte private seed (64 hex characters). For hmac-sha256, this is the shared secret as hex; the decoded length is half the number of hex digits, up to CURL_MAX_INPUT_LENGTH / 2 bytes (the same upper bound as other libcurl string options).

PEM and other encodings are not supported; pass the raw key material as hex.

Generating Ed25519 keys

With OpenSSL 3:

openssl genpkey -algorithm ED25519 -out k.pem
openssl pkey -in k.pem -text -noout | \
  grep -A3 ^priv: | \
  tr -cd '[:xdigit:]' > k.hex

The key.hex file is one line of 64 hexadecimal digits.

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.

DEFAULT

NULL

%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_KEY
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_HTTPSIG_ALGORITHM (3)
9 - CURLOPT_HTTPSIG_KEYID (3)
10Protocol:
11 - HTTP
12Added-in: 8.22.0
13---
15# NAME
17CURLOPT_HTTPSIG_KEY - hex-encoded key for HTTP Message Signatures
19# SYNOPSIS
21~~~c
22#include <curl/curl.h>
24CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPSIG_KEY, char *key);
25~~~
27# DESCRIPTION
29This feature is **experimental** and may change before it is considered
30stable. We advise against using it in production.
32Pass a null-terminated string containing the hex-encoded private key or
33shared secret used for RFC 9421 HTTP Message Signatures.
35For **ed25519**, this is the 32-byte private seed (64 hex characters). For
36**hmac-sha256**, this is the shared secret as hex; the decoded length is half
37the number of hex digits, up to `CURL_MAX_INPUT_LENGTH / 2` bytes (the same
38upper bound as other libcurl string options).
40PEM and other encodings are not supported; pass the raw key material as hex.
42## Generating Ed25519 keys
44With OpenSSL 3:
46 openssl genpkey -algorithm ED25519 -out k.pem
47 openssl pkey -in k.pem -text -noout | \
48 grep -A3 ^priv: | \
49 tr -cd '[:xdigit:]' > k.hex
51The `key.hex` file is one line of 64 hexadecimal digits.
53The application does not have to keep the string around after setting this
54option.
56Using this option multiple times makes the last set string override the
57previous ones. Set it to NULL to disable its use again.
59# DEFAULT
61NULL
63# %PROTOCOLS%
65# EXAMPLE
67~~~c
68int main(void)
70 CURL *curl = curl_easy_init();
72 if(curl) {
73 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/api");
74 curl_easy_setopt(curl, CURLOPT_HTTPSIG_ALGORITHM, CURLHTTPSIG_ED25519);
75 curl_easy_setopt(curl, CURLOPT_HTTPSIG_KEY,
76 "9f8362f87a484a954e6e740c5b4c0e84"
77 "229139a20aa8ab56ff66586f6a7d29c5");
78 curl_easy_setopt(curl, CURLOPT_HTTPSIG_KEYID, "my-key-id");
79 curl_easy_perform(curl);
80 }
82~~~
84# %AVAILABILITY%
86# RETURN VALUE
88curl_easy_setopt(3) returns a CURLcode indicating success or error.
90CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
91libcurl-errors(3).
Diagnostics4 git calls · 295 ms
CallStatusSizeTime0295 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 · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=1
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.3 KiB289 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=289
git.response.bytes=1309
git.response.cache=MISS
git.response.duration_ms=289
git.fetch.wants=94d65353dd39b9668d2abb989673b4b3c145fe86
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=1309
git.pkt.payload.max=1288
git.sideband.band1.bytes=1287
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
a5e35d16f8f75cd4
Request
bdc3e630…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format