mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-17 04:22:32 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
72 lines
2.1 KiB
Markdown
72 lines
2.1 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_userauth_publickey_fromfile_ex
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_session_init_ex(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_userauth_publickey_fromfile_ex - authenticate a session with a public key, read from a file
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_userauth_publickey_fromfile_ex(LIBSSH2_SESSION *session,
|
|
const char *username,
|
|
unsigned int username_len,
|
|
const char *publickey,
|
|
const char *privatekey,
|
|
const char *passphrase);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
*session* - Session instance as returned by
|
|
**libssh2_session_init_ex(3)**
|
|
|
|
*username* - Pointer to user name to authenticate as.
|
|
|
|
*username_len* - Length of *username*.
|
|
|
|
*publickey* - Path name of the public key file.
|
|
(e.g. /etc/ssh/hostkey.pub). If libssh2 is built against OpenSSL, this option
|
|
can be set to NULL.
|
|
|
|
*privatekey* - Path name of the private key file. (e.g. /etc/ssh/hostkey)
|
|
|
|
*passphrase* - Passphrase to use when decoding *privatekey*.
|
|
|
|
Attempt public key authentication using either a public key file or a PEM
|
|
encoded private key file stored on disk. When providing a private key, the
|
|
public key is automatically extracted from it. When providing both, the
|
|
passed public key takes precedence.
|
|
|
|
# RETURN VALUE
|
|
|
|
Return 0 on success or negative on failure. It returns
|
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
|
|
|
# ERRORS
|
|
|
|
*LIBSSH2_ERROR_FILE* - An issue opening, reading or parsing the disk file.
|
|
|
|
*LIBSSH2_ERROR_ALLOC* - An internal memory allocation call failed.
|
|
|
|
*LIBSSH2_ERROR_SOCKET_SEND* - Unable to send data on socket.
|
|
|
|
*LIBSSH2_ERROR_SOCKET_TIMEOUT* -
|
|
|
|
*LIBSSH2_ERROR_PUBLICKEY_UNVERIFIED* - The username/public key
|
|
combination was invalid.
|
|
|
|
*LIBSSH2_ERROR_AUTHENTICATION_FAILED* - Authentication using the supplied
|
|
public key was not accepted.
|