forward.h File Reference

Interface functions to the internal and external multiplexers. More...

#include "openvpn.h"
#include "occ.h"
#include "ping.h"
#include "multi_io.h"

Include dependency graph for forward.h:

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

Go to the source code of this file.

Macros
#define	TUN_OUT(c)
#define	LINK_OUT(c)
#define	ANY_OUT(c)
#define	TO_LINK_FRAG(c)
#define	TO_LINK_DEF(c)
#define	IOW_TO_TUN   (1 << 0)
#define	IOW_TO_LINK   (1 << 1)
#define	IOW_READ_TUN   (1 << 2)
#define	IOW_READ_LINK   (1 << 3)
#define	IOW_SHAPER   (1 << 4)
#define	IOW_CHECK_RESIDUAL   (1 << 5)
#define	IOW_FRAG   (1 << 6)
#define	IOW_READ_TUN_FORCE   (1 << 8)
#define	IOW_WAIT_SIGNAL   (1 << 9)
#define	IOW_READ   (IOW_READ_TUN | IOW_READ_LINK)
#define	PIPV4_PASSTOS   (1u << 0)
#define	PIP_MSSFIX   (1u << 1) /* v4 and v6 */
#define	PIP_OUTGOING   (1u << 2)
#define	PIPV4_EXTRACT_DHCP_ROUTER   (1u << 3)
#define	PIPV4_CLIENT_NAT   (1u << 4)
#define	PIPV6_ICMP_NOHOST_CLIENT   (1u << 5)
#define	PIPV6_ICMP_NOHOST_SERVER   (1u << 6)

Functions
void	multi_io_process_flags (struct context *c, struct event_set *es, struct link_socket *sock, const unsigned int flags)
	Processes I/O flags to configure socket and TUN/TAP event monitors.
void	io_wait (struct context *c, const unsigned int flags)
void	pre_select (struct context *c)
void	process_io (struct context *c, struct link_socket *sock)
void	encrypt_sign (struct context *c, bool comp_frag)
	Process a data channel packet that will be sent through a VPN tunnel.
int	get_server_poll_remaining_time (const struct event_timeout *server_poll_timeout)
void	read_incoming_link (struct context *c, struct link_socket *sock)
	Read a packet from the external network interface.
bool	process_incoming_link_part1 (struct context *c, const struct link_socket_info *lsi, bool floated)
	Starts processing a packet read from the external network interface.
void	process_incoming_link_part2 (struct context *c, struct link_socket_info *lsi, const uint8_t *orig_buf)
	Continues processing a packet read from the external network interface.
void	extract_dco_float_peer_addr (sa_family_t socket_family, struct openvpn_sockaddr *out_osaddr, const struct sockaddr *float_sa)
	Transfers float_sa data extracted from an incoming DCO PEER_FLOAT_NTF to out_osaddr for later processing.
void	process_incoming_dco (dco_context_t *dco)
	Process an incoming DCO message (from kernel space).
void	process_outgoing_link (struct context *c, struct link_socket *sock)
	Write a packet to the external network interface.
void	read_incoming_tun (struct context *c)
	Read a packet from the virtual tun/tap network interface.
void	process_incoming_tun (struct context *c, struct link_socket *out_sock)
	Process a packet read from the virtual tun/tap network interface.
void	process_outgoing_tun (struct context *c, struct link_socket *in_sock)
	Write a packet to the virtual tun/tap network interface.
bool	send_control_channel_string (struct context *c, const char *str, msglvl_t msglevel)
bool	send_control_channel_string_dowork (struct tls_session *session, const char *str, msglvl_t msglevel)
void	reschedule_multi_process (struct context *c)
	Reschedule tls_multi_process.
void	process_ip_header (struct context *c, unsigned int flags, struct buffer *buf, struct link_socket *sock)
bool	schedule_exit (struct context *c)
static struct link_socket_info *	get_link_socket_info (struct context *c)
static void	register_activity (struct context *c, const int64_t size)
static unsigned int	p2p_iow_flags (const struct context *c)
static bool	connection_established (struct context *c)

