#include "buffer.h"
#include "common.h"
#include "error.h"
#include "proto.h"
#include "mtu.h"
#include "win32.h"
#include "event.h"
#include "proxy.h"
#include "socks.h"
#include "misc.h"
#include "tun.h"
#include "socket_util.h"

Include dependency graph for socket.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	cached_dns_entry

struct	link_socket_addr

struct	link_socket_info

struct	stream_buf
	struct used to extract packets encapsulated in streams into a buffer, in this case OpenVPN packets (data or control) embedded in a TCP stream. More...

struct	socket_buffer_size

struct	link_socket

struct	sockethandle_t

Macros
#define	OPENVPN_PORT "1194"

#define	RESOLV_RETRY_INFINITE 1000000000

#define	htonps(x) htons(x)

#define	ntohps(x) ntohs(x)

#define	LS_MODE_DEFAULT 0

#define	LS_MODE_TCP_LISTEN 1

#define	LS_MODE_TCP_ACCEPT_FROM 2

#define	SF_USE_IP_PKTINFO (1 << 0)

#define	SF_TCP_NODELAY (1 << 1)

#define	SF_PORT_SHARE (1 << 2)

#define	SF_HOST_RANDOMIZE (1 << 3)

#define	SF_GETADDRINFO_DGRAM (1 << 4)

#define	SF_DCO_WIN (1 << 5)

#define	SF_PREPEND_SA (1 << 6)

#define	SF_PKTINFO_COPY_IIF (1 << 7)

#define	MSG_NOSIGNAL 0

#define	openvpn_close_socket(s) closesocket(s)

#define	IPV4_INVALID_ADDR 0xffffffff

Typedefs
typedef uint16_t	packet_size_type

Functions
void	socket_set_buffers (socket_descriptor_t fd, const struct socket_buffer_size *sbs, bool reduce_size)
	Sets the receive and send buffer sizes of a socket descriptor.

int	socket_recv_queue (struct link_socket *sock, int maxsize)

int	socket_send_queue (struct link_socket sock, struct buffer buf, const struct link_socket_actual *to)

int	sockethandle_finalize (sockethandle_t sh, struct overlapped_io io, struct buffer buf, struct link_socket_actual *from)

static BOOL	SocketHandleGetOverlappedResult (sockethandle_t sh, struct overlapped_io *io)

static int	SocketHandleGetLastError (sockethandle_t sh)

static void	SocketHandleSetLastError (sockethandle_t sh, DWORD err)

static void	SocketHandleSetInvalError (sockethandle_t sh)

static int	openvpn_select (socket_descriptor_t nfds, fd_set readfds, fd_set writefds, fd_set exceptfds, struct timeval timeout)

static ssize_t	openvpn_send (socket_descriptor_t sockfd, const void *buf, size_t len, int flags)

static int	openvpn_bind (socket_descriptor_t sockfd, const struct sockaddr *addr, size_t addrlen)

struct link_socket *	link_socket_new (void)

void	socket_bind (socket_descriptor_t sd, struct addrinfo local, int af_family, const char prefix, bool ipv6only)

int	openvpn_connect (socket_descriptor_t sd, const struct sockaddr remote, int connect_timeout, volatile int signal_received)

void	link_socket_init_phase1 (struct context *c, int sock_index, int mode)

void	link_socket_init_phase2 (struct context c, struct link_socket sock)

void	do_preresolve (struct context *c)

void	link_socket_close (struct link_socket *sock)

void	sd_close (socket_descriptor_t *sd)

void	bad_address_length (int actual, int expected)

in_addr_t	link_socket_current_remote (const struct link_socket_info *info)

const struct in6_addr *	link_socket_current_remote_ipv6 (const struct link_socket_info *info)

void	link_socket_connection_initiated (struct link_socket_info info, const struct link_socket_actual addr, const char common_name, struct env_set es)

void	link_socket_bad_incoming_addr (struct buffer buf, const struct link_socket_info info, const struct link_socket_actual *from_addr)

void	set_actual_address (struct link_socket_actual actual, struct addrinfo ai)

void	link_socket_bad_outgoing_addr (void)

void	setenv_trusted (struct env_set es, const struct link_socket_info info)

