Artifactspublic-v0

curl

master
ply4 git calls131 ms288 KiB2 cachedprotocol v2
108 lines2.5 KiBRaw

NAME

CURLOPT_HSTSWRITEFUNCTION - write 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] */
};

struct curl_index {
  size_t index; /* the provided entry's "index" or count */
  size_t total; /* total number of entries to save */
};

CURLSTScode hstswrite(CURL *easy, struct curl_hstsentry *sts,
                      struct curl_index *count, void *clientp);

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTSWRITEFUNCTION, hstswrite);

DESCRIPTION

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

This callback function gets called by libcurl repeatedly to allow the application to store the in-memory HSTS cache when libcurl is about to discard it.

Set the clientp argument with the CURLOPT_HSTSWRITEDATA(3) option or it is NULL. When the callback is invoked, the sts pointer points to a populated struct: Read the hostname to 'name' (it is namelen bytes long and null-terminated. The includeSubDomains field is non-zero if the entry matches subdomains. The expire string is a date stamp null-terminated string using the syntax YYYYMMDD HH:MM:SS.

The callback should return CURLSTS_OK if it succeeded and is prepared to be called again (for another host) or CURLSTS_DONE if there is nothing more to do. It can also return CURLSTS_FAIL to signal error.

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

DEFAULT

NULL - no callback.

%PROTOCOLS%

EXAMPLE

c
struct priv {
  void *custom;
};

static CURLSTScode hswr_cb(CURL *easy, struct curl_hstsentry *sts,
                           struct curl_index *count, void *clientp)
{
  /* save the passed in HSTS data somewhere */
  return CURLSTS_OK;
}

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

    /* set HSTS read callback */
    curl_easy_setopt(curl, CURLOPT_HSTSWRITEFUNCTION, hswr_cb);

    /* pass in suitable argument to the callback */
    curl_easy_setopt(curl, CURLOPT_HSTSWRITEDATA, &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_HSTSWRITEFUNCTION
5Section: 3
6Source: libcurl
7Protocol:
8 - HTTP
9See-also:
10 - CURLOPT_HSTS (3)
11 - CURLOPT_HSTSWRITEDATA (3)
12 - CURLOPT_HSTSWRITEFUNCTION (3)
13 - CURLOPT_HSTS_CTRL (3)
14Added-in: 7.74.0
15---
17# NAME
19CURLOPT_HSTSWRITEFUNCTION - write 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};
33struct curl_index {
34 size_t index; /* the provided entry's "index" or count */
35 size_t total; /* total number of entries to save */
36};
38CURLSTScode hstswrite(CURL *easy, struct curl_hstsentry *sts,
39 struct curl_index *count, void *clientp);
41CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTSWRITEFUNCTION, hstswrite);
42~~~
44# DESCRIPTION
46Pass a pointer to your callback function, as the prototype shows above.
48This callback function gets called by libcurl repeatedly to allow the
49application to store the in-memory HSTS cache when libcurl is about to discard
50it.
52Set the *clientp* argument with the CURLOPT_HSTSWRITEDATA(3) option or it is
53NULL. When the callback is invoked, the *sts* pointer points to a populated
54struct: Read the hostname to 'name' (it is *namelen* bytes long and
55null-terminated. The *includeSubDomains* field is non-zero if the entry
56matches subdomains. The *expire* string is a date stamp null-terminated string
57using the syntax YYYYMMDD HH:MM:SS.
59The callback should return *CURLSTS_OK* if it succeeded and is prepared to be
60called again (for another host) or *CURLSTS_DONE* if there is nothing more to
61do. It can also return *CURLSTS_FAIL* to signal error.
63This option does not enable HSTS, you need to use CURLOPT_HSTS_CTRL(3) to
64do that.
66# DEFAULT
68NULL - no callback.
70# %PROTOCOLS%
72# EXAMPLE
74~~~c
75struct priv {
76 void *custom;
77};
79static CURLSTScode hswr_cb(CURL *easy, struct curl_hstsentry *sts,
80 struct curl_index *count, void *clientp)
82 /* save the passed in HSTS data somewhere */
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 /* set HSTS read callback */
94 curl_easy_setopt(curl, CURLOPT_HSTSWRITEFUNCTION, hswr_cb);
96 /* pass in suitable argument to the callback */
97 curl_easy_setopt(curl, CURLOPT_HSTSWRITEDATA, &my_stuff);
99 result = curl_easy_perform(curl);
100 }
102~~~
104# %AVAILABILITY%
106# RETURN VALUE
108This returns CURLE_OK.
Diagnostics4 git calls · 131 ms
CallStatusSizeTime0131 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.3 KiB126 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=126
git.response.bytes=1303
git.response.cache=MISS
git.response.duration_ms=126
git.fetch.wants=180cd39dd2c8c6612b5ad65b8c379821a09f024a
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=1303
git.pkt.payload.max=1282
git.sideband.band1.bytes=1281
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
a5e313acaad53e6e
Request
55af9b0c…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format