Name

libssh2_channel_request_auth_agent - request agent forwarding for a session

Synopsis

#include <libssh2.h>
 
int
libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel);

Description

Request that agent forwarding be enabled for this SSH session. This sends the request over this specific channel, which causes the agent listener to be started on the remote side upon success. This agent listener will then run for the duration of the SSH session.

To use agent forwarding, libssh2_session_callback_set2 must first be called to set LIBSSH2_CALLBACK_AUTHAGENT. This callback will be invoked when the remote host opens a connection to the local agent.

channel - Previously opened channel instance such as returned by libssh2_channel_open_ex

Return value

Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.

See also

libssh2_session_callback_set2

This HTML page was made with roffit.