File: libssh2_channel_direct_tcpip_ex.3

package info (click to toggle)
libssh2 1.2.6-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 3,512 kB
  • ctags: 1,941
  • sloc: ansic: 19,640; sh: 10,525; makefile: 388; awk: 19
file content (37 lines) | stat: -rw-r--r-- 1,364 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
.\" $Id: libssh2_channel_direct_tcpip_ex.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
.\"
.TH libssh2_channel_direct_tcpip_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session
.SH SYNOPSIS
#include <libssh2.h>

LIBSSH2_CHANNEL * 
libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session, const char *host, int port, const char *shost, int sport);

LIBSSH2_CHANNEL * 
libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port);

.SH DESCRIPTION
\fIsession\fP - Session instance as returned by 
.BR libssh2_session_init_ex(3)

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

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

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

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

Tunnel a TCP/IP connection through the SSH transport via the remote host to 
a third party. Communication from the client to the SSH server remains 
encrypted, communication from the server to the 3rd party host travels 
in cleartext.

.SH RETURN VALUE
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
.SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
.SH SEE ALSO
.BR libssh2_session_init_ex(3)