Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_GSSAPI_DELEGATION.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_GSSAPI_DELEGATION 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_GSSAPI_DELEGATION \- set allowed GSS-API delegation
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_GSSAPI_DELEGATION, long level);
31 .SH DESCRIPTION
32 Set the long parameter \fIlevel\fP to \fBCURLGSSAPI_DELEGATION_FLAG\fP to
33 allow unconditional GSSAPI credential delegation. The delegation is disabled
34 by default since 7.21.7.  Set the parameter to
35 \fBCURLGSSAPI_DELEGATION_POLICY_FLAG\fP to delegate only if the OK-AS-DELEGATE
36 flag is set in the service ticket in case this feature is supported by the
37 GSS-API implementation and the definition of GSS_C_DELEG_POLICY_FLAG was
38 available at compile-time.
39 .SH DEFAULT
40 CURLGSSAPI_DELEGATION_NONE
41 .SH PROTOCOLS
42 HTTP
43 .SH EXAMPLE
44 .nf
45 CURL *curl = curl_easy_init();
46 if(curl) {
47   CURLcode ret;
48   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
49   /* delegate if okayed by policy */
50   curl_easy_setopt(curl, CURLOPT_GSSAPI_DELEGATION,
51                          CURLGSSAPI_DELEGATION_POLICY_FLAG);
52   ret = curl_easy_perform(curl);
53 }
54 .fi
55
56 .SH AVAILABILITY
57 Added in 7.22.0
58 .SH RETURN VALUE
59 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
60 .SH "SEE ALSO"
61 .BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3), "