socks.h

Go to the documentation of this file.

/*
 *  OpenVPN -- An application to securely tunnel IP networks
 *             over a single TCP/UDP port, with support for SSL/TLS-based
 *             session authentication and key exchange,
 *             packet encryption, packet authentication, and
 *             packet compression.
 *
 *  Copyright (C) 2002-2026 OpenVPN Inc <sales@openvpn.net>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2
 *  as published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, see <https://www.gnu.org/licenses/>.
 */
 
/*
 * 2004-01-30: Added Socks5 proxy support
 *   (Christof Meerwald, https://cmeerw.org)
 */
 
#ifndef SOCKS_H
#define SOCKS_H
 
#include "buffer.h"
#include "interval.h"
#include "sig.h"
 
struct openvpn_sockaddr;
struct link_socket_actual;
 
struct socks_proxy_info
{
    bool defined;
 
    char server[128];
    const char *port;
    char authfile[256];
};
 
struct socks_proxy_info *socks_proxy_new(const char *server, const char *port,
                                         const char *authfile);
 
void socks_proxy_close(struct socks_proxy_info *sp);
 
void establish_socks_proxy_passthru(const struct socks_proxy_info *p,
                                    socket_descriptor_t sd, /* already open to proxy */
                                    const char *host,       /* openvpn server remote */
                                    const char *servname,   /* openvpn server port */
                                    const struct event_timeout *server_poll_timeout,
                                    struct signal_info *sig_info);
 
void establish_socks_proxy_udpassoc(const struct socks_proxy_info *p,
                                    socket_descriptor_t ctrl_sd, /* already open to proxy */
                                    struct openvpn_sockaddr *relay_addr,
                                    const struct event_timeout *server_poll_timeout,
                                    struct signal_info *sig_info);
 
void socks_process_incoming_udp(struct buffer *buf, struct link_socket_actual *from);
 
int socks_process_outgoing_udp(struct buffer *buf, const struct link_socket_actual *to);
 
#endif /* ifndef SOCKS_H */