GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
CURLOPT_HSTSWRITEFUNCTION(3) curl_easy_setopt options CURLOPT_HSTSWRITEFUNCTION(3)

CURLOPT_HSTSWRITEFUNCTION - write callback for HSTS hosts

#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 *userp);
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTSWRITEFUNCTION, hstswrite);

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 userp argument with the CURLOPT_HSTSWRITEDATA(3) option or it will be NULL.

When the callback is invoked, the sts pointer points to a populated struct: Read the host name 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's 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.

NULL - no callback.

This feature is only used for HTTP(S) transfer.

{
  /* set HSTS read callback */
  curl_easy_setopt(curl, CURLOPT_HSTSWRITEFUNCTION, hstswrite);
  /* pass in suitable argument to the callback */
  curl_easy_setopt(curl, CURLOPT_HSTSWRITEDATA, &hstspreload[0]);
  result = curl_easy_perform(curl);
}

Added in 7.74.0

This will return CURLE_OK.

CURLOPT_HSTSWRITEDATA(3), CURLOPT_HSTSWRITEFUNCTION(3), CURLOPT_HSTS(3), CURLOPT_HSTS_CTRL(3),
May 3, 2022 libcurl 7.83.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.