Artifactspublic-v0

curl

master
ply4 git calls115 ms288 KiB2 cachedprotocol v2
82 lines2.0 KiBRaw

NAME

CURLOPT_SSH_PRIVATE_KEYFILE - private key file for SSH auth

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PRIVATE_KEYFILE,
                          char *filename);

DESCRIPTION

Pass a char pointer pointing to a filename for your private key. If not used, libcurl defaults to $HOME/.ssh/id_rsa or $HOME/.ssh/id_dsa if the HOME environment variable is set, and in the current directory if HOME is not set.

If the file is password-protected, set the password with CURLOPT_KEYPASSWD(3).

The SSH library derives the public key from this private key when possible. If the SSH library cannot derive the public key from the private one and no public one is provided with CURLOPT_SSH_PUBLIC_KEYFILE(3), the transfer fails.

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

This option is used to set up a new connection only. The private key is used when libcurl establishes a new SSH connection; once that connection has been successfully set up and verified, it is deemed vetted and may be reused by libcurl even if this option is changed.

DEFAULT

As explained above

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
    curl_easy_setopt(curl, CURLOPT_SSH_PRIVATE_KEYFILE,
                     "/home/clarkkent/.ssh/id_rsa");
    curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "password");
    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_SSH_PRIVATE_KEYFILE
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_SSH_AUTH_TYPES (3)
9 - CURLOPT_SSH_PUBLIC_KEYFILE (3)
10Protocol:
11 - SFTP
12 - SCP
13Added-in: 7.16.1
14---
16# NAME
18CURLOPT_SSH_PRIVATE_KEYFILE - private key file for SSH auth
20# SYNOPSIS
22~~~c
23#include <curl/curl.h>
25CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PRIVATE_KEYFILE,
26 char *filename);
27~~~
29# DESCRIPTION
31Pass a char pointer pointing to a *filename* for your private key. If not
32used, libcurl defaults to **$HOME/.ssh/id_rsa** or **$HOME/.ssh/id_dsa** if
33the HOME environment variable is set, and in the current directory if HOME is
34not set.
36If the file is password-protected, set the password with CURLOPT_KEYPASSWD(3).
38The SSH library derives the public key from this private key when possible. If
39the SSH library cannot derive the public key from the private one and no
40public one is provided with CURLOPT_SSH_PUBLIC_KEYFILE(3), the transfer
41fails.
43The application does not have to keep the string around after setting this
44option.
46This option is used to set up a new connection only. The private key is used
47when libcurl establishes a new SSH connection; once that connection has been
48successfully set up and verified, it is deemed vetted and may be reused by
49libcurl even if this option is changed.
51# DEFAULT
53As explained above
55# %PROTOCOLS%
57# EXAMPLE
59~~~c
60int main(void)
62 CURL *curl = curl_easy_init();
63 if(curl) {
64 CURLcode result;
65 curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
66 curl_easy_setopt(curl, CURLOPT_SSH_PRIVATE_KEYFILE,
67 "/home/clarkkent/.ssh/id_rsa");
68 curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "password");
69 result = curl_easy_perform(curl);
70 curl_easy_cleanup(curl);
71 }
73~~~
75# %AVAILABILITY%
77# RETURN VALUE
79curl_easy_setopt(3) returns a CURLcode indicating success or error.
81CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
82libcurl-errors(3).
Diagnostics4 git calls · 115 ms
CallStatusSizeTime0115 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=1
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 · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=110
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=2
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.1 KiB110 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1116
git.response.cache=MISS
git.response.duration_ms=110
git.fetch.wants=efc627b8dcfff79e9f24c34c5d928876a5427579
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=1116
git.pkt.payload.max=1095
git.sideband.band1.bytes=1094
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
a5e322a61c9e5aae
Request
a2f2e8af…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format