Artifactspublic-v0

curl

master
ply4 git calls282 ms289 KiB2 cachedprotocol v2
131 lines3.6 KiBRaw

NAME

CURLOPT_AWS_SIGV4 - V4 signature

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_AWS_SIGV4, char *param);

DESCRIPTION

Provides AWS V4 signature authentication on HTTP(S) header.

Pass a char pointer that is the collection of specific arguments are used for creating outgoing authentication headers. The format of the param option is:

provider1[:provider2[:region[:service]]]

provider1, provider2

The providers arguments are used for generating some authentication parameters such as "Algorithm", "date", "request type" and "signed headers".

region

The argument is a geographic area of a resources collection. It is extracted from the hostname specified in the URL if omitted.

service

The argument is a function provided by a cloud. It is extracted from the hostname specified in the URL if omitted.

NOTE: This call set CURLOPT_HTTPAUTH(3) to CURLAUTH_AWS_SIGV4. Calling CURLOPT_HTTPAUTH(3) with CURLAUTH_AWS_SIGV4 is the same as calling this with "aws:amz" in parameter.

Example with "Test:Try", when curl uses the algorithm, it generates "TEST-HMAC-SHA256" for "Algorithm", "x-try-date" and "X-Try-Date" for "date", "test4_request" for "request type", "SignedHeaders=content-type;host;x-try-date" for "signed headers"

If you use "test", instead of "test:try", test is used for every generated string.

Setting CURLOPT_HTTPAUTH(3) with the CURLAUTH_AWS_SIGV4 bit set is the same as setting this option with a "aws:amz" parameter.

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) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL,
                    "https://service.region.example.com/uri");
    curl_easy_setopt(curl, CURLOPT_AWS_SIGV4, "provider1:provider2");

    /* service and region can also be set in CURLOPT_AWS_SIGV4 */
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/uri");
    curl_easy_setopt(curl, CURLOPT_AWS_SIGV4,
                     "provider1:provider2:region:service");

    curl_easy_setopt(curl, CURLOPT_USERPWD, "MY_ACCESS_KEY:MY_SECRET_KEY");
    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

NOTES

This option overrides the other auth types you might have set in CURLOPT_HTTPAUTH(3) which should be highlighted as this makes this auth method special. This method cannot be combined with other auth types.

A sha256 checksum of the request payload is used as input to the signature calculation. For POST requests, this is a checksum of the provided CURLOPT_POSTFIELDS(3). Otherwise, it is the checksum of an empty buffer. For requests like PUT, you can provide your own checksum in an HTTP header named x-provider2-content-sha256.

For aws:s3, a x-amz-content-sha256 header is added to every request if not already present. For s3 requests with unknown payload, this header takes the special value "UNSIGNED-PAYLOAD".

%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_AWS_SIGV4
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_HEADEROPT (3)
9 - CURLOPT_HTTPAUTH (3)
10 - CURLOPT_HTTPHEADER (3)
11 - CURLOPT_PROXYAUTH (3)
12Protocol:
13 - HTTP
14Added-in: 7.75.0
15---
17# NAME
19CURLOPT_AWS_SIGV4 - V4 signature
21# SYNOPSIS
23~~~c
24#include <curl/curl.h>
26CURLcode curl_easy_setopt(CURL *handle, CURLOPT_AWS_SIGV4, char *param);
27~~~
29# DESCRIPTION
31Provides AWS V4 signature authentication on HTTP(S) header.
33Pass a char pointer that is the collection of specific arguments are used for
34creating outgoing authentication headers. The format of the *param* option
35is:
37## provider1[:provider2[:region[:service]]]
39## provider1, provider2
41The providers arguments are used for generating some authentication parameters
42such as "Algorithm", "date", "request type" and "signed headers".
44## region
46The argument is a geographic area of a resources collection.
47It is extracted from the hostname specified in the URL if omitted.
49## service
51The argument is a function provided by a cloud. It is extracted from the
52hostname specified in the URL if omitted.
54##
56NOTE: This call set CURLOPT_HTTPAUTH(3) to CURLAUTH_AWS_SIGV4. Calling
57CURLOPT_HTTPAUTH(3) with CURLAUTH_AWS_SIGV4 is the same as calling this with
58**"aws:amz"** in parameter.
60Example with "Test:Try", when curl uses the algorithm, it generates
61**"TEST-HMAC-SHA256"** for "Algorithm", **"x-try-date"** and **"X-Try-Date"**
62for "date", **"test4_request"** for "request type",
63**"SignedHeaders=content-type;host;x-try-date"** for "signed headers"
65If you use "test", instead of "test:try", test is used for every generated
66string.
68Setting CURLOPT_HTTPAUTH(3) with the CURLAUTH_AWS_SIGV4 bit set is the same as
69setting this option with a **"aws:amz"** parameter.
71The application does not have to keep the string around after setting this
72option.
74Using this option multiple times makes the last set string override the
75previous ones. Set it to NULL to disable its use again.
77# DEFAULT
79NULL
81# %PROTOCOLS%
83# EXAMPLE
85~~~c
86int main(void)
88 CURL *curl = curl_easy_init();
90 if(curl) {
91 CURLcode result;
92 curl_easy_setopt(curl, CURLOPT_URL,
93 "https://service.region.example.com/uri");
94 curl_easy_setopt(curl, CURLOPT_AWS_SIGV4, "provider1:provider2");
96 /* service and region can also be set in CURLOPT_AWS_SIGV4 */
97 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/uri");
98 curl_easy_setopt(curl, CURLOPT_AWS_SIGV4,
99 "provider1:provider2:region:service");
101 curl_easy_setopt(curl, CURLOPT_USERPWD, "MY_ACCESS_KEY:MY_SECRET_KEY");
102 result = curl_easy_perform(curl);
103 curl_easy_cleanup(curl);
104 }
106~~~
108# NOTES
110This option overrides the other auth types you might have set in
111CURLOPT_HTTPAUTH(3) which should be highlighted as this makes this auth method
112special. This method cannot be combined with other auth types.
114A sha256 checksum of the request payload is used as input to the signature
115calculation. For POST requests, this is a checksum of the provided
116CURLOPT_POSTFIELDS(3). Otherwise, it is the checksum of an empty buffer. For
117requests like PUT, you can provide your own checksum in an HTTP header named
118**x-provider2-content-sha256**.
120For **aws:s3**, a **x-amz-content-sha256** header is added to every request if
121not already present. For s3 requests with unknown payload, this header takes
122the special value "UNSIGNED-PAYLOAD".
124# %AVAILABILITY%
126# RETURN VALUE
128curl_easy_setopt(3) returns a CURLcode indicating success or error.
130CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
131libcurl-errors(3).
Diagnostics4 git calls · 282 ms
CallStatusSizeTime0282 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=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=276
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.7 KiB276 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1780
git.response.cache=MISS
git.response.duration_ms=276
git.fetch.wants=2f17a201c358d1e4ae7a554927d9b20c55994b85
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=1780
git.pkt.payload.max=1759
git.sideband.band1.bytes=1758
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
a5e37ef34e139318
Request
ea5f5fb8…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format