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