Variables
counter_type	link_read_bytes_global
counter_type	link_write_bytes_global

Detailed Description

Interface functions to the internal and external multiplexers.

Definition in file forward.h.

Macro Definition Documentation

ANY_OUT

#define ANY_OUT

(

c

)

Value:

(TUN_OUT(c) || LINK_OUT(c))

Definition at line 39 of file forward.h.

Referenced by multi_process_post().

IOW_CHECK_RESIDUAL

#define IOW_CHECK_RESIDUAL   (1 << 5)

Definition at line 59 of file forward.h.

Referenced by io_wait(), and p2p_iow_flags().

IOW_FRAG

#define IOW_FRAG   (1 << 6)

Definition at line 60 of file forward.h.

Referenced by multi_io_process_flags(), and p2p_iow_flags().

IOW_READ

#define IOW_READ   (IOW_READ_TUN | IOW_READ_LINK)

Definition at line 64 of file forward.h.

Referenced by p2mp_iow_flags(), and p2p_iow_flags().

IOW_READ_LINK

#define IOW_READ_LINK   (1 << 3)

Definition at line 57 of file forward.h.

Referenced by multi_io_process_flags().

IOW_READ_TUN

#define IOW_READ_TUN   (1 << 2)

Definition at line 56 of file forward.h.

Referenced by multi_io_process_flags().

IOW_READ_TUN_FORCE

#define IOW_READ_TUN_FORCE   (1 << 8)

Definition at line 61 of file forward.h.

Referenced by multi_io_process_flags(), and multi_io_wait_lite().

IOW_SHAPER

#define IOW_SHAPER   (1 << 4)

Definition at line 58 of file forward.h.

Referenced by multi_io_process_flags(), and p2p_iow_flags().

IOW_TO_LINK

#define IOW_TO_LINK   (1 << 1)

Definition at line 55 of file forward.h.

Referenced by multi_io_process_flags(), multi_io_wait_lite(), p2mp_iow_flags(), and p2p_iow_flags().

IOW_TO_TUN

#define IOW_TO_TUN   (1 << 0)

Definition at line 54 of file forward.h.

Referenced by multi_io_process_flags(), multi_io_wait_lite(), p2mp_iow_flags(), and p2p_iow_flags().

IOW_WAIT_SIGNAL

#define IOW_WAIT_SIGNAL   (1 << 9)

Definition at line 62 of file forward.h.

Referenced by multi_io_process_flags(), p2mp_iow_flags(), and p2p_iow_flags().

LINK_OUT

#define LINK_OUT

(

c

)

Value:

(BLEN(&(c)->c2.to_link) > 0)

Definition at line 38 of file forward.h.

Referenced by multi_io_post(), and p2mp_iow_flags().

PIP_MSSFIX

#define PIP_MSSFIX   (1u << 1) /* v4 and v6 */

Definition at line 337 of file forward.h.

Referenced by multi_get_queue(), process_incoming_tun(), process_ip_header(), and process_outgoing_tun().

PIP_OUTGOING

#define PIP_OUTGOING   (1u << 2)

Definition at line 338 of file forward.h.

Referenced by process_ip_header(), and process_outgoing_tun().

PIPV4_CLIENT_NAT

#define PIPV4_CLIENT_NAT   (1u << 4)

Definition at line 340 of file forward.h.

Referenced by process_incoming_tun(), process_ip_header(), and process_outgoing_tun().

PIPV4_EXTRACT_DHCP_ROUTER

#define PIPV4_EXTRACT_DHCP_ROUTER   (1u << 3)

Definition at line 339 of file forward.h.

Referenced by process_ip_header(), and process_outgoing_tun().

PIPV4_PASSTOS

#define PIPV4_PASSTOS   (1u << 0)

Definition at line 336 of file forward.h.

Referenced by multi_get_queue(), process_incoming_tun(), and process_ip_header().

PIPV6_ICMP_NOHOST_CLIENT

#define PIPV6_ICMP_NOHOST_CLIENT   (1u << 5)

Definition at line 341 of file forward.h.

