CURLOPT_PROXY_TLS13_CIPHERS.3 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  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_PROXY_TLS13_CIPHERS 3 "25 May 2018" "libcurl 7.61.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROXY_TLS13_CIPHERS \- ciphers suites for proxy TLS 1.3
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLS13_CIPHERS,
  30. char *list);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a char *, pointing to a null-terminated string holding the list of cipher
  34. suites to use for the TLS 1.3 connection to a proxy. The list must be
  35. syntactically correct, it consists of one or more cipher suite strings
  36. 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. If you are using a different SSL backend you can try setting TLS 1.3
  41. cipher suites by using the CURLOPT_PROXY_SSL_CIPHER_LIST option.
  42. The application does not have to keep the string around after setting this
  43. option.
  44. .SH DEFAULT
  45. NULL, use internal default
  46. .SH PROTOCOLS
  47. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  48. .SH EXAMPLE
  49. .nf
  50. CURL *curl = curl_easy_init();
  51. if(curl) {
  52. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  53. curl_easy_setopt(curl, CURLOPT_PROXY_TLS13_CIPHERS,
  54. "TLS13-CHACHA20-POLY1305-SHA256");
  55. ret = curl_easy_perform(curl);
  56. curl_easy_cleanup(curl);
  57. }
  58. .fi
  59. .SH AVAILABILITY
  60. Added in 7.61.0.
  61. Available when built with OpenSSL >= 1.1.1.
  62. .SH RETURN VALUE
  63. Returns CURLE_OK if supported, CURLE_NOT_BUILT_IN otherwise.
  64. .SH "SEE ALSO"
  65. .BR CURLOPT_PROXY_SSL_CIPHER_LIST "(3), " CURLOPT_PROXY_SSLVERSION "(3), "
  66. .BR CURLOPT_SSL_CIPHER_LIST "(3), " CURLOPT_TLS13_CIPHERS "(3), "
  67. .BR CURLOPT_SSLVERSION "(3), "