Blame view

3rdparty/curl/share/man/man3/CURLOPT_HSTSWRITEFUNCTION.3 3.14 KB
a86c63ca   Hu Chunming   提交三方库文件
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
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
  .\" *
  .\" * This software is licensed as described in the file COPYING, which
  .\" * you should have received as part of this distribution. The terms
  .\" * are also available at https://curl.se/docs/copyright.html.
  .\" *
  .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  .\" * copies of the Software, and permit persons to whom the Software is
  .\" * furnished to do so, under the terms of the COPYING file.
  .\" *
  .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  .\" * KIND, either express or implied.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLOPT_HSTSWRITEFUNCTION 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_HSTSWRITEFUNCTION \- write callback for HSTS hosts
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLSTScode hstswrite(CURL *easy, struct curl_hstsentry *sts,
                        struct curl_index *count, void *userp);
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTSWRITEFUNCTION, hstswrite);
  .SH EXPERIMENTAL
  Warning: this feature is early code and is marked as experimental. It can only
  be enabled by explicitly telling configure with \fB--enable-hsts\fP. You are
  advised to not ship this in production before the experimental label is
  removed.
  .SH 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 \fIuserp\fP argument with the \fICURLOPT_HSTSWRITEDATA(3)\fP option or
  it will be NULL.
  
  When the callback is invoked, the \fIsts\fP 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 \fICURLSTS_OK\fP if it succeeded and is prepared to
  be called again (for another host) or \fICURLSTS_DONE\fP if there's nothing
  more to do. It can also return \fICURLSTS_FAIL\fP to signal error.
  .SH DEFAULT
  NULL - no callback.
  .SH PROTOCOLS
  This feature is only used for HTTP(S) transfer.
  .SH EXAMPLE
  .nf
  {
    /* 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);
  }
  .fi
  .SH AVAILABILITY
  Added in 7.74.0
  .SH RETURN VALUE
  This will return CURLE_OK.
  .SH "SEE ALSO"
  .BR CURLOPT_HSTSWRITEDATA "(3), " CURLOPT_HSTSWRITEFUNCTION "(3), "
  .BR CURLOPT_HSTS "(3), " CURLOPT_HSTS_CTRL "(3), "