CURLOPT_PROXY_TLSAUTH_PASSWORD.3 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2022, 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_TLSAUTH_PASSWORD 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROXY_TLSAUTH_PASSWORD \- password to use for proxy TLS authentication
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_PASSWORD,
  30. char *pwd);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a char * as parameter, which should point to the null-terminated password
  34. to use for the TLS authentication method specified with the
  35. \fICURLOPT_PROXY_TLSAUTH_TYPE(3)\fP option. Requires that the
  36. \fICURLOPT_PROXY_TLSAUTH_USERNAME(3)\fP option also be set.
  37. The application does not have to keep the string around after setting this
  38. option.
  39. .SH DEFAULT
  40. NULL
  41. .SH PROTOCOLS
  42. All
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  48. curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
  49. curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_TYPE, "SRP");
  50. curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_USERNAME, "user");
  51. curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_PASSWORD, "secret");
  52. ret = curl_easy_perform(curl);
  53. curl_easy_cleanup(curl);
  54. }
  55. .fi
  56. .SH AVAILABILITY
  57. Added in 7.52.0, with the OpenSSL and GnuTLS backends only
  58. .SH RETURN VALUE
  59. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  60. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  61. .SH "SEE ALSO"
  62. .BR CURLOPT_PROXY_TLSAUTH_TYPE "(3), " CURLOPT_PROXY_TLSAUTH_USERNAME "(3), "
  63. .BR CURLOPT_TLSAUTH_TYPE "(3), " CURLOPT_TLSAUTH_USERNAME "(3), "