#include "service.h"
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <userenv.h>
#include <accctrl.h>
#include <aclapi.h>
#include <stdio.h>
#include <sddl.h>
#include <shellapi.h>
#include <mstcpip.h>
#include <inttypes.h>
#include <versionhelpers.h>
#include "openvpn-msg.h"
#include "validate.h"
#include "wfp_block.h"
#include "ring_buffer.h"

Include dependency graph for interactive.c:

Data Structures
struct	STARTUP_DATA

struct	_list_item

struct	wfp_block_data_t

struct	dns_domains_undo_data_t

struct	ring_buffer_maps_t

union	pipe_message_t

Macros
#define	IO_TIMEOUT 2000 /ms/

#define	ERROR_OPENVPN_STARTUP 0x20000000

#define	ERROR_STARTUP_DATA 0x20000001

#define	ERROR_MESSAGE_DATA 0x20000002

#define	ERROR_MESSAGE_TYPE 0x20000003

#define	RDNS_TIMEOUT 600 /* seconds to wait for the semaphore */

#define	TUN_IOCTL_REGISTER_RINGS CTL_CODE(51820U, 0x970U, METHOD_BUFFERED, FILE_READ_DATA \| FILE_WRITE_DATA)

Typedefs
typedef struct _list_item	list_item_t

typedef list_item_t *	undo_lists_t[_undo_type_max]

typedef BOOL(*	match_fn_t) (LPVOID item, LPVOID ctx)

Enumerations
enum	undo_type_t { address, route, wfp_block, undo_dns4, undo_dns6, undo_domains, undo_ring_buffer, undo_wins, _undo_type_max }

enum	async_op_t { peek, read, write }

Functions
static DWORD	AddListItem (list_item_t **pfirst, LPVOID data)

static LPVOID	RemoveListItem (list_item_t **pfirst, match_fn_t match, LPVOID ctx)

static HANDLE	CloseHandleEx (LPHANDLE handle)

static void	OvpnUnmapViewOfFile (struct tun_ring **ring)

static void	UnmapRingBuffer (ring_buffer_maps_t *ring_buffer_maps)

static HANDLE	InitOverlapped (LPOVERLAPPED overlapped)

static BOOL	ResetOverlapped (LPOVERLAPPED overlapped)

static DWORD	AsyncPipeOp (async_op_t op, HANDLE pipe, LPVOID buffer, DWORD size, DWORD count, LPHANDLE events)

static DWORD	PeekNamedPipeAsync (HANDLE pipe, DWORD count, LPHANDLE events)

static DWORD	ReadPipeAsync (HANDLE pipe, LPVOID buffer, DWORD size, DWORD count, LPHANDLE events)

static DWORD	WritePipeAsync (HANDLE pipe, LPVOID data, DWORD size, DWORD count, LPHANDLE events)

static VOID	ReturnProcessId (HANDLE pipe, DWORD pid, DWORD count, LPHANDLE events)

static VOID	ReturnError (HANDLE pipe, DWORD error, LPCWSTR func, DWORD count, LPHANDLE events)

static VOID	ReturnLastError (HANDLE pipe, LPCWSTR func)

static BOOL	ValidateOptions (HANDLE pipe, const WCHAR workdir, const WCHAR options, WCHAR *errmsg, DWORD capacity)

static BOOL	GetStartupData (HANDLE pipe, STARTUP_DATA *sud)

static VOID	FreeStartupData (STARTUP_DATA *sud)

static SOCKADDR_INET	sockaddr_inet (short family, inet_address_t *addr)

static DWORD	InterfaceLuid (const char *iface_name, PNET_LUID luid)

static BOOL	CmpAddress (LPVOID item, LPVOID address)

static DWORD	DeleteAddress (PMIB_UNICASTIPADDRESS_ROW addr_row)

static DWORD	HandleAddressMessage (address_message_t msg, undo_lists_t lists)

static BOOL	CmpRoute (LPVOID item, LPVOID route)

static DWORD	DeleteRoute (PMIB_IPFORWARD_ROW2 fwd_row)

static DWORD	HandleRouteMessage (route_message_t msg, undo_lists_t lists)

static DWORD	HandleFlushNeighborsMessage (flush_neighbors_message_t *msg)

static void	BlockDNSErrHandler (DWORD err, const char *msg)

static BOOL	CmpAny (LPVOID item, LPVOID any)

static DWORD	DeleteWfpBlock (const wfp_block_message_t msg, undo_lists_t lists)

static DWORD	AddWfpBlock (const wfp_block_message_t msg, undo_lists_t lists)

static DWORD	HandleWfpBlockMessage (const wfp_block_message_t msg, undo_lists_t lists)

static DWORD	ExecCommand (const WCHAR argv0, const WCHAR cmdline, DWORD timeout)

static DWORD WINAPI	RegisterDNS (LPVOID unused)

static DWORD	HandleRegisterDNSMessage (void)

static DWORD	netsh_wins_cmd (const wchar_t action, const wchar_t if_name, const wchar_t *addr)
	Run the command: netsh interface ip $action wins $if_name [static] $addr. More...

static BOOL	CmpWString (LPVOID item, LPVOID str)

static BOOL	ApplyGpolSettings32 (void)
	Signal the DNS resolver (and others potentially) to reload the group policy (DNS) settings on 32 bit Windows systems. More...

static BOOL	ApplyGpolSettings64 (void)
	Signal the DNS resolver (and others potentially) to reload the group policy (DNS) settings on 64 bit Windows systems. More...

static BOOL	ApplyGpolSettings (void)
	Signal the DNS resolver (and others potentially) to reload the group policy (DNS) settings. More...

static BOOL	ApplyDnsSettings (BOOL apply_gpol)
	Signal the DNS resolver to reload its settings. More...

static DWORD	InterfaceIdString (PCSTR itf_name, PWSTR str, size_t len)
	Get the string interface UUID (with braces) for an interface alias name. More...

static BOOL	HasValidSearchList (HKEY key)
	Check for a valid search list in a certain key of the registry. More...

static BOOL	GetDnsSearchListKey (PCSTR itf_name, PBOOL gpol, PHKEY key)
	Find the registry key for storing the DNS domains for the VPN interface. More...

static BOOL	InitialSearchListExists (HKEY key)
	Check if a initial list had already been created. More...

