libssh2_session_handshake(3)

💖 libssh2_session_handshake(3) — the moment you and the server finally say hi 💖

okay bestie, welcome to libssh2_session_handshake, aka the page where your lil session and a random remote host lock eyes across the room and start the whole "let's be friends" ritual. this is from the libssh2 manual, and honestly? it's the glow-up moment of every SSH connection. 🦋

---

✨ NAME ✨

libssh2_session_handshake — perform the SSH handshake

like, literally just that. the handshake. the vibe check between you and the server. 💅

---

🌸 SYNOPSIS 🌸

#include <libssh2.h>

int
libssh2_session_handshake(LIBSSH2_SESSION *session, libssh2_socket_t socket);

look at her. two args. one int return. so simple, so powerful. 👑

---

🎀 DESCRIPTION 🎀

• session — the session instance you got back from libssh2_session_init_ex(3). your main character. your baby. 🫶
• socket — a connected socket descriptor. usually it's a TCP connection, but ngl the protocol is flexible like that — it allows for any reliable transport, and the library will attempt to use any berkeley socket. so like, whatever socket you bring, she'll try. 💁‍♀️

and what does it do? it begins transport layer protocol negotiation with the connected host. that's the whole thing. that's the moment. it's giving first-date energy, but for cryptography. 🔥

---

💀 RETURN VALUE 💀

• Returns 0 on success. slay. ✨
• Returns negative on failure. not slay. 😭

---

🙈 ERRORS 🙈

ok so if it flops, here's the receipt. one of these is gonna come back at you:

• LIBSSH2_ERROR_SOCKET_NONE — the socket is invalid. bestie. that socket is not a socket. 💀
• LIBSSH2_ERROR_BANNER_SEND — unable to send banner to remote host. the server didn't get your lil intro card. 💌
• LIBSSH2_ERROR_KEX_FAILURE — encryption key exchange with the remote host failed. the key swap did NOT work out, it's giving situationship. 😭
• LIBSSH2_ERROR_SOCKET_SEND — unable to send data on socket. the data said "no thank you". 📭
• LIBSSH2_ERROR_SOCKET_DISCONNECT — the socket was disconnected. she left. she blocked you. 🚪
• LIBSSH2_ERROR_PROTO — an invalid SSH protocol response was received on the socket. the server is speaking nonsense and we are NOT fluent. 🙃
• LIBSSH2_ERROR_EAGAIN — marked for non-blocking I/O but the call would block. you said "don't wait" and now she'd have to wait. awkward. ⏳

---

🌈 AVAILABILITY 🌈

added in 1.2.8. a vintage icon, honestly. iykyk. ⭐

---

👑 SEE ALSO 👑

• libssh2_session_free(3)
• libssh2_session_init_ex(3)

go read those too, bestie, they're the supporting cast. 💜

---

⚠️ real talk though — the negative return value means it did NOT work, so please check it before you start doing session things. no cap, check your return codes. 🫡

---

and that's the whole page, fr fr. this was the libssh2 manual, libssh2_session_handshake(3), dated 7 Oct 2010 — yeah she's old, she's iconic, she's still doing the handshake to this day. mwah. 💋✨🎀