Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_HTTPAUTH.3 @ 2:b50eed0cc0ef upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2018, 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_HTTPAUTH 3 "2 Aug 2014" "libcurl 7.38.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_HTTPAUTH \- set HTTP server authentication methods to try
26 .SH SYNOPSIS
27 .nf
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPAUTH, long bitmask);
31 .SH DESCRIPTION
32 Pass a long as parameter, which is set to a bitmask, to tell libcurl which
33 authentication method(s) you want it to use speaking to the remote server.
34
35 The available bits are listed below. If more than one bit is set, libcurl will
36 first query the site to see which authentication methods it supports and then
37 pick the best one you allow it to use. For some methods, this will induce an
38 extra network round-trip. Set the actual name and password with the
39 \fICURLOPT_USERPWD(3)\fP option or with the \fICURLOPT_USERNAME(3)\fP and the
40 \fICURLOPT_PASSWORD(3)\fP options.
41
42 For authentication with a proxy, see \fICURLOPT_PROXYAUTH(3)\fP.
43
44 .IP CURLAUTH_BASIC
45 HTTP Basic authentication. This is the default choice, and the only method
46 that is in wide-spread use and supported virtually everywhere. This sends
47 the user name and password over the network in plain text, easily captured by
48 others.
49 .IP CURLAUTH_DIGEST
50 HTTP Digest authentication. Digest authentication is defined in RFC2617 and
51 is a more secure way to do authentication over public networks than the
52 regular old-fashioned Basic method.
53 .IP CURLAUTH_DIGEST_IE
54 HTTP Digest authentication with an IE flavor. Digest authentication is
55 defined in RFC2617 and is a more secure way to do authentication over public
56 networks than the regular old-fashioned Basic method. The IE flavor is simply
57 that libcurl will use a special "quirk" that IE is known to have used before
58 version 7 and that some servers require the client to use.
59 .IP CURLAUTH_BEARER
60 HTTP Bearer token authentication, used primarily in OAuth 2.0 protocol.
61
62 You can set the Bearer token to use with \fICURLOPT_XOAUTH2_BEARER(3)\fP.
63 .IP CURLAUTH_NEGOTIATE
64 HTTP Negotiate (SPNEGO) authentication. Negotiate authentication is defined
65 in RFC 4559 and is the most secure way to perform authentication over HTTP.
66
67 You need to build libcurl with a suitable GSS-API library or SSPI on Windows
68 for this to work.
69 .IP CURLAUTH_NTLM
70 HTTP NTLM authentication. A proprietary protocol invented and used by
71 Microsoft. It uses a challenge-response and hash concept similar to Digest, to
72 prevent the password from being eavesdropped.
73
74 You need to build libcurl with either OpenSSL, GnuTLS or NSS support for this
75 option to work, or build libcurl on Windows with SSPI support.
76 .IP CURLAUTH_NTLM_WB
77 NTLM delegating to winbind helper. Authentication is performed by a separate
78 binary application that is executed when needed. The name of the application
79 is specified at compile time but is typically /usr/bin/ntlm_auth
80
81 Note that libcurl will fork when necessary to run the winbind application and
82 kill it when complete, calling waitpid() to await its exit when done. On POSIX
83 operating systems, killing the process will cause a SIGCHLD signal to be
84 raised (regardless of whether \fICURLOPT_NOSIGNAL(3)\fP is set), which must be
85 handled intelligently by the application. In particular, the application must
86 not unconditionally call wait() in its SIGCHLD signal handler to avoid being
87 subject to a race condition. This behavior is subject to change in future
88 versions of libcurl.
89 .IP CURLAUTH_ANY
90 This is a convenience macro that sets all bits and thus makes libcurl pick any
91 it finds suitable. libcurl will automatically select the one it finds most
92 secure.
93 .IP CURLAUTH_ANYSAFE
94 This is a convenience macro that sets all bits except Basic and thus makes
95 libcurl pick any it finds suitable. libcurl will automatically select the one
96 it finds most secure.
97 .IP CURLAUTH_ONLY
98 This is a meta symbol. OR this value together with a single specific auth
99 value to force libcurl to probe for un-restricted auth and if not, only that
100 single auth algorithm is acceptable.
101 .SH DEFAULT
102 CURLAUTH_BASIC
103 .SH PROTOCOLS
104 HTTP
105 .SH EXAMPLE
106 .nf
107 CURL *curl = curl_easy_init();
108 if(curl) {
109 CURLcode ret;
110 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
111 /* allow whatever auth the server speaks */
112 curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
113 curl_easy_setopt(curl, CURLOPT_USERPWD, "james:bond");
114 ret = curl_easy_perform(curl);
115 }
116 .fi
117 .SH AVAILABILITY
118 Option Added in 7.10.6.
119
120 CURLAUTH_DIGEST_IE was added in 7.19.3
121
122 CURLAUTH_ONLY was added in 7.21.3
123
124 CURLAUTH_NTLM_WB was added in 7.22.0
125
126 CURLAUTH_BEARER was added in 7.61.0
127 .SH RETURN VALUE
128 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
129 CURLE_NOT_BUILT_IN if the bitmask specified no supported authentication
130 methods.
131 .SH "SEE ALSO"
132 .BR CURLOPT_PROXYAUTH "(3), " CURLOPT_USERPWD "(3), "