Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_channel_direct_tcpip_ex (3ssh2)

Name

libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session

Synopsis

#include <libssh2.h>

LIBSSH2_CHANNEL * libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *ses-
sion, const char *host, int port, const char *shost, int sport);

LIBSSH2_CHANNEL  *  libssh2_channel_direct_tcpip(LIBSSH2_SESSION  *ses-
sion, const char *host, int port);

Description

libssh2 manual                          libssh2_channel_direct_tcpip_ex(3ssh2)



NAME
       libssh2_channel_direct_tcpip_ex  -  Tunnel  a TCP connection through an
       SSH session

SYNOPSIS
       #include <libssh2.h>

       LIBSSH2_CHANNEL * libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *ses-
       sion, const char *host, int port, const char *shost, int sport);

       LIBSSH2_CHANNEL  *  libssh2_channel_direct_tcpip(LIBSSH2_SESSION  *ses-
       sion, const char *host, int port);


DESCRIPTION
       session - Session instance as returned by libssh2_session_init_ex(3)

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

       port - Port on third party host to connect to.

       shost - Host to tell the SSH server the connection originated on.

       sport - 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.


RETURN VALUE
       Pointer  to  a  newly  allocated  LIBSSH2_CHANNEL  instance, or NULL on
       errors.

ERRORS
       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_session_init_ex(3)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source  was  downloaded   from    https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 0.15                      1 Jun 2007
                                        libssh2_channel_direct_tcpip_ex(3ssh2)