Artifactspublic-v0

curl

master
ply4 git calls417 ms288 KiB2 cachedprotocol v2
97 lines2.5 KiBRaw

NAME

CURLOPT_USERNAME - username to use in authentication

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERNAME,
                          char *username);

DESCRIPTION

Pass a char pointer as parameter, which should be pointing to the null-terminated username to use for the transfer.

CURLOPT_USERNAME(3) sets the username to be used in protocol authentication. You should not use this option together with the (older) CURLOPT_USERPWD(3) option.

When using Kerberos V5 authentication with a Windows based server, you should include 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.

To include the domain name use either Down-Level Logon Name or UPN (User Principal Name) formats. For example, EXAMPLE\user and user@example.com respectively.

Some HTTP servers (on Windows) support inclusion of the domain for Basic authentication as well.

To specify the password and login options, along with the username, use the CURLOPT_PASSWORD(3) and CURLOPT_LOGIN_OPTIONS(3) options.

The application does not have to keep the string around after setting this option.

For some authentication methods (like Negotiate), setting it to a zero-length string ("") makes libcurl use an implied ambient user decided by the environment. libcurl cannot identify this user and may reuse an authenticated connection for a later transfer on the same easy handle. If the ambient user changes while that connection remains reusable, the later transfer can be authenticated as the previous user. Applications must prevent such reuse when changing ambient users.

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");

    curl_easy_setopt(curl, CURLOPT_USERNAME, "clark");

    result = curl_easy_perform(curl);

    curl_easy_cleanup(curl);
  }
}

%AVAILABILITY%

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_USERNAME
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_HTTPAUTH (3)
9 - CURLOPT_PASSWORD (3)
10 - CURLOPT_PROXYAUTH (3)
11 - CURLOPT_USERPWD (3)
12Protocol:
13 - All
14Added-in: 7.19.1
15---
17# NAME
19CURLOPT_USERNAME - username to use in authentication
21# SYNOPSIS
23~~~c
24#include <curl/curl.h>
26CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERNAME,
27 char *username);
28~~~
30# DESCRIPTION
32Pass a char pointer as parameter, which should be pointing to the
33null-terminated username to use for the transfer.
35CURLOPT_USERNAME(3) sets the username to be used in protocol authentication.
36You should not use this option together with the (older) CURLOPT_USERPWD(3)
37option.
39When using Kerberos V5 authentication with a Windows based server, you should
40include the domain name in order for the server to successfully obtain a
41Kerberos Ticket. If you do not then the initial part of the authentication
42handshake may fail.
44To include the domain name use either Down-Level Logon Name or UPN (User
45Principal Name) formats. For example, **EXAMPLE\user** and
46**user@example.com** respectively.
48Some HTTP servers (on Windows) support inclusion of the domain for Basic
49authentication as well.
51To specify the password and login options, along with the username, use the
52CURLOPT_PASSWORD(3) and CURLOPT_LOGIN_OPTIONS(3) options.
54The application does not have to keep the string around after setting this
55option.
57For some authentication methods (like `Negotiate`), setting it to a
58zero-length string (`""`) makes libcurl use an implied *ambient* user decided
59by the environment. libcurl cannot identify this user and may reuse an
60authenticated connection for a later transfer on the same easy handle. If the
61ambient user changes while that connection remains reusable, the later
62transfer can be authenticated as the previous user. Applications must prevent
63such reuse when changing ambient users.
65# DEFAULT
67NULL
69# %PROTOCOLS%
71# EXAMPLE
73~~~c
74int main(void)
76 CURL *curl = curl_easy_init();
77 if(curl) {
78 CURLcode result;
79 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
81 curl_easy_setopt(curl, CURLOPT_USERNAME, "clark");
83 result = curl_easy_perform(curl);
85 curl_easy_cleanup(curl);
86 }
88~~~
90# %AVAILABILITY%
92# RETURN VALUE
94curl_easy_setopt(3) returns a CURLcode indicating success or error.
96CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
97libcurl-errors(3).
Diagnostics4 git calls · 417 ms
CallStatusSizeTime0417 ms
discover200152 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=152
git.server.agent=gitty/1.0
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch object-format
git.server.fetch=shallow filter sideband-all
git.protocol.version=2
git.pkt.frames=8
git.pkt.data=6
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=152
git.pkt.payload.max=34
ls-refs200149 B · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=149
git.pkt.payload.max=78
git.ls_refs.count=2
git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=411
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=blob:none
git.fetch.filter.requested=tree:0
git.fetch.filter.fallback=blob:none
git.fetch.filter.learned=false
git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=10
git.pkt.data=8
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=293470
git.pkt.payload.max=65516
git.sideband.band1.bytes=293354
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=87
git.pack.bytes=293354
git.pack.ofs_delta=0
git.pack.ref_delta=1
git.pack.chain.max=1
git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0
git.pack.full=86
Open pack map
fetch2001.3 KiB411 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1344
git.response.cache=MISS
git.response.duration_ms=411
git.fetch.wants=4388306bdc46674063ea3cd1191e7f183baa1a39
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1344
git.pkt.payload.max=1323
git.sideband.band1.bytes=1322
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
Ref
refs/heads/master
Commit
31c911efe5652725e930f4d2e60c9060e5f6646d
cf-ray
a5e32f225e368821
Request
758a1256…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format