lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-08-07 08:02:56 +03:00
Code Activity

New function to retrieve pre-auth server banner

Browse Source
This commit is contained in:
Anders Borum
2020-01-04 11:00:39 +01:00
parent f1b6fca89b 2c7c6516f9
commit 4906578ac7
4 changed files with 104 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/libssh2_userauth_banner.3 Normal file
View File

@@ -0,0 +1,25 @@
.TH libssh2_userauth_banner 3 "27 Nov 2018" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_userauth_banner - get the server's pre-auth banner message
.SH SYNOPSIS
.nf
#include <libssh2.h>
char *
libssh2_userauth_banner(LIBSSH2_SESSION *session,
size_t *banner_len_out);
.SH DESCRIPTION
\fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3)
\fIbanner_len_out\fP - The length of the server banner returned.
After an authentication has been attempted, such as a \fBSSH_USERAUTH_NONE\fP request sent by
.BR libssh2_userauth_list(3) ,
this function can be called to retrieve the pre-auth banner sent by the server. If no such banner is sent, or if an authentication has not yet been attempted, returns NULL.
.SH RETURN VALUE
On success a UTF-8 pre-authentication banner message from the server.
On failure returns NULL.
.SH SEE ALSO
.BR libssh2_session_init_ex(3),
.BR libssh2_userauth_list(3)