Referenced by process_incoming_tun(), and process_ip_header().

PIPV6_ICMP_NOHOST_SERVER

#define PIPV6_ICMP_NOHOST_SERVER   (1u << 6)

Definition at line 342 of file forward.h.

Referenced by multi_get_queue(), and process_ip_header().

TO_LINK_DEF

#define TO_LINK_DEF

(

c

)

Value:

(LINK_OUT(c) || TO_LINK_FRAG(c))

Definition at line 47 of file forward.h.

Referenced by check_ping_send(), check_send_occ_load_test(), check_send_occ_msg(), and check_send_occ_req().

TO_LINK_FRAG

#define TO_LINK_FRAG

(

c

)

Value:

((c)->c2.fragment && fragment_outgoing_defined((c)->c2.fragment))

Definition at line 42 of file forward.h.

Referenced by multi_io_process_flags().

TUN_OUT

#define TUN_OUT

(

c

)

Value:

(BLEN(&(c)->c2.to_tun) > 0)

Definition at line 37 of file forward.h.

Referenced by multi_io_post(), and p2mp_iow_flags().

Function Documentation

connection_established()

bool connection_established ( struct context * c )

inlinestatic

Definition at line 398 of file forward.h.

References context::c2, CAS_WAITING_OPTIONS_IMPORT, link_socket_info::connection_established, get_link_socket_info(), tls_multi::multi_state, and context_2::tls_multi.

Referenced by check_connection_established(), and check_send_occ_load_test_dowork().

extract_dco_float_peer_addr()

void extract_dco_float_peer_addr	(	sa_family_t	socket_family,
		struct openvpn_sockaddr *	out_osaddr,
		const struct sockaddr *	float_sa )

Transfers float_sa data extracted from an incoming DCO PEER_FLOAT_NTF to out_osaddr for later processing.

Parameters

socket_family	- The address family of the socket
out_osaddr	- openvpn_sockaddr struct that will be filled the new address data
float_sa	- The sockaddr struct containing the data received from the DCO notification

Definition at line 1234 of file forward.c.

References openvpn_sockaddr::addr, openvpn_sockaddr::in4, and openvpn_sockaddr::in6.

get_link_socket_info()

struct link_socket_info * get_link_socket_info ( struct context * c )

inlinestatic

Definition at line 351 of file forward.h.

References context::c2, link_socket::info, context_2::link_socket_infos, and context_2::link_sockets.

Referenced by check_fragment(), check_tls(), connection_established(), do_deferred_options_part2(), do_deferred_p2p_ncp(), do_init_fragment(), drop_if_recursive_routing(), encrypt_sign(), frame_adjust_path_mtu(), initialization_sequence_completed(), multi_client_connect_setenv(), multi_client_disconnect_setenv(), and multi_client_generate_tls_keys().

get_server_poll_remaining_time()

int get_server_poll_remaining_time

(

const struct event_timeout *

server_poll_timeout

)

Definition at line 510 of file forward.c.

References event_timeout_remaining(), max_int(), and update_time().

Referenced by dco_p2p_new_peer(), establish_http_proxy_passthru(), phase2_socks_client(), phase2_tcp_client(), and socks_proxy_recv_char().

io_wait()

void io_wait	(	struct context *	c,
		const unsigned int	flags )

Definition at line 2148 of file forward.c.

References event_set_return::arg, context::c1, context::c2, check_debug_level(), check_status(), D_EVENT_WAIT, D_LINK_ERRORS, tuntap::dco, dco_event_set(), DCO_SHIFT, dmsg, ES_ERROR, ES_TIMEOUT, EVENT_ARG_LINK_SOCKET, event_reset(), context_2::event_set, context_2::event_set_status, event_wait(), get_signal(), IOW_CHECK_RESIDUAL, context_2::link_sockets, MANAGEMENT_SHIFT, management_socket_set(), msg, multi_io_process_flags(), MULTI_N, event_set_return::rwflags, show_wait_status(), context::sig, signal_info::signal_received, SIZE, SOCKET_READ, SOCKET_SHIFT, sockets_read_residual(), status, context_2::timeval, context_1::tuntap, event_arg::type, and update_time().