bool	link_socket_update_flags (struct link_socket *sock, unsigned int sockflags)

void	link_socket_update_buffer_sizes (struct link_socket *sock, int rcvbuf, int sndbuf)

socket_descriptor_t	create_socket_tcp (struct addrinfo *)

socket_descriptor_t	socket_do_accept (socket_descriptor_t sd, struct link_socket_actual *act, const bool nowait)

static bool	link_socket_connection_oriented (const struct link_socket *sock)

static bool	socket_connection_reset (const struct link_socket *sock, int status)

static bool	link_socket_verify_incoming_addr (struct buffer buf, const struct link_socket_info info, const struct link_socket_actual *from_addr)

static void	link_socket_get_outgoing_addr (struct buffer buf, const struct link_socket_info info, struct link_socket_actual **act)

static void	link_socket_set_outgoing_addr (struct link_socket_info info, const struct link_socket_actual act, const char common_name, struct env_set es)

bool	stream_buf_read_setup_dowork (struct stream_buf *sb)
	Will try to check if the buffers in stream form a full packet.

static bool	stream_buf_read_setup (struct link_socket *sock)

static bool	socket_is_dco_win (const struct link_socket *s)
	Returns true if we are on Windows and this link is running on DCO-WIN.

int	link_socket_read_tcp (struct link_socket sock, struct buffer buf)

static int	link_socket_read_udp_win32 (struct link_socket sock, struct buffer buf, struct link_socket_actual *from)

static int	link_socket_read (struct link_socket sock, struct buffer buf, struct link_socket_actual *from)

ssize_t	link_socket_write_tcp (struct link_socket sock, struct buffer buf, struct link_socket_actual *to)

static int	link_socket_write_win32 (struct link_socket sock, struct buffer buf, struct link_socket_actual *to)

static ssize_t	link_socket_write_udp (struct link_socket sock, struct buffer buf, struct link_socket_actual *to)

static ssize_t	link_socket_write (struct link_socket sock, struct buffer buf, struct link_socket_actual *to)

bool	sockets_read_residual (const struct context *c)

static event_t	socket_event_handle (const struct link_socket *sock)

event_t	socket_listen_event_handle (struct link_socket *sock)

unsigned int	socket_set (struct link_socket sock, struct event_set es, unsigned int rwflags, void arg, unsigned int persistent)

static void	socket_set_listen_persistent (struct link_socket sock, struct event_set es, void *arg)

static void	socket_reset_listen_persistent (struct link_socket *sock)

const char *	socket_stat (const struct link_socket sock, unsigned int rwflags, struct gc_arena gc)

Macro Definition Documentation

◆ htonps

#define htonps ( x ) htons(x)

Definition at line 59 of file socket.h.

◆ IPV4_INVALID_ADDR

#define IPV4_INVALID_ADDR 0xffffffff

Definition at line 375 of file socket.h.

◆ LS_MODE_DEFAULT

#define LS_MODE_DEFAULT 0

Definition at line 197 of file socket.h.

◆ LS_MODE_TCP_ACCEPT_FROM

#define LS_MODE_TCP_ACCEPT_FROM 2

Definition at line 199 of file socket.h.

◆ LS_MODE_TCP_LISTEN

#define LS_MODE_TCP_LISTEN 1

Definition at line 198 of file socket.h.

◆ MSG_NOSIGNAL

#define MSG_NOSIGNAL 0

Definition at line 261 of file socket.h.

◆ ntohps

#define ntohps ( x ) ntohs(x)

Definition at line 62 of file socket.h.

◆ openvpn_close_socket

#define openvpn_close_socket ( s ) closesocket(s)

Definition at line 266 of file socket.h.

◆ OPENVPN_PORT

#define OPENVPN_PORT "1194"

Definition at line 42 of file socket.h.

◆ RESOLV_RETRY_INFINITE

#define RESOLV_RETRY_INFINITE 1000000000

Definition at line 48 of file socket.h.

◆ SF_DCO_WIN

#define SF_DCO_WIN (1 << 5)

Definition at line 214 of file socket.h.

◆ SF_GETADDRINFO_DGRAM

#define SF_GETADDRINFO_DGRAM (1 << 4)

Definition at line 213 of file socket.h.

◆ SF_HOST_RANDOMIZE

