Artifactspublic-v0

curl

master
ply4 git calls119 ms288 KiB2 cachedprotocol v2
111 lines2.6 KiBRaw

NAME

CURLOPT_SSH_HOSTKEYFUNCTION - callback to check host key

SYNOPSIS

c
#include <curl/curl.h>

int keycallback(void *clientp,
                int keytype,
                const char *key,
                size_t keylen);

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_HOSTKEYFUNCTION,
                          keycallback);

DESCRIPTION

Pass a pointer to your callback function, which should match the prototype shown above. It overrides CURLOPT_SSH_KNOWNHOSTS(3).

This callback gets called when the verification of the SSH host key is needed.

key is keylen bytes long and is the key to check. keytype says what type it is, from the CURLKHTYPE_* series in the curl_khtype enum.

clientp is a custom pointer set with CURLOPT_SSH_HOSTKEYDATA(3).

This option is used to verify new SSH connections only. Once the connection has been vetted by this callback it is deemed vetted and may be reused again without invoking this callback again.

The callback must return one of the following return codes to tell libcurl how to act:

CURLKHMATCH_OK

The host key is accepted, the connection should continue.

CURLKHMATCH_MISMATCH

the host key is rejected, the connection is canceled.

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

c
struct mine {
  void *custom;
};

static int hostkeycb(void *clientp,   /* passed with CURLOPT_SSH_HOSTKEYDATA */
                     int keytype,     /* CURLKHTYPE */
                     const char *key, /* host key to check */
                     size_t keylen)   /* length of the key */
{
  /* 'clientp' points to the callback_data struct */
  /* investigate the situation and return the correct value */
  return CURLKHMATCH_OK;
}

int main(void)
{
  struct mine callback_data;
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/thisfile.txt");
    curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYFUNCTION, hostkeycb);
    curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYDATA, &callback_data);

    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

NOTES

Work only with the libssh2 backend.

%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_HOSTKEYFUNCTION
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_SSH_HOSTKEYDATA (3)
9 - CURLOPT_SSH_KNOWNHOSTS (3)
10Protocol:
11 - SFTP
12 - SCP
13Added-in: 7.84.0
14---
16# NAME
18CURLOPT_SSH_HOSTKEYFUNCTION - callback to check host key
20# SYNOPSIS
22~~~c
23#include <curl/curl.h>
25int keycallback(void *clientp,
26 int keytype,
27 const char *key,
28 size_t keylen);
30CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_HOSTKEYFUNCTION,
31 keycallback);
32~~~
34# DESCRIPTION
36Pass a pointer to your callback function, which should match the prototype
37shown above. It overrides CURLOPT_SSH_KNOWNHOSTS(3).
39This callback gets called when the verification of the SSH host key is needed.
41**key** is **keylen** bytes long and is the key to check. **keytype** says
42what type it is, from the **CURLKHTYPE_*** series in the **curl_khtype** enum.
44**clientp** is a custom pointer set with CURLOPT_SSH_HOSTKEYDATA(3).
46This option is used to verify new SSH connections only. Once the connection
47has been vetted by this callback it is deemed vetted and may be reused again
48without invoking this callback again.
50The callback must return one of the following return codes to tell libcurl how
51to act:
53## CURLKHMATCH_OK
55The host key is accepted, the connection should continue.
57## CURLKHMATCH_MISMATCH
59the host key is rejected, the connection is canceled.
61# DEFAULT
63NULL
65# %PROTOCOLS%
67# EXAMPLE
69~~~c
70struct mine {
71 void *custom;
72};
74static int hostkeycb(void *clientp, /* passed with CURLOPT_SSH_HOSTKEYDATA */
75 int keytype, /* CURLKHTYPE */
76 const char *key, /* host key to check */
77 size_t keylen) /* length of the key */
79 /* 'clientp' points to the callback_data struct */
80 /* investigate the situation and return the correct value */
81 return CURLKHMATCH_OK;
84int main(void)
86 struct mine callback_data;
87 CURL *curl = curl_easy_init();
88 if(curl) {
89 CURLcode result;
90 curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/thisfile.txt");
91 curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYFUNCTION, hostkeycb);
92 curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYDATA, &callback_data);
94 result = curl_easy_perform(curl);
95 curl_easy_cleanup(curl);
96 }
98~~~
100# NOTES
102Work only with the libssh2 backend.
104# %AVAILABILITY%
106# RETURN VALUE
108curl_easy_setopt(3) returns a CURLcode indicating success or error.
110CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
111libcurl-errors(3).
Diagnostics4 git calls · 119 ms
CallStatusSizeTime0119 ms
discover200152 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
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 · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=2
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=115
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.3 KiB115 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1299
git.response.cache=MISS
git.response.duration_ms=115
git.fetch.wants=6ff15427a8fe59878de1710035eda8c64f8361db
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=1299
git.pkt.payload.max=1278
git.sideband.band1.bytes=1277
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
a5e352956bc7224d
Request
04b8f5d6…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format