static BOOL	StoreInitialDnsSearchList (HKEY key, PCWSTR list)
	Prepare DNS domain "SearchList" registry value, so additional VPN domains can be added and its original state can be restored in case the system cannot clean up regularly. More...

static BOOL	AddDnsSearchDomains (HKEY key, BOOL have_list, PCWSTR domains)
	Append domain suffixes to an existing search list. More...

static BOOL	ResetDnsSearchDomains (HKEY key)
	Reset the DNS search list to its original value. More...

static void	RemoveDnsSearchDomains (HKEY key, PCWSTR domains)
	Remove domain suffixes from an existing search list. More...

static void	UndoDnsSearchDomains (dns_domains_undo_data_t *undo_data)
	Removes DNS domains from a search list they were previously added to. More...

static DWORD	SetDnsSearchDomains (PCSTR itf_name, PCSTR domains, PBOOL gpol, undo_lists_t *lists)
	Add or remove DNS search domains. More...

static BOOL	GetInterfacesKey (short family, PHKEY key)
	Return the interfaces registry key for the specified address family. More...

static DWORD	SetNameServersValue (PCWSTR itf_id, short family, PCSTR value)
	Set the DNS name servers in a registry interface configuration. More...

static DWORD	SetNameServers (PCWSTR itf_id, short family, PCSTR addrs)
	Set the DNS name servers in a registry interface configuration. More...

static DWORD	ResetNameServers (PCWSTR itf_id, short family)
	Delete all DNS name servers from a registry interface configuration. More...

static DWORD	HandleDNSConfigMessage (const dns_cfg_message_t msg, undo_lists_t lists)

static DWORD	HandleWINSConfigMessage (const wins_cfg_message_t msg, undo_lists_t lists)

static DWORD	HandleEnableDHCPMessage (const enable_dhcp_message_t *dhcp)

static DWORD	OvpnDuplicateHandle (HANDLE ovpn_proc, HANDLE orig_handle, HANDLE *new_handle)

static DWORD	DuplicateAndMapRing (HANDLE ovpn_proc, HANDLE orig_handle, struct tun_ring **ring)

static DWORD	HandleRegisterRingBuffers (const register_ring_buffers_message_t rrb, HANDLE ovpn_proc, undo_lists_t lists)

static DWORD	HandleMTUMessage (const set_mtu_message_t *mtu)

static VOID	HandleMessage (HANDLE pipe, HANDLE ovpn_proc, DWORD bytes, DWORD count, LPHANDLE events, undo_lists_t *lists)

static VOID	Undo (undo_lists_t *lists)

static DWORD WINAPI	RunOpenvpn (LPVOID p)

static DWORD WINAPI	ServiceCtrlInteractive (DWORD ctrl_code, DWORD event, LPVOID data, LPVOID ctx)

static HANDLE	CreateClientPipeInstance (VOID)

static DWORD	UpdateWaitHandles (LPHANDLE handles_ptr, LPDWORD count, HANDLE io_event, HANDLE exit_event, list_item_t threads)

static VOID	FreeWaitHandles (LPHANDLE h)

static BOOL	CmpHandle (LPVOID item, LPVOID hnd)

VOID WINAPI	ServiceStartInteractiveOwn (DWORD dwArgc, LPWSTR *lpszArgv)

static void	CleanupRegistry (void)
	Clean up remains of previous sessions in registry. More...

VOID WINAPI	ServiceStartInteractive (DWORD dwArgc, LPWSTR *lpszArgv)

Variables
static SERVICE_STATUS_HANDLE	service

static SERVICE_STATUS	status = { .dwServiceType = SERVICE_WIN32_SHARE_PROCESS }

static HANDLE	exit_event = NULL

static settings_t	settings

static HANDLE	rdns_semaphore = NULL

openvpn_service_t	interactive_service

Macro Definition Documentation

◆ ERROR_MESSAGE_DATA

#define ERROR_MESSAGE_DATA 0x20000002

Definition at line 49 of file interactive.c.

◆ ERROR_MESSAGE_TYPE

#define ERROR_MESSAGE_TYPE 0x20000003

Definition at line 50 of file interactive.c.

◆ ERROR_OPENVPN_STARTUP

#define ERROR_OPENVPN_STARTUP 0x20000000

Definition at line 47 of file interactive.c.

◆ ERROR_STARTUP_DATA

#define ERROR_STARTUP_DATA 0x20000001

Definition at line 48 of file interactive.c.

◆ IO_TIMEOUT

#define IO_TIMEOUT 2000 /*ms*/

Definition at line 45 of file interactive.c.

◆ RDNS_TIMEOUT

#define RDNS_TIMEOUT 600 /* seconds to wait for the semaphore */

Definition at line 57 of file interactive.c.

◆ TUN_IOCTL_REGISTER_RINGS

#define TUN_IOCTL_REGISTER_RINGS CTL_CODE(51820U, 0x970U, METHOD_BUFFERED, FILE_READ_DATA | FILE_WRITE_DATA)

Definition at line 59 of file interactive.c.

Typedef Documentation

◆ list_item_t

typedef struct _list_item list_item_t

◆ match_fn_t

typedef BOOL(* match_fn_t) (LPVOID item, LPVOID ctx)

Definition at line 144 of file interactive.c.

◆ undo_lists_t

typedef list_item_t* undo_lists_t[_undo_type_max]

Definition at line 96 of file interactive.c.

Enumeration Type Documentation

◆ async_op_t

enum async_op_t

Enumerator
peek
read
write

Definition at line 221 of file interactive.c.

◆ undo_type_t

enum undo_type_t

Enumerator
address
route
wfp_block
undo_dns4
undo_dns6
undo_domains
undo_ring_buffer
undo_wins
_undo_type_max

Definition at line 85 of file interactive.c.

Function Documentation

◆ AddDnsSearchDomains()

static BOOL AddDnsSearchDomains	(	HKEY	key,
		BOOL	have_list,
		PCWSTR	domains
	)

static

Append domain suffixes to an existing search list.

Parameters

key	HKEY the list is stored at
have_list	BOOL to indicate if a search list already exists
domains	domain suffixes as comma separated string

Returns: BOOL to indicate success or failure

Definition at line 1474 of file interactive.c.

