1.2 KiB
c, SPDX-License-Identifier, Title, Section, Source, See-also
| c | SPDX-License-Identifier | Title | Section | Source | See-also | ||
|---|---|---|---|---|---|---|---|
| Copyright (C) The libssh2 project and its contributors. | BSD-3-Clause | libssh2_channel_request_auth_agent | 3 | libssh2 |
|
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 is then run for the duration of the SSH session.
To use agent forwarding, libssh2_session_callback_set2(3) must first be called to set LIBSSH2_CALLBACK_AUTHAGENT. This callback is 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(3)
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.