docs/libcurl/opts/CURLOPT_SSH_KNOWNHOSTS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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_KNOWNHOSTS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SSH_KNOWNHOSTS \- file name holding the SSH known hosts
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_KNOWNHOSTS, char *fname);
  30 .SH DESCRIPTION
  31 Pass a pointer to a zero terminated string holding the file name of the
  32 known_host file to use.  The known_hosts file should use the OpenSSH file
  33 format as supported by libssh2. If this file is specified, libcurl will only
  34 accept connections with hosts that are known and present in that file, with a
  35 matching public key. Use \fICURLOPT_SSH_KEYFUNCTION(3)\fP to alter the default
  36 behavior on host and key (mis)matching.
  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 SFTP and SCP
  44 .SH EXAMPLE
  45 TODO
  46 .SH AVAILABILITY
  47 Added in 7.19.6
  48 .SH RETURN VALUE
  49 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  50 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  51 .SH "SEE ALSO"
  52 .BR CURLOPT_SSH_AUTH_TYPES "(3), " CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 "(3), "