References M_SYSERR, MsgToEventLog(), pos(), and StoreInitialDnsSearchList().

Referenced by SetDnsSearchDomains().

◆ AddListItem()

static DWORD AddListItem	(	list_item_t **	pfirst,
		LPVOID	data
	)

static

Definition at line 129 of file interactive.c.

References _list_item::data, and _list_item::next.

Referenced by AddWfpBlock(), HandleAddressMessage(), HandleDNSConfigMessage(), HandleRegisterRingBuffers(), HandleRouteMessage(), HandleWINSConfigMessage(), ServiceStartInteractive(), and SetDnsSearchDomains().

◆ AddWfpBlock()

static DWORD AddWfpBlock	(	const wfp_block_message_t *	msg,
		undo_lists_t *	lists
	)

static

Definition at line 806 of file interactive.c.

References add_wfp_block_filters(), AddListItem(), BlockDNSErrHandler(), delete_wfp_block_filters(), DeleteWfpBlock(), wfp_block_data_t::engine, settings_t::exe_path, get_interface_metric(), wfp_block_data_t::index, wfp_block_data_t::metric_v4, wfp_block_data_t::metric_v6, msg, set_interface_metric(), settings, wfp_block, wfp_block_dns, and WFP_BLOCK_IFACE_METRIC.

Referenced by HandleWfpBlockMessage().

◆ ApplyDnsSettings()

static BOOL ApplyDnsSettings ( BOOL apply_gpol )

static

Signal the DNS resolver to reload its settings.

Parameters

apply_gpol BOOL reload setting from group policy hives as well

Returns: BOOL to indicate if the reload was initiated

Definition at line 1189 of file interactive.c.

References ApplyGpolSettings(), M_ERR, MsgToEventLog(), and status.

Referenced by CleanupRegistry(), HandleDNSConfigMessage(), and UndoDnsSearchDomains().

◆ ApplyGpolSettings()

static BOOL ApplyGpolSettings ( void )

static

Signal the DNS resolver (and others potentially) to reload the group policy (DNS) settings.

Returns: BOOL to indicate if the reload was initiated

Definition at line 1173 of file interactive.c.

References ApplyGpolSettings32(), and ApplyGpolSettings64().

Referenced by ApplyDnsSettings().

◆ ApplyGpolSettings32()

static BOOL ApplyGpolSettings32 ( void )

static

Signal the DNS resolver (and others potentially) to reload the group policy (DNS) settings on 32 bit Windows systems.

Returns: BOOL to indicate if the reload was initiated

Definition at line 1096 of file interactive.c.

Referenced by ApplyGpolSettings().

◆ ApplyGpolSettings64()

static BOOL ApplyGpolSettings64 ( void )

static

Signal the DNS resolver (and others potentially) to reload the group policy (DNS) settings on 64 bit Windows systems.

Returns: BOOL to indicate if the reload was initiated

Definition at line 1136 of file interactive.c.

Referenced by ApplyGpolSettings().

◆ AsyncPipeOp()

static DWORD AsyncPipeOp	(	async_op_t	op,
		HANDLE	pipe,
		LPVOID	buffer,
		DWORD	size,
		DWORD	count,
		LPHANDLE	events
	)

static

Definition at line 228 of file interactive.c.

References CloseHandleEx(), InitOverlapped(), IO_TIMEOUT, peek, and write.

Referenced by PeekNamedPipeAsync(), ReadPipeAsync(), and WritePipeAsync().

◆ BlockDNSErrHandler()

static void BlockDNSErrHandler	(	DWORD	err,
		const char *	msg
	)

static

Definition at line 747 of file interactive.c.

References M_ERR, msg, and MsgToEventLog().

Referenced by AddWfpBlock().

◆ CleanupRegistry()

static void CleanupRegistry ( void )

static

Clean up remains of previous sessions in registry.

These remains can happen with unclean shutdowns or crashes and would interfere with normal operation of the system with and without active tunnels.

Definition at line 2849 of file interactive.c.

References ApplyDnsSettings(), GetDnsSearchListKey(), and ResetDnsSearchDomains().

Referenced by ServiceStartInteractive().

◆ CloseHandleEx()

static HANDLE CloseHandleEx ( LPHANDLE handle )

static

Definition at line 171 of file interactive.c.

Referenced by AsyncPipeOp(), DuplicateAndMapRing(), HandleRegisterRingBuffers(), RunOpenvpn(), and ServiceStartInteractive().

◆ CmpAddress()

static BOOL CmpAddress	(	LPVOID	item,
		LPVOID	address
	)

static

Definition at line 574 of file interactive.c.

References address.

Referenced by HandleAddressMessage().

◆ CmpAny()

static BOOL CmpAny	(	LPVOID	item,
		LPVOID	any
	)

static

Definition at line 771 of file interactive.c.

Referenced by DeleteWfpBlock(), HandleDNSConfigMessage(), HandleRegisterRingBuffers(), and SetDnsSearchDomains().

◆ CmpHandle()

static BOOL CmpHandle	(	LPVOID	item,
		LPVOID	hnd
	)

static

Definition at line 2830 of file interactive.c.

Referenced by ServiceStartInteractive().

◆ CmpRoute()

static BOOL CmpRoute	(	LPVOID	item,
		LPVOID	route
	)

static

Definition at line 652 of file interactive.c.

References route.

Referenced by HandleRouteMessage().

◆ CmpWString()

static BOOL CmpWString	(	LPVOID	item,
		LPVOID	str
	)

static

Definition at line 1084 of file interactive.c.

Referenced by HandleWINSConfigMessage().

◆ CreateClientPipeInstance()

static HANDLE CreateClientPipeInstance ( VOID )

static

Definition at line 2723 of file interactive.c.

References _L, M_SYSERR, MsgToEventLog(), PACKAGE, and service_instance.

Referenced by ServiceStartInteractive().

◆ DeleteAddress()

static DWORD DeleteAddress ( PMIB_UNICASTIPADDRESS_ROW addr_row )

static

Definition at line 580 of file interactive.c.

Referenced by HandleAddressMessage(), and Undo().

◆ DeleteRoute()

static DWORD DeleteRoute ( PMIB_IPFORWARD_ROW2 fwd_row )

static

Definition at line 658 of file interactive.c.

Referenced by HandleRouteMessage(), and Undo().