#define SF_HOST_RANDOMIZE (1 << 3)

Definition at line 212 of file socket.h.

◆ SF_PKTINFO_COPY_IIF

#define SF_PKTINFO_COPY_IIF (1 << 7)

Definition at line 216 of file socket.h.

◆ SF_PORT_SHARE

#define SF_PORT_SHARE (1 << 2)

Definition at line 211 of file socket.h.

◆ SF_PREPEND_SA

#define SF_PREPEND_SA (1 << 6)

Definition at line 215 of file socket.h.

◆ SF_TCP_NODELAY

#define SF_TCP_NODELAY (1 << 1)

Definition at line 210 of file socket.h.

◆ SF_USE_IP_PKTINFO

#define SF_USE_IP_PKTINFO (1 << 0)

Definition at line 209 of file socket.h.

Typedef Documentation

◆ packet_size_type

typedef uint16_t packet_size_type

Definition at line 56 of file socket.h.

Function Documentation

◆ bad_address_length()

void bad_address_length	(	int	actual,
		int	expected
	)

Definition at line 2258 of file socket.c.

References buffer::len, M_FATAL, and msg.

Referenced by read_sockaddr_from_overlapped(), and socket_recv_queue().

◆ create_socket_tcp()

socket_descriptor_t create_socket_tcp ( struct addrinfo * addrinfo )

Definition at line 564 of file socket.c.

References ASSERT, M_ERR, msg, set_cloexec(), and SOCKET_UNDEFINED.

Referenced by create_socket(), man_connect(), man_listen(), and phase2_tcp_client().

◆ do_preresolve()

void do_preresolve ( struct context * c )

Definition at line 323 of file socket.c.

References connection_entry::af, local_list::array, connection_list::array, connection_entry::bind_local, do_preresolve_host(), connection_entry::flags, GETADDR_DATAGRAM, GETADDR_FATAL, GETADDR_MENTION_RESOLVE_RETRY, GETADDR_PASSIVE, GETADDR_RANDOMIZE, GETADDR_RESOLVE, GETADDR_UPDATE_MANAGEMENT_STATE, connection_entry::http_proxy_options, options::ip_remote_hint, local_list::len, connection_list::len, local_entry::local, connection_entry::local_list, context::options, local_entry::port, http_proxy_options::port, connection_entry::proto, proto_is_dgram(), connection_entry::remote, connection_entry::remote_port, http_proxy_options::server, SF_HOST_RANDOMIZE, SIGHUP, options::sockflags, connection_entry::socks_proxy_port, connection_entry::socks_proxy_server, status, and throw_signal_soft().

Referenced by init_instance().

◆ link_socket_bad_incoming_addr()

void link_socket_bad_incoming_addr	(	struct buffer *	buf,
		const struct link_socket_info *	info,
		const struct link_socket_actual *	from_addr
	)

Definition at line 1922 of file socket.c.

References openvpn_sockaddr::addr, D_LINK_ERRORS, link_socket_actual::dest, gc, gc_free(), gc_new(), buffer::len, link_socket_info::lsa, msg, print_link_socket_actual(), print_sockaddr_ex(), PS_SHOW_PORT, link_socket_addr::remote_list, and openvpn_sockaddr::sa.

Referenced by process_incoming_link_part1().

◆ link_socket_bad_outgoing_addr()

void link_socket_bad_outgoing_addr ( void )

Definition at line 1949 of file socket.c.

References D_READ_WRITE, and dmsg.

Referenced by link_socket_get_outgoing_addr().

◆ link_socket_close()

void link_socket_close ( struct link_socket * sock )

Definition at line 1796 of file socket.c.

References close_net_event_win32(), link_socket::ctrl_sd, D_LOW, free_buf(), link_socket::listen_handle, M_ERRNO, M_WARN, msg, openvpn_close_socket, overlapped_io_close(), link_socket::reads, link_socket::sd, socket_defined(), SOCKET_UNDEFINED, link_socket::stream_buf, stream_buf_close(), link_socket::stream_buf_data, and link_socket::writes.

Referenced by do_close_link_socket().

◆ link_socket_connection_initiated()

void link_socket_connection_initiated	(	struct link_socket_info *	info,
		const struct link_socket_actual *	addr,
		const char *	common_name,
		struct env_set *	es
	)

