Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_SOCKS5_GSSAPI_NEC.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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_SOCKS5_GSSAPI_NEC 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_SOCKS5_GSSAPI_NEC \- set socks proxy gssapi negotiation protection
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_NEC, long nec);
31 .SH DESCRIPTION
32 Pass a long set to 1 to enable or 0 to disable. As part of the gssapi
33 negotiation a protection mode is negotiated. The RFC1961 says in section
34 4.3/4.4 it should be protected, but the NEC reference implementation does not.
35 If enabled, this option allows the unprotected exchange of the protection mode
36 negotiation.
37 .SH DEFAULT
38 ?
39 .SH PROTOCOLS
40 Most
41 .SH EXAMPLE
42 .nf
43 CURL *curl = curl_easy_init();
44 if(curl) {
45   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
46   curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://proxy");
47   curl_easy_setopt(curl, CURLOPT_SOCKS5_GSSAPI_NEC, 1L);
48   ret = curl_easy_perform(curl);
49   curl_easy_cleanup(curl);
50 }
51 .fi
52 .SH AVAILABILITY
53 Added in 7.19.4
54 .SH RETURN VALUE
55 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
56 .SH "SEE ALSO"
57 .BR CURLOPT_SOCKS5_GSSAPI_SERVICE "(3), " CURLOPT_PROXY "(3), "