◆ DeleteWfpBlock()

static DWORD DeleteWfpBlock	(	const wfp_block_message_t *	msg,
		undo_lists_t *	lists
	)

static

Definition at line 777 of file interactive.c.

References CmpAny(), delete_wfp_block_filters(), wfp_block_data_t::engine, M_ERR, wfp_block_data_t::metric_v4, wfp_block_data_t::metric_v6, msg, MsgToEventLog(), RemoveListItem(), set_interface_metric(), and wfp_block.

Referenced by AddWfpBlock(), and HandleWfpBlockMessage().

◆ DuplicateAndMapRing()

static DWORD DuplicateAndMapRing	(	HANDLE	ovpn_proc,
		HANDLE	orig_handle,
		struct tun_ring **	ring
	)

static

Definition at line 2084 of file interactive.c.

References CloseHandleEx(), M_SYSERR, MsgToEventLog(), and OvpnDuplicateHandle().

Referenced by HandleRegisterRingBuffers().

◆ ExecCommand()

static DWORD ExecCommand	(	const WCHAR *	argv0,
		const WCHAR *	cmdline,
		DWORD	timeout
	)

static

Definition at line 895 of file interactive.c.

References M_ERR, M_INFO, M_SYSERR, and MsgToEventLog().

Referenced by HandleEnableDHCPMessage(), netsh_wins_cmd(), and RegisterDNS().

◆ FreeStartupData()

static VOID FreeStartupData ( STARTUP_DATA * sud )

static

Definition at line 532 of file interactive.c.

References STARTUP_DATA::directory.

Referenced by RunOpenvpn().

◆ FreeWaitHandles()

static VOID FreeWaitHandles ( LPHANDLE h )

static

Definition at line 2824 of file interactive.c.

Referenced by ServiceStartInteractive().

◆ GetDnsSearchListKey()

static BOOL GetDnsSearchListKey	(	PCSTR	itf_name,
		PBOOL	gpol,
		PHKEY	key
	)

static

Find the registry key for storing the DNS domains for the VPN interface.

Parameters

itf_name	PCSTR that contains the alias name of the interface the domains are related to. If this is NULL the interface probing is skipped.
gpol	PBOOL to indicate if the key returned is the group policy hive
key	PHKEY in which the found registry key is returned in

Returns: BOOL to indicate if a search list is already present at the location. If the key returned is INVALID_HANDLE_VALUE, this indicates an unrecoverable error.

The correct location to add them is where a non-empty "SearchList" value exists, or in the interface configuration itself. However, the system-wide and then the group policy search lists overrule the previous one respectively, so we need to probe to find the effective list.

Definition at line 1341 of file interactive.c.

References HasValidSearchList(), and InterfaceIdString().

Referenced by CleanupRegistry(), SetDnsSearchDomains(), and UndoDnsSearchDomains().

◆ GetInterfacesKey()

static BOOL GetInterfacesKey	(	short	family,
		PHKEY	key
	)

static

Return the interfaces registry key for the specified address family.

Parameters

family	the internet address family to open the key for
key	PHKEY to return the key in

Returns: BOOL to indicate success or failure

Definition at line 1749 of file interactive.c.

References M_SYSERR, and MsgToEventLog().

Referenced by SetNameServersValue().

◆ GetStartupData()

static BOOL GetStartupData	(	HANDLE	pipe,
		STARTUP_DATA *	sud
	)

static

Definition at line 456 of file interactive.c.

References STARTUP_DATA::directory, ERROR_STARTUP_DATA, exit_event, M_ERR, M_SYSERR, MsgToEventLog(), STARTUP_DATA::options, PeekNamedPipeAsync(), read, ReadPipeAsync(), ReturnError(), ReturnLastError(), and STARTUP_DATA::std_input.

Referenced by RunOpenvpn().

◆ HandleAddressMessage()

static DWORD HandleAddressMessage	(	address_message_t *	msg,
		undo_lists_t *	lists
	)

static

Definition at line 586 of file interactive.c.

References AddListItem(), address, CmpAddress(), DeleteAddress(), InterfaceLuid(), msg, msg_add_address, RemoveListItem(), and sockaddr_inet().

Referenced by HandleMessage().

◆ HandleDNSConfigMessage()

static DWORD HandleDNSConfigMessage	(	const dns_cfg_message_t *	msg,
		undo_lists_t *	lists
	)

static

Definition at line 1844 of file interactive.c.

References AddListItem(), ApplyDnsSettings(), CmpAny(), dns_cfg_message_t::domains, ERROR_MESSAGE_DATA, dns_cfg_message_t::iface, InterfaceIdString(), msg, msg_del_dns_cfg, interface_t::name, RemoveListItem(), ResetNameServers(), SetDnsSearchDomains(), SetNameServers(), undo_dns4, and undo_dns6.

Referenced by HandleMessage().

◆ HandleEnableDHCPMessage()

static DWORD HandleEnableDHCPMessage ( const enable_dhcp_message_t * dhcp )

static

Definition at line 2031 of file interactive.c.

References ExecCommand(), and get_win_sys_path().

Referenced by HandleMessage().

◆ HandleFlushNeighborsMessage()

static DWORD HandleFlushNeighborsMessage ( flush_neighbors_message_t * msg )

static

Definition at line 736 of file interactive.c.

References msg.

Referenced by HandleMessage().

◆ HandleMessage()

static VOID HandleMessage	(	HANDLE	pipe,
		HANDLE	ovpn_proc,
		DWORD	bytes,
		DWORD	count,
		LPHANDLE	events,
		undo_lists_t *	lists
	)

static

Definition at line 2205 of file interactive.c.

References ERROR_MESSAGE_DATA, ERROR_MESSAGE_TYPE, ack_message_t::error_number, HandleAddressMessage(), HandleDNSConfigMessage(), HandleEnableDHCPMessage(), HandleFlushNeighborsMessage(), HandleMTUMessage(), HandleRegisterDNSMessage(), HandleRegisterRingBuffers(), HandleRouteMessage(), HandleWfpBlockMessage(), HandleWINSConfigMessage(), ack_message_t::header, message_header_t::message_id, msg, msg_acknowledgement, msg_add_address, msg_add_dns_cfg, msg_add_route, msg_add_wfp_block, msg_add_wins_cfg, msg_del_address, msg_del_dns_cfg, msg_del_route, msg_del_wfp_block, msg_del_wins_cfg, msg_enable_dhcp, MSG_FLAGS_ERROR, msg_flush_neighbors, msg_register_dns, msg_register_ring_buffers, msg_set_mtu, MsgToEventLog(), read, ReadPipeAsync(), message_header_t::type, and WritePipeAsync().

