CURLOPT_UNRESTRICTED_AUTH.3 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2017, 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_UNRESTRICTED_AUTH 3 "May 15, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_UNRESTRICTED_AUTH \- send credentials to other hosts too
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UNRESTRICTED_AUTH,
  30. long goahead);
  31. .SH DESCRIPTION
  32. Set the long \fIgohead\fP parameter to 1L to make libcurl continue to send
  33. authentication (user+password) credentials when following locations, even when
  34. hostname changed. This option is meaningful only when setting
  35. \fICURLOPT_FOLLOWLOCATION(3)\fP.
  36. By default, libcurl will only send given credentials to the initial host name
  37. as given in the original URL, to avoid leaking username + password to other
  38. sites.
  39. .SH DEFAULT
  40. 0
  41. .SH PROTOCOLS
  42. HTTP
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  48. curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  49. curl_easy_setopt(curl, CURLOPT_UNRESTRICTED_AUTH, 1L);
  50. curl_easy_perform(curl);
  51. }
  52. .fi
  53. .SH AVAILABILITY
  54. Along with HTTP
  55. .SH RETURN VALUE
  56. Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  57. .SH "SEE ALSO"
  58. .BR CURLOPT_FOLLOWLOCATION "(3), " CURLOPT_USERPWD "(3), "