The mandatory header now has a mandatory list of protocols for which the manpage is relevant. Most man pages already has a "PROTOCOLS" section, but this introduces a stricter way to specify the relevant protocols. cd2nroff verifies that at least one protocol is mentioned (which can be `*`). This information is not used just yet, but A) the PROTOCOLS section can now instead get generated and get a unified wording across all manpages and B) this allows us to more reliably filter/search for protocol specific manpages/options. Closes #13166
1.6 KiB
c | SPDX-License-Identifier | Title | Section | Source | Protocol | See-also | |||||
---|---|---|---|---|---|---|---|---|---|---|---|
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. | curl | CURLOPT_HSTS_CTRL | 3 | libcurl |
|
|
NAME
CURLOPT_HSTS_CTRL - control HSTS behavior
SYNOPSIS
#include <curl/curl.h>
#define CURLHSTS_ENABLE (1<<0)
#define CURLHSTS_READONLYFILE (1<<1)
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTS_CTRL, long bitmask);
DESCRIPTION
HSTS (HTTP Strict Transport Security) means that an HTTPS server can instruct the client to not contact it again over clear-text HTTP for a certain period into the future. libcurl then automatically redirects HTTP attempts to such hosts to instead use HTTPS. This is done by libcurl retaining this knowledge in an in-memory cache.
Populate the long bitmask with the correct set of features to instruct libcurl how to handle HSTS for the transfers using this handle.
BITS
CURLHSTS_ENABLE
Enable the in-memory HSTS cache for this handle.
CURLHSTS_READONLYFILE
Make the HSTS file (if specified) read-only - makes libcurl not save the cache to the file when closing the handle.
DEFAULT
- HSTS is disabled by default.
PROTOCOLS
HTTPS and HTTP
EXAMPLE
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_HSTS_CTRL, (long)CURLHSTS_ENABLE);
curl_easy_perform(curl);
}
}
AVAILABILITY
Added in 7.74.0
RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.