CURLOPT_USERPWD - user name and password to use in authentication
#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERPWD, char *userpwd);
CURLOPT_USERPWD(3) curl_easy_setopt options CURLOPT_USERPWD(3)
NAME
CURLOPT_USERPWD - user name and password to use in authentication
SYNOPSIS
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERPWD, char *userpwd);
DESCRIPTION
Pass a char * as parameter, pointing to a null-terminated login details
string for the connection. The format of which is: [user name]:[pass-
word].
When using Kerberos V5 authentication with a Windows based server, you
should specify the user name part with the domain name in order for the
server to successfully obtain a Kerberos Ticket. If you do not then the
initial part of the authentication handshake may fail.
When using NTLM, the user name can be specified simply as the user name
without the domain name should the server be part of a single domain
and forest.
To specify the domain name use either Down-Level Logon Name or UPN
(User Principal Name) formats. For example, EXAMPLE\user and user@exam-
ple.com respectively.
Some HTTP servers (on Windows) support inclusion of the domain for
Basic authentication as well.
When using HTTP and CURLOPT_FOLLOWLOCATION(3), libcurl might perform
several requests to possibly different hosts. libcurl will only send
this user and password information to hosts using the initial host name
(unless CURLOPT_UNRESTRICTED_AUTH(3) is set), so if libcurl follows
locations to other hosts it will not send the user and password to
those. This is enforced to prevent accidental information leakage.
Use CURLOPT_HTTPAUTH(3) to specify the authentication method for HTTP
based connections or CURLOPT_LOGIN_OPTIONS(3) to control IMAP, POP3 and
SMTP options.
The user and password strings are not URL decoded, so there's no way to
send in a user name containing a colon using this option. Use CUR-
LOPT_USERNAME(3) for that, or include it in the URL.
The application does not have to keep the string around after setting
this option.
DEFAULT
NULL
PROTOCOLS
Most
EXAMPLE
CURL *curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
curl_easy_setopt(curl, CURLOPT_USERPWD, "clark:kent");
ret = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
AVAILABILITY
Always
RETURN VALUE
Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insuf-
ficient heap space.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | web/curl |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
CURLOPT_USERNAME(3), CURLOPT_PASSWORD(3), CURLOPT_PROXYUSERPWD(3),
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://curl.se/down-
load/curl-7.83.1.tar.bz2.
Further information about this software can be found on the open source
community website at http://curl.haxx.se/.
libcurl 7.83.1 November 26, 2021 CURLOPT_USERPWD(3)