Referenced by RunOpenvpn().

◆ HandleMTUMessage()

static DWORD HandleMTUMessage ( const set_mtu_message_t * mtu )

static

Definition at line 2182 of file interactive.c.

References set_mtu_message_t::family, set_mtu_message_t::iface, interface_t::index, and set_mtu_message_t::mtu.

Referenced by HandleMessage().

◆ HandleRegisterDNSMessage()

static DWORD HandleRegisterDNSMessage ( void )

static

Definition at line 1001 of file interactive.c.

References RegisterDNS().

Referenced by HandleMessage().

◆ HandleRegisterRingBuffers()

static DWORD HandleRegisterRingBuffers	(	const register_ring_buffers_message_t *	rrb,
		HANDLE	ovpn_proc,
		undo_lists_t *	lists
	)

static

◆ HandleRouteMessage()

static DWORD HandleRouteMessage	(	route_message_t *	msg,
		undo_lists_t *	lists
	)

static

Definition at line 664 of file interactive.c.

References AddListItem(), CmpRoute(), DeleteRoute(), InterfaceLuid(), msg, msg_add_route, RemoveListItem(), route, and sockaddr_inet().

Referenced by HandleMessage().

◆ HandleWfpBlockMessage()

static DWORD HandleWfpBlockMessage	(	const wfp_block_message_t *	msg,
		undo_lists_t *	lists
	)

static

Definition at line 877 of file interactive.c.

References AddWfpBlock(), DeleteWfpBlock(), msg, and msg_add_wfp_block.

Referenced by HandleMessage().

◆ HandleWINSConfigMessage()

static DWORD HandleWINSConfigMessage	(	const wins_cfg_message_t *	msg,
		undo_lists_t *	lists
	)

static

Definition at line 1951 of file interactive.c.

References AddListItem(), CmpWString(), ERROR_MESSAGE_DATA, wins_cfg_message_t::iface, msg, msg_del_wins_cfg, interface_t::name, netsh_wins_cmd(), RemoveListItem(), undo_wins, and utf8to16().

Referenced by HandleMessage().

◆ HasValidSearchList()

static BOOL HasValidSearchList ( HKEY key )

static

Check for a valid search list in a certain key of the registry.

Valid means that a string value "SearchList" exists and that it contains one or more domains. We only check if the string contains a valid domain name character, but the main point is to prevent letting pass whitespace-only lists, so that check is good enough for that purpose.

Parameters

key	HKEY in which to check for a valid search list

Returns: BOOL to indicate if a valid search list has been found

Definition at line 1304 of file interactive.c.

Referenced by GetDnsSearchListKey().

◆ InitialSearchListExists()

static BOOL InitialSearchListExists ( HKEY key )

static

Check if a initial list had already been created.

Parameters

key	HKEY of the registry subkey to search in

Returns: BOOL to indicate if the initial list is already present under key

Definition at line 1409 of file interactive.c.

References M_ERR, and MsgToEventLog().

Referenced by StoreInitialDnsSearchList().

◆ InitOverlapped()

static HANDLE InitOverlapped ( LPOVERLAPPED overlapped )

static

Definition at line 199 of file interactive.c.

Referenced by AsyncPipeOp(), and ServiceStartInteractive().

◆ InterfaceIdString()

static DWORD InterfaceIdString	(	PCSTR	itf_name,
		PWSTR	str,
		size_t	len
	)

static

Get the string interface UUID (with braces) for an interface alias name.

Parameters

itf_name	the interface alias name
str	pointer to the buffer the wide UUID is returned in
len	size of the str buffer in characters

Returns: NO_ERROR on success, or the Windows error code for the failure

Definition at line 1248 of file interactive.c.

References InterfaceLuid(), M_ERR, and MsgToEventLog().

Referenced by GetDnsSearchListKey(), and HandleDNSConfigMessage().

◆ InterfaceLuid()

static DWORD InterfaceLuid	(	const char *	iface_name,
		PNET_LUID	luid
	)

static

Definition at line 556 of file interactive.c.

References status, and utf8to16().

Referenced by HandleAddressMessage(), HandleRouteMessage(), and InterfaceIdString().

◆ netsh_wins_cmd()

static DWORD netsh_wins_cmd	(	const wchar_t *	action,
		const wchar_t *	if_name,
		const wchar_t *	addr
	)

static

Run the command: netsh interface ip $action wins $if_name [static] $addr.

Parameters

action	"delete", "add" or "set"
if_name	"name_of_interface"
addr	IPv4 address as a string

If addr is null and action = "delete" all addresses are deleted. if action = "set" then "static" is added before $addr

Definition at line 1036 of file interactive.c.

References ExecCommand(), and get_win_sys_path().

Referenced by HandleWINSConfigMessage(), and Undo().

◆ OvpnDuplicateHandle()

static DWORD OvpnDuplicateHandle	(	HANDLE	ovpn_proc,
		HANDLE	orig_handle,
		HANDLE *	new_handle
	)

static

Definition at line 2069 of file interactive.c.

References M_SYSERR, and MsgToEventLog().

Referenced by DuplicateAndMapRing(), and HandleRegisterRingBuffers().

◆ OvpnUnmapViewOfFile()

static void OvpnUnmapViewOfFile ( struct tun_ring ** ring )

static

Definition at line 182 of file interactive.c.

Referenced by UnmapRingBuffer().

◆ PeekNamedPipeAsync()

static DWORD PeekNamedPipeAsync	(	HANDLE	pipe,
		DWORD	count,
		LPHANDLE	events
	)

static

Definition at line 292 of file interactive.c.

References AsyncPipeOp(), and peek.

Referenced by GetStartupData(), and RunOpenvpn().

◆ ReadPipeAsync()

static DWORD ReadPipeAsync	(	HANDLE	pipe,
		LPVOID	buffer,
		DWORD	size,
		DWORD	count,
		LPHANDLE	events
	)

