Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.3, revision 1.1
1.1 ! misho 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_PUBLIC_KEYFILE 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_SSH_PUBLIC_KEYFILE \- set public key file for SSH auth
! 27: .SH SYNOPSIS
! 28: .nf
! 29: #include <curl/curl.h>
! 30:
! 31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PUBLIC_KEYFILE,
! 32: char *filename);
! 33: .SH DESCRIPTION
! 34: Pass a char * pointing to a \fIfilename\fP for your public key. If not used,
! 35: libcurl defaults to \fB$HOME/.ssh/id_dsa.pub\fP if the HOME environment
! 36: variable is set, and just "id_dsa.pub" in the current directory if HOME is not
! 37: set.
! 38:
! 39: If NULL (or an empty string) is passed, libcurl will pass no public key to
! 40: libssh2, which then tries to compute it from the private key. This is known
! 41: to work with libssh2 1.4.0+ linked against OpenSSL.
! 42:
! 43: The application does not have to keep the string around after setting this
! 44: option.
! 45: .SH DEFAULT
! 46: NULL
! 47: .SH PROTOCOLS
! 48: SFTP and SCP
! 49: .SH EXAMPLE
! 50: .nf
! 51: CURL *curl = curl_easy_init();
! 52: if(curl) {
! 53: curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
! 54: curl_easy_setopt(curl, CURLOPT_SSH_PUBLIC_KEYFILE,
! 55: "/home/clarkkent/.ssh/id_rsa.pub");
! 56: ret = curl_easy_perform(curl);
! 57: curl_easy_cleanup(curl);
! 58: }
! 59: .fi
! 60: .SH AVAILABILITY
! 61: The "" trick was added in 7.26.0
! 62: .SH RETURN VALUE
! 63: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
! 64: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
! 65: .SH "SEE ALSO"
! 66: .BR CURLOPT_SSH_PRIVATE_KEYFILE "(3), " CURLOPT_SSH_AUTH_TYPES "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>