Referenced by multi_io_wait_lite(), and tunnel_point_to_point().

multi_io_process_flags()

void multi_io_process_flags	(	struct context *	c,
		struct event_set *	es,
		struct link_socket *	sock,
		const unsigned int	flags )

Processes I/O flags to configure socket and TUN/TAP event monitors.

Evaluates the current I/O state (flags) and context mode to determine which READ or WRITE events to register in the event loop.

Note

This function gets called from client instances from io_wait() and from p2mp (Point-to-multipoint) instances in multi_io_wait().

Parameters

c	Pointer to the core context.
es	The event set where descriptors are registered.
sock	The link socket to configure.
flags	Bitmask of active I/O operation requests (e.g., IOW_TO_LINK, IOW_READ_TUN, IOW_TO_TUN, IOW_SHAPER).

Definition at line 2054 of file forward.c.

References context::c1, context::c2, ERR_SHIFT, link_socket::ev_arg, EVENT_READ, EVENT_WRITE, IOW_FRAG, IOW_READ_LINK, IOW_READ_TUN, IOW_READ_TUN_FORCE, IOW_SHAPER, IOW_TO_LINK, IOW_TO_TUN, IOW_WAIT_SIGNAL, max_int(), options::mode, MODE_SERVER, context::options, context_2::shaper, options::shaper, shaper_delay(), shaper_soonest_event(), socket_set(), context_2::timeval, TO_LINK_FRAG, tun_set(), TUN_SHIFT, context_1::tuntap, and wait_signal().

Referenced by io_wait(), and multi_io_wait().

p2p_iow_flags()

unsigned int p2p_iow_flags ( const struct context * c )

inlinestatic

Definition at line 382 of file forward.h.

References context::c2, IOW_CHECK_RESIDUAL, IOW_FRAG, IOW_READ, IOW_SHAPER, IOW_TO_LINK, IOW_TO_TUN, IOW_WAIT_SIGNAL, buffer::len, context_2::to_link, and context_2::to_tun.

Referenced by tunnel_point_to_point().

pre_select()

void pre_select

(

struct context *

c

)

Definition at line 1988 of file forward.c.

References BIG_TIMEOUT, context::c1, context::c2, check_coarse_timers(), check_debug_level(), check_fragment(), check_incoming_control_channel(), check_send_occ_msg(), check_timeout_random_component(), check_tls(), check_tls_errors(), D_TAP_WIN_DEBUG, context_2::fragment, context::sig, signal_info::signal_received, context_2::timeval, context_2::tls_multi, tls_test_payload_len(), tun_show_debug(), context_1::tuntap, and tuntap_defined().

Referenced by multi_process_post(), and tunnel_point_to_point().

process_incoming_dco()

void process_incoming_dco

(

dco_context_t *

dco

)

Process an incoming DCO message (from kernel space).

Parameters

dco	- Pointer to the structure representing the DCO context.

Definition at line 1268 of file forward.c.

References context::c2, D_DCO_DEBUG, tls_multi::dco_peer_id, msg, OVPN_CMD_DEL_PEER, OVPN_CMD_SWAP_KEYS, OVPN_DEL_PEER_REASON_EXPIRED, context_2::tls_multi, tls_session_soft_reset(), and trigger_ping_timeout_signal().

Referenced by dco_read_and_process().

process_io()

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

Definition at line 2269 of file forward.c.

References ASSERT, context::c1, context::c2, tuntap::dco, DCO_READ, dco_read_and_process(), context_2::event_set_status, IS_SIG, management_io(), MANAGEMENT_READ, MANAGEMENT_WRITE, process_incoming_link(), process_incoming_tun(), process_outgoing_link(), process_outgoing_tun(), read_incoming_link(), read_incoming_tun(), event_arg::sock, SOCKET_READ, SOCKET_WRITE, status, TUN_READ, TUN_WRITE, and context_1::tuntap.

Referenced by tunnel_point_to_point().

process_ip_header()

