CURLOPT_TLS13_CIPHERS.3 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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.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_TLS13_CIPHERS 3 "25 May 2018" "libcurl 7.61.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_TLS13_CIPHERS \- ciphers suites to use for TLS 1.3
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLS13_CIPHERS, char *list);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a char *, pointing to a null-terminated string holding the list of cipher
  33. suites to use for the TLS 1.3 connection. The list must be syntactically
  34. correct, it consists of one or more cipher suite strings separated by colons.
  35. you will find more details about cipher lists on this URL:
  36. https://curl.se/docs/ssl-ciphers.html
  37. This option is currently used only when curl is built to use OpenSSL 1.1.1 or
  38. later. If you are using a different SSL backend you can try setting TLS 1.3
  39. cipher suites by using the CURLOPT_SSL_CIPHER_LIST option.
  40. The application does not have to keep the string around after setting this
  41. option.
  42. .SH DEFAULT
  43. NULL, use internal default
  44. .SH PROTOCOLS
  45. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  46. .SH EXAMPLE
  47. .nf
  48. CURL *curl = curl_easy_init();
  49. if(curl) {
  50. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  51. curl_easy_setopt(curl, CURLOPT_TLS13_CIPHERS,
  52. "TLS13-CHACHA20-POLY1305-SHA256");
  53. ret = curl_easy_perform(curl);
  54. curl_easy_cleanup(curl);
  55. }
  56. .fi
  57. .SH AVAILABILITY
  58. Added in 7.61.0.
  59. Available when built with OpenSSL >= 1.1.1.
  60. .SH RETURN VALUE
  61. Returns CURLE_OK if supported, CURLE_NOT_BUILT_IN otherwise.
  62. .SH "SEE ALSO"
  63. .BR CURLOPT_SSL_CIPHER_LIST "(3), " CURLOPT_SSLVERSION "(3), "
  64. .BR CURLOPT_PROXY_SSL_CIPHER_LIST "(3), " CURLOPT_PROXY_TLS13_CIPHERS "(3), "
  65. .BR CURLOPT_PROXY_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "