1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: CURLOPT_HSTSWRITEFUNCTION
Section: 3
Source: libcurl
Protocol:
- HTTP
See-also:
- CURLOPT_HSTS (3)
- CURLOPT_HSTSWRITEDATA (3)
- CURLOPT_HSTSWRITEFUNCTION (3)
- CURLOPT_HSTS_CTRL (3)
Added-in: 7.74.0
---
# 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.
|