void process_ip_header	(	struct context *	c,
		unsigned int	flags,
		struct buffer *	buf,
		struct link_socket *	sock )

Definition at line 1685 of file forward.c.

References options::block_ipv6, context::c1, context::c2, options::ce, options::client_nat, client_nat_transform(), CN_INCOMING, CN_OUTGOING, dhcp_extract_router_msg(), context_2::es, context_2::frame, ipv6_send_icmp_unreachable(), is_ipv4(), is_ipv6(), buffer::len, frame::mss_fix, mss_fixup_ipv4(), mss_fixup_ipv6(), connection_entry::mssfix, context::options, PIP_MSSFIX, PIP_OUTGOING, PIPV4_CLIENT_NAT, PIPV4_EXTRACT_DHCP_ROUTER, PIPV4_PASSTOS, PIPV6_ICMP_NOHOST_CLIENT, PIPV6_ICMP_NOHOST_SERVER, options::route_gateway_via_dhcp, context_1::route_list, route_list_add_vpn_gateway(), TUNNEL_TYPE, and context_1::tuntap.

Referenced by multi_get_queue(), process_incoming_tun(), and process_outgoing_tun().

register_activity()

void register_activity ( struct context * c, const int64_t size )

inlinestatic

Definition at line 364 of file forward.h.

References context::c2, event_timeout_reset(), context_2::inactivity_bytes, context_2::inactivity_interval, options::inactivity_minimum_bytes, options::inactivity_timeout, and context::options.

Referenced by multi_process_incoming_link_data(), process_outgoing_link(), and process_outgoing_tun().

reschedule_multi_process()

void reschedule_multi_process

(

struct context *

c

)

Reschedule tls_multi_process.

NOTE: in multi-client mode, usually calling the function is insufficient to reschedule the client instance object unless multi_schedule_context_wakeup(m, mi) is also called.

Definition at line 397 of file forward.c.

References context::c2, context_immediate_reschedule(), interval_action(), and context_2::tmp_int.

Referenced by management_client_pending_auth(), send_auth_failed(), and send_control_channel_string().

schedule_exit()

bool schedule_exit

(

struct context *

c

)

Definition at line 534 of file forward.c.

References context::c2, D_SCHED_EXIT, dco_delete_iroutes(), context::did_dco_iroutes, event_timeout_defined(), event_timeout_init(), msg, context::net_ctx, now, context::options, reset_coarse_timers(), context_2::scheduled_exit, options::scheduled_exit_interval, context_2::scheduled_exit_signal, SIGTERM, context_2::tls_multi, tls_set_single_session(), and update_time().

Referenced by receive_exit_message(), send_auth_failed(), and send_restart().

send_control_channel_string()

bool send_control_channel_string	(	struct context *	c,
		const char *	str,
		msglvl_t	msglevel )

Definition at line 404 of file forward.c.

References context::c2, reschedule_multi_process(), send_control_channel_string_dowork(), tls_multi::session, context_2::tls_multi, and TM_ACTIVE.

Referenced by management_callback_send_cc_message(), multi_push_restart_schedule_exit(), process_explicit_exit_notification_init(), send_push_options(), send_push_reply(), send_push_request(), send_restart(), and send_single_push_update().

send_control_channel_string_dowork()

bool send_control_channel_string_dowork	(	struct tls_session *	session,
		const char *	str,
		msglvl_t	msglevel )

Definition at line 376 of file forward.c.

References ASSERT, gc, gc_free(), gc_new(), session::key, KS_PRIMARY, msg, sanitize_control_message(), and tls_send_payload().

Referenced by send_auth_failed(), send_auth_pending_messages(), send_control_channel_string(), and send_push_reply_auth_token().

Variable Documentation

link_read_bytes_global

counter_type link_read_bytes_global

extern

Definition at line 48 of file forward.c.

Referenced by man_load_stats(), and process_incoming_link_part1().

link_write_bytes_global

counter_type link_write_bytes_global

extern

Definition at line 49 of file forward.c.

Referenced by man_load_stats(), and process_outgoing_link().