Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_DISALLOW_USERNAME_IN_URL (3)

Name

CURLOPT_DISALLOW_USERNAME_IN_URL - disallow specifying username in the URL

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DISALLOW_USERNAME_IN_URL,
long disallow);

Description

curl_easy_setopt options                   CURLOPT_DISALLOW_USERNAME_IN_URL(3)



NAME
       CURLOPT_DISALLOW_USERNAME_IN_URL  - disallow specifying username in the
       URL

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DISALLOW_USERNAME_IN_URL,
                                 long disallow);

DESCRIPTION
       A long parameter set to 1 tells the library  to  not  allow  URLs  that
       include a username.

DEFAULT
       0 (disabled) - user names are allowed by default.

PROTOCOLS
       Several

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {

         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
         curl_easy_setopt(curl, CURLOPT_DISALLOW_USERNAME_IN_URL, 1L);

         curl_easy_perform(curl);
       }

AVAILABILITY
       Added in 7.61.0

RETURN VALUE
       Returns  CURLE_OK  if the option is supported, and CURLE_UNKNOWN_OPTION
       if not.

       curl_easy_perform() will return CURLE_LOGIN_DENIED if  this  option  is
       enabled and a URL containing a username is specified.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libcurl-security(3), ,CURLOPT_PROTOCOLS(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                  March 28, 2022
                                           CURLOPT_DISALLOW_USERNAME_IN_URL(3)