CURLOPT_TLS13_CIPHERS.3 2.8 KB

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