static

Definition at line 298 of file interactive.c.

References AsyncPipeOp(), and read.

Referenced by GetStartupData(), and HandleMessage().

◆ RegisterDNS()

static DWORD WINAPI RegisterDNS ( LPVOID unused )

static

Definition at line 956 of file interactive.c.

References ExecCommand(), exit_event, get_win_sys_path(), M_ERR, M_SYSERR, MsgToEventLog(), rdns_semaphore, and RDNS_TIMEOUT.

Referenced by HandleRegisterDNSMessage().

◆ RemoveDnsSearchDomains()

static void RemoveDnsSearchDomains	(	HKEY	key,
		PCWSTR	domains
	)

static

Remove domain suffixes from an existing search list.

Parameters

key	HKEY the list is stored at
domains	domain suffixes to remove as comma separated string

Definition at line 1579 of file interactive.c.

References M_ERR, M_SYSERR, MsgToEventLog(), and ResetDnsSearchDomains().

Referenced by SetDnsSearchDomains(), and UndoDnsSearchDomains().

◆ RemoveListItem()

static LPVOID RemoveListItem	(	list_item_t **	pfirst,
		match_fn_t	match,
		LPVOID	ctx
	)

static

Definition at line 147 of file interactive.c.

References _list_item::data, and _list_item::next.

Referenced by DeleteWfpBlock(), HandleAddressMessage(), HandleDNSConfigMessage(), HandleRegisterRingBuffers(), HandleRouteMessage(), HandleWINSConfigMessage(), ServiceStartInteractive(), and SetDnsSearchDomains().

◆ ResetDnsSearchDomains()

static BOOL ResetDnsSearchDomains ( HKEY key )

static

Reset the DNS search list to its original value.

Looks for a "InitialSearchList" value as the one to reset to. If it doesn't exist, doesn't reset anything, as there was no SearchList in the first place.

Parameters

key	HKEY of the location in the registry to reset

Returns: BOOL to indicate if something was reset

Definition at line 1538 of file interactive.c.

References M_SYSERR, and MsgToEventLog().

Referenced by CleanupRegistry(), and RemoveDnsSearchDomains().

◆ ResetNameServers()

static DWORD ResetNameServers	(	PCWSTR	itf_id,
		short	family
	)

static

Delete all DNS name servers from a registry interface configuration.

Parameters

itf_id	the interface id to clear the servers for
family	internet address family to clear the servers for

Returns: DWORD NO_ERROR on success, a Windows error code otherwise

Definition at line 1838 of file interactive.c.

References SetNameServersValue().

Referenced by HandleDNSConfigMessage(), and Undo().

◆ ResetOverlapped()

static BOOL ResetOverlapped ( LPOVERLAPPED overlapped )

static

Definition at line 208 of file interactive.c.

Referenced by ServiceStartInteractive().

◆ ReturnError()

static VOID ReturnError	(	HANDLE	pipe,
		DWORD	error,
		LPCWSTR	func,
		DWORD	count,
		LPHANDLE	events
	)

static

Definition at line 325 of file interactive.c.

References ERROR_OPENVPN_STARTUP, MSG_FLAGS_ERROR, MsgToEventLog(), and WritePipeAsync().

Referenced by GetStartupData(), ReturnLastError(), RunOpenvpn(), and ServiceStartInteractive().

◆ ReturnLastError()

static VOID ReturnLastError	(	HANDLE	pipe,
		LPCWSTR	func
	)

static

Definition at line 364 of file interactive.c.

References exit_event, and ReturnError().

Referenced by GetStartupData(), and RunOpenvpn().

◆ ReturnProcessId()

static VOID ReturnProcessId	(	HANDLE	pipe,
		DWORD	pid,
		DWORD	count,
		LPHANDLE	events
	)

static

Definition at line 310 of file interactive.c.

References msg, and WritePipeAsync().

Referenced by RunOpenvpn().

◆ RunOpenvpn()

static DWORD WINAPI RunOpenvpn ( LPVOID p )

static

◆ ServiceCtrlInteractive()

static DWORD WINAPI ServiceCtrlInteractive	(	DWORD	ctrl_code,
		DWORD	event,
		LPVOID	data,
		LPVOID	ctx
	)

static

Definition at line 2699 of file interactive.c.

References exit_event, ReportStatusToSCMgr(), service, and status.

Referenced by ServiceStartInteractive().

◆ ServiceStartInteractive()

VOID WINAPI ServiceStartInteractive	(	DWORD	dwArgc,
		LPWSTR *	lpszArgv
	)

Definition at line 2873 of file interactive.c.

References AddListItem(), CleanupRegistry(), CloseHandleEx(), CmpHandle(), CreateClientPipeInstance(), exit_event, FreeWaitHandles(), GetOpenvpnSettings(), InitOverlapped(), interactive_service, M_SYSERR, MsgToEventLog(), openvpn_service_t::name, rdns_semaphore, RemoveListItem(), ReportStatusToSCMgr(), ResetOverlapped(), ReturnError(), RunOpenvpn(), service, ServiceCtrlInteractive(), settings, status, and UpdateWaitHandles().

Referenced by ServiceStartInteractiveOwn(), and wmain().

◆ ServiceStartInteractiveOwn()

VOID WINAPI ServiceStartInteractiveOwn	(	DWORD	dwArgc,
		LPWSTR *	lpszArgv
	)

Definition at line 2837 of file interactive.c.

References ServiceStartInteractive(), and status.

Referenced by wmain().

◆ SetDnsSearchDomains()

static DWORD SetDnsSearchDomains	(	PCSTR	itf_name,
		PCSTR	domains,
		PBOOL	gpol,
		undo_lists_t *	lists
	)

static

Add or remove DNS search domains.

Parameters

itf_name	alias name of the interface the domains are set for
domains	a comma separated list of domain name suffixes
gpol	PBOOL to indicate if group policy values were modified
lists	pointer to the undo lists

Returns: NO_ERROR on success, an error status code otherwise

If a SearchList is present in the registry already, the domains are added to that list. Otherwise the domains are added to the VPN interface specific list. A group policy search list takes precedence over a system-wide list, and that one itself takes precedence over interface specific ones.

This function will remove previously set domains if the domains parameter is NULL or empty.

