libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_channel_direct_tcpip_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
LIBSSH2_CHANNEL *
11
libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session,
12
                                const char *host, int port,
13
                                const char *shost, int sport);
14

15
LIBSSH2_CHANNEL *
16
libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session,
17
                             const char *host, int port);
18
.fi
19
.SH DESCRIPTION
20
\fIsession\fP - Session instance as returned by
21
.BR libssh2_session_init_ex(3)
22

23
\fIhost\fP - Third party host to connect to using the SSH host as a proxy.
24

25
\fIport\fP - Port on third party host to connect to.
26

27
\fIshost\fP - Host to tell the SSH server the connection originated on.
28

29
\fIsport\fP - Port to tell the SSH server the connection originated from.
30

31
Tunnel a TCP/IP connection through the SSH transport via the remote host to
32
a third party. Communication from the client to the SSH server remains
33
encrypted, communication from the server to the 3rd party host travels
34
in cleartext.
35
.SH RETURN VALUE
36
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
37
.SH ERRORS
38
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
39
.SH SEE ALSO
40
.BR libssh2_session_init_ex(3)
41