CURLOPT_TLS13_CIPHERS.3 2.4 KB

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