The gpol value is only valid if the function returns no error. In the error case nothing is changed.

Definition at line 1682 of file interactive.c.

References AddDnsSearchDomains(), AddListItem(), CmpAny(), dns_domains_undo_data_t::domains, GetDnsSearchListKey(), dns_domains_undo_data_t::itf_name, M_SYSERR, MsgToEventLog(), RemoveDnsSearchDomains(), RemoveListItem(), undo_domains, and utf8to16().

Referenced by HandleDNSConfigMessage().

◆ SetNameServers()

static DWORD SetNameServers	(	PCWSTR	itf_id,
		short	family,
		PCSTR	addrs
	)

static

Set the DNS name servers in a registry interface configuration.

Parameters

itf_id	the interface id to set the servers for
family	internet address family to set the servers for
addrs	comma separated list of name server addresses

Returns: DWORD NO_ERROR on success, a Windows error code otherwise

Definition at line 1824 of file interactive.c.

References SetNameServersValue().

Referenced by HandleDNSConfigMessage().

◆ SetNameServersValue()

static DWORD SetNameServersValue	(	PCWSTR	itf_id,
		short	family,
		PCSTR	value
	)

static

Set the DNS name servers in a registry interface configuration.

Parameters

itf_id	the interface id to set the servers for
family	internet address family to set the servers for
value	the value to set the name servers to

Returns: DWORD NO_ERROR on success, a Windows error code otherwise

Definition at line 1776 of file interactive.c.

References GetInterfacesKey(), M_SYSERR, and MsgToEventLog().

Referenced by ResetNameServers(), and SetNameServers().

◆ sockaddr_inet()

static SOCKADDR_INET sockaddr_inet	(	short	family,
		inet_address_t *	addr
	)

static

Definition at line 539 of file interactive.c.

References inet_address_t::ipv4, and inet_address_t::ipv6.

Referenced by HandleAddressMessage(), and HandleRouteMessage().

◆ StoreInitialDnsSearchList()

static BOOL StoreInitialDnsSearchList	(	HKEY	key,
		PCWSTR	list
	)

static

Prepare DNS domain "SearchList" registry value, so additional VPN domains can be added and its original state can be restored in case the system cannot clean up regularly.

Parameters

key	registry subkey to store the list in
list	string of comma separated domains to use as the list

Returns: boolean to indicate whether the list was stored successfully

Definition at line 1438 of file interactive.c.

References InitialSearchListExists(), M_ERR, and MsgToEventLog().

Referenced by AddDnsSearchDomains().

◆ Undo()

static VOID Undo ( undo_lists_t * lists )

static

Definition at line 2306 of file interactive.c.

References _undo_type_max, address, _list_item::data, delete_wfp_block_filters(), DeleteAddress(), DeleteRoute(), wfp_block_data_t::engine, wfp_block_data_t::index, wfp_block_data_t::metric_v4, wfp_block_data_t::metric_v6, netsh_wins_cmd(), _list_item::next, ResetNameServers(), route, set_interface_metric(), undo_dns4, undo_dns6, undo_domains, undo_ring_buffer, undo_wins, UndoDnsSearchDomains(), UnmapRingBuffer(), and wfp_block.

Referenced by RunOpenvpn().

◆ UndoDnsSearchDomains()

static void UndoDnsSearchDomains ( dns_domains_undo_data_t * undo_data )

static

Removes DNS domains from a search list they were previously added to.

Parameters

undo_data pointer to dns_domains_undo_data_t

Definition at line 1644 of file interactive.c.

References ApplyDnsSettings(), dns_domains_undo_data_t::domains, GetDnsSearchListKey(), dns_domains_undo_data_t::itf_name, and RemoveDnsSearchDomains().

Referenced by Undo().

◆ UnmapRingBuffer()

static void UnmapRingBuffer ( ring_buffer_maps_t * ring_buffer_maps )

static

Definition at line 192 of file interactive.c.

References OvpnUnmapViewOfFile(), ring_buffer_maps_t::receive_ring, and ring_buffer_maps_t::send_ring.

Referenced by HandleRegisterRingBuffers(), and Undo().

◆ UpdateWaitHandles()

static DWORD UpdateWaitHandles	(	LPHANDLE *	handles_ptr,
		LPDWORD	count,
		HANDLE	io_event,
		HANDLE	exit_event,
		list_item_t *	threads
	)

static

Definition at line 2774 of file interactive.c.

References _list_item::data, exit_event, _list_item::next, and pos().

Referenced by ServiceStartInteractive().

◆ ValidateOptions()

static BOOL ValidateOptions	(	HANDLE	pipe,
		const WCHAR *	workdir,
		const WCHAR *	options,
		WCHAR *	errmsg,
		DWORD	capacity
	)

static

Definition at line 375 of file interactive.c.

References CheckOption(), IsOption(), settings_t::ovpn_admin_group, and settings.

Referenced by RunOpenvpn().

◆ WritePipeAsync()

static DWORD WritePipeAsync	(	HANDLE	pipe,
		LPVOID	data,
		DWORD	size,
		DWORD	count,
		LPHANDLE	events
	)

static

Definition at line 304 of file interactive.c.

References AsyncPipeOp(), and write.

Referenced by HandleMessage(), ReturnError(), and ReturnProcessId().

Variable Documentation

◆ exit_event

HANDLE exit_event = NULL

static

Definition at line 54 of file interactive.c.

Referenced by GetStartupData(), RegisterDNS(), ReturnLastError(), RunOpenvpn(), ServiceCtrlInteractive(), ServiceStartInteractive(), and UpdateWaitHandles().

◆ interactive_service

openvpn_service_t interactive_service

Initial value:

= {
    interactive,
    _L(PACKAGE_NAME) L"ServiceInteractive",
    _L(PACKAGE_NAME) L" Interactive Service",
    SERVICE_DEPENDENCIES,
    SERVICE_AUTO_START
}

Definition at line 61 of file interactive.c.

Referenced by ServiceStartInteractive(), and wmain().

◆ rdns_semaphore

HANDLE rdns_semaphore = NULL

static

Definition at line 56 of file interactive.c.

Referenced by RegisterDNS(), and ServiceStartInteractive().

◆ service

SERVICE_STATUS_HANDLE service

static

Definition at line 52 of file interactive.c.

