ctai/3rdparty/curl/share/man/man3/CURLOPT_CA_CACHE_TIMEOUT.3
2025-02-24 17:47:32 +08:00

66 lines
2.0 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_CA_CACHE_TIMEOUT.md
.TH CURLOPT_CA_CACHE_TIMEOUT 3 "2024-09-25" libcurl
.SH NAME
CURLOPT_CA_CACHE_TIMEOUT \- life\-time for cached certificate stores
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CA_CACHE_TIMEOUT, long age);
.fi
.SH DESCRIPTION
Pass a long, this sets the timeout in seconds. This tells libcurl the maximum
time any cached CA certificate store it has in memory may be kept and reused
for new connections. Once the timeout has expired, a subsequent fetch
requiring a CA certificate has to reload it.
Building a CA certificate store from a \fICURLOPT_CAINFO(3)\fP file is a slow
operation so curl may cache the generated certificate store internally to
speed up future connections.
Set the timeout to zero to completely disable caching, or set to \-1 to retain
the cached store remain forever. By default, libcurl caches this info for 24
hours.
.SH DEFAULT
86400 (24 hours)
.SH PROTOCOLS
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This option works only with the following TLS backends:
GnuTLS, OpenSSL, Schannel and wolfSSL
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
/* only reuse certificate stores for a short time */
curl_easy_setopt(curl, CURLOPT_CA_CACHE_TIMEOUT, 60L);
res = curl_easy_perform(curl);
/* in this second request, the cache is not used if more than
sixty seconds passed since the previous connection */
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
}
.fi
.SH HISTORY
This option is supported by OpenSSL and its forks (since 7.87.0), Schannel
(since 8.5.0), wolfSSL (since 8.9.0) and GnuTLS (since 8.9.0).
.SH AVAILABILITY
Added in curl 7.87.0
.SH RETURN VALUE
Returns CURLE_OK
.SH SEE ALSO
.BR CURLOPT_CAINFO (3),
.BR CURLOPT_CAINFO_BLOB (3),
.BR CURLOPT_CAPATH (3),
.BR CURLOPT_SSL_VERIFYHOST (3),
.BR CURLOPT_SSL_VERIFYPEER (3)