docs/libcurl/opts/CURLOPT_SSH_HOST_PUBLIC_KEY_MD5.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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.haxx.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_MD5 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 \- checksum of SSH server public key
  27 .SH SYNOPSIS
  28 .nf
  29 #include <curl/curl.h>
  30
  31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_HOST_PUBLIC_KEY_MD5,
  32                           char *md5);
  33 .SH DESCRIPTION
  34 Pass a char * pointing to a string containing 32 hexadecimal digits. The
  35 string should be the 128 bit MD5 checksum of the remote host's public key, and
  36 libcurl will reject the connection to the host unless the md5sums match.
  37
  38 The application does not have to keep the string around after setting this
  39 option.
  40 .SH DEFAULT
  41 NULL
  42 .SH PROTOCOLS
  43 SCP and SFTP
  44 .SH EXAMPLE
  45 .nf
  46 CURL *curl = curl_easy_init();
  47 if(curl) {
  48   curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
  49   curl_easy_setopt(curl, CURLOPT_SSH_HOST_PUBLIC_KEY_MD5,
  50                    "afe17cd62a0f3b61f1ab9cb22ba269a7");
  51   ret = curl_easy_perform(curl);
  52   curl_easy_cleanup(curl);
  53 }
  54 .fi
  55 .SH AVAILABILITY
  56 Added in 7.17.1
  57 .SH RETURN VALUE
  58 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  59 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  60 .SH "SEE ALSO"
  61 .BR CURLOPT_SSH_PUBLIC_KEYFILE "(3), " CURLOPT_SSH_AUTH_TYPES "(3), "