libssh2_channe...est_auth_agent(3)

✨ libssh2_channel_request_auth_agent ✨

okay bestie, welcome to the libssh2 manual, page libssh2_channe...est_auth_agent(3) 💅 yes the title got truncated in the header, that's just how the man page vibes are, we move.

🌸 NAME 🌸

libssh2_channel_request_auth_agent — ask for agent forwarding on a session, that's the whole job 🫶

🎀 SYNOPSIS 🎀

#include <libssh2.h>

int
libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel);

🦋 DESCRIPTION 🦋

So like, this function requests that agent forwarding be enabled for this SSH session. Not me casually unlocking the whole ssh-agent pipeline for you 😭✨

It sends that request over this specific channel, and if it goes well, that causes the agent listener to be started on the remote side. That agent listener then runs for the duration of the SSH session. it's giving long-term commitment, lowkey.

• channel — a previously opened channel instance, like the kind you get back from libssh2_channel_open_ex(3) 👑

💖 RETURN VALUE 💖

• Returns 0 on success, or negative on failure. slay.
• Returns LIBSSH2_ERROR_EAGAIN when it would otherwise block.

and yes, LIBSSH2_ERROR_EAGAIN is technically a negative number, but it is not really a failure per se, so don't spiral about it bestie 💀 it's just saying "try again later", not "everything is ruined".

🌈 SEE ALSO 🌈

• libssh2_channel_open_ex(3)

that's the page, no cap 💜 libssh2 0.15, dated 1 Jun 2007 — vintage but still iconic, periodt 👑🌸