CURLOPT_DISALLOW_USERNAME_IN_URL - Man Page

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.

This is the equivalent to the CURLU_DISALLOW_USER flag for the curl_url_set(3) function.

Default

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

Protocols

Several

Example

int main(void)
{
  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(3) returns CURLE_LOGIN_DENIED if this option is enabled and a URL containing a username is specified.

See Also

CURLOPT_PROTOCOLS(3), CURLOPT_URL(3), curl_url_set(3), libcurl-security(3)

Referenced By

curl_easy_setopt(3), libcurl-symbols(3).

February 19 2024 libcurl