71 lines
2.3 KiB
Groff
71 lines
2.3 KiB
Groff
|
.\" generated by cd2nroff 0.1 from CURLOPT_HSTS.md
|
||
|
|
.TH CURLOPT_HSTS 3 "2025-07-07" libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_HSTS \- HSTS cache filename
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTS, char *filename);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Make the \fIfilename\fP point to a filename to load an existing HSTS cache
|
||
|
|
from, and to store the cache in when the easy handle is closed. Setting a file
|
||
|
|
name with this option also enables HSTS for this handle (the equivalent of
|
||
|
|
setting \fICURLHSTS_ENABLE\fP with \fICURLOPT_HSTS_CTRL(3)\fP).
|
||
|
|
|
||
|
|
If the given file does not exist or contains no HSTS entries at startup, the
|
||
|
|
HSTS cache simply starts empty. Setting the filename to NULL allows HSTS
|
||
|
|
without reading from or writing to any file. NULL also makes libcurl clear the
|
||
|
|
list of files to read HSTS data from, if any such were previously set.
|
||
|
|
|
||
|
|
If this option is set multiple times, libcurl loads cache entries from each
|
||
|
|
given file but only stores the last used name for later writing.
|
||
|
|
.SH FILE FORMAT
|
||
|
|
The HSTS cache is saved to and loaded from a text file with one entry per
|
||
|
|
physical line. Each line in the file has the following format:
|
||
|
|
|
||
|
|
.nf
|
||
|
|
[host] [stamp]
|
||
|
|
.fi
|
||
|
|
|
||
|
|
[host] is the domain name for the entry and the name is dot\-prefixed if it is
|
||
|
|
an entry valid for all subdomains to the name as well or only for the exact
|
||
|
|
name.
|
||
|
|
|
||
|
|
[stamp] is the time (in UTC) when the entry expires and it uses the format
|
||
|
|
\&"YYYYMMDD HH:MM:SS".
|
||
|
|
|
||
|
|
Lines starting with "#" are treated as comments and are ignored. There is
|
||
|
|
currently no length or size limit.
|
||
|
|
.SH DEFAULT
|
||
|
|
NULL, no filename
|
||
|
|
.SH SECURITY CONCERNS
|
||
|
|
libcurl cannot fully protect against attacks where an attacker has write
|
||
|
|
access to the same directory where it is directed to save files. This is
|
||
|
|
particularly sensitive if you save files using elevated privileges.
|
||
|
|
.SH PROTOCOLS
|
||
|
|
This functionality affects http only
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
int main(void)
|
||
|
|
{
|
||
|
|
CURL *curl = curl_easy_init();
|
||
|
|
if(curl) {
|
||
|
|
curl_easy_setopt(curl, CURLOPT_HSTS, "/home/user/.hsts-cache");
|
||
|
|
curl_easy_perform(curl);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH AVAILABILITY
|
||
|
|
Added in curl 7.74.0
|
||
|
|
.SH RETURN VALUE
|
||
|
|
\fIcurl_easy_setopt(3)\fP returns a CURLcode indicating success or error.
|
||
|
|
|
||
|
|
CURLE_OK (0) means everything was OK, non\-zero means an error occurred, see
|
||
|
|
\fIlibcurl\-errors(3)\fP.
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR CURLOPT_ALTSVC (3),
|
||
|
|
.BR CURLOPT_HSTS_CTRL (3),
|
||
|
|
.BR CURLOPT_RESOLVE (3)
|