curl-w32/docs/libcurl/opts/CURLOPT_DISALLOW_USERNAME_IN_URL.md

69 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

---
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
SPDX-License-Identifier: curl
Title: CURLOPT_DISALLOW_USERNAME_IN_URL
Section: 3
Source: libcurl
See-also:
- CURLOPT_PROTOCOLS (3)
- CURLOPT_URL (3)
- curl_url_set (3)
- libcurl-security (3)
---
# NAME
CURLOPT_DISALLOW_USERNAME_IN_URL - disallow specifying username in the URL
# SYNOPSIS
~~~c
#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
~~~c
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.