Definition at line 1870 of file socket.c.

References link_socket_addr::actual, alloc_buf_gc(), argv_free(), argv_new(), BSTR, buf_printf(), link_socket_info::connection_established, es, gc, gc_free(), gc_new(), link_socket_info::ipchange_command, ipchange_fmt(), buffer::len, link_socket_info::lsa, M_INFO, M_WARN, msg, openvpn_run_script(), plugin_call(), plugin_defined(), link_socket_info::plugins, print_link_socket_actual(), setenv_str(), and setenv_trusted().

Referenced by link_socket_set_outgoing_addr().

◆ link_socket_connection_oriented()

static bool link_socket_connection_oriented ( const struct link_socket * sock )

inlinestatic

Definition at line 427 of file socket.h.

References link_socket::info, link_socket_proto_connection_oriented(), and link_socket_info::proto.

Referenced by check_tls_errors(), process_incoming_link_part1(), socket_connection_reset(), socket_frame_init(), and stream_buf_read_setup().

◆ link_socket_current_remote()

in_addr_t link_socket_current_remote ( const struct link_socket_info * info )

Definition at line 1955 of file socket.c.

References link_socket_addr::actual, openvpn_sockaddr::addr, link_socket_addr::current_remote, link_socket_actual::dest, openvpn_sockaddr::in4, IPV4_INVALID_ADDR, link_socket_actual_defined(), link_socket_info::lsa, and openvpn_sockaddr::sa.

Referenced by do_init_route_list().

◆ link_socket_current_remote_ipv6()

const struct in6_addr * link_socket_current_remote_ipv6 ( const struct link_socket_info * info )

Definition at line 1989 of file socket.c.

References link_socket_addr::actual, openvpn_sockaddr::addr, link_socket_addr::current_remote, link_socket_actual::dest, openvpn_sockaddr::in6, link_socket_actual_defined(), link_socket_info::lsa, and openvpn_sockaddr::sa.

Referenced by do_init_route_ipv6_list().

◆ link_socket_get_outgoing_addr()

static void link_socket_get_outgoing_addr	(	struct buffer *	buf,
		const struct link_socket_info *	info,
		struct link_socket_actual **	act
	)

inlinestatic

Definition at line 512 of file socket.h.

References link_socket_addr::actual, buffer::len, link_socket_actual_defined(), link_socket_bad_outgoing_addr(), and link_socket_info::lsa.

Referenced by encrypt_sign().

◆ link_socket_init_phase1()

void link_socket_init_phase1	(	struct context *	c,
		int	sock_index,
		int	mode
	)

Definition at line 1343 of file socket.c.

References context_2::accept_from, connection_entry::af, link_socket_info::af, local_list::array, ASSERT, options::bind_dev, link_socket::bind_dev, connection_entry::bind_ipv6_only, link_socket_info::bind_ipv6_only, connection_entry::bind_local, link_socket::bind_local, context::c1, context::c2, options::ce, CM_CHILD_TCP, CM_CHILD_UDP, context_1::dns_cache, link_socket::dns_cache, context_1::http_proxy, link_socket::http_proxy, link_socket::info, options::ipchange, link_socket_info::ipchange_command, context_1::link_socket_addrs, context_2::link_sockets, local_entry::local, link_socket::local_host, connection_entry::local_list, link_socket::local_port, LS_MODE_TCP_ACCEPT_FROM, link_socket_info::lsa, options::mark, link_socket::mark, context::mode, link_socket::mode, connection_entry::mtu_discover_type, link_socket::mtu_discover_type, context::options, http_proxy_info::options, context::plugins, link_socket_info::plugins, local_entry::port, http_proxy_options::port, socks_proxy_info::port, local_entry::proto, connection_entry::proto, link_socket_info::proto, PROTO_TCP_CLIENT, PROTO_TCP_SERVER, link_socket::proxy_dest_host, link_socket::proxy_dest_port, options::rcvbuf, socket_buffer_size::rcvbuf, connection_entry::remote, connection_entry::remote_float, link_socket_info::remote_float, link_socket::remote_host, connection_entry::remote_port, link_socket::remote_port, resolve_bind_local(), resolve_remote(), options::resolve_retry_seconds, link_socket::resolve_retry_seconds, link_socket::sd, http_proxy_options::server, socks_proxy_info::server, context_2::server_poll_interval, link_socket::server_poll_timeout, SF_PORT_SHARE, options::sndbuf, socket_buffer_size::sndbuf, link_socket::socket_buffer_sizes, options::sockflags, link_socket::sockflags, context_1::socks_proxy, and link_socket::socks_proxy.

