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