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