1libssh2_userauth_banner(3)          libssh2         libssh2_userauth_banner(3)
2
3
4

NAME

6       libssh2_userauth_banner - get the server's userauth banner message
7

SYNOPSIS

9       #include <libssh2.h>
10
11       int
12       libssh2_userauth_banner(LIBSSH2_SESSION *session, char **banner);
13

DESCRIPTION

15       session - Session instance as returned by libssh2_session_init_ex(3)
16
17       banner  -  Should  point to a pointer that gets filled with banner mes‐
18       sage.
19
20       After an authentication has been attempted, such as a SSH_USERAUTH_NONE
21       request  sent  by libssh2_userauth_list(3), this function can be called
22       to retrieve the userauth banner sent by the server. If no  such  banner
23       is  sent,  or  if an authentication has not yet been attempted, returns
24       LIBSSH2_ERROR_MISSING_USERAUTH_BANNER.
25

RETURN VALUE

27       On success returns 0 and an UTF-8 NUL-terminated string  is  stored  in
28       the  banner.  This  string is internally managed by libssh2 and will be
29       deallocated upon session termination.  On failure  returns  LIBSSH2_ER‐
30       ROR_MISSING_USERAUTH_BANNER.
31

SEE ALSO

33       libssh2_session_init_ex(3), libssh2_userauth_list(3)
34
35
36
37libssh2 1.9.0                     1 Jun 2021        libssh2_userauth_banner(3)
Impressum