lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-23 16:21:00 +03:00
Code Activity

docs: improve libssh2_userauth_publickey_from* manpages

Browse Source 
Reported-by: Lyndon Brown
Assisted-by: Ryan Kelley
Fixes #652
Closes #1308
Closes #xxxx
This commit is contained in:
Viktor Szakats
2024-04-03 02:48:37 +00:00
parent 43983f8709
commit 581b72aab7
2 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/libssh2_userauth_publickey_fromfile_ex.3
View File

@ -31,13 +31,17 @@ can be set to NULL.
\fIpassphrase\fP - Passphrase to use when decoding \fIprivatekey\fP. \fIpassphrase\fP - Passphrase to use when decoding \fIprivatekey\fP.
Attempt public key authentication using a PEM encoded private key file stored Attempt public key authentication using either a public key file or a PEM
on disk 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.
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_FILE\fP - An issue opening, reading or parsing the disk file.
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.

8
docs/libssh2_userauth_publickey_frommemory.3
View File

@ -18,8 +18,6 @@ libssh2_userauth_publickey_frommemory(LIBSSH2_SESSION *session,
const char *passphrase); const char *passphrase);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
This function allows to authenticate a session with a public key read from memory.
It is only supported when libssh2 is backed by OpenSSL.
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)
@ -37,7 +35,10 @@ It is only supported when libssh2 is backed by OpenSSL.
\fIpassphrase\fP - Passphrase to use when decoding private key file. \fIpassphrase\fP - Passphrase to use when decoding private key file.
Attempt public key authentication using a PEM encoded private key file stored in memory. Attempt public key authentication using either a public key file or a PEM
encoded private key file stored in memory. When providing a private key, the
public key is automatically extracted from it. When providing both, the
passed public key takes precedence.
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
@ -56,5 +57,6 @@ combination was invalid.
public key was not accepted. public key was not accepted.
.SH AVAILABILITY .SH AVAILABILITY
libssh2_userauth_publickey_frommemory was added in libssh2 1.6.0 libssh2_userauth_publickey_frommemory was added in libssh2 1.6.0
Supported with OpenSSL, WinCNG, mbedTLS, OS/400 crypto backends.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)