CURLOPT_UNRESTRICTED_AUTH.3 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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_UNRESTRICTED_AUTH 3 "17 Jun 2014" "libcurl 7.37.0" "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. Further, when this option is not used or set to \fB0L\fP, libcurl will not
  37. send custom set nor internally generated Authentication: headers on requests
  38. done to other hosts than the one used for the initial URL.
  39. By default, libcurl will only send credentials and Authentication headers to
  40. the initial host name as given in the original URL, to avoid leaking username
  41. + password to other sites.
  42. This option should be used with caution: when curl follows redirects it
  43. blindly fetches the next URL as instructed by the server. Setting
  44. \fICURLOPT_UNRESTRICTED_AUTH(3)\fP to 1L will therefore also make curl trust
  45. the server and send possibly sensitive credentials to a host the server points
  46. out.
  47. .SH DEFAULT
  48. 0
  49. .SH PROTOCOLS
  50. HTTP
  51. .SH EXAMPLE
  52. .nf
  53. CURL *curl = curl_easy_init();
  54. if(curl) {
  55. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  56. curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  57. curl_easy_setopt(curl, CURLOPT_UNRESTRICTED_AUTH, 1L);
  58. curl_easy_perform(curl);
  59. }
  60. .fi
  61. .SH AVAILABILITY
  62. Along with HTTP
  63. .SH RETURN VALUE
  64. Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  65. .SH "SEE ALSO"
  66. .BR CURLOPT_FOLLOWLOCATION "(3), " CURLOPT_USERPWD "(3), "