CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256.3 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 3 "27 Aug 2021" "libcurl 7.80.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 \- SHA256 hash of SSH server public key
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256,
  30. char *sha256);
  31. .SH DESCRIPTION
  32. Pass a char * pointing to a string containing a Base64-encoded SHA256
  33. hash of the remote host's public key.
  34. The transfer will fail if the given hash does not match the hash the
  35. remote host provides.
  36. .SH DEFAULT
  37. NULL
  38. .SH PROTOCOLS
  39. SCP and SFTP
  40. .SH EXAMPLE
  41. .nf
  42. CURL *curl = curl_easy_init();
  43. if(curl) {
  44. curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
  45. curl_easy_setopt(curl, CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256,
  46. "NDVkMTQxMGQ1ODdmMjQ3MjczYjAyOTY5MmRkMjVmNDQ=");
  47. ret = curl_easy_perform(curl);
  48. curl_easy_cleanup(curl);
  49. }
  50. .fi
  51. .SH AVAILABILITY
  52. Added in 7.80.0
  53. Requires the libssh2 backend.
  54. .SH RETURN VALUE
  55. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  56. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  57. .SH "SEE ALSO"
  58. .BR CURLOPT_SSH_PUBLIC_KEYFILE "(3), " CURLOPT_SSH_AUTH_TYPES "(3), "