Referenced by CmdInstallServices(), CmdRemoveServices(), CmdStartService(), do_deferred_pam_auth(), pam_auth(), pam_server(), port_from_servname(), ReportStatusToSCMgr(), ServiceCtrlInteractive(), and ServiceStartInteractive().

◆ settings

settings_t settings

static

Definition at line 55 of file interactive.c.

Referenced by AddWfpBlock(), RunOpenvpn(), ServiceStartInteractive(), and ValidateOptions().

◆ status

SERVICE_STATUS status = { .dwServiceType = SERVICE_WIN32_SHARE_PROCESS }

static

Definition at line 53 of file interactive.c.

Referenced by add_route(), add_route_ipapi(), add_route_ipv6(), ApplyDnsSettings(), bio_write_post(), check_for_client_reason(), check_status(), close_tun(), CmdRemoveServices(), dco_get_supported_ciphers(), del_route_ipapi(), delete_route(), delete_temp_addresses(), dhcp_release_by_adapter_index(), dhcp_renew_by_adapter_index(), do_open_tun(), do_preresolve(), do_preresolve_host(), do_route_ipv6_service(), establish_http_proxy_passthru(), exec_command(), fork_to_self(), get_adapter_info_list(), get_best_route(), get_console_input_win32(), get_default_gateway(), get_default_gateway_ipv6(), get_device_instance_id_interface(), get_interface_info_list(), get_openvpn_reg_value(), get_pa_var(), get_panel_reg(), get_per_adapter_info(), get_special_addr(), get_tap_reg(), get_windows_routing_table(), getaddr(), GetOpenvpnSettings(), GetRegString(), helper_client_server(), in_extra_dispatch(), in_src_get(), incoming_push_message(), init_route(), InterfaceLuid(), io_wait_dowork(), link_socket_write_win32(), man_block(), man_client_deny(), man_client_kill(), man_connect(), man_kill(), man_proxy(), man_remote(), man_send_cc_message(), man_settings_init(), man_standalone_event_loop(), management_callback_remote_entry_get(), management_callback_send_cc_message(), management_io(), multi_get_create_instance_udp(), multi_io_wait(), multi_process_io_udp(), net_event_win32_reset_write(), openvpn_connect(), openvpn_exit(), openvpn_getaddrinfo(), openvpn_gettimeofday(), openvpn_plugin_func_v1(), openvpn_plugin_open_v3(), openvpn_popen(), openvpn_waitpid_check(), pam_auth(), plugin_call_item(), plugin_call_ssl(), print_sockaddr_ex(), process_io(), read_incoming_link(), read_incoming_tls_ciphertext(), read_incoming_tls_plaintext(), recv_line(), recv_socks_reply(), report_command_status(), ReportStatusToSCMgr(), resolve_bind_local(), resolve_remote(), semaphore_lock(), send_push_options(), send_push_reply(), ServiceCtrlInteractive(), ServiceStartInteractive(), ServiceStartInteractiveOwn(), set_win_sys_path_via_env(), socket_connect(), socket_connection_reset(), socket_listen_accept(), socket_recv_queue(), socket_send_queue(), sockethandle_finalize(), socks_handshake(), socks_username_password_auth(), strerror_win32(), tap_allow_nonadmin_access_handle(), test_adapter_ip_netmask(), tls_pre_decrypt_lite(), tls_process_state(), tun_read_queue(), tun_write_queue(), tun_write_win32(), tunnel_server_loop(), tuntap_abort(), tuntap_is_dco_win_timeout(), tuntap_set_connected(), tuntap_set_ip_addr(), tuntap_set_ptp(), tuntap_stop(), we_wait(), win32_sleep(), win_get_exe_path(), win_wfp_block(), write_outgoing_tls_ciphertext(), and x_check_status().

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ ERROR_MESSAGE_DATA

◆ ERROR_MESSAGE_TYPE

◆ ERROR_OPENVPN_STARTUP

◆ ERROR_STARTUP_DATA

◆ IO_TIMEOUT

◆ RDNS_TIMEOUT

◆ TUN_IOCTL_REGISTER_RINGS

Typedef Documentation

◆ list_item_t

◆ match_fn_t

◆ undo_lists_t

Enumeration Type Documentation

◆ async_op_t

◆ undo_type_t

Function Documentation

◆ AddDnsSearchDomains()

◆ AddListItem()

◆ AddWfpBlock()

◆ ApplyDnsSettings()

◆ ApplyGpolSettings()

◆ ApplyGpolSettings32()

◆ ApplyGpolSettings64()

◆ AsyncPipeOp()

◆ BlockDNSErrHandler()

◆ CleanupRegistry()

◆ CloseHandleEx()

◆ CmpAddress()

◆ CmpAny()

◆ CmpHandle()

◆ CmpRoute()

◆ CmpWString()

◆ CreateClientPipeInstance()

◆ DeleteAddress()

◆ DeleteRoute()

◆ DeleteWfpBlock()

◆ DuplicateAndMapRing()

◆ ExecCommand()

◆ FreeStartupData()

◆ FreeWaitHandles()

◆ GetDnsSearchListKey()

◆ GetInterfacesKey()

◆ GetStartupData()

◆ HandleAddressMessage()

◆ HandleDNSConfigMessage()

◆ HandleEnableDHCPMessage()

◆ HandleFlushNeighborsMessage()

◆ HandleMessage()

◆ HandleMTUMessage()

◆ HandleRegisterDNSMessage()

◆ HandleRegisterRingBuffers()

◆ HandleRouteMessage()

◆ HandleWfpBlockMessage()

◆ HandleWINSConfigMessage()

◆ HasValidSearchList()

◆ InitialSearchListExists()

◆ InitOverlapped()

◆ InterfaceIdString()

◆ InterfaceLuid()

◆ netsh_wins_cmd()

◆ OvpnDuplicateHandle()

◆ OvpnUnmapViewOfFile()

◆ PeekNamedPipeAsync()

◆ ReadPipeAsync()

◆ RegisterDNS()

◆ RemoveDnsSearchDomains()

◆ RemoveListItem()

◆ ResetDnsSearchDomains()

◆ ResetNameServers()

◆ ResetOverlapped()

◆ ReturnError()

◆ ReturnLastError()

◆ ReturnProcessId()

◆ RunOpenvpn()