mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-03 22:13:11 +03:00
378ffa9ba8
files: channel.c, test_agent_forward_succeeds.c, libssh2_priv.h, libssh2.h, ssh2_agent_forwarding.c notes: * Adding SSH agent forwarding. * Fix agent forwarding message, updated example. Added integration test code and cmake target. Added example to cmake list. credit: pkittenis
23 lines
865 B
Groff
23 lines
865 B
Groff
.TH libssh2_channel_request_auth_agent 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_channel_request_auth_agent - request agent forwarding for a session
|
|
.SH SYNOPSIS
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel);
|
|
|
|
.SH 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.
|
|
|
|
\fIchannel\fP - Previously opened channel instance such as returned by
|
|
.BR libssh2_channel_open_ex(3)
|
|
|
|
.SH 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 isn't really a failure per se.
|