Referenced by do_init_socket_phase1().

◆ link_socket_init_phase2()

void link_socket_init_phase2	(	struct context *	c,
		struct link_socket *	sock
	)

Definition at line 1686 of file socket.c.

References link_socket_addr::actual, openvpn_sockaddr::addr, addr_family_name(), link_socket_info::af, ASSERT, link_socket_addr::bind_local, link_socket::bind_local, context::c2, create_socket(), create_socket_dco_win(), link_socket_addr::current_remote, dco_enabled(), link_socket_actual::dest, context_2::frame, link_socket::info, linksock_print_addr(), link_socket_info::lsa, M_WARN, msg, context::options, phase2_set_socket_flags(), phase2_socks_client(), phase2_tcp_client(), phase2_tcp_server(), link_socket_info::proto, PROTO_TCP_CLIENT, PROTO_TCP_SERVER, PROTO_UDP, register_signal(), link_socket::remote_host, resolve_remote(), openvpn_sockaddr::sa, link_socket::sd, context::sig, SIG_SOURCE_HARD, siginfo_static, signal_info::signal_received, signal_reset(), signal_info::signal_text, SIGUSR1, socket_frame_init(), SOCKET_UNDEFINED, link_socket::socks_proxy, signal_info::source, and throw_signal().

Referenced by do_init_socket_phase2().

◆ link_socket_new()

struct link_socket * link_socket_new ( void )

Definition at line 1329 of file socket.c.

References ALLOC_OBJ_CLEAR, link_socket::ctrl_sd, link_socket::ev_arg, EVENT_ARG_LINK_SOCKET, link_socket::sd, event_arg::sock, SOCKET_UNDEFINED, event_arg::type, and event_arg::u.

Referenced by do_link_socket_new().

◆ link_socket_read()

static int link_socket_read	(	struct link_socket *	sock,
		struct buffer *	buf,
		struct link_socket_actual *	from
	)

inlinestatic

Definition at line 616 of file socket.h.

References link_socket_addr::actual, ASSERT, link_socket_actual::dest, link_socket::info, link_socket_read_tcp(), link_socket_read_udp_win32(), link_socket_info::lsa, link_socket_info::proto, proto_is_tcp(), proto_is_udp(), and socket_is_dco_win().

Referenced by read_incoming_link().

◆ link_socket_read_tcp()

int link_socket_read_tcp	(	struct link_socket *	sock,
		struct buffer *	buf
	)

Definition at line 2270 of file socket.c.

References BLENZ, BPTR, buffer::len, M_INFO, msg, MSG_NOSIGNAL, link_socket::reads, stream_buf::residual_fully_formed, sockethandle_t::s, link_socket::sd, SOCKET_UNDEFINED, sockethandle_finalize(), link_socket::stream_buf, stream_buf_added(), stream_buf_get_final(), stream_buf_get_next(), stream_buf_reset(), and link_socket::stream_reset.

Referenced by link_socket_read().

◆ link_socket_read_udp_win32()

static int link_socket_read_udp_win32	(	struct link_socket *	sock,
		struct buffer *	buf,
		struct link_socket_actual *	from
	)

inlinestatic

Definition at line 594 of file socket.h.

References link_socket_addr::actual, link_socket::info, sockethandle_t::is_handle, link_socket_info::lsa, sockethandle_t::prepend_sa, link_socket::reads, sockethandle_t::s, link_socket::sd, SF_PREPEND_SA, socket_is_dco_win(), sockethandle_finalize(), and link_socket::sockflags.

Referenced by link_socket_read().

◆ link_socket_set_outgoing_addr()

static void link_socket_set_outgoing_addr	(	struct link_socket_info *	info,
		const struct link_socket_actual *	act,
		const char *	common_name,
		struct env_set *	es
	)