Artifactspublic-v0

curl

master
ply4 git calls282 ms288 KiB2 cachedprotocol v2
110 lines2.6 KiBRaw

NAME

CURLOPT_HSTSREADFUNCTION - read callback for HSTS hosts

SYNOPSIS

c
#include <curl/curl.h>

struct curl_hstsentry {
  char *name;
  size_t namelen;
  unsigned int includeSubDomains:1;
  char expire[18]; /* YYYYMMDD HH:MM:SS [null-terminated] */
};

CURLSTScode hstsread(CURL *easy, struct curl_hstsentry *sts, void *clientp);

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTSREADFUNCTION, hstsread);

DESCRIPTION

Pass a pointer to your callback function, as the prototype shows above.

This callback function gets called by libcurl repeatedly when it populates the in-memory HSTS cache.

Set the clientp argument with the CURLOPT_HSTSREADDATA(3) option or it is NULL.

When this callback is invoked, the sts pointer points to a populated struct: Copy the hostname to name (no longer than namelen bytes). Make it null-terminated. Set includeSubDomains to TRUE or FALSE. Set expire to a date stamp or a zero length string for forever (wrong date stamp format might cause the name to not get accepted)

The callback should return CURLSTS_OK if it returns a name and is prepared to be called again (for another host) or CURLSTS_DONE if it has no entry to return. It can also return CURLSTS_FAIL to signal error. Returning CURLSTS_FAIL stops the transfer from being performed and make CURLE_ABORTED_BY_CALLBACK get returned.

This option does not enable HSTS, you need to use CURLOPT_HSTS_CTRL(3) to do that.

The hostname provided to libcurl should not have a trailing dot nor leading dot.

DEFAULT

NULL - no callback.

%PROTOCOLS%

EXAMPLE

c
struct priv {
  void *custom;
};

static CURLSTScode hsts_cb(CURL *easy, struct curl_hstsentry *sts,
                           void *clientp)
{
  /* populate the struct as documented */
  return CURLSTS_OK;
}

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    struct priv my_stuff;
    CURLcode result;

    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    /* set HSTS read callback */
    curl_easy_setopt(curl, CURLOPT_HSTSREADFUNCTION, hsts_cb);

    /* pass in suitable argument to the callback */
    curl_easy_setopt(curl, CURLOPT_HSTSREADDATA, &my_stuff);

    result = curl_easy_perform(curl);
  }
}

%AVAILABILITY%

RETURN VALUE

This returns CURLE_OK.

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_HSTSREADFUNCTION
5Section: 3
6Source: libcurl
7Protocol:
8 - HTTP
9See-also:
10 - CURLOPT_HSTS (3)
11 - CURLOPT_HSTSREADDATA (3)
12 - CURLOPT_HSTSWRITEFUNCTION (3)
13 - CURLOPT_HSTS_CTRL (3)
14Added-in: 7.74.0
15---
17# NAME
19CURLOPT_HSTSREADFUNCTION - read callback for HSTS hosts
21# SYNOPSIS
23~~~c
24#include <curl/curl.h>
26struct curl_hstsentry {
27 char *name;
28 size_t namelen;
29 unsigned int includeSubDomains:1;
30 char expire[18]; /* YYYYMMDD HH:MM:SS [null-terminated] */
31};
33CURLSTScode hstsread(CURL *easy, struct curl_hstsentry *sts, void *clientp);
35CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTSREADFUNCTION, hstsread);
36~~~
38# DESCRIPTION
40Pass a pointer to your callback function, as the prototype shows above.
42This callback function gets called by libcurl repeatedly when it populates the
43in-memory HSTS cache.
45Set the *clientp* argument with the CURLOPT_HSTSREADDATA(3) option or it is
46NULL.
48When this callback is invoked, the *sts* pointer points to a populated struct:
49Copy the hostname to *name* (no longer than *namelen* bytes). Make it
50null-terminated. Set *includeSubDomains* to TRUE or FALSE. Set *expire* to a
51date stamp or a zero length string for *forever* (wrong date stamp format
52might cause the name to not get accepted)
54The callback should return *CURLSTS_OK* if it returns a name and is prepared
55to be called again (for another host) or *CURLSTS_DONE* if it has no entry to
56return. It can also return *CURLSTS_FAIL* to signal error. Returning
57*CURLSTS_FAIL* stops the transfer from being performed and make
58*CURLE_ABORTED_BY_CALLBACK* get returned.
60This option does not enable HSTS, you need to use CURLOPT_HSTS_CTRL(3) to do
61that.
63The hostname provided to libcurl *should not* have a trailing dot nor leading
64dot.
66# DEFAULT
68NULL - no callback.
70# %PROTOCOLS%
72# EXAMPLE
74~~~c
75struct priv {
76 void *custom;
77};
79static CURLSTScode hsts_cb(CURL *easy, struct curl_hstsentry *sts,
80 void *clientp)
82 /* populate the struct as documented */
83 return CURLSTS_OK;
86int main(void)
88 CURL *curl = curl_easy_init();
89 if(curl) {
90 struct priv my_stuff;
91 CURLcode result;
93 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
95 /* set HSTS read callback */
96 curl_easy_setopt(curl, CURLOPT_HSTSREADFUNCTION, hsts_cb);
98 /* pass in suitable argument to the callback */
99 curl_easy_setopt(curl, CURLOPT_HSTSREADDATA, &my_stuff);
101 result = curl_easy_perform(curl);
102 }
104~~~
106# %AVAILABILITY%
108# RETURN VALUE
110This returns CURLE_OK.
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 · 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=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.3 KiB276 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1359
git.response.cache=MISS
git.response.duration_ms=276
git.fetch.wants=259d2f0f26ed41456da88e1e9c2cc67bd9910367
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=1359
git.pkt.payload.max=1338
git.sideband.band1.bytes=1337
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
a5e337359e2424ce
Request
a2646247…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format