---
name: "libssh2_userauth_banner"
section: "3"
platform: "linux"
package: "libssh2"
version: "1.11.1-7"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/libssh2_userauth_banner"
---

# libssh2\_userauth\_banner(3)

get the server's userauth banner message

## NAME

libssh2\_userauth\_banner - get the server's userauth banner message

## SYNOPSIS

```
#include <libssh2.h>
int
libssh2_userauth_banner(LIBSSH2_SESSION *session, char **banner);
```

## DESCRIPTION

*session* - Session instance as returned by **[libssh2\_session\_init\_ex(3)](/libssh2_session_init_ex/3.md)**

*banner* - Should point to a pointer that gets filled with banner message.

After an authentication has been attempted, such as a **SSH\_USERAUTH\_NONE** request sent by **[libssh2\_userauth\_list(3)](/libssh2_userauth_list/3.md)**, this function can be called to retrieve the userauth banner sent by the server. If no such banner is sent, or if an authentication has not yet been attempted, returns LIBSSH2\_ERROR\_MISSING\_USERAUTH\_BANNER.

## RETURN VALUE

On success returns 0 and an UTF-8 NUL-terminated string is stored in the *banner*. This string is internally managed by libssh2 and will be deallocated upon session termination. On failure returns LIBSSH2\_ERROR\_MISSING\_USERAUTH\_BANNER.

## SEE ALSO

**[libssh2\_session\_init\_ex(3)](/libssh2_session_init_ex/3.md),** **[libssh2\_userauth\_list(3)](/libssh2_userauth_list/3.md)**