Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_SSL_SESSIONID_CACHE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_SSL_SESSIONID_CACHE 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_SSL_SESSIONID_CACHE \- enable/disable use of the SSL session-ID cache
27 .SH SYNOPSIS
28 .nf
29 #include <curl/curl.h>
30
31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_SESSIONID_CACHE,
32                          long enabled);
33 .SH DESCRIPTION
34 Pass a long set to 0 to disable libcurl's use of SSL session-ID caching. Set
35 this to 1 to enable it. By default all transfers are done using the cache
36 enabled. While nothing ever should get hurt by attempting to reuse SSL
37 session-IDs, there seem to be or have been broken SSL implementations in the
38 wild that may require you to disable this in order for you to succeed.
39 .SH DEFAULT
40 1
41 .SH PROTOCOLS
42 All TLS-based
43 .SH EXAMPLE
44 .nf
45 CURL *curl = curl_easy_init();
46 if(curl) {
47   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
48   /* switch off session-id use! */
49   curl_easy_setopt(curl, CURLOPT_SSL_SESSIONID_CACHE, 0L);
50   ret = curl_easy_perform(curl);
51   curl_easy_cleanup(curl);
52 }
53 .fi
54 .SH AVAILABILITY
55 Added in 7.16.0
56 .SH RETURN VALUE
57 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
58 .SH "SEE ALSO"
59 .BR CURLOPT_DNS_CACHE_TIMEOUT "(3), " CURLOPT_SSLVERSION "(3), "