OpenVPN
options.c
Go to the documentation of this file.
1/*
2 * OpenVPN -- An application to securely tunnel IP networks
3 * over a single UDP port, with support for SSL/TLS-based
4 * session authentication and key exchange,
5 * packet encryption, packet authentication, and
6 * packet compression.
7 *
8 * Copyright (C) 2002-2025 OpenVPN Inc <sales@openvpn.net>
9 * Copyright (C) 2008-2025 David Sommerseth <dazo@eurephia.org>
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2
13 * as published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, see <https://www.gnu.org/licenses/>.
22 */
23
24/*
25 * 2004-01-28: Added Socks5 proxy support
26 * (Christof Meerwald, https://cmeerw.org)
27 */
28
29#ifdef HAVE_CONFIG_H
30#include "config.h"
31#endif
32#ifdef HAVE_CONFIG_VERSION_H
33#include "config-version.h"
34#endif
35
36#include "syshead.h"
37
38#include "buffer.h"
39#include "error.h"
40#include "common.h"
41#include "run_command.h"
42#include "shaper.h"
43#include "crypto.h"
44#include "ssl.h"
45#include "ssl_ncp.h"
46#include "options.h"
47#include "misc.h"
48#include "socket_util.h"
49#include "packet_id.h"
50#include "pkcs11.h"
51#include "win32.h"
52#include "push.h"
53#include "pool.h"
54#include "proto.h"
55#include "helper.h"
56#include "manage.h"
57#include "forward.h"
58#include "ssl_verify.h"
59#include "platform.h"
60#include "xkey_common.h"
61#include "dco.h"
62#include "options_util.h"
63#include "tun_afunix.h"
64#include "domain_helper.h"
65#include "mbuf.h"
66
67#include <ctype.h>
68
69#include "memdbg.h"
70#include "options_util.h"
71
72const char title_string[] = PACKAGE_STRING
73#ifdef CONFIGURE_GIT_REVISION
74 " [git:" CONFIGURE_GIT_REVISION CONFIGURE_GIT_FLAGS "]"
75#endif
76 " " TARGET_ALIAS
77#if defined(ENABLE_CRYPTO_MBEDTLS)
78 " [SSL (mbed TLS)]"
79#elif defined(ENABLE_CRYPTO_OPENSSL)
80 " [SSL (OpenSSL)]"
81#else
82 " [SSL]"
83#endif /* defined(ENABLE_CRYPTO_MBEDTLS) */
84#ifdef USE_COMP
85#ifdef ENABLE_LZO
86 " [LZO]"
87#endif
88#ifdef ENABLE_LZ4
89 " [LZ4]"
90#endif
91#ifdef ENABLE_COMP_STUB
92 " [COMP_STUB]"
93#endif
94#endif /* USE_COMP */
95#if EPOLL
96 " [EPOLL]"
97#endif
98#ifdef PRODUCT_TAP_DEBUG
99 " [TAPDBG]"
100#endif
101#ifdef ENABLE_PKCS11
102 " [PKCS11]"
103#endif
104#if ENABLE_IP_PKTINFO
105#if defined(HAVE_IN_PKTINFO) && defined(HAVE_IPI_SPEC_DST)
106 " [MH/PKTINFO]"
107#elif defined(IP_RECVDSTADDR)
108 " [MH/RECVDA]"
109#endif
110#endif
111 " [AEAD]"
112#ifdef ENABLE_DCO
113 " [DCO]"
114#endif
115#ifdef CONFIGURE_GIT_REVISION
116 " built on " __DATE__
117#endif
118 ;
119
120#ifndef ENABLE_SMALL
121
122static const char usage_message[] =
123 "%s\n"
124 "\n"
125 "General Options:\n"
126 "--config file : Read configuration options from file.\n"
127 "--help : Show options.\n"
128 "--version : Show copyright and version information.\n"
129 "\n"
130 "Tunnel Options:\n"
131 "--local host|* [port]: Local host name or IP address and port for bind.\n"
132 " If specified, OpenVPN will bindto this address. If unspecified,\n"
133 " OpenVPN will bind to all interfaces. '*' can be used as hostname\n"
134 " and means 'any host' (OpenVPN will listen on what is returned by the OS).\n"
135 " On a client, or in point-to-point mode, this can only be specified once (1 socket).\n"
136 " On an OpenVPN setup running as ``--server``, this can be specified multiple times\n"
137 " to open multiple listening sockets on different addresses and/or different ports.\n"
138 " In order to specify multiple listen ports without specifying an address, use '*'\n"
139 " to signal 'use what the operating system gives you as default', for\n"
140 " 'all IPv4 addresses' use '0.0.0.0', for 'all IPv6 addresses' use '::'.\n"
141 " ``--local`` implies ``--bind``.\n"
142 "--remote host [port] : Remote host name or ip address.\n"
143 "--remote-random : If multiple --remote options specified, choose one randomly.\n"
144 "--remote-random-hostname : Add a random string to remote DNS name.\n"
145 "--mode m : Major mode, m = 'p2p' (default, point-to-point) or 'server'.\n"
146 "--proto p : Use protocol p for communicating with peer.\n"
147 " p = udp (default), tcp-server, tcp-client\n"
148 " udp4, tcp4-server, tcp4-client\n"
149 " udp6, tcp6-server, tcp6-client\n"
150 "--proto-force p : only consider protocol p in list of connection profiles.\n"
151 " p = udp or tcp\n"
152 "--connect-retry n [m] : For client, number of seconds to wait between\n"
153 " connection retries (default=%d). On repeated retries\n"
154 " the wait time is exponentially increased to a maximum of m\n"
155 " (default=%d).\n"
156 "--connect-retry-max n : Maximum connection attempt retries, default infinite.\n"
157 "--http-proxy s p [up] [auth] : Connect to remote host\n"
158 " through an HTTP proxy at address s and port p.\n"
159 " If proxy authentication is required,\n"
160 " up is a file containing username/password on 2 lines, or\n"
161 " 'stdin' to prompt from console. Add auth='ntlm2' if\n"
162 " the proxy requires NTLM authentication.\n"
163 "--http-proxy s p 'auto[-nct]' : Like the above directive, but automatically\n"
164 " determine auth method and query for username/password\n"
165 " if needed. auto-nct disables weak proxy auth methods.\n"
166 "--http-proxy-option type [parm] : Set extended HTTP proxy options.\n"
167 " Repeat to set multiple options.\n"
168 " VERSION version (default=1.0)\n"
169 " AGENT user-agent\n"
170 "--socks-proxy s [p] [up] : Connect to remote host through a Socks5 proxy at\n"
171 " address s and port p (default port = 1080).\n"
172 " If proxy authentication is required,\n"
173 " up is a file containing username/password on 2 lines, or\n"
174 " 'stdin' to prompt for console.\n"
175 "--socks-proxy-retry : Retry indefinitely on Socks proxy errors.\n"
176 "--resolv-retry n: If hostname resolve fails for --remote, retry\n"
177 " resolve for n seconds before failing (disabled by default).\n"
178 " Set n=\"infinite\" to retry indefinitely.\n"
179 "--float : Allow remote to change its IP address/port, such as through\n"
180 " DHCP (this is the default if --remote is not used).\n"
181 "--ipchange cmd : Run command cmd on remote ip address initial\n"
182 " setting or change -- execute as: cmd ip-address port#\n"
183 "--port port : TCP/UDP port # for both local and remote.\n"
184 "--lport port : TCP/UDP port # for local (default=%s). Implies --bind.\n"
185 "--rport port : TCP/UDP port # for remote (default=%s).\n"
186 "--bind : Bind to local address and port. (This is the default unless\n"
187 " --proto tcp-client"
188 " or --http-proxy"
189 " or --socks-proxy"
190 " is used).\n"
191 "--nobind : Do not bind to local address and port.\n"
192 "--dev tunX|tapX : tun/tap device (X can be omitted for dynamic device.\n"
193 "--dev-type dt : Which device type are we using? (dt = tun or tap) Use\n"
194 " this option only if the tun/tap device used with --dev\n"
195 " does not begin with \"tun\" or \"tap\".\n"
196 "--dev-node node : Explicitly set the device node rather than using\n"
197 " /dev/net/tun, /dev/tun, /dev/tap, etc.\n"
198#if defined(ENABLE_DCO)
199 "--disable-dco : Do not attempt using Data Channel Offload.\n"
200#endif
201 "--lladdr hw : Set the link layer address of the tap device.\n"
202 "--topology t : Set --dev tun topology: 'net30', 'p2p', or 'subnet'.\n"
203#ifdef ENABLE_IPROUTE
204 "--iproute cmd : Use this command instead of default " IPROUTE_PATH ".\n"
205#endif
206 "--ifconfig l rn : TUN: configure device to use IP address l as a local\n"
207 " endpoint and rn as a remote endpoint. l & rn should be\n"
208 " swapped on the other peer. l & rn must be private\n"
209 " addresses outside of the subnets used by either peer.\n"
210 " TAP: configure device to use IP address l as a local\n"
211 " endpoint and rn as a subnet mask.\n"
212 "--ifconfig-ipv6 l r : configure device to use IPv6 address l as local\n"
213 " endpoint (as a /64) and r as remote endpoint\n"
214 "--ifconfig-noexec : Don't actually execute ifconfig/netsh command, instead\n"
215 " pass --ifconfig parms by environment to scripts.\n"
216 "--ifconfig-nowarn : Don't warn if the --ifconfig option on this side of the\n"
217 " connection doesn't match the remote side.\n"
218#ifdef TARGET_LINUX
219 "--route-table table_id : Specify a custom routing table for use with --route(-ipv6).\n"
220 " If not specified, the id of the default routing table will be used.\n"
221#endif
222 "--route network [netmask] [gateway] [metric] :\n"
223 " Add route to routing table after connection\n"
224 " is established. Multiple routes can be specified.\n"
225 " netmask default: 255.255.255.255\n"
226 " gateway default: taken from --route-gateway or --ifconfig\n"
227 " Specify default by leaving blank or setting to \"default\".\n"
228 "--route-ipv6 network/bits [gateway] [metric] :\n"
229 " Add IPv6 route to routing table after connection\n"
230 " is established. Multiple routes can be specified.\n"
231 " gateway default: taken from --route-ipv6-gateway or 'remote'\n"
232 " in --ifconfig-ipv6\n"
233 "--route-gateway gw|'dhcp' : Specify a default gateway for use with --route.\n"
234 "--route-ipv6-gateway gw : Specify a default gateway for use with --route-ipv6.\n"
235 "--route-metric m : Specify a default metric for use with --route.\n"
236 "--route-delay n [w] : Delay n seconds after connection initiation before\n"
237 " adding routes (may be 0). If not specified, routes will\n"
238 " be added immediately after tun/tap open. On Windows, wait\n"
239 " up to w seconds for TUN/TAP adapter to come up.\n"
240 "--route-up cmd : Run command cmd after routes are added.\n"
241 "--route-pre-down cmd : Run command cmd before routes are removed.\n"
242 "--route-noexec : Don't add routes automatically. Instead pass routes to\n"
243 " --route-up script using environmental variables.\n"
244 "--route-nopull : When used with --client or --pull, accept options pushed\n"
245 " by server EXCEPT for routes, dns, and dhcp options.\n"
246 "--allow-pull-fqdn : Allow client to pull DNS names from server for\n"
247 " --ifconfig, --route, and --route-gateway.\n"
248 "--redirect-gateway [flags]: Automatically execute routing\n"
249 " commands to redirect all outgoing IP traffic through the\n"
250 " VPN. Add 'local' flag if both " PACKAGE_NAME " servers are directly\n"
251 " connected via a common subnet, such as with WiFi.\n"
252 " Add 'def1' flag to set default route using using 0.0.0.0/1\n"
253 " and 128.0.0.0/1 rather than 0.0.0.0/0. Add 'bypass-dhcp'\n"
254 " flag to add a direct route to DHCP server, bypassing tunnel.\n"
255 " Add 'bypass-dns' flag to similarly bypass tunnel for DNS.\n"
256 "--redirect-private [flags]: Like --redirect-gateway, but omit actually changing\n"
257 " the default gateway. Useful when pushing private subnets.\n"
258 "--block-ipv6 : (Client) Instead sending IPv6 to the server generate\n"
259 " ICMPv6 host unreachable messages on the client.\n"
260 " (Server) Instead of forwarding IPv6 packets send\n"
261 " ICMPv6 host unreachable packets to the client.\n"
262 "--client-nat snat|dnat network netmask alias : on client add 1-to-1 NAT rule.\n"
263 "--push-peer-info : (client only) push client info to server.\n"
264 "--setenv name value : Set a custom environmental variable to pass to script.\n"
265 "--setenv FORWARD_COMPATIBLE 1 : Relax config file syntax checking to allow\n"
266 " directives for future OpenVPN versions to be ignored.\n"
267 "--ignore-unknown-option opt1 opt2 ...: Relax config file syntax. Allow\n"
268 " these options to be ignored when unknown\n"
269 "--script-security level: Where level can be:\n"
270 " 0 -- strictly no calling of external programs\n"
271 " 1 -- (default) only call built-ins such as ifconfig\n"
272 " 2 -- allow calling of built-ins and scripts\n"
273 " 3 -- allow password to be passed to scripts via env\n"
274 "--shaper n : Restrict output to peer to n bytes per second.\n"
275 "--keepalive n m : Helper option for setting timeouts in server mode. Send\n"
276 " ping once every n seconds, restart if ping not received\n"
277 " for m seconds.\n"
278 "--inactive n [bytes] : Exit after n seconds of activity on tun/tap device\n"
279 " produces a combined in/out byte count < bytes.\n"
280 "--session-timeout n: Limit connection time to n seconds.\n"
281 "--ping-exit n : Exit if n seconds pass without reception of remote ping.\n"
282 "--ping-restart n: Restart if n seconds pass without reception of remote ping.\n"
283 "--ping-timer-rem: Run the --ping-exit/--ping-restart timer only if we have a\n"
284 " remote address.\n"
285 "--ping n : Ping remote once every n seconds over TCP/UDP port.\n"
286#if ENABLE_IP_PKTINFO
287 "--multihome : Configure a multi-homed UDP server.\n"
288#endif
289 "--remap-usr1 s : On SIGUSR1 signals, remap signal (s='SIGHUP' or 'SIGTERM').\n"
290 "--persist-tun : Keep tun/tap device open across SIGUSR1 or --ping-restart.\n"
291 "--persist-remote-ip : Keep remote IP address across SIGUSR1 or --ping-restart.\n"
292 "--persist-local-ip : Keep local IP address across SIGUSR1 or --ping-restart.\n"
293#if PASSTOS_CAPABILITY
294 "--passtos : TOS passthrough (applies to IPv4 only).\n"
295#endif
296 "--tun-mtu n : Take the tun/tap device MTU to be n and derive the\n"
297 " TCP/UDP MTU from it (default=%d).\n"
298 "--tun-mtu-extra n : Assume that tun/tap device might return as many\n"
299 " as n bytes more than the tun-mtu size on read\n"
300 " (default TUN=0 TAP=%d).\n"
301 "--tun-mtu-max n : Maximum pushable MTU (default and minimum=%d).\n"
302 "--link-mtu n : Take the TCP/UDP device MTU to be n and derive the tun MTU\n"
303 " from it.\n"
304 "--mtu-disc type : Should we do Path MTU discovery on TCP/UDP channel?\n"
305 " 'no' -- Never send DF (Don't Fragment) frames\n"
306 " 'maybe' -- Use per-route hints\n"
307 " 'yes' -- Always DF (Don't Fragment)\n"
308 "--mtu-test : Empirically measure and report MTU.\n"
309#ifdef ENABLE_FRAGMENT
310 "--fragment max : Enable internal datagram fragmentation so that no UDP\n"
311 " datagrams are sent which are larger than max bytes.\n"
312 " Adds 4 bytes of overhead per datagram.\n"
313#endif
314 "--mssfix [n] : Set upper bound on TCP MSS, default = tun-mtu size\n"
315 " or --fragment max value, whichever is lower.\n"
316 "--sndbuf size : Set the TCP/UDP send buffer size.\n"
317 "--rcvbuf size : Set the TCP/UDP receive buffer size.\n"
318#if defined(TARGET_LINUX)
319 "--mark value : Mark encrypted packets being sent with value. The mark value\n"
320 " can be matched in policy routing and packetfilter rules.\n"
321 "--bind-dev dev : Bind to the given device when making connection to a peer or\n"
322 " listening for connections. This allows sending encrypted packets\n"
323 " via a VRF present on the system.\n"
324#endif
325 "--txqueuelen n : Set the tun/tap TX queue length to n (Linux only).\n"
326 "--mlock : Disable Paging -- ensures key material and tunnel\n"
327 " data will never be written to disk.\n"
328 "--up cmd : Run command cmd after successful tun device open.\n"
329 " Execute as: cmd tun/tap-dev tun-mtu link-mtu \\\n"
330 " ifconfig-local-ip ifconfig-remote-ip\n"
331 " (pre --user or --group UID/GID change)\n"
332 "--up-delay : Delay tun/tap open and possible --up script execution\n"
333 " until after TCP/UDP connection establishment with peer.\n"
334 "--down cmd : Run command cmd after tun device close.\n"
335 " (post --user/--group UID/GID change and/or --chroot)\n"
336 " (command parameters are same as --up option)\n"
337 "--down-pre : Run --down command before TUN/TAP close.\n"
338 "--up-restart : Run up/down commands for all restarts including those\n"
339 " caused by --ping-restart or SIGUSR1\n"
340 "--user user : Set UID to user after initialization.\n"
341 "--group group : Set GID to group after initialization.\n"
342 "--chroot dir : Chroot to this directory after initialization.\n"
343#ifdef ENABLE_SELINUX
344 "--setcon context: Apply this SELinux context after initialization.\n"
345#endif
346 "--cd dir : Change to this directory before initialization.\n"
347 "--daemon [name] : Become a daemon after initialization.\n"
348 " The optional 'name' parameter will be passed\n"
349 " as the program name to the system logger.\n"
350 "--syslog [name] : Output to syslog, but do not become a daemon.\n"
351 " See --daemon above for a description of the 'name' parm.\n"
352 "--log file : Output log to file which is created/truncated on open.\n"
353 "--log-append file : Append log to file, or create file if nonexistent.\n"
354 "--suppress-timestamps : Don't log timestamps to stdout/stderr.\n"
355 "--machine-readable-output : Always log timestamp, message flags to stdout/stderr.\n"
356 "--writepid file : Write main process ID to file.\n"
357 "--nice n : Change process priority (>0 = lower, <0 = higher).\n"
358 "--echo [parms ...] : Echo parameters to log output.\n"
359 "--verb n : Set output verbosity to n (default=%d):\n"
360 " (Level 3 is recommended if you want a good summary\n"
361 " of what's happening without being swamped by output).\n"
362 " : 0 -- no output except fatal errors\n"
363 " : 1 -- startup info + connection initiated messages +\n"
364 " non-fatal encryption & net errors\n"
365 " : 2,3 -- show TLS negotiations & route info\n"
366 " : 4 -- show parameters\n"
367 " : 5 -- show 'RrWw' chars on console for each packet sent\n"
368 " and received from TCP/UDP (caps) or tun/tap (lc)\n"
369 " : 6 to 11 -- debug messages of increasing verbosity\n"
370 "--mute n : Log at most n consecutive messages in the same category.\n"
371 "--status file [n] : Write operational status to file every n seconds.\n"
372 "--status-version [n] : Choose the status file format version number.\n"
373 " Currently, n can be 1, 2, or 3 (default=1).\n"
374 "--disable-occ : (DEPRECATED) Disable options consistency check between peers.\n"
375#ifdef ENABLE_DEBUG
376 "--gremlin mask : Special stress testing mode (for debugging only).\n"
377#endif
378#if defined(USE_COMP)
379 "--compress alg : Use compression algorithm alg\n"
380 "--allow-compression: Specify whether compression should be allowed\n"
381#if defined(ENABLE_LZO)
382 "--comp-lzo : Use LZO compression -- may add up to 1 byte per\n"
383 " packet for incompressible data.\n"
384 "--comp-noadapt : Don't use adaptive compression when --comp-lzo\n"
385 " is specified.\n"
386#endif
387#endif
388#ifdef ENABLE_MANAGEMENT
389 "--management ip port [pass] : Enable a TCP server on ip:port to handle\n"
390 " management functions. pass is a password file\n"
391 " or 'stdin' to prompt from console.\n"
392#if UNIX_SOCK_SUPPORT
393 " To listen on a unix domain socket, specific the pathname\n"
394 " in place of ip and use 'unix' as the port number.\n"
395#endif
396 "--management-client : Management interface will connect as a TCP client to\n"
397 " ip/port rather than listen as a TCP server.\n"
398 "--management-query-passwords : Query management channel for private key\n"
399 " and auth-user-pass passwords.\n"
400 "--management-query-proxy : Query management channel for proxy information.\n"
401 "--management-query-remote : Query management channel for --remote directive.\n"
402 "--management-hold : Start " PACKAGE_NAME " in a hibernating state, until a client\n"
403 " of the management interface explicitly starts it.\n"
404 "--management-signal : Issue SIGUSR1 when management disconnect event occurs.\n"
405 "--management-forget-disconnect : Forget passwords when management disconnect\n"
406 " event occurs.\n"
407 "--management-up-down : Report tunnel up/down events to management interface.\n"
408 "--management-log-cache n : Cache n lines of log file history for usage\n"
409 " by the management channel.\n"
410#if UNIX_SOCK_SUPPORT
411 "--management-client-user u : When management interface is a unix socket, only\n"
412 " allow connections from user u.\n"
413 "--management-client-group g : When management interface is a unix socket, only\n"
414 " allow connections from group g.\n"
415#endif
416 "--management-client-auth : gives management interface client the responsibility\n"
417 " to authenticate clients after their client certificate\n"
418 " has been verified.\n"
419#endif /* ifdef ENABLE_MANAGEMENT */
420#ifdef ENABLE_PLUGIN
421 "--plugin m [str]: Load plug-in module m passing str as an argument\n"
422 " to its initialization function.\n"
423#endif
424 "--vlan-tagging : Enable 802.1Q-based VLAN tagging.\n"
425 "--vlan-accept tagged|untagged|all : Set VLAN tagging mode. Default is 'all'.\n"
426 "--vlan-pvid v : Sets the Port VLAN Identifier. Defaults to 1.\n"
427 "\n"
428 "Multi-Client Server options (when --mode server is used):\n"
429 "--server network netmask : Helper option to easily configure server mode.\n"
430 "--server-ipv6 network/bits : Configure IPv6 server mode.\n"
431 "--server-bridge [IP netmask pool-start-IP pool-end-IP] : Helper option to\n"
432 " easily configure ethernet bridging server mode.\n"
433 "--push \"option\" : Push a config file option back to the peer for remote\n"
434 " execution. Peer must specify --pull in its config file.\n"
435 "--push-reset : Don't inherit global push list for specific\n"
436 " client instance.\n"
437 "--push-remove opt : Remove options matching 'opt' from the push list for\n"
438 " a specific client instance.\n"
439 "--ifconfig-pool start-IP end-IP [netmask] : Set aside a pool of subnets\n"
440 " to be dynamically allocated to connecting clients.\n"
441 "--ifconfig-pool-persist file [seconds] : Persist/unpersist ifconfig-pool\n"
442 " data to file, at seconds intervals (default=600).\n"
443 " If seconds=0, file will be treated as read-only.\n"
444 "--ifconfig-ipv6-pool base-IP/bits : set aside an IPv6 network block\n"
445 " to be dynamically allocated to connecting clients.\n"
446 "--ifconfig-push local remote-netmask : Push an ifconfig option to remote,\n"
447 " overrides --ifconfig-pool dynamic allocation.\n"
448 " Only valid in a client-specific config file.\n"
449 "--ifconfig-ipv6-push local/bits remote : Push an ifconfig-ipv6 option to\n"
450 " remote, overrides --ifconfig-ipv6-pool allocation.\n"
451 " Only valid in a client-specific config file.\n"
452 "--iroute network [netmask] : Route subnet to client.\n"
453 "--iroute-ipv6 network/bits : Route IPv6 subnet to client.\n"
454 " Sets up internal routes only.\n"
455 " Only valid in a client-specific config file.\n"
456 "--disable : Client is disabled.\n"
457 " Only valid in a client-specific config file.\n"
458 "--override-username: Overrides the client-specific username to be used.\n"
459 " Only valid in a client-specific config file.\n"
460 "--verify-client-cert [none|optional|require] : perform no, optional or\n"
461 " mandatory client certificate verification.\n"
462 " Default is to require the client to supply a certificate.\n"
463 "--username-as-common-name : For auth-user-pass authentication, use\n"
464 " the authenticated username as the common name,\n"
465 " rather than the common name from the client cert.\n"
466 "--auth-user-pass-verify cmd method: Query client for username/password and\n"
467 " run command cmd to verify. If method='via-env', pass\n"
468 " user/pass via environment, if method='via-file', pass\n"
469 " user/pass via temporary file.\n"
470 "--auth-gen-token [lifetime] Generate a random authentication token which is pushed\n"
471 " to each client, replacing the password. Useful when\n"
472 " OTP based two-factor auth mechanisms are in use and\n"
473 " --reneg-* options are enabled. Optionally a lifetime in seconds\n"
474 " for generated tokens can be set.\n"
475 "--auth-user-pass-optional : Allow connections by clients that don't\n"
476 " specify a username/password.\n"
477 "--client-to-client : Internally route client-to-client traffic.\n"
478 "--duplicate-cn : Allow multiple clients with the same common name to\n"
479 " concurrently connect.\n"
480 "--client-connect cmd : Run command cmd on client connection.\n"
481 "--client-disconnect cmd : Run command cmd on client disconnection.\n"
482 "--client-config-dir dir : Directory for custom client config files.\n"
483 "--ccd-exclusive : Refuse connection unless custom client config is found.\n"
484 "--tmp-dir dir : Temporary directory, used for --client-connect return file and plugin communication.\n"
485 "--hash-size r v : Set the size of the real address hash table to r and the\n"
486 " virtual address table to v.\n"
487 "--bcast-buffers n : Allocate n broadcast buffers.\n"
488 "--tcp-queue-limit n : Maximum number of queued TCP output packets.\n"
489 "--tcp-nodelay : Macro that sets TCP_NODELAY socket flag on the server\n"
490 " as well as pushes it to connecting clients.\n"
491 "--learn-address cmd : Run command cmd to validate client virtual addresses.\n"
492 "--connect-freq n s : Allow a maximum of n new connections per s seconds.\n"
493 "--connect-freq-initial n s : Allow a maximum of n replies for initial connections attempts per s seconds.\n"
494 "--max-clients n : Allow a maximum of n simultaneously connected clients.\n"
495 "--max-routes-per-client n : Allow a maximum of n internal routes per client.\n"
496 "--stale-routes-check n [t] : Remove routes with a last activity timestamp\n"
497 " older than n seconds. Run this check every t\n"
498 " seconds (defaults to n).\n"
499 "--explicit-exit-notify [n] : In UDP server mode send [RESTART] command on exit/restart to connected\n"
500 " clients. n = 1 - reconnect to same server,\n"
501 " 2 - advance to next server, default=1.\n"
502#if PORT_SHARE
503 "--port-share host port [dir] : When run in TCP mode, proxy incoming HTTPS\n"
504 " sessions to a web server at host:port. dir specifies an\n"
505 " optional directory to write origin IP:port data.\n"
506#endif
507 "\n"
508 "Client options (when connecting to a multi-client server):\n"
509 "--client : Helper option to easily configure client mode.\n"
510 "--auth-user-pass [up] : Authenticate with server using username/password.\n"
511 " up is a file containing the username on the first line,\n"
512 " and a password on the second. If either the password or both\n"
513 " the username and the password are omitted OpenVPN will prompt\n"
514 " for them from console.\n"
515 "--pull : Accept certain config file options from the peer as if they\n"
516 " were part of the local config file. Must be specified\n"
517 " when connecting to a '--mode server' remote host.\n"
518 "--pull-filter accept|ignore|reject t : Filter each option received from the\n"
519 " server if it starts with the text t. The action flag accept,\n"
520 " ignore or reject causes the option to be allowed, removed or\n"
521 " rejected with error. May be specified multiple times, and\n"
522 " each filter is applied in the order of appearance.\n"
523 "--dns server <n> <option> <value> [value ...] : Configure option for DNS server #n\n"
524 " Valid options are :\n"
525 " address <addr[:port]> [addr[:port] ...] : server addresses 4/6\n"
526 " resolve-domains <domain> [domain ...] : split domains\n"
527 " dnssec <yes|no|optional> : option to use DNSSEC\n"
528 " transport <DoH|DoT> : query server over HTTPS / TLS\n"
529 " sni <domain> : DNS server name indication\n"
530 "--dns search-domains <domain> [domain ...]:\n"
531 " Add domains to DNS domain search list\n"
532 "--dns-updown cmd|force|disable : Run cmd as user defined dns config command,\n"
533 " force running the default script or disable running it.\n"
534 "--auth-retry t : How to handle auth failures. Set t to\n"
535 " none (default), interact, or nointeract.\n"
536 "--static-challenge t e [<scrv1|concat>]: Enable static challenge/response protocol using\n"
537 " challenge text t, with e indicating echo flag (0|1)\n"
538 " and optional argument scrv1 or concat to use SCRV1 protocol or"
539 " concatenate response with password. Default is scrv1.\n"
540 "--connect-timeout n : when polling possible remote servers to connect to\n"
541 " in a round-robin fashion, spend no more than n seconds\n"
542 " waiting for a response before trying the next server.\n"
543 "--allow-recursive-routing : When this option is set, OpenVPN will not drop\n"
544 " incoming tun packets with same destination as host.\n"
545 "--explicit-exit-notify [n] : On exit/restart, send exit signal to\n"
546 " server/remote. n = # of retries, default=1.\n"
547 "\n"
548 "Data Channel Encryption Options (must be compatible between peers):\n"
549 "(These options are meaningful for both Static Key & TLS-mode)\n"
550 "--auth alg : Authenticate packets with HMAC using message\n"
551 " digest algorithm alg (default=%s).\n"
552 " (usually adds 16 or 20 bytes per packet)\n"
553 " Set alg=none to disable authentication.\n"
554 "--cipher alg : Encrypt packets with cipher algorithm alg.\n"
555 " You should usually use --data-ciphers instead.\n"
556 " Set alg=none to disable encryption.\n"
557 "--data-ciphers list : List of ciphers that are allowed to be negotiated.\n"
558#ifndef ENABLE_CRYPTO_MBEDTLS
559 "--engine [name] : Enable OpenSSL hardware crypto engine functionality.\n"
560#endif
561 "--mute-replay-warnings : Silence the output of replay warnings to log file.\n"
562 "--replay-window n [t] : Use a replay protection sliding window of size n\n"
563 " and a time window of t seconds.\n"
564 " Default n=%d t=%d\n"
565 "--replay-persist file : Persist replay-protection state across sessions\n"
566 " using file.\n"
567 "--test-crypto : Run a self-test of crypto features enabled.\n"
568 " For debugging only.\n"
569#ifdef ENABLE_PREDICTION_RESISTANCE
570 "--use-prediction-resistance: Enable prediction resistance on the random\n"
571 " number generator.\n"
572#endif
573 "\n"
574 "TLS Key Negotiation Options:\n"
575 "(These options are meaningful only for TLS-mode)\n"
576 "--tls-server : Enable TLS and assume server role during TLS handshake.\n"
577 "--tls-client : Enable TLS and assume client role during TLS handshake.\n"
578 "--ca file : Certificate authority file in .pem format containing\n"
579 " root certificate.\n"
580#ifndef ENABLE_CRYPTO_MBEDTLS
581 "--capath dir : A directory of trusted certificates (CAs"
582 " and CRLs).\n"
583#endif /* ENABLE_CRYPTO_MBEDTLS */
584 "--dh file : File containing Diffie Hellman parameters\n"
585 " in .pem format (for --tls-server only).\n"
586 " Use \"openssl dhparam -out dh1024.pem 1024\" to generate.\n"
587 "--cert file : Local certificate in .pem format or a URI -- must be signed\n"
588 " by a Certificate Authority in --ca file used by the peer.\n"
589 "--extra-certs file : one or more PEM certs that complete the cert chain.\n"
590 "--key file : Local private key in .pem format or a URI.\n"
591 "--tls-version-min <version> ['or-highest'] : sets the minimum TLS version we\n"
592 " will accept from the peer. If version is unrecognized and 'or-highest'\n"
593 " is specified, require max TLS version supported by SSL implementation.\n"
594 "--tls-version-max <version> : sets the maximum TLS version we will use.\n"
595#ifndef ENABLE_CRYPTO_MBEDTLS
596 "--pkcs12 file : PKCS#12 file containing local private key, local certificate\n"
597 " and optionally the root CA certificate.\n"
598#endif
599#ifdef ENABLE_X509ALTUSERNAME
600 "--x509-username-field : Field in x509 certificate containing the username.\n"
601 " Default is CN in the Subject field.\n"
602#endif
603 "--verify-hash hash [algo] : Specify fingerprint for level-1 certificate.\n"
604 " Valid algo flags are SHA1 and SHA256. \n"
605#ifdef _WIN32
606 "--cryptoapicert select-string : Load the certificate and private key from the\n"
607 " Windows Certificate System Store.\n"
608#endif
609 "--tls-cipher l : A list l of allowable TLS ciphers separated by : (optional).\n"
610 "--tls-ciphersuites l: A list of allowed TLS 1.3 cipher suites separated by : (optional)\n"
611 " : Use --show-tls to see a list of supported TLS ciphers (suites).\n"
612 "--tls-cert-profile p : Set the allowed certificate crypto algorithm profile\n"
613 " (default=legacy).\n"
614 "--providers l : A list l of OpenSSL providers to load.\n"
615 "--tls-timeout n : Packet retransmit timeout on TLS control channel\n"
616 " if no ACK from remote within n seconds (default=%d).\n"
617 "--reneg-bytes n : Renegotiate data chan. key after n bytes sent and recvd.\n"
618 "--reneg-pkts n : Renegotiate data chan. key after n packets sent and recvd.\n"
619 "--reneg-sec max [min] : Renegotiate data chan. key after at most max (default=%d)\n"
620 " and at least min (defaults to 90%% of max on servers and equal\n"
621 " to max on clients).\n"
622 "--hand-window n : Data channel key exchange must finalize within n seconds\n"
623 " of handshake initiation by any peer (default=%d).\n"
624 "--tran-window n : Transition window -- old key can live this many seconds\n"
625 " after new key renegotiation begins (default=%d).\n"
626 "--single-session: Allow only one session (reset state on restart).\n"
627 "--tls-exit : Exit on TLS negotiation failure.\n"
628 "--tls-auth f [d]: Add an additional layer of authentication on top of the TLS\n"
629 " control channel to protect against attacks on the TLS stack\n"
630 " and DoS attacks.\n"
631 " f (required) is a shared-secret key file.\n"
632 " The optional d parameter controls key directionality.\n"
633 "--tls-crypt key : Add an additional layer of authenticated encryption on top\n"
634 " of the TLS control channel to hide the TLS certificate,\n"
635 " provide basic post-quantum security and protect against\n"
636 " attacks on the TLS stack and DoS attacks.\n"
637 " key (required) provides the pre-shared key file.\n"
638 "--tls-crypt-v2 key : For clients: use key as a client-specific tls-crypt key.\n"
639 " For servers: use key to decrypt client-specific keys. For\n"
640 " key generation (--genkey tls-crypt-v2-client): use key to\n"
641 " encrypt generated client-specific key. (See --tls-crypt.)\n"
642 "--genkey tls-crypt-v2-client [keyfile] [base64 metadata]: Generate a\n"
643 " fresh tls-crypt-v2 client key, and store to\n"
644 " keyfile. If supplied, include metadata in wrapped key.\n"
645 "--genkey tls-crypt-v2-server [keyfile] [base64 metadata]: Generate a\n"
646 " fresh tls-crypt-v2 server key, and store to keyfile\n"
647 "--tls-crypt-v2-verify cmd : Run command cmd to verify the metadata of the\n"
648 " client-supplied tls-crypt-v2 client key\n"
649 "--tls-crypt-v2-max-age n : Only accept tls-crypt-v2 client keys that have a\n"
650 " timestamp which is at most n days old.\n"
651 "--askpass [file]: Get PEM password from controlling tty before we daemonize.\n"
652 "--auth-nocache : Don't cache --askpass or --auth-user-pass passwords.\n"
653 "--crl-verify crl ['dir']: Check peer certificate against a CRL.\n"
654 "--tls-verify cmd: Run command cmd to verify the X509 name of a\n"
655 " pending TLS connection that has otherwise passed all other\n"
656 " tests of certification. cmd should return 0 to allow\n"
657 " TLS handshake to proceed, or 1 to fail. (cmd is\n"
658 " executed as 'cmd certificate_depth subject')\n"
659 "--verify-x509-name name: Accept connections only from a host with X509 subject\n"
660 " DN name. The remote host must also pass all other tests\n"
661 " of verification.\n"
662#ifndef ENABLE_CRYPTO_MBEDTLS
663 "--ns-cert-type t: (DEPRECATED) Require that peer certificate was signed with \n"
664 " an explicit nsCertType designation t = 'client' | 'server'.\n"
665#endif
666 "--x509-track x : Save peer X509 attribute x in environment for use by\n"
667 " plugins and management interface.\n"
668 "--keying-material-exporter label len : Save Exported Keying Material (RFC5705)\n"
669 " of len bytes (min. 16 bytes) using label in environment for use by plugins.\n"
670 "--remote-cert-ku v ... : Require that the peer certificate was signed with\n"
671 " explicit key usage, you can specify more than one value.\n"
672 " value should be given in hex format.\n"
673 "--remote-cert-eku oid : Require that the peer certificate was signed with\n"
674 " explicit extended key usage. Extended key usage can be encoded\n"
675 " as an object identifier or OpenSSL string representation.\n"
676 "--remote-cert-tls t: Require that peer certificate was signed with explicit\n"
677 " key usage and extended key usage based on RFC3280 TLS rules.\n"
678 " t = 'client' | 'server'.\n"
679#ifdef ENABLE_PKCS11
680 "\n"
681 "PKCS#11 Options:\n"
682 "--pkcs11-providers provider ... : PKCS#11 provider to load.\n"
683 "--pkcs11-protected-authentication [0|1] ... : Use PKCS#11 protected authentication\n"
684 " path. Set for each provider.\n"
685 "--pkcs11-private-mode hex ... : PKCS#11 private key mode mask.\n"
686 " 0 : Try to determine automatically (default).\n"
687 " 1 : Use Sign.\n"
688 " 2 : Use SignRecover.\n"
689 " 4 : Use Decrypt.\n"
690 " 8 : Use Unwrap.\n"
691 "--pkcs11-cert-private [0|1] ... : Set if login should be performed before\n"
692 " certificate can be accessed. Set for each provider.\n"
693 "--pkcs11-pin-cache seconds : Number of seconds to cache PIN. The default is -1\n"
694 " cache until token is removed.\n"
695 "--pkcs11-id-management : Acquire identity from management interface.\n"
696 "--pkcs11-id serialized-id 'id' : Identity to use, get using standalone --show-pkcs11-ids\n"
697#endif /* ENABLE_PKCS11 */
698 "\n"
699 "SSL Library information:\n"
700 "--show-ciphers : Show cipher algorithms to use with --cipher option.\n"
701 "--show-digests : Show message digest algorithms to use with --auth option.\n"
702 "--show-engines : Show hardware crypto accelerator engines (if available).\n"
703 "--show-tls : Show all TLS ciphers (TLS used only as a control channel).\n"
704#ifdef _WIN32
705 "\n"
706 "Windows Specific:\n"
707 "--win-sys path : Pathname of Windows system directory. Default is the pathname\n"
708 " from SystemRoot environment variable.\n"
709 "--ip-win32 method : When using --ifconfig on Windows, set TAP-Windows adapter\n"
710 " IP address using method = manual, netsh, ipapi,\n"
711 " dynamic, or adaptive (default = adaptive).\n"
712 " Dynamic method allows two optional parameters:\n"
713 " offset: DHCP server address offset (> -256 and < 256).\n"
714 " If 0, use network address, if >0, take nth\n"
715 " address forward from network address, if <0,\n"
716 " take nth address backward from broadcast\n"
717 " address.\n"
718 " Default is 0.\n"
719 " lease-time: Lease time in seconds.\n"
720 " Default is one year.\n"
721 "--route-method : Which method to use for adding routes on Windows?\n"
722 " adaptive (default) -- Try ipapi then fall back to exe.\n"
723 " ipapi -- Use IP helper API.\n"
724 " exe -- Call the route.exe shell command.\n"
725 "--dhcp-option type [parm] : Set extended TAP-Windows properties, must\n"
726 " be used with --ip-win32 dynamic. For options\n"
727 " which allow multiple addresses,\n"
728 " --dhcp-option must be repeated.\n"
729 " DOMAIN name : Set DNS suffix\n"
730 " DOMAIN-SEARCH entry : Add entry to DNS domain search list\n"
731 " DNS addr : Set domain name server address(es) (IPv4 and IPv6)\n"
732 " NTP : Set NTP server address(es)\n"
733 " NBDD : Set NBDD server address(es)\n"
734 " WINS addr : Set WINS server address(es)\n"
735 " NBT type : Set NetBIOS over TCP/IP Node type\n"
736 " 1: B, 2: P, 4: M, 8: H\n"
737 " NBS id : Set NetBIOS scope ID\n"
738 " DISABLE-NBT : Disable Netbios-over-TCP/IP.\n"
739 "--dhcp-renew : Ask Windows to renew the TAP adapter lease on startup.\n"
740 "--dhcp-pre-release : Ask Windows to release the previous TAP adapter lease on\n"
741 " startup.\n"
742 "--register-dns : Run ipconfig /flushdns and ipconfig /registerdns\n"
743 " on connection initiation.\n"
744 "--tap-sleep n : Sleep for n seconds after TAP adapter open before\n"
745 " attempting to set adapter properties.\n"
746 "--pause-exit : When run from a console window, pause before exiting.\n"
747 "--service ex [0|1] : For use when " PACKAGE_NAME " is being instantiated by a\n"
748 " service, and should not be used directly by end-users.\n"
749 " ex is the name of an event object which, when\n"
750 " signaled, will cause " PACKAGE_NAME " to exit. A second\n"
751 " optional parameter controls the initial state of ex.\n"
752 "--show-net-up : Show " PACKAGE_NAME "'s view of routing table and net adapter list\n"
753 " after TAP adapter is up and routes have been added.\n"
754 "--block-outside-dns : Block DNS on other network adapters to prevent DNS leaks\n"
755 "Windows Standalone Options:\n"
756 "\n"
757 "--show-adapters : Show all TAP-Windows adapters.\n"
758 "--show-net : Show " PACKAGE_NAME "'s view of routing table and net adapter list.\n"
759 "--show-valid-subnets : Show valid subnets for --dev tun emulation.\n"
760 "--allow-nonadmin [TAP-adapter] : Allow " PACKAGE_NAME " running without admin privileges\n"
761 " to access TAP adapter.\n"
762#endif /* ifdef _WIN32 */
763 "\n"
764 "Generate a new key :\n"
765 "--genkey tls-auth file : Generate a new random key of type and write to file\n"
766 " (for use with --tls-auth or --tls-crypt)."
767#ifdef ENABLE_FEATURE_TUN_PERSIST
768 "\n"
769 "Tun/tap config mode:\n"
770 "--mktun : Create a persistent tunnel.\n"
771 "--rmtun : Remove a persistent tunnel.\n"
772 "--dev tunX|tapX : tun/tap device\n"
773 "--dev-type dt : Device type. See tunnel options above for details.\n"
774 "--user user : User to set privilege to.\n"
775 "--group group : Group to set privilege to.\n"
776#endif
777#ifdef ENABLE_PKCS11
778 "\n"
779 "PKCS#11 standalone options:\n"
780#ifdef DEFAULT_PKCS11_MODULE
781 "--show-pkcs11-ids [provider] [cert_private] : Show PKCS#11 available ids.\n"
782#else
783 "--show-pkcs11-ids provider [cert_private] : Show PKCS#11 available ids.\n"
784#endif
785 " --verb option can be added *BEFORE* this.\n"
786#endif /* ENABLE_PKCS11 */
787 "\n"
788 "General Standalone Options:\n"
789#ifdef ENABLE_DEBUG
790 "--show-gateway [address]: Show info about gateway [to v4/v6 address].\n"
791#endif
792 ;
793
794#endif /* !ENABLE_SMALL */
795
796/*
797 * This is where the options defaults go.
798 * Any option not explicitly set here
799 * will be set to 0.
800 */
801void
802init_options(struct options *o, const bool init_gc)
803{
804 CLEAR(*o);
805 if (init_gc)
806 {
807 gc_init(&o->gc);
809 o->gc_owned = true;
810 }
812 o->topology = TOP_UNDEF;
813 o->ce.proto = PROTO_UDP;
814 o->ce.af = AF_UNSPEC;
815 o->ce.bind_ipv6_only = false;
818 o->ce.connect_timeout = 120;
819 o->connect_retry_max = 0;
821 o->verbosity = 1;
823 o->status_file_version = 1;
824 o->ce.bind_local = true;
826 o->ce.occ_mtu = 0;
829 o->ce.mtu_discover_type = -1;
830 o->ce.mssfix = 0;
831 o->ce.mssfix_default = true;
832 o->ce.mssfix_encap = true;
834 o->route_delay_window = 30;
836 o->resolve_in_advance = false;
837 o->proto_force = -1;
838 o->occ = true;
839#ifdef ENABLE_MANAGEMENT
843#endif
844#ifdef ENABLE_FEATURE_TUN_PERSIST
845 o->persist_mode = 1;
846#endif
847#ifdef _WIN32
848#if 0
850#else
852#endif
853 o->tuntap_options.dhcp_lease_time = 31536000; /* one year */
854 /* use network address as internal DHCP server address */
857 o->block_outside_dns = false;
859#endif
861 o->vlan_pvid = 1;
862 o->real_hash_size = 256;
863 o->virtual_hash_size = 256;
864 o->n_bcast_buf = 256;
865 o->tcp_queue_limit = 64;
866 o->max_clients = 1024;
867 o->cf_initial_per = 10;
868 o->cf_initial_max = 100;
869 o->max_routes_per_client = 256;
873 o->authname = "SHA1";
877#ifdef ENABLE_PREDICTION_RESISTANCE
878 o->use_prediction_resistance = false;
879#endif
880 o->tls_timeout = 2;
881 o->renegotiate_bytes = -1;
882 o->renegotiate_seconds = 3600;
884 o->handshake_window = 60;
885 o->transition_window = 3600;
886 o->tls_cert_profile = NULL;
887 o->ecdh_curve = NULL;
888#ifdef ENABLE_X509ALTUSERNAME
889 o->x509_username_field[0] = X509_USERNAME_FIELD_DEFAULT;
890#endif
891#ifdef ENABLE_PKCS11
892 o->pkcs11_pin_cache_period = -1;
893#endif /* ENABLE_PKCS11 */
894
895 /* P2MP server context features */
896 o->auth_token_generate = false;
897
898 /* Set default --tmp-dir */
899#ifdef _WIN32
900 /* On Windows, find temp dir via environment variables */
902
903 if (!o->tmp_dir)
904 {
905 /* Error out if we can't find a valid temporary directory, which should
906 * be very unlikely. */
907 msg(M_USAGE, "Could not find a suitable temporary directory."
908 " (GetTempPath() failed). Consider using --tmp-dir");
909 }
910#else /* ifdef _WIN32 */
911 /* Non-windows platforms use $TMPDIR, and if not set, default to '/tmp' */
912 o->tmp_dir = getenv("TMPDIR");
913 if (!o->tmp_dir)
914 {
915 o->tmp_dir = "/tmp";
916 }
917#endif /* _WIN32 */
918 o->allow_recursive_routing = false;
919
920#ifndef ENABLE_DCO
921 o->disable_dco = true;
922#endif /* ENABLE_DCO */
923
924#ifdef ENABLE_DNS_UPDOWN_BY_DEFAULT
925 o->dns_options.updown = DEFAULT_DNS_UPDOWN;
926#endif /* ENABLE_DNS_UPDOWN_BY_DEFAULT */
927}
928
929void
931{
932 if (o->connection_list)
933 {
935 }
936 if (o->remote_list)
937 {
938 CLEAR(*o->remote_list);
939 }
940 if (o->gc_owned)
941 {
942 gc_free(&o->gc);
944 }
945}
946
947#ifndef ENABLE_SMALL
948
949static const char *
951{
952 if (type == PUF_TYPE_ACCEPT)
953 {
954 return "accept";
955 }
956 if (type == PUF_TYPE_IGNORE)
957 {
958 return "ignore";
959 }
960 if (type == PUF_TYPE_REJECT)
961 {
962 return "reject";
963 }
964 else
965 {
966 return "???";
967 }
968}
969
970#define SHOW_PARM(name, value, format) msg(D_SHOW_PARMS, " " #name " = " format, (value))
971#define SHOW_STR(var) SHOW_PARM(var, (o->var ? o->var : "[UNDEF]"), "'%s'")
972#define SHOW_STR_INLINE(var) \
973 SHOW_PARM(var, o->var##_inline ? "[INLINE]" : (o->var ? o->var : "[UNDEF]"), "'%s'")
974#define SHOW_INT(var) SHOW_PARM(var, o->var, "%d")
975#define SHOW_UINT(var) SHOW_PARM(var, o->var, "%u")
976#define SHOW_INT64(var) SHOW_PARM(var, o->var, "%" PRIi64)
977#define SHOW_UNSIGNED(var) SHOW_PARM(var, o->var, "0x%08x")
978#define SHOW_BOOL(var) SHOW_PARM(var, (o->var ? "ENABLED" : "DISABLED"), "%s");
979
980#endif /* ifndef ENABLE_SMALL */
981
982static void
983setenv_connection_entry(struct env_set *es, const struct connection_entry *e, const int i)
984{
985 setenv_str_i(es, "remote", e->remote, i);
986 setenv_str_i(es, "remote_port", e->remote_port, i);
987
988 if (e->http_proxy_options)
989 {
990 setenv_str_i(es, "http_proxy_server", e->http_proxy_options->server, i);
991 setenv_str_i(es, "http_proxy_port", e->http_proxy_options->port, i);
992 }
993 if (e->socks_proxy_server)
994 {
995 setenv_str_i(es, "socks_proxy_server", e->socks_proxy_server, i);
996 setenv_str_i(es, "socks_proxy_port", e->socks_proxy_port, i);
997 }
998}
999
1000static void
1001setenv_local_entry(struct env_set *es, const struct local_entry *e, const int i)
1002{
1003 setenv_str_i(es, "proto", proto2ascii(e->proto, AF_UNSPEC, false), i);
1004 setenv_str_i(es, "local", e->local, i);
1005 setenv_str_i(es, "local_port", e->port, i);
1006}
1007
1008void
1009setenv_settings(struct env_set *es, const struct options *o)
1010{
1011 setenv_str(es, "config", o->config);
1012 setenv_int(es, "verb", o->verbosity);
1013 setenv_int(es, "daemon", o->daemon);
1014 setenv_int(es, "daemon_log_redirect", o->log);
1015 setenv_long_long(es, "daemon_start_time", time(NULL));
1016 setenv_int(es, "daemon_pid", platform_getpid());
1017
1018 if (o->connection_list)
1019 {
1020 int i;
1021 for (i = 0; i < o->connection_list->len; ++i)
1022 {
1024 }
1025 }
1026 else
1027 {
1028 setenv_connection_entry(es, &o->ce, 1);
1029 }
1030
1031 if (o->ce.local_list)
1032 {
1033 for (int i = 0; i < o->ce.local_list->len; i++)
1034 {
1035 setenv_local_entry(es, o->ce.local_list->array[i], i + 1);
1036 }
1037 }
1038}
1039
1040#ifndef _WIN32
1041static void
1042setenv_foreign_option(struct options *o, const char *option, const char *value, struct env_set *es)
1043{
1044 struct gc_arena gc = gc_new();
1047 bool good = true;
1048
1049 good &= buf_printf(&env_name, "foreign_option_%d", o->foreign_option_index + 1);
1050 if (value)
1051 {
1052 good &= buf_printf(&env_value, "dhcp-option %s %s", option, value);
1053 }
1054 else
1055 {
1056 good &= buf_printf(&env_value, "dhcp-option %s", option);
1057 }
1058 if (good)
1059 {
1061 ++o->foreign_option_index;
1062 }
1063 else
1064 {
1065 msg(M_WARN, "foreign_option: name/value overflow");
1066 }
1067 gc_free(&gc);
1068}
1069
1070static void
1071delete_all_dhcp_fo(struct options *o, struct env_item **list)
1072{
1073 struct env_item *current, *prev;
1074
1075 ASSERT(list);
1076
1077 for (current = *list, prev = NULL; current != NULL; current = current->next)
1078 {
1079 char *tmp_value = NULL;
1080 if (!strncmp(current->string, "foreign_option_", sizeof("foreign_option_") - 1))
1081 {
1082 tmp_value = strchr(current->string, '=');
1083 if (tmp_value && ++tmp_value)
1084 {
1085 if (!strncmp(tmp_value, "dhcp-option ", sizeof("dhcp-option ") - 1))
1086 {
1087 if (prev)
1088 {
1089 prev->next = current->next;
1090 }
1091 else
1092 {
1093 *list = current->next;
1094 }
1096 }
1097 }
1098 }
1099 prev = current;
1100 }
1101}
1102
1103#endif /* ifndef _WIN32 */
1104
1105static in_addr_t
1106get_ip_addr(const char *ip_string, msglvl_t msglevel, bool *error)
1107{
1108 unsigned int flags = GETADDR_HOST_ORDER;
1109 bool succeeded = false;
1110 in_addr_t ret;
1111
1112 if (msglevel & M_FATAL)
1113 {
1114 flags |= GETADDR_FATAL;
1115 }
1116
1117 ret = getaddr(flags, ip_string, 0, &succeeded, NULL);
1118 if (!succeeded && error)
1119 {
1120 *error = true;
1121 }
1122 return ret;
1123}
1124
1130static char *
1131get_ipv6_addr_no_netbits(const char *addr, struct gc_arena *gc)
1132{
1133 const char *end = strchr(addr, '/');
1134 char *ret = NULL;
1135 if (NULL == end)
1136 {
1137 ret = string_alloc(addr, gc);
1138 }
1139 else
1140 {
1141 size_t len = end - addr;
1142 ret = gc_malloc(len + 1, true, gc);
1143 memcpy(ret, addr, len);
1144 }
1145 return ret;
1146}
1147
1148static bool
1149ipv6_addr_safe_hexplusbits(const char *ipv6_prefix_spec)
1150{
1151 struct in6_addr t_addr;
1152 unsigned int t_bits;
1153
1154 return get_ipv6_addr(ipv6_prefix_spec, &t_addr, &t_bits, M_WARN);
1155}
1156
1157static char *
1158string_substitute(const char *src, char from, char to, struct gc_arena *gc)
1159{
1160 char *ret = (char *)gc_malloc(strlen(src) + 1, true, gc);
1161 char *dest = ret;
1162 char c;
1163
1164 do
1165 {
1166 c = *src++;
1167 if (c == from)
1168 {
1169 c = to;
1170 }
1171 *dest++ = c;
1172 } while (c);
1173 return ret;
1174}
1175
1185static struct verify_hash_list *
1186parse_hash_fingerprint(const char *str, int nbytes, msglvl_t msglevel, struct gc_arena *gc)
1187{
1188 int i = 0;
1189 const char *cp = str;
1190
1191 struct verify_hash_list *ret;
1193
1194 char term = 0;
1195 unsigned int byte;
1196
1197 while (*cp && i < nbytes)
1198 {
1199 /* valid segments consist of exactly two hex digits, then ':' or EOS */
1200 if (!isxdigit(cp[0]) || !isxdigit(cp[1]) || (cp[2] != ':' && cp[2] != '\0')
1201 || sscanf(cp, "%x", &byte) != 1)
1202 {
1203 msg(msglevel, "format error in hash fingerprint: %s", str);
1204 break;
1205 }
1206
1207 ret->hash[i++] = (uint8_t)byte;
1208
1209 term = cp[2];
1210 if (term == '\0')
1211 {
1212 break;
1213 }
1214 cp += 3;
1215 }
1216 if (i < nbytes)
1217 {
1218 msg(msglevel, "hash fingerprint is wrong length - expected %d bytes, got %d: %s", nbytes, i,
1219 str);
1220 }
1221 else if (term != '\0')
1222 {
1223 msg(msglevel, "hash fingerprint too long - expected only %d bytes: %s", nbytes, str);
1224 }
1225 return ret;
1226}
1227
1238static struct verify_hash_list *
1239parse_hash_fingerprint_multiline(const char *str, int nbytes, msglvl_t msglevel,
1240 struct gc_arena *gc)
1241{
1242 struct gc_arena gc_temp = gc_new();
1243 char *lines = string_alloc(str, &gc_temp);
1244
1245 struct verify_hash_list *ret = NULL;
1246
1247 const char *line;
1248 while ((line = strsep(&lines, "\n")))
1249 {
1250 /* ignore leading whitespace */
1251 while (isspace(*line))
1252 {
1253 line++;
1254 }
1255 /* skip empty lines and comment lines */
1256 if (strlen(line) == 0 || *line == '#' || *line == ';')
1257 {
1258 continue;
1259 }
1260
1261 struct verify_hash_list *hash = parse_hash_fingerprint(line, nbytes, msglevel, gc);
1262
1263 if (!hash)
1264 {
1265 gc_free(&gc_temp);
1266 return NULL;
1267 }
1268
1269 hash->next = ret;
1270 ret = hash;
1271 }
1272 gc_free(&gc_temp);
1273
1274 return ret;
1275}
1276#ifdef _WIN32
1277
1278#ifndef ENABLE_SMALL
1279
1280static void
1281show_dhcp_option_list(const char *name, const char *const *array, int len)
1282{
1283 int i;
1284 for (i = 0; i < len; ++i)
1285 {
1286 msg(D_SHOW_PARMS, " %s[%d] = %s", name, i, array[i]);
1287 }
1288}
1289
1290static void
1291show_dhcp_option_addrs(const char *name, const in_addr_t *array, int len)
1292{
1293 struct gc_arena gc = gc_new();
1294 int i;
1295 for (i = 0; i < len; ++i)
1296 {
1297 msg(D_SHOW_PARMS, " %s[%d] = %s", name, i, print_in_addr_t(array[i], 0, &gc));
1298 }
1299 gc_free(&gc);
1300}
1301
1302static void
1304{
1305 SHOW_BOOL(ip_win32_defined);
1306 SHOW_INT(ip_win32_type);
1307 SHOW_INT(dhcp_masq_offset);
1308 SHOW_INT(dhcp_lease_time);
1309 SHOW_INT(tap_sleep);
1312 SHOW_BOOL(dhcp_pre_release);
1313 SHOW_STR(domain);
1314 SHOW_STR(netbios_scope);
1315 SHOW_UNSIGNED(netbios_node_type);
1316 SHOW_BOOL(disable_nbt);
1317
1318 show_dhcp_option_addrs("DNS", o->dns, o->dns_len);
1319 show_dhcp_option_addrs("WINS", o->wins, o->wins_len);
1320 show_dhcp_option_addrs("NTP", o->ntp, o->ntp_len);
1321 show_dhcp_option_addrs("NBDD", o->nbdd, o->nbdd_len);
1323}
1324
1325#endif /* ifndef ENABLE_SMALL */
1326#endif /* ifdef _WIN32 */
1327
1328static void
1329dhcp_option_dns6_parse(const char *parm, struct in6_addr *dns6_list, int *len, msglvl_t msglevel)
1330{
1331 struct in6_addr addr;
1332 if (*len >= N_DHCP_ADDR)
1333 {
1334 msg(msglevel, "--dhcp-option DNS: maximum of %d IPv6 dns servers can be specified",
1335 N_DHCP_ADDR);
1336 }
1337 else if (get_ipv6_addr(parm, &addr, NULL, msglevel))
1338 {
1339 dns6_list[(*len)++] = addr;
1340 }
1341}
1342static void
1343dhcp_option_address_parse(const char *name, const char *parm, in_addr_t *array, int *len,
1344 msglvl_t msglevel)
1345{
1346 if (*len >= N_DHCP_ADDR)
1347 {
1348 msg(msglevel, "--dhcp-option %s: maximum of %d %s servers can be specified", name,
1349 N_DHCP_ADDR, name);
1350 }
1351 else
1352 {
1353 if (ip_addr_dotted_quad_safe(parm)) /* FQDN -- IP address only */
1354 {
1355 bool error = false;
1356 const in_addr_t addr = get_ip_addr(parm, msglevel, &error);
1357 if (!error)
1358 {
1359 array[(*len)++] = addr;
1360 }
1361 }
1362 else
1363 {
1364 msg(msglevel, "dhcp-option parameter %s '%s' must be an IP address", name, parm);
1365 }
1366 }
1367}
1368
1369#ifndef ENABLE_SMALL
1370static const char *
1372{
1373 switch (mode)
1374 {
1375 case VLAN_ONLY_TAGGED:
1376 return "tagged";
1377
1379 return "untagged";
1380
1381 case VLAN_ALL:
1382 return "all";
1383 }
1384 return NULL;
1385}
1386
1387static void
1388show_p2mp_parms(const struct options *o)
1389{
1390 struct gc_arena gc = gc_new();
1391
1392 msg(D_SHOW_PARMS, " server_network = %s", print_in_addr_t(o->server_network, 0, &gc));
1393 msg(D_SHOW_PARMS, " server_netmask = %s", print_in_addr_t(o->server_netmask, 0, &gc));
1394 msg(D_SHOW_PARMS, " server_network_ipv6 = %s", print_in6_addr(o->server_network_ipv6, 0, &gc));
1395 SHOW_INT(server_netbits_ipv6);
1396 msg(D_SHOW_PARMS, " server_bridge_ip = %s", print_in_addr_t(o->server_bridge_ip, 0, &gc));
1397 msg(D_SHOW_PARMS, " server_bridge_netmask = %s",
1399 msg(D_SHOW_PARMS, " server_bridge_pool_start = %s",
1401 msg(D_SHOW_PARMS, " server_bridge_pool_end = %s",
1403 if (o->push_list.head)
1404 {
1405 const struct push_entry *e = o->push_list.head;
1406 while (e)
1407 {
1408 if (e->enable)
1409 {
1410 msg(D_SHOW_PARMS, " push_entry = '%s'", e->option);
1411 }
1412 e = e->next;
1413 }
1414 }
1415 SHOW_BOOL(ifconfig_pool_defined);
1416 msg(D_SHOW_PARMS, " ifconfig_pool_start = %s",
1418 msg(D_SHOW_PARMS, " ifconfig_pool_end = %s", print_in_addr_t(o->ifconfig_pool_end, 0, &gc));
1419 msg(D_SHOW_PARMS, " ifconfig_pool_netmask = %s",
1421 SHOW_STR(ifconfig_pool_persist_filename);
1422 SHOW_INT(ifconfig_pool_persist_refresh_freq);
1423 SHOW_BOOL(ifconfig_ipv6_pool_defined);
1424 msg(D_SHOW_PARMS, " ifconfig_ipv6_pool_base = %s",
1426 SHOW_INT(ifconfig_ipv6_pool_netbits);
1427 SHOW_INT(n_bcast_buf);
1428 SHOW_INT(tcp_queue_limit);
1429 SHOW_INT(real_hash_size);
1430 SHOW_INT(virtual_hash_size);
1431 SHOW_STR(client_connect_script);
1433 SHOW_STR(client_disconnect_script);
1434 SHOW_STR(client_crresponse_script);
1435 SHOW_STR(client_config_dir);
1436 SHOW_BOOL(ccd_exclusive);
1437 SHOW_STR(tmp_dir);
1438 SHOW_BOOL(push_ifconfig_defined);
1439 msg(D_SHOW_PARMS, " push_ifconfig_local = %s",
1441 msg(D_SHOW_PARMS, " push_ifconfig_remote_netmask = %s",
1443 SHOW_BOOL(push_ifconfig_ipv6_defined);
1444 msg(D_SHOW_PARMS, " push_ifconfig_ipv6_local = %s/%d",
1446 msg(D_SHOW_PARMS, " push_ifconfig_ipv6_remote = %s",
1448 SHOW_BOOL(enable_c2c);
1449 SHOW_BOOL(duplicate_cn);
1450 SHOW_INT(cf_max);
1451 SHOW_INT(cf_per);
1452 SHOW_INT(cf_initial_max);
1453 SHOW_INT(cf_initial_per);
1454 SHOW_INT(max_clients);
1455 SHOW_INT(max_routes_per_client);
1456 SHOW_STR(auth_user_pass_verify_script);
1457 SHOW_BOOL(auth_user_pass_verify_script_via_file);
1458 SHOW_BOOL(auth_token_generate);
1459 SHOW_BOOL(force_key_material_export);
1460 SHOW_INT(auth_token_lifetime);
1461 SHOW_STR_INLINE(auth_token_secret_file);
1462#if PORT_SHARE
1463 SHOW_STR(port_share_host);
1464 SHOW_STR(port_share_port);
1465#endif
1466 SHOW_BOOL(vlan_tagging);
1467 msg(D_SHOW_PARMS, " vlan_accept = %s", print_vlan_accept(o->vlan_accept));
1468 SHOW_INT(vlan_pvid);
1469
1470 SHOW_BOOL(client);
1471 SHOW_BOOL(pull);
1472 SHOW_STR_INLINE(auth_user_pass_file);
1473
1474 gc_free(&gc);
1475}
1476
1477#endif /* ! ENABLE_SMALL */
1478
1479static void
1480option_iroute(struct options *o, const char *network_str, const char *netmask_str,
1481 msglvl_t msglevel)
1482{
1483 struct iroute *ir;
1484
1485 ALLOC_OBJ_GC(ir, struct iroute, &o->gc);
1486 ir->network = getaddr(GETADDR_HOST_ORDER, network_str, 0, NULL, NULL);
1487 ir->netbits = 32; /* host route if no netmask given */
1488
1489 if (netmask_str)
1490 {
1491 const in_addr_t netmask = getaddr(GETADDR_HOST_ORDER, netmask_str, 0, NULL, NULL);
1492 ir->netbits = netmask_to_netbits2(netmask);
1493
1494 if (ir->netbits < 0)
1495 {
1496 msg(msglevel, "in --iroute %s %s : Bad network/subnet specification", network_str,
1497 netmask_str);
1498 return;
1499 }
1500 }
1501
1502 ir->next = o->iroutes;
1503 o->iroutes = ir;
1504}
1505
1506static void
1507option_iroute_ipv6(struct options *o, const char *prefix_str, msglvl_t msglevel)
1508{
1509 struct iroute_ipv6 *ir;
1510
1511 ALLOC_OBJ_GC(ir, struct iroute_ipv6, &o->gc);
1512
1513 if (!get_ipv6_addr(prefix_str, &ir->network, &ir->netbits, msglevel))
1514 {
1515 msg(msglevel, "in --iroute-ipv6 %s: Bad IPv6 prefix specification", prefix_str);
1516 return;
1517 }
1518
1519 ir->next = o->iroutes_ipv6;
1520 o->iroutes_ipv6 = ir;
1521}
1522
1523#ifndef ENABLE_SMALL
1524static void
1526{
1527 int i;
1528 msg(D_SHOW_PARMS, "BEGIN http_proxy");
1529 SHOW_STR(server);
1530 SHOW_STR(port);
1531 SHOW_STR(auth_method_string);
1532 SHOW_STR(auth_file);
1533 SHOW_STR(auth_file_up);
1534 SHOW_BOOL(inline_creds);
1535 SHOW_BOOL(nocache);
1536 SHOW_STR(http_version);
1537 SHOW_STR(user_agent);
1538 for (i = 0; i < MAX_CUSTOM_HTTP_HEADER && o->custom_headers[i].name; i++)
1539 {
1540 if (o->custom_headers[i].content)
1541 {
1542 msg(D_SHOW_PARMS, " custom_header[%d] = %s: %s", i, o->custom_headers[i].name,
1543 o->custom_headers[i].content);
1544 }
1545 else
1546 {
1547 msg(D_SHOW_PARMS, " custom_header[%d] = %s", i, o->custom_headers[i].name);
1548 }
1549 }
1550 msg(D_SHOW_PARMS, "END http_proxy");
1551}
1552#endif /* ifndef ENABLE_SMALL */
1553
1554void
1556{
1557 gc_detach(&o->gc);
1558 o->routes = NULL;
1559 o->client_nat = NULL;
1560 clone_push_list(o);
1561}
1562
1563void
1565{
1566 if (!options->routes)
1567 {
1569 }
1570}
1571
1572static void
1580
1581static void
1583{
1584 if (!options->client_nat)
1585 {
1587 }
1588}
1589
1590#ifndef ENABLE_SMALL
1591static void
1593{
1594 /* Display the global proto only in client mode or with no '--local'*/
1595 if (o->local_list->len == 1)
1596 {
1597 msg(D_SHOW_PARMS, " proto = %s", proto2ascii(o->proto, o->af, false));
1598 }
1599
1600 msg(D_SHOW_PARMS, " Local Sockets:");
1601 for (int i = 0; i < o->local_list->len; i++)
1602 {
1603 msg(D_SHOW_PARMS, " [%s]:%s-%s", o->local_list->array[i]->local,
1604 o->local_list->array[i]->port,
1605 proto2ascii(o->local_list->array[i]->proto, o->af, false));
1606 }
1607 SHOW_STR(remote);
1608 SHOW_STR(remote_port);
1609 SHOW_BOOL(remote_float);
1610 SHOW_BOOL(bind_defined);
1612 SHOW_BOOL(bind_ipv6_only);
1613 SHOW_INT(connect_retry_seconds);
1614 SHOW_INT(connect_timeout);
1615
1616 if (o->http_proxy_options)
1617 {
1619 }
1620 SHOW_STR(socks_proxy_server);
1621 SHOW_STR(socks_proxy_port);
1622 SHOW_INT(tun_mtu);
1623 SHOW_BOOL(tun_mtu_defined);
1624 SHOW_INT(link_mtu);
1625 SHOW_BOOL(link_mtu_defined);
1626 SHOW_INT(tun_mtu_extra);
1627 SHOW_BOOL(tun_mtu_extra_defined);
1628 SHOW_INT(tls_mtu);
1629
1630 SHOW_INT(mtu_discover_type);
1631
1632#ifdef ENABLE_FRAGMENT
1634#endif
1635 SHOW_INT(mssfix);
1636 SHOW_BOOL(mssfix_encap);
1637 SHOW_BOOL(mssfix_fixed);
1638
1639 SHOW_INT(explicit_exit_notification);
1640
1641 SHOW_STR_INLINE(tls_auth_file);
1642 SHOW_PARM(key_direction, keydirection2ascii(o->key_direction, false, true), "%s");
1643 SHOW_STR_INLINE(tls_crypt_file);
1644 SHOW_STR_INLINE(tls_crypt_v2_file);
1645}
1646
1647
1648static void
1650{
1651 if (o->connection_list)
1652 {
1653 const struct connection_list *l = o->connection_list;
1654 int i;
1655 for (i = 0; i < l->len; ++i)
1656 {
1657 msg(D_SHOW_PARMS, "Connection profiles [%d]:", i);
1658 show_connection_entry(l->array[i]);
1659 }
1660 }
1661 else
1662 {
1663 msg(D_SHOW_PARMS, "Connection profiles [default]:");
1665 }
1666 msg(D_SHOW_PARMS, "Connection profiles END");
1667}
1668
1669static void
1671{
1672 struct pull_filter *f;
1673 if (!l)
1674 {
1675 return;
1676 }
1677
1678 msg(D_SHOW_PARMS, " Pull filters:");
1679 for (f = l->head; f; f = f->next)
1680 {
1681 msg(D_SHOW_PARMS, " %s \"%s\"", pull_filter_type_name(f->type), f->pattern);
1682 }
1683}
1684
1685#endif /* ifndef ENABLE_SMALL */
1686
1687void
1688show_settings(const struct options *o)
1689{
1690#ifndef ENABLE_SMALL
1691 msg(D_SHOW_PARMS, "Current Parameter Settings:");
1692
1693 SHOW_STR(config);
1694
1695 SHOW_INT(mode);
1696
1697#ifdef ENABLE_FEATURE_TUN_PERSIST
1698 SHOW_BOOL(persist_config);
1699 SHOW_INT(persist_mode);
1700#endif
1701
1702 SHOW_BOOL(show_ciphers);
1703 SHOW_BOOL(show_digests);
1704 SHOW_BOOL(show_engines);
1705 SHOW_BOOL(genkey);
1706 SHOW_STR(genkey_filename);
1707 SHOW_STR(key_pass_file);
1708 SHOW_BOOL(show_tls_ciphers);
1709
1710 SHOW_INT(connect_retry_max);
1712
1713 SHOW_BOOL(remote_random);
1714
1715 SHOW_STR(ipchange);
1716 SHOW_STR(dev);
1717 SHOW_STR(dev_type);
1718 SHOW_STR(dev_node);
1719#if defined(ENABLE_DCO)
1720 SHOW_BOOL(disable_dco);
1721#endif
1722 SHOW_STR(lladdr);
1723 SHOW_INT(topology);
1724 SHOW_STR(ifconfig_local);
1725 SHOW_STR(ifconfig_remote_netmask);
1726 SHOW_BOOL(ifconfig_noexec);
1727 SHOW_BOOL(ifconfig_nowarn);
1728 SHOW_STR(ifconfig_ipv6_local);
1729 SHOW_INT(ifconfig_ipv6_netbits);
1730 SHOW_STR(ifconfig_ipv6_remote);
1731
1733 SHOW_INT(mtu_test);
1734
1735 SHOW_BOOL(mlock);
1736
1737 SHOW_INT(keepalive_ping);
1738 SHOW_INT(keepalive_timeout);
1739 SHOW_INT(inactivity_timeout);
1740 SHOW_INT(session_timeout);
1741 SHOW_INT64(inactivity_minimum_bytes);
1742 SHOW_INT(ping_send_timeout);
1743 SHOW_INT(ping_rec_timeout);
1744 SHOW_INT(ping_rec_timeout_action);
1745 SHOW_BOOL(ping_timer_remote);
1746 SHOW_INT(remap_sigusr1);
1747 SHOW_BOOL(persist_tun);
1748 SHOW_BOOL(persist_local_ip);
1749 SHOW_BOOL(persist_remote_ip);
1750
1751#if PASSTOS_CAPABILITY
1752 SHOW_BOOL(passtos);
1753#endif
1754
1755 SHOW_INT(resolve_retry_seconds);
1756 SHOW_BOOL(resolve_in_advance);
1757
1758 SHOW_STR(username);
1759 SHOW_STR(groupname);
1760 SHOW_STR(chroot_dir);
1761 SHOW_STR(cd_dir);
1762#ifdef ENABLE_SELINUX
1763 SHOW_STR(selinux_context);
1764#endif
1765 SHOW_STR(writepid);
1766 SHOW_STR(up_script);
1767 SHOW_STR(down_script);
1768 SHOW_BOOL(down_pre);
1769 SHOW_BOOL(up_restart);
1770 SHOW_BOOL(up_delay);
1772 SHOW_BOOL(log);
1775 SHOW_INT(nice);
1776 SHOW_INT(verbosity);
1777 SHOW_INT(mute);
1778#ifdef ENABLE_DEBUG
1779 SHOW_INT(gremlin);
1780#endif
1781 SHOW_STR(status_file);
1782 SHOW_INT(status_file_version);
1783 SHOW_INT(status_file_update_freq);
1784
1785 SHOW_BOOL(occ);
1786 SHOW_INT(rcvbuf);
1787 SHOW_INT(sndbuf);
1788#if defined(TARGET_LINUX)
1789 SHOW_INT(mark);
1790#endif
1791 SHOW_INT(sockflags);
1792
1793 SHOW_INT(comp.alg);
1794 SHOW_INT(comp.flags);
1795
1796 SHOW_STR(route_script);
1797 SHOW_STR(route_default_gateway);
1798 SHOW_INT(route_default_metric);
1799 SHOW_INT(route_default_table_id);
1800 SHOW_BOOL(route_noexec);
1801 SHOW_INT(route_delay);
1802 SHOW_INT(route_delay_window);
1803 SHOW_BOOL(route_delay_defined);
1804 SHOW_BOOL(route_nopull);
1805 SHOW_BOOL(route_gateway_via_dhcp);
1806 SHOW_BOOL(allow_pull_fqdn);
1808
1809 if (o->routes)
1810 {
1812 }
1813
1814 if (o->client_nat)
1815 {
1817 }
1818
1820
1821#ifdef ENABLE_MANAGEMENT
1822 SHOW_STR(management_addr);
1823 SHOW_STR(management_port);
1824 SHOW_STR(management_user_pass);
1825 SHOW_INT(management_log_history_cache);
1826 SHOW_INT(management_echo_buffer_size);
1827 SHOW_STR(management_client_user);
1828 SHOW_STR(management_client_group);
1829 SHOW_INT(management_flags);
1830#endif
1831#ifdef ENABLE_PLUGIN
1832 if (o->plugin_list)
1833 {
1835 }
1836#endif
1837
1838 SHOW_STR_INLINE(shared_secret_file);
1839 SHOW_PARM(key_direction, keydirection2ascii(o->key_direction, false, true), "%s");
1840 SHOW_STR(ciphername);
1841 SHOW_STR(ncp_ciphers);
1842 SHOW_STR(authname);
1843#ifndef ENABLE_CRYPTO_MBEDTLS
1844 SHOW_BOOL(engine);
1845#endif /* ENABLE_CRYPTO_MBEDTLS */
1846 SHOW_BOOL(mute_replay_warnings);
1847 SHOW_INT(replay_window);
1848 SHOW_INT(replay_time);
1849 SHOW_STR(packet_id_file);
1851#ifdef ENABLE_PREDICTION_RESISTANCE
1852 SHOW_BOOL(use_prediction_resistance);
1853#endif
1854
1855 SHOW_BOOL(tls_server);
1856 SHOW_BOOL(tls_client);
1857 SHOW_STR_INLINE(ca_file);
1858 SHOW_STR(ca_path);
1859 SHOW_STR_INLINE(dh_file);
1861 {
1862 SHOW_PARM("cert_file", "EXTERNAL_CERT", "%s");
1863 }
1864 else
1865 {
1866 SHOW_STR_INLINE(cert_file);
1867 }
1868 SHOW_STR_INLINE(extra_certs_file);
1869
1871 {
1872 SHOW_PARM("priv_key_file", "EXTERNAL_PRIVATE_KEY", "%s");
1873 }
1874 else
1875 {
1876 SHOW_STR_INLINE(priv_key_file);
1877 }
1878#ifndef ENABLE_CRYPTO_MBEDTLS
1879 SHOW_STR_INLINE(pkcs12_file);
1880#endif
1881#ifdef ENABLE_CRYPTOAPI
1882 SHOW_STR(cryptoapi_cert);
1883#endif
1884 SHOW_STR(cipher_list);
1885 SHOW_STR(cipher_list_tls13);
1886 SHOW_STR(tls_cert_profile);
1888 SHOW_STR(tls_export_peer_cert_dir);
1889 SHOW_INT(verify_x509_type);
1890 SHOW_STR(verify_x509_name);
1891 SHOW_STR_INLINE(crl_file);
1892 SHOW_INT(ns_cert_type);
1893 {
1894 int i;
1895 for (i = 0; i < MAX_PARMS; i++)
1896 {
1897 SHOW_INT(remote_cert_ku[i]);
1898 }
1899 }
1900 SHOW_STR(remote_cert_eku);
1901 if (o->verify_hash)
1902 {
1903 SHOW_INT(verify_hash_algo);
1904 SHOW_INT(verify_hash_depth);
1905 struct gc_arena gc = gc_new();
1906 struct verify_hash_list *hl = o->verify_hash;
1907 int digest_len =
1909 while (hl)
1910 {
1911 char *s = format_hex_ex(hl->hash, digest_len, 0, 1, ":", &gc);
1912 SHOW_PARM(verify_hash, s, "%s");
1913 hl = hl->next;
1914 }
1915 gc_free(&gc);
1916 }
1917 SHOW_INT(ssl_flags);
1918
1919 SHOW_INT(tls_timeout);
1920
1921 SHOW_INT64(renegotiate_bytes);
1922 SHOW_INT64(renegotiate_packets);
1923 SHOW_INT(renegotiate_seconds);
1924
1925 SHOW_INT(handshake_window);
1926 SHOW_INT(transition_window);
1927
1928 SHOW_BOOL(single_session);
1930 SHOW_BOOL(tls_exit);
1931
1932 SHOW_STR(tls_crypt_v2_metadata);
1933
1934#ifdef ENABLE_PKCS11
1935 {
1936 int i;
1937 for (i = 0; i < MAX_PARMS && o->pkcs11_providers[i] != NULL; i++)
1938 {
1939 SHOW_PARM(pkcs11_providers, o->pkcs11_providers[i], "%s");
1940 }
1941 }
1942 {
1943 int i;
1944 for (i = 0; i < MAX_PARMS; i++)
1945 {
1946 SHOW_PARM(pkcs11_protected_authentication,
1947 o->pkcs11_protected_authentication[i] ? "ENABLED" : "DISABLED", "%s");
1948 }
1949 }
1950 {
1951 int i;
1952 for (i = 0; i < MAX_PARMS; i++)
1953 {
1954 SHOW_PARM(pkcs11_private_mode, o->pkcs11_private_mode[i], "%08x");
1955 }
1956 }
1957 {
1958 int i;
1959 for (i = 0; i < MAX_PARMS; i++)
1960 {
1961 SHOW_PARM(pkcs11_cert_private, o->pkcs11_cert_private[i] ? "ENABLED" : "DISABLED",
1962 "%s");
1963 }
1964 }
1965 SHOW_INT(pkcs11_pin_cache_period);
1966 SHOW_STR(pkcs11_id);
1968#endif /* ENABLE_PKCS11 */
1969
1970 show_p2mp_parms(o);
1971
1972#ifdef _WIN32
1973 SHOW_BOOL(show_net_up);
1974 SHOW_INT(route_method);
1975 SHOW_BOOL(block_outside_dns);
1977#endif
1978#endif /* ifndef ENABLE_SMALL */
1979}
1980
1981#undef SHOW_PARM
1982#undef SHOW_STR
1983#undef SHOW_INT
1984#undef SHOW_BOOL
1985
1986#ifdef ENABLE_MANAGEMENT
1987
1988static struct http_proxy_options *
1989parse_http_proxy_override(const char *server, const char *port, const char *flags,
1990 struct gc_arena *gc)
1991{
1992 if (server && port)
1993 {
1994 struct http_proxy_options *ho;
1996 ho->server = string_alloc(server, gc);
1997 ho->port = port;
1998 if (flags && !strcmp(flags, "nct"))
1999 {
2000 ho->auth_retry = PAR_NCT;
2001 }
2002 else
2003 {
2004 ho->auth_retry = PAR_ALL;
2005 }
2006 ho->http_version = "1.0";
2007 ho->user_agent = "OpenVPN-Autoproxy/1.0";
2008 return ho;
2009 }
2010 else
2011 {
2012 return NULL;
2013 }
2014}
2015
2016static void
2018{
2019 const struct connection_list *l = o->connection_list;
2020 int i;
2021 bool succeed = false;
2022 for (i = 0; i < l->len; ++i)
2023 {
2024 struct connection_entry *ce = l->array[i];
2025 if (ce->proto == PROTO_TCP_CLIENT || ce->proto == PROTO_TCP)
2026 {
2028 succeed = true;
2029 }
2030 }
2031 if (succeed)
2032 {
2033 for (i = 0; i < l->len; ++i)
2034 {
2035 struct connection_entry *ce = l->array[i];
2036 if (ce->proto == PROTO_UDP)
2037 {
2038 ce->flags |= CE_DISABLED;
2039 }
2040 }
2041 }
2042 else
2043 {
2044 msg(M_WARN,
2045 "Note: option http-proxy-override ignored because no TCP-based connection profiles are defined");
2046 }
2047}
2048
2049#endif /* ifdef ENABLE_MANAGEMENT */
2050
2051static struct local_list *
2053{
2054 if (!ce->local_list)
2055 {
2057 }
2058 return ce->local_list;
2059}
2060
2061static struct local_entry *
2062alloc_local_entry(struct connection_entry *ce, const msglvl_t msglevel, struct gc_arena *gc)
2063{
2065 struct local_entry *e;
2066
2067 if (l->len >= l->capacity)
2068 {
2069 const int new_cap = l->capacity + 1;
2070 const size_t elem_size = sizeof(*l->array);
2071
2072 struct local_entry **new_array = gc_realloc(l->array, new_cap * elem_size, gc);
2073 if (!new_array)
2074 {
2075 msg(msglevel,
2076 "Unable to process more local options: out of memory. Number of entries = %d",
2077 l->len);
2078 return NULL;
2079 }
2080
2081 l->array = new_array;
2082 l->capacity = new_cap;
2083 }
2084
2085 ALLOC_OBJ_CLEAR_GC(e, struct local_entry, gc);
2086 e->proto = PROTO_NONE;
2087 l->array[l->len++] = e;
2088
2089 return e;
2090}
2091
2092static struct connection_list *
2101
2102static struct connection_entry *
2104{
2106 struct connection_entry *e;
2107
2108 if (l->len == l->capacity)
2109 {
2110 int capacity = l->capacity + CONNECTION_LIST_SIZE;
2111 struct connection_entry **ce =
2112 gc_realloc(l->array, capacity * sizeof(struct connection_entry *), &options->gc);
2113 if (ce == NULL)
2114 {
2115 msg(msglevel,
2116 "Unable to process more connection options: out of memory. Number of entries = %d",
2117 l->len);
2118 return NULL;
2119 }
2120 l->array = ce;
2121 l->capacity = capacity;
2122 }
2124 l->array[l->len++] = e;
2125 return e;
2126}
2127
2128static struct remote_list *
2130{
2131 if (!options->remote_list)
2132 {
2134 }
2135 return options->remote_list;
2136}
2137
2138static struct remote_entry *
2140{
2142 struct remote_entry *e;
2143
2144 if (l->len == l->capacity)
2145 {
2146 int capacity = l->capacity + CONNECTION_LIST_SIZE;
2147 struct remote_entry **re =
2148 gc_realloc(l->array, capacity * sizeof(struct remote_entry *), &options->gc);
2149 if (re == NULL)
2150 {
2151 msg(msglevel,
2152 "Unable to process more remote options: out of memory. Number of entries = %d",
2153 l->len);
2154 return NULL;
2155 }
2156 l->array = re;
2157 l->capacity = capacity;
2158 }
2159 ALLOC_OBJ_GC(e, struct remote_entry, &options->gc);
2160 l->array[l->len++] = e;
2161 return e;
2162}
2163
2164static struct pull_filter_list *
2166{
2167 if (!o->pull_filter_list)
2168 {
2170 }
2171 return o->pull_filter_list;
2172}
2173
2174static struct pull_filter *
2176{
2178 struct pull_filter *f;
2179
2180 ALLOC_OBJ_CLEAR_GC(f, struct pull_filter, &o->gc);
2181 if (l->head)
2182 {
2183 ASSERT(l->tail);
2184 l->tail->next = f;
2185 }
2186 else
2187 {
2188 ASSERT(!l->tail);
2189 l->head = f;
2190 }
2191 l->tail = f;
2192 return f;
2193}
2194
2195static void
2197{
2198 if (re->remote)
2199 {
2200 ce->remote = re->remote;
2201 }
2202 if (re->remote_port)
2203 {
2204 ce->remote_port = re->remote_port;
2205 }
2206 if (re->proto >= 0)
2207 {
2208 ce->proto = re->proto;
2209 }
2210 if (re->af > 0)
2211 {
2212 ce->af = re->af;
2213 }
2214}
2215
2216static void
2217connection_entry_preload_key(const char **key_file, bool *key_inline, struct gc_arena *gc)
2218{
2219 if (key_file && *key_file && !(*key_inline))
2220 {
2221 struct buffer in = buffer_read_from_file(*key_file, gc);
2222 if (!buf_valid(&in))
2223 {
2224 msg(M_FATAL, "Cannot pre-load keyfile (%s)", *key_file);
2225 }
2226
2227 *key_file = (const char *)in.data;
2228 *key_inline = true;
2229 }
2230}
2231
2232static void
2234{
2235#ifdef ENABLE_CRYPTO_MBEDTLS
2236 if (options->ca_path)
2237 {
2238 msg(M_USAGE, "Parameter --capath cannot be used with the mbed TLS version of OpenVPN.");
2239 }
2240#endif
2241
2244 || options->ca_path
2245#endif
2246 )
2247 {
2248 return;
2249 }
2250
2251 const char *const str = "You must define CA file (--ca)"
2252#ifndef ENABLE_CRYPTO_MBEDTLS
2253 " or CA path (--capath)"
2254#endif
2255 " and/or peer fingerprint verification (--peer-fingerprint)";
2256 msg(M_USAGE, "%s", str);
2257}
2258
2259#define MUST_BE_UNDEF(parm, parm_name) \
2260 if (options->parm != defaults.parm) \
2261 { \
2262 msg(M_USAGE, use_err, parm_name); \
2263 }
2264#define MUST_BE_FALSE(condition, parm_name) \
2265 if (condition) \
2266 { \
2267 msg(M_USAGE, use_err, parm_name); \
2268 }
2269
2270static void
2272{
2273 struct options defaults;
2274 int dev = DEV_TYPE_UNDEF;
2275 bool pull = false;
2276
2277 init_options(&defaults, true);
2278
2279 if (!options->test_crypto)
2280 {
2281 notnull(options->dev, "TUN/TAP device (--dev)");
2282 }
2283
2284 /*
2285 * Get tun/tap/null device type
2286 */
2288
2289 /*
2290 * If "proto tcp" is specified, make sure we know whether it is
2291 * tcp-client or tcp-server.
2292 */
2293 if (ce->proto == PROTO_TCP)
2294 {
2295 msg(M_USAGE, "--proto tcp is ambiguous in this context. Please specify "
2296 "--proto tcp-server or --proto tcp-client");
2297 }
2298
2299 /*
2300 * Sanity check on Client mode
2301 */
2302
2303 if (options->mode != MODE_SERVER && ce->local_list->len > 1)
2304 {
2305 msg(M_USAGE, "multiple --local statements only allowed in --server mode");
2306 }
2307
2308 if (options->lladdr && dev != DEV_TYPE_TAP)
2309 {
2310 msg(M_USAGE, "--lladdr can only be used in --dev tap mode");
2311 }
2312
2313 /*
2314 * Sanity check on MTU parameters
2315 */
2317 {
2318 msg(M_USAGE, "only one of --tun-mtu or --link-mtu may be defined");
2319 }
2320
2322 {
2323 msg(M_USAGE, "--mtu-test only makes sense with --proto udp");
2324 }
2325
2326 /* will we be pulling options from server? */
2327 pull = options->pull;
2328
2329 /*
2330 * Sanity check on --local, --remote, and --ifconfig
2331 */
2332
2335 {
2336 msg(M_USAGE, "--local and --remote addresses must be distinct from --ifconfig "
2337 "addresses");
2338 }
2339
2341 {
2342 msg(M_USAGE, "local and remote/netmask --ifconfig addresses must be different");
2343 }
2344
2345 if (ce->bind_defined && !ce->bind_local)
2346 {
2347 msg(M_USAGE, "--bind and --nobind can't be used together");
2348 }
2349
2351 {
2352 msg(M_USAGE, "--lport and --nobind don't make sense when used together");
2353 }
2354
2355 if (!ce->remote && !ce->bind_local)
2356 {
2357 msg(M_USAGE, "--nobind doesn't make sense unless used with --remote");
2358 }
2359
2360 for (int i = 0; i < ce->local_list->len; i++)
2361 {
2362 struct local_entry *le = ce->local_list->array[i];
2363
2364 if (proto_is_net(le->proto) && string_defined_equal(le->local, ce->remote)
2366 {
2367 msg(M_USAGE, "--remote and one of the --local addresses are the same");
2368 }
2369
2372 {
2373 msg(M_USAGE, "--local addresses must be distinct from --ifconfig addresses");
2374 }
2375
2376 if (le->local && !ce->bind_local)
2377 {
2378 msg(M_USAGE, "--local and --nobind don't make sense when used together");
2379 }
2380 }
2381
2382 /*
2383 * Check for consistency of management options
2384 */
2385#ifdef ENABLE_MANAGEMENT
2389 {
2390 msg(M_USAGE,
2391 "--management is not specified, however one or more options which modify the behavior of --management were specified");
2392 }
2393
2396 {
2397 msg(M_USAGE, "--management-client-(user|group) can only be used on unix domain sockets");
2398 }
2399
2402 {
2403 msg(M_WARN, "WARNING: Using --management on a TCP port WITHOUT "
2404 "passwords is STRONGLY discouraged and considered insecure");
2405 }
2406
2407#endif /* ifdef ENABLE_MANAGEMENT */
2408
2409#if !defined(HAVE_XKEY_PROVIDER)
2412 {
2413 msg(M_FATAL, "management-external-key with TLS 1.3 or later requires "
2414 "nopadding argument/support");
2415 }
2416#endif
2417 /*
2418 * Windows-specific options.
2419 */
2420
2421#ifdef _WIN32
2422 if (dev == DEV_TYPE_TUN
2424 {
2425 msg(M_USAGE, "On Windows, --ifconfig is required when --dev tun is used");
2426 }
2427
2430 {
2431 msg(M_USAGE, "On Windows, --ip-win32 doesn't make sense unless --ifconfig is also used");
2432 }
2433
2435 {
2436 const char *prefix = "Some --dhcp-option or --dns options require DHCP server";
2438 {
2439 msg(M_USAGE, "%s, which is not supported by the selected %s driver", prefix,
2441 }
2444 {
2445 msg(M_USAGE, "%s, which requires --ip-win32 dynamic or adaptive", prefix);
2446 }
2447 }
2448#endif /* ifdef _WIN32 */
2449
2450 /*
2451 * Check that protocol options make sense.
2452 */
2453
2454#ifdef ENABLE_FRAGMENT
2455 if (!proto_is_udp(ce->proto) && ce->fragment)
2456 {
2457 msg(M_USAGE, "--fragment can only be used with --proto udp");
2458 }
2459#endif
2460
2461 if (!ce->remote && ce->proto == PROTO_TCP_CLIENT)
2462 {
2463 msg(M_USAGE, "--remote MUST be used in TCP Client mode");
2464 }
2465
2466 if ((ce->http_proxy_options) && ce->proto != PROTO_TCP_CLIENT)
2467 {
2468 msg(M_USAGE, "--http-proxy MUST be used in TCP Client mode (i.e. --proto "
2469 "tcp-client)");
2470 }
2471
2472 if ((ce->http_proxy_options) && !ce->http_proxy_options->server)
2473 {
2474 msg(M_USAGE, "--http-proxy not specified but other http proxy options present");
2475 }
2476
2478 {
2479 msg(M_USAGE, "--http-proxy can not be used together with --socks-proxy");
2480 }
2481
2482 if (ce->socks_proxy_server && ce->proto == PROTO_TCP_SERVER)
2483 {
2484 msg(M_USAGE, "--socks-proxy can not be used in TCP Server mode");
2485 }
2486
2487 if (ce->proto == PROTO_TCP_SERVER && (options->connection_list->len > 1))
2488 {
2489 msg(M_USAGE, "TCP server mode allows at most one --remote address");
2490 }
2491
2492 /*
2493 * Check consistency of --mode server options.
2494 */
2495 if (options->mode == MODE_SERVER)
2496 {
2497 const char use_err[] = "--%s cannot be used with --mode server.";
2498
2499#define USAGE_VALID_SERVER_PROTOS \
2500 "--mode server currently only supports " \
2501 "--proto values of udp, tcp-server, tcp4-server, or tcp6-server"
2502#ifdef TARGET_ANDROID
2503 msg(M_FATAL, "--mode server not supported on Android");
2504#endif
2505 if (!(dev == DEV_TYPE_TUN || dev == DEV_TYPE_TAP))
2506 {
2507 msg(M_USAGE, "--mode server only works with --dev tun or --dev tap");
2508 }
2509 MUST_BE_UNDEF(pull, "pull");
2511 {
2512 msg(M_WARN, "--pull-filter ignored for --mode server");
2513 }
2514 if (!(proto_is_udp(ce->proto) || ce->proto == PROTO_TCP_SERVER))
2515 {
2517 }
2518#if PORT_SHARE
2519 if ((options->port_share_host || options->port_share_port)
2520 && (ce->proto != PROTO_TCP_SERVER))
2521 {
2522 msg(M_USAGE, "--port-share only works in TCP server mode "
2523 "(--proto values of tcp-server, tcp4-server, or tcp6-server)");
2524 }
2525#endif
2526 if (!options->tls_server)
2527 {
2528 msg(M_USAGE, "--mode server requires --tls-server");
2529 }
2530 MUST_BE_FALSE(ce->remote, "remote");
2531 MUST_BE_FALSE(!ce->bind_local, "nobind");
2532 MUST_BE_FALSE(ce->http_proxy_options, "http-proxy");
2533 MUST_BE_FALSE(ce->socks_proxy_server, "socks-proxy");
2534 /* <connection> blocks force to have a remote embedded, so we check
2535 * for the --remote and bail out if it is present
2536 */
2538 {
2539 msg(M_USAGE, "<connection> cannot be used with --mode server");
2540 }
2541
2542 MUST_BE_UNDEF(shaper, "shaper");
2543 if (options->ipchange)
2544 {
2545 msg(M_USAGE, "--ipchange cannot be used with --mode server (use "
2546 "--client-connect instead)");
2547 }
2548 if (!(proto_is_dgram(ce->proto) || ce->proto == PROTO_TCP_SERVER))
2549 {
2551 }
2552 if (!proto_is_udp(ce->proto) && (options->cf_max || options->cf_per))
2553 {
2554 msg(M_USAGE,
2555 "--connect-freq only works with --mode server --proto udp. Try --max-clients instead.");
2556 }
2557 if (!(dev == DEV_TYPE_TAP || (dev == DEV_TYPE_TUN && options->topology == TOP_SUBNET))
2559 {
2560 msg(M_USAGE,
2561 "The third parameter to --ifconfig-pool (netmask) is only valid in --dev tap mode");
2562 }
2564 {
2565 msg(M_USAGE,
2566 "--redirect-gateway cannot be used with --mode server (however --push \"redirect-gateway\" is fine)");
2567 }
2568 MUST_BE_UNDEF(route_delay_defined, "route-delay");
2569 MUST_BE_UNDEF(up_delay, "up-delay");
2572 {
2573 msg(M_USAGE,
2574 "--ifconfig-pool-persist must be used with --ifconfig-pool or --ifconfig-ipv6-pool");
2575 }
2577 {
2578 msg(M_USAGE, "--ifconfig-ipv6-pool needs --ifconfig-ipv6");
2579 }
2580 MUST_BE_UNDEF(allow_recursive_routing, "allow-recursive-routing");
2582 {
2583 msg(M_USAGE,
2584 "--auth-user-pass cannot be used with --mode server (it should be used on the client side only)");
2585 }
2587 {
2588 msg(M_USAGE, "--ccd-exclusive must be used with --client-config-dir");
2589 }
2591 {
2592 msg(M_USAGE, "--auth-gen-token needs a non-infinite "
2593 "--renegotiate_seconds setting");
2594 }
2597 {
2598 msg(M_USAGE,
2599 "--auth-gen-token renewal time needs to be at least "
2600 " two times --hand-window (%d).",
2602 }
2605 {
2606 const char *use_err =
2607 "--%s must be used with --management-client-auth, an --auth-user-pass-verify script, or plugin";
2608
2611 "verify-client-cert none|optional");
2613 "username-as-common-name");
2615 "auth-user-pass-optional");
2616 }
2617
2618 if (options->vlan_tagging && dev != DEV_TYPE_TAP)
2619 {
2620 msg(M_USAGE, "--vlan-tagging must be used with --dev tap");
2621 }
2622 if (!options->vlan_tagging)
2623 {
2624 const char use_err[] = "--%s requires --vlan-tagging";
2625 MUST_BE_UNDEF(vlan_accept, "vlan-accept");
2626 MUST_BE_UNDEF(vlan_pvid, "vlan-pvid");
2627 }
2628 }
2629 else
2630 {
2631 const char use_err[] = "--%s requires --mode server";
2632 /*
2633 * When not in server mode, err if parameters are
2634 * specified which require --mode server.
2635 */
2636 MUST_BE_UNDEF(ifconfig_pool_defined, "ifconfig-pool");
2637 MUST_BE_UNDEF(ifconfig_pool_persist_filename, "ifconfig-pool-persist");
2638 MUST_BE_UNDEF(ifconfig_ipv6_pool_defined, "ifconfig-ipv6-pool");
2639 MUST_BE_UNDEF(real_hash_size, "hash-size");
2640 MUST_BE_UNDEF(virtual_hash_size, "hash-size");
2641 MUST_BE_UNDEF(learn_address_script, "learn-address");
2642 MUST_BE_UNDEF(client_connect_script, "client-connect");
2643 MUST_BE_UNDEF(client_crresponse_script, "client-crresponse");
2644 MUST_BE_UNDEF(client_disconnect_script, "client-disconnect");
2645 MUST_BE_UNDEF(client_config_dir, "client-config-dir");
2646 MUST_BE_UNDEF(ccd_exclusive, "ccd-exclusive");
2647 MUST_BE_UNDEF(enable_c2c, "client-to-client");
2648 MUST_BE_UNDEF(duplicate_cn, "duplicate-cn");
2649 MUST_BE_UNDEF(cf_max, "connect-freq");
2650 MUST_BE_UNDEF(cf_per, "connect-freq");
2653 "verify-client-cert");
2654 MUST_BE_FALSE(options->ssl_flags & SSLF_USERNAME_AS_COMMON_NAME, "username-as-common-name");
2655 MUST_BE_FALSE(options->ssl_flags & SSLF_AUTH_USER_PASS_OPTIONAL, "auth-user-pass-optional");
2657 {
2658 msg(M_WARN, "WARNING: setting tcp-nodelay on the client side will not "
2659 "affect the server. To have TCP_NODELAY in both direction use "
2660 "tcp-nodelay in the server configuration instead.");
2661 }
2662 MUST_BE_UNDEF(auth_user_pass_verify_script, "auth-user-pass-verify");
2663 MUST_BE_UNDEF(auth_token_generate, "auth-gen-token");
2664#if PORT_SHARE
2665 if (options->port_share_host || options->port_share_port)
2666 {
2667 msg(M_USAGE,
2668 "--port-share requires TCP server mode (--mode server --proto tcp-server)");
2669 }
2670#endif
2671 MUST_BE_UNDEF(stale_routes_check_interval, "stale-routes-check");
2672 MUST_BE_UNDEF(vlan_tagging, "vlan-tagging");
2673 MUST_BE_UNDEF(vlan_accept, "vlan-accept");
2674 MUST_BE_UNDEF(vlan_pvid, "vlan-pvid");
2675 MUST_BE_UNDEF(force_key_material_export, "force-key-material-export");
2676
2677 if (options->push_list.head)
2678 {
2679 msg(M_WARN, "Note: Using --push without --mode server is an "
2680 "unsupported configuration. Negotiation of OpenVPN "
2681 "features is expected to fail.");
2682 }
2683 }
2684
2685 /*
2686 * SSL/TLS mode sanity checks.
2687 */
2689 {
2690 msg(M_USAGE, "specify only one of --tls-server, --tls-client, or --secret");
2691 }
2692
2694 {
2695 msglvl_t msglevel = M_USAGE;
2697 {
2698 msglevel = M_INFO;
2699 }
2700
2701 msg(msglevel, "DEPRECATION: No tls-client or tls-server option in "
2702 "configuration detected. OpenVPN 2.8 will remove the "
2703 "functionality to run a VPN without TLS. "
2704 "See the examples section in the manual page for "
2705 "examples of a similar quick setup with peer-fingerprint. "
2706 "OpenVPN 2.7 allows using this configuration when using "
2707 "--allow-deprecated-insecure-static-crypto but you should move "
2708 "to a proper configuration using TLS as soon as possible.");
2709 }
2710
2712 {
2713 msg(M_WARN, "WARNING: POTENTIALLY DANGEROUS OPTION "
2714 "--verify-client-cert none|optional "
2715 "may accept clients which do not present a certificate");
2716 }
2717
2718 const unsigned int tls_version_max =
2720 const unsigned int tls_version_min =
2722
2723 if (tls_version_max > 0 && tls_version_max < tls_version_min)
2724 {
2725 msg(M_USAGE, "--tls-version-min bigger than --tls-version-max");
2726 }
2727
2729 {
2731#ifdef ENABLE_PKCS11
2732 if (!options->pkcs11_providers[0] && options->pkcs11_id)
2733 {
2734 msg(M_WARN, "Option pkcs11-id is ignored as no pkcs11-providers are specified");
2735 }
2736 else if (!options->pkcs11_providers[0] && options->pkcs11_id_management)
2737 {
2738 msg(M_WARN,
2739 "Option pkcs11-id-management is ignored as no pkcs11-providers are specified");
2740 }
2741
2742 if (options->pkcs11_providers[0])
2743 {
2744 if (options->pkcs11_id_management && options->pkcs11_id != NULL)
2745 {
2746 msg(M_USAGE,
2747 "Parameter --pkcs11-id cannot be used when --pkcs11-id-management is also specified.");
2748 }
2749 if (!options->pkcs11_id_management && options->pkcs11_id == NULL)
2750 {
2751 msg(M_USAGE,
2752 "Parameter --pkcs11-id or --pkcs11-id-management should be specified.");
2753 }
2754 const char use_err[] =
2755 "Parameter --%s cannot be used when --pkcs11-provider is also specified.";
2756 MUST_BE_UNDEF(cert_file, "cert");
2757 MUST_BE_UNDEF(priv_key_file, "key");
2758 MUST_BE_UNDEF(pkcs12_file, "pkcs12");
2759 MUST_BE_FALSE(options->management_flags & MF_EXTERNAL_KEY, "management-external-key");
2760 MUST_BE_FALSE(options->management_flags & MF_EXTERNAL_CERT, "management-external-cert");
2761#ifdef ENABLE_CRYPTOAPI
2762 MUST_BE_UNDEF(cryptoapi_cert, "cryptoapicert");
2763#endif
2764 }
2765 else
2766#endif /* ifdef ENABLE_PKCS11 */
2767#ifdef ENABLE_CRYPTOAPI
2769 {
2770 const char use_err[] =
2771 "Parameter --%s cannot be used when --cryptoapicert is also specified.";
2772 MUST_BE_UNDEF(cert_file, "cert");
2773 MUST_BE_UNDEF(priv_key_file, "key");
2774 MUST_BE_UNDEF(pkcs12_file, "pkcs12");
2775 MUST_BE_FALSE(options->management_flags & MF_EXTERNAL_KEY, "management-external-key");
2776 MUST_BE_FALSE(options->management_flags & MF_EXTERNAL_CERT, "management-external-cert");
2777 }
2778 else
2779#endif
2780 if (options->pkcs12_file)
2781 {
2782#ifdef ENABLE_CRYPTO_MBEDTLS
2783 msg(M_USAGE, "Parameter --pkcs12 cannot be used with the mbed TLS version of OpenVPN.");
2784#else
2785 const char use_err[] = "Parameter --%s cannot be used when --pkcs12 is also specified.";
2786 MUST_BE_UNDEF(ca_path, "capath");
2787 MUST_BE_UNDEF(cert_file, "cert");
2788 MUST_BE_UNDEF(priv_key_file, "key");
2789 MUST_BE_FALSE(options->management_flags & MF_EXTERNAL_KEY, "management-external-key");
2790 MUST_BE_FALSE(options->management_flags & MF_EXTERNAL_CERT, "management-external-cert");
2791#endif /* ifdef ENABLE_CRYPTO_MBEDTLS */
2792 }
2793 else /* cert/key from none of pkcs11, pkcs12, cryptoapi */
2794 {
2796 {
2797 msg(M_USAGE, "--key and --management-external-key are mutually exclusive");
2798 }
2800 {
2801 if (options->cert_file)
2802 {
2803 msg(M_USAGE, "--cert and --management-external-cert are mutually exclusive");
2804 }
2806 {
2807 msg(M_USAGE,
2808 "--management-external-cert must be used with --management-external-key");
2809 }
2810 }
2811 if (pull)
2812 {
2813 const int sum =
2815 + ((options->priv_key_file != NULL)
2817
2818 if (sum == 0)
2819 {
2821 {
2822 msg(M_USAGE, "No client-side authentication method is "
2823 "specified. You must use either "
2824 "--cert/--key, --pkcs12, or "
2825 "--auth-user-pass");
2826 }
2827 }
2828 else if (sum != 2)
2829 {
2830 msg(M_USAGE, "If you use one of --cert or --key, you must use them both");
2831 }
2832 }
2833 else
2834 {
2836 {
2838 "certificate file (--cert) or PKCS#12 file (--pkcs12)");
2839 }
2841 {
2843 "private key file (--key) or PKCS#12 file (--pkcs12)");
2844 }
2845 }
2846 }
2847 if (ce->tls_auth_file && ce->tls_crypt_file)
2848 {
2849 msg(M_USAGE, "--tls-auth and --tls-crypt are mutually exclusive");
2850 }
2852 && (ce->tls_auth_file || ce->tls_crypt_file))
2853 {
2854 msg(M_USAGE,
2855 "--tls-crypt-v2, --tls-auth and --tls-crypt are mutually exclusive in client mode");
2856 }
2857 }
2858 else
2859 {
2860 /*
2861 * Make sure user doesn't specify any TLS options
2862 * when in non-TLS mode.
2863 */
2864
2865 const char use_err[] = "Parameter %s can only be specified in TLS-mode, "
2866 "i.e. where --tls-server or --tls-client is also specified.";
2867
2868 MUST_BE_UNDEF(ca_file, "ca");
2869 MUST_BE_UNDEF(ca_path, "capath");
2870 MUST_BE_UNDEF(dh_file, "dh");
2871 MUST_BE_UNDEF(cert_file, "cert");
2872 MUST_BE_UNDEF(priv_key_file, "key");
2873#ifndef ENABLE_CRYPTO_MBEDTLS
2874 MUST_BE_UNDEF(pkcs12_file, "pkcs12");
2875#endif
2876 MUST_BE_UNDEF(cipher_list, "tls-cipher");
2877 MUST_BE_UNDEF(cipher_list_tls13, "tls-ciphersuites");
2878 MUST_BE_UNDEF(tls_cert_profile, "tls-cert-profile");
2879 MUST_BE_UNDEF(tls_verify, "tls-verify");
2880 MUST_BE_UNDEF(tls_export_peer_cert_dir, "tls-export-cert");
2881 MUST_BE_UNDEF(verify_x509_name, "verify-x509-name");
2882 MUST_BE_UNDEF(tls_timeout, "tls-timeout");
2883 MUST_BE_UNDEF(renegotiate_bytes, "reneg-bytes");
2884 MUST_BE_UNDEF(renegotiate_packets, "reneg-pkts");
2885 MUST_BE_UNDEF(renegotiate_seconds, "reneg-sec");
2886 MUST_BE_UNDEF(handshake_window, "hand-window");
2887 MUST_BE_UNDEF(transition_window, "tran-window");
2888 MUST_BE_UNDEF(tls_auth_file, "tls-auth");
2889 MUST_BE_UNDEF(tls_crypt_file, "tls-crypt");
2890 MUST_BE_UNDEF(tls_crypt_v2_file, "tls-crypt-v2");
2891 MUST_BE_UNDEF(single_session, "single-session");
2892 MUST_BE_UNDEF(push_peer_info, "push-peer-info");
2893 MUST_BE_UNDEF(tls_exit, "tls-exit");
2894 MUST_BE_UNDEF(crl_file, "crl-verify");
2895 MUST_BE_UNDEF(ns_cert_type, "ns-cert-type");
2896 MUST_BE_UNDEF(remote_cert_ku[0], "remote-cert-ku");
2897 MUST_BE_UNDEF(remote_cert_eku, "remote-cert-eku");
2898#ifdef ENABLE_PKCS11
2899 MUST_BE_UNDEF(pkcs11_providers[0], "pkcs11-providers");
2900 MUST_BE_UNDEF(pkcs11_private_mode[0], "pkcs11-private-mode");
2901 MUST_BE_UNDEF(pkcs11_id, "pkcs11-id");
2902 MUST_BE_UNDEF(pkcs11_id_management, "pkcs11-id-management");
2903#endif
2904
2905 if (pull)
2906 {
2907 msg(M_USAGE, use_err, "--pull");
2908 }
2909 }
2911 {
2912 msg(M_USAGE, "--auth-user-pass requires --pull");
2913 }
2914
2915 uninit_options(&defaults);
2916}
2917
2918#undef MUST_BE_UNDEF
2919#undef MUST_BE_FALSE
2920
2921static void
2923{
2924 const int dev = dev_type_enum(o->dev, o->dev_type);
2925
2927 {
2928 if (ce->proto == PROTO_TCP)
2929 {
2930 ce->proto = PROTO_TCP_SERVER;
2931 o->ce.proto = ce->proto;
2932 }
2933 }
2934
2935 if (o->mode != MODE_SERVER)
2936 {
2937 if (ce->proto == PROTO_TCP)
2938 {
2939 ce->proto = PROTO_TCP_CLIENT;
2940 o->ce.proto = ce->proto;
2941 }
2942 }
2943
2944 /* an option is present that requires local bind to enabled */
2945 bool need_bind = ce->local_port_defined || ce->bind_defined || ce->local_list;
2946
2947 /* socks proxy is enabled */
2948 bool uses_socks = ce->proto == PROTO_UDP && ce->socks_proxy_server;
2949
2950 /* If binding is not forced by an explicit option and we have (at least)
2951 * one of --tcp-client, --pull (or --client), or socks we do not bind
2952 * locally to have "normal" IP client behaviour of a random source port */
2953 if (!need_bind && (ce->proto == PROTO_TCP_CLIENT || uses_socks || o->pull))
2954 {
2955 ce->bind_local = false;
2956 }
2957
2958 if (!ce->bind_local)
2959 {
2960 ce->local_port = NULL;
2961 }
2962
2963 /* if protocol forcing is enabled, disable all protocols
2964 * except for the forced one
2965 */
2966 if (o->proto_force >= 0 && o->proto_force != ce->proto)
2967 {
2968 ce->flags |= CE_DISABLED;
2969 }
2970
2971 if (ce->http_proxy_options)
2972 {
2974 }
2975
2976 /* our socks code is not fully IPv6 enabled yet (TCP works, UDP not)
2977 * so fall back to IPv4-only (trac #1221)
2978 */
2979 if (ce->socks_proxy_server && proto_is_udp(ce->proto) && ce->af != AF_INET)
2980 {
2981 if (ce->af == AF_INET6)
2982 {
2983 msg(M_INFO, "WARNING: '--proto udp6' is not compatible with "
2984 "'--socks-proxy' today. Forcing IPv4 mode.");
2985 }
2986 else
2987 {
2988 msg(M_INFO, "NOTICE: dual-stack mode for '--proto udp' does not "
2989 "work correctly with '--socks-proxy' today. Forcing IPv4.");
2990 }
2991 ce->af = AF_INET;
2992 }
2993
2994 /*
2995 * Set MTU defaults
2996 */
2997 {
2998 if (!ce->tun_mtu_defined && !ce->link_mtu_defined)
2999 {
3000 ce->tun_mtu_defined = true;
3001 }
3002 if ((dev == DEV_TYPE_TAP) && !ce->tun_mtu_extra_defined)
3003 {
3004 ce->tun_mtu_extra_defined = true;
3006 }
3007 }
3008
3009 /*
3010 * If --mssfix is supplied without a parameter or not specified at all,
3011 * default it to --fragment value, if --fragment is specified and otherwise
3012 * to the default if tun-mtu is 1500
3013 */
3014 if (o->ce.mssfix_default)
3015 {
3016#ifdef ENABLE_FRAGMENT
3017 if (ce->fragment)
3018 {
3019 ce->mssfix = ce->fragment;
3020 }
3021 else
3022#endif
3023 if (ce->tun_mtu_defined)
3024 {
3025 if (o->ce.tun_mtu == TUN_MTU_DEFAULT)
3026 {
3027 /* We want to only set mssfix default value if we use a default
3028 * MTU Size, otherwise the different size of tun should either
3029 * already solve the problem or mssfix might artifically make the
3030 * payload packets smaller without mssfix 0 */
3031 ce->mssfix = MSSFIX_DEFAULT;
3032 ce->mssfix_encap = true;
3033 }
3034 else
3035 {
3036 /* We still apply the mssfix value but only adjust it to the
3037 * size of the tun interface. */
3038 ce->mssfix = ce->tun_mtu;
3039 ce->mssfix_fixed = true;
3040 }
3041 }
3042 }
3043
3044 /*
3045 * Set per-connection block tls-auth/crypt/crypto-v2 fields if undefined.
3046 *
3047 * At the end only one of these will be really set because the parser
3048 * logic prevents configurations where more are set.
3049 */
3050 if (!ce->tls_auth_file && !ce->tls_crypt_file && !ce->tls_crypt_v2_file)
3051 {
3055
3058
3061 }
3062
3063 /* Pre-cache tls-auth/crypt(-v2) key file if
3064 * keys were not already embedded in the config file.
3065 */
3069
3070
3072 {
3073 msg(M_WARN, "NOTICE: --explicit-exit-notify ignored for --proto tcp");
3075 }
3076}
3077
3078static void
3080{
3081 /* use the global port if none is specified */
3082 if (!le->port)
3083 {
3084 le->port = ce->local_port;
3085 }
3086 /* use the global proto if none is specified and
3087 * allow proto bindings on server mode only */
3088 if (!le->proto || mode == MODE_POINT_TO_POINT)
3089 {
3090 le->proto = ce->proto;
3091 }
3092}
3093
3094#ifdef _WIN32
3095/* If iservice is in use, we need def1 method for redirect-gateway */
3096static void
3098{
3099 if (opt->routes && opt->route_method == ROUTE_METHOD_SERVICE
3100 && opt->routes->flags & RG_REROUTE_GW && !(opt->routes->flags & RG_DEF1))
3101 {
3102 msg(M_INFO, "Flag 'def1' added to --redirect-gateway (iservice is in use)");
3103 opt->routes->flags |= RG_DEF1;
3104 }
3105}
3106#endif /* ifdef _WIN32 */
3107
3108/*
3109 * Save/Restore certain option defaults before --pull is applied.
3110 */
3111
3112static void
3114{
3119
3120 if (o->routes)
3121 {
3123 o->pre_connect->routes_defined = true;
3124 }
3125 if (o->routes_ipv6)
3126 {
3129 }
3130 if (o->client_nat)
3131 {
3134 }
3135
3138
3141
3143
3144 /* NCP related options that can be overwritten by a push */
3146 o->pre_connect->authname = o->authname;
3147
3148 /* Ping related options should be reset to the config values on reconnect */
3152
3153 /* Miscellaneous Options */
3154 o->pre_connect->comp = o->comp;
3155}
3156
3157void
3159{
3160 const struct options_pre_connect *pp = o->pre_connect;
3161 if (pp)
3162 {
3164 if (pp->tuntap_options_defined)
3165 {
3167 }
3168
3169 if (pp->routes_defined)
3170 {
3171 rol_check_alloc(o);
3173 }
3174 else
3175 {
3176 o->routes = NULL;
3177 }
3178
3179 if (pp->routes_ipv6_defined)
3180 {
3183 }
3184 else
3185 {
3186 o->routes_ipv6 = NULL;
3187 }
3188
3191
3194
3195 /* Free DNS options and reset them to pre-pull state */
3196 gc_free(&o->dns_options.gc);
3197 struct gc_arena dns_gc = gc_new();
3198 o->dns_options = clone_dns_options(&pp->dns_options, &dns_gc);
3199 o->dns_options.gc = dns_gc;
3200
3201 if (pp->client_nat_defined)
3202 {
3205 }
3206 else
3207 {
3208 o->client_nat = NULL;
3209 }
3210
3212
3213 o->ciphername = pp->ciphername;
3214 o->authname = pp->authname;
3215
3219
3220 /* Miscellaneous Options */
3221 o->comp = pp->comp;
3222 }
3223
3224 o->push_continuation = 0;
3228}
3229
3230static void
3232{
3233#ifdef _WIN32
3234 const int dev = dev_type_enum(options->dev, options->dev_type);
3235
3236 /* when using ovpn-dco, kernel doesn't send DHCP requests, so don't use it */
3240 {
3242 }
3243
3244 if ((dev == DEV_TYPE_TUN || dev == DEV_TYPE_TAP) && !options->route_delay_defined)
3245 {
3246 /* delay may only be necessary when we perform DHCP handshake */
3249 if ((options->mode == MODE_POINT_TO_POINT) && dhcp)
3250 {
3252 options->route_delay = 5; /* Vista sometimes has a race without this */
3253 }
3254 }
3255
3257 {
3259 options->ifconfig_noexec = false;
3260 }
3261
3263
3264 /*
3265 * Check consistency of --mode server options.
3266 */
3267 if (options->mode == MODE_SERVER)
3268 {
3269 /*
3270 * We need to explicitly set --tap-sleep because
3271 * we do not schedule event timers in the top-level context.
3272 */
3275 {
3277 }
3279 }
3280#endif /* ifdef _WIN32 */
3281
3282#ifdef DEFAULT_PKCS11_MODULE
3283 /* If p11-kit is present on the system then load its p11-kit-proxy.so
3284 * by default if the user asks for PKCS#11 without otherwise specifying
3285 * the module to use. */
3286 if (!options->pkcs11_providers[0] && (options->pkcs11_id || options->pkcs11_id_management))
3287 {
3288 options->pkcs11_providers[0] = DEFAULT_PKCS11_MODULE;
3289 }
3290#endif
3291}
3292
3293static void
3295{
3296 if (o->connection_list)
3297 {
3298 int i;
3299 for (i = 0; i < o->connection_list->len; ++i)
3300 {
3302 }
3303 }
3304 else
3305 {
3307 }
3308
3310
3311 if (dco_enabled(o))
3312 {
3313 if (o->enable_c2c)
3314 {
3315 msg(M_WARN, "Note: --client-to-client has no effect when using data "
3316 "channel offload: packets are always sent to the VPN "
3317 "interface and then routed based on the system routing table");
3318 }
3319
3320 if (o->renegotiate_bytes > 0 || o->renegotiate_packets)
3321 {
3322 msg(M_WARN, "Note: '--reneg-bytes' and '--reneg-pkts' are not supported "
3323 "by data channel offload; automatic key renegotiation "
3324 "mechanisms are sufficient for modern ciphers. "
3325 "Ignoring these options.");
3326 }
3327 }
3328}
3329
3330static void
3332{
3333 if (!o->pull && !(o->mode == MODE_SERVER))
3334 {
3335 /* If the cipher is not set, use the old default of BF-CBC. We will
3336 * warn that this is deprecated on cipher initialisation, no need
3337 * to warn here as well */
3338 if (!o->ciphername)
3339 {
3340 o->ciphername = "BF-CBC";
3341 }
3342 else
3343 {
3344 o->enable_ncp_fallback = true;
3345 }
3346 return;
3347 }
3348
3349 /* pull or P2MP mode */
3350 if (!o->ciphername)
3351 {
3352 /* We still need to set the ciphername to BF-CBC since various other
3353 * parts of OpenVPN assert that the ciphername is set */
3354 o->ciphername = "BF-CBC";
3355
3356 msg(M_INFO,
3357 "Note: --cipher is not set. OpenVPN versions before 2.5 "
3358 "defaulted to BF-CBC as fallback when cipher negotiation "
3359 "failed in this case. If you need this fallback please add "
3360 "'--data-ciphers-fallback BF-CBC' to your configuration "
3361 "and/or add BF-CBC to --data-ciphers. E.g. "
3362 "--data-ciphers %s:BF-CBC",
3363 o->ncp_ciphers_conf);
3364 }
3366 {
3367 msg(M_WARN,
3368 "DEPRECATED OPTION: --cipher set to '%s' but missing in "
3369 "--data-ciphers (%s). OpenVPN ignores --cipher for cipher "
3370 "negotiations. ",
3372 }
3373}
3374
3390static bool
3391need_compatibility_before(const struct options *o, unsigned int version)
3392{
3393 return o->backwards_compatible != 0 && o->backwards_compatible < version;
3394}
3395
3400static void
3402{
3403 /* TLS min version is not set */
3404 unsigned int tls_ver_min = (o->ssl_flags >> SSLF_TLS_VERSION_MIN_SHIFT) & SSLF_TLS_VERSION_MIN_MASK;
3405 if (tls_ver_min == 0)
3406 {
3407 unsigned int tls_ver_max = (o->ssl_flags >> SSLF_TLS_VERSION_MAX_SHIFT) & SSLF_TLS_VERSION_MAX_MASK;
3408 if (need_compatibility_before(o, 20307))
3409 {
3410 /* 2.3.6 and earlier have TLS 1.0 only, set minimum to TLS 1.0 */
3412 }
3413 else if (tls_ver_max == 0 || tls_ver_max >= TLS_VER_1_2)
3414 {
3415 /* Use TLS 1.2 as proper default */
3417 }
3418 else
3419 {
3420 /* Maximize the minimum version */
3421 o->ssl_flags |= (tls_ver_max << SSLF_TLS_VERSION_MIN_SHIFT);
3422 }
3423 }
3424
3425 if (need_compatibility_before(o, 20400))
3426 {
3427 if (!o->ciphername)
3428 {
3429 /* If ciphername is not set default to BF-CBC when targeting these
3430 * old versions that do not have NCP */
3431 o->ciphername = "BF-CBC";
3432 }
3433 /* Versions < 2.4.0 additionally might be compiled with --enable-small and
3434 * not have OCC strings required for "poor man's NCP" */
3435 o->enable_ncp_fallback = true;
3436 }
3437
3438 /* Versions < 2.5.0 do need --cipher in the list of accepted ciphers.
3439 * Version 2.4 probably does not need it but NCP was not so
3440 * good with 2.4 and ncp-disable might be more common on 2.4 peers.
3441 * Only do this iff --cipher is set (explicitly or by compat mode
3442 * < 2.4.0, see above). This is not 100% correct backwards compatible
3443 * behaviour but 2.5 already behaved like this */
3444 if (o->ciphername && need_compatibility_before(o, 20500)
3446 {
3448 }
3449
3450#ifdef USE_COMP
3451 /* Compression is deprecated and we do not want to announce support for it
3452 * by default anymore, additionally DCO breaks with compression.
3453 *
3454 * Disable compression by default starting with 2.6.0 if no other
3455 * compression related option has been explicitly set */
3456 if (!need_compatibility_before(o, 20600) && (o->comp.flags == 0))
3457 {
3458 if (!comp_non_stub_enabled(&o->comp))
3459 {
3461 }
3462 }
3463#else /* ifdef USE_COMP */
3465#endif
3466}
3467
3468static void
3470{
3471 if (!check_tls_prf_working())
3472 {
3473 msg(D_TLS_ERRORS, "Warning: TLS 1.0 PRF with MD5+SHA1 PRF is not "
3474 "supported by the TLS library. Your system does not support this "
3475 "calculation anymore or your security policy (e.g. FIPS 140-2) "
3476 "forbids it. Connections will only work with peers running "
3477 "OpenVPN 2.6.0 or higher)");
3478 if (o->mode == MODE_SERVER)
3479 {
3480 msg(M_WARN, "Automatically enabling option "
3481 "--force-tls-key-material-export");
3482 o->force_key_material_export = true;
3483 }
3484 }
3485}
3486
3487#if defined(_WIN32) || defined(TARGET_ANDROID)
3496static void
3498{
3499 struct dns_options *dns = &o->dns_options;
3500 struct tuntap_options *tt = &o->tuntap_options;
3501 if (!dns->servers)
3502 {
3503 /* Copy --dhcp-options to tuntap_options */
3504 struct dhcp_options *dhcp = &dns->from_dhcp;
3505 ASSERT(sizeof(dhcp->dns) == sizeof(tt->dns));
3506 ASSERT(sizeof(dhcp->dns6) == sizeof(tt->dns6));
3507 ASSERT(sizeof(dhcp->domain_search_list) == sizeof(tt->domain_search_list));
3508
3509 tt->domain = dhcp->domain;
3510 tt->dns_len = dhcp->dns_len;
3511 tt->dns6_len = dhcp->dns6_len;
3512
3513 memcpy(tt->dns, dhcp->dns, sizeof(tt->dns));
3514 memcpy(tt->dns6, dhcp->dns6, sizeof(tt->dns6));
3515
3516 tt->domain_search_list_len = dhcp->domain_search_list_len;
3517 for (size_t i = 0; i < SIZE(tt->domain_search_list); ++i)
3518 {
3519 tt->domain_search_list[i] = dhcp->domain_search_list[i];
3520 }
3521
3522 return;
3523 }
3524
3525#if defined(_WIN32)
3527 {
3528 return; /* Not in DHCP mode */
3529 }
3530#endif /* if defined(_WIN32) */
3531
3532 /* Copy --dns options to tuntap_options */
3533
3534 const struct dns_domain *d = dns->search_domains;
3535 if (d)
3536 {
3537 tt->domain_search_list_len = 0;
3538 }
3539
3540 while (d && tt->domain_search_list_len + 1 < N_SEARCH_LIST_LEN)
3541 {
3543 d = d->next;
3544 }
3545 if (d)
3546 {
3547 msg(M_WARN, "WARNING: couldn't copy all --dns search-domains to TUN/TAP");
3548 }
3549
3550 tt->dns_len = 0;
3551 tt->dns6_len = 0;
3552
3553 const struct dns_server *s = dns->servers;
3554 while (s)
3555 {
3556 bool non_standard_server_port = false;
3557 for (int i = 0; i < s->addr_count; ++i)
3558 {
3559 if (s->addr[i].port && s->addr[i].port != 53)
3560 {
3561 non_standard_server_port = true;
3562 break;
3563 }
3564 }
3565 if ((s->transport && s->transport != DNS_TRANSPORT_PLAIN)
3566 || (s->dnssec && s->dnssec != DNS_SECURITY_NO) || non_standard_server_port)
3567 {
3568 /* Skip servers requiring unsupported config to be set */
3569 s = s->next;
3570 }
3571 else
3572 {
3573 bool overflow = false;
3574 for (int i = 0; i < s->addr_count; ++i)
3575 {
3576 if (s->addr[i].family == AF_INET && tt->dns_len + 1 < N_DHCP_ADDR)
3577 {
3578 tt->dns[tt->dns_len++] = ntohl(s->addr[i].in.a4.s_addr);
3579 }
3580 else if (tt->dns6_len + 1 < N_DHCP_ADDR)
3581 {
3582 tt->dns6[tt->dns6_len++] = s->addr[i].in.a6;
3583 }
3584 else
3585 {
3586 overflow = true;
3587 }
3588 }
3589 if (overflow)
3590 {
3591 msg(M_WARN, "WARNING: couldn't copy all --dns server addresses to TUN/TAP");
3592 }
3594 return;
3595 }
3596 }
3597}
3598
3599#else /* if defined(_WIN32) || defined(TARGET_ANDROID) */
3600
3611static void
3612dhcp_options_postprocess_dns(struct options *o, struct env_set *es)
3613{
3614 struct gc_arena gc = gc_new();
3615 struct dns_options *dns = &o->dns_options;
3616
3617 if (is_tun_afunix(o->dev_node))
3618 {
3619 /* Disable running dns-updown script with lwipovpn */
3621 dns->updown = NULL;
3622 }
3623
3624 if (dns->servers || dns_updown_user_set(dns) || dns_updown_forced(dns))
3625 {
3626 /* Clean up env from --dhcp-option DNS config */
3627 struct buffer name = alloc_buf_gc(OPTION_PARM_SIZE, &gc);
3628 struct buffer value = alloc_buf_gc(OPTION_PARM_SIZE, &gc);
3629
3630 const int fo_count = o->foreign_option_index;
3631 o->foreign_option_index = 0;
3632
3633 for (int i = 1; i <= fo_count; ++i)
3634 {
3635 buf_clear(&name);
3636 buf_printf(&name, "foreign_option_%d", i);
3637 const char *env_str = env_set_get(es, BSTR(&name));
3638 const char *item_val = strchr(env_str, '=') + 1;
3639 buf_clear(&value);
3640 buf_printf(&value, "%s", item_val);
3641
3642 /* Remove foreign option item from env set */
3643 env_set_del(es, BSTR(&name));
3644
3645 item_val = BSTR(&value);
3646 if (strncmp(item_val, "dhcp-option ", 12) != 0
3647 || (strncmp(item_val + 12, "ADAPTER-DOMAIN-SUFFIX ", 22) != 0
3648 && strncmp(item_val + 12, "DOMAIN-SEARCH ", 14) != 0
3649 && strncmp(item_val + 12, "DOMAIN ", 7) != 0
3650 && strncmp(item_val + 12, "DNS6 ", 5) != 0
3651 && strncmp(item_val + 12, "DNS ", 4) != 0))
3652 {
3653 /* Re-set the item with potentially updated name */
3654 buf_clear(&name);
3655 buf_printf(&name, "foreign_option_%d", ++o->foreign_option_index);
3656 setenv_str(es, BSTR(&name), BSTR(&value));
3657 }
3658 }
3659 }
3660
3661 if (!dns->servers)
3662 {
3663 /* Copy --dhcp-options to dns_options */
3664 struct dhcp_options *dhcp = &dns->from_dhcp;
3665
3666 if (dhcp->dns_len || dhcp->dns6_len)
3667 {
3668 struct dns_domain **entry = &dns->search_domains;
3669 ALLOC_OBJ_CLEAR_GC(*entry, struct dns_domain, &dns->gc);
3670 struct dns_domain *new = *entry;
3671 new->name = dhcp->domain;
3672 entry = &new->next;
3673
3674 for (size_t i = 0; i < dhcp->domain_search_list_len; ++i)
3675 {
3676 ALLOC_OBJ_CLEAR_GC(*entry, struct dns_domain, &dns->gc);
3677 struct dns_domain *new = *entry;
3678 new->name = dhcp->domain_search_list[i];
3679 entry = &new->next;
3680 }
3681
3682 struct dns_server *server = dns_server_get(&dns->servers, 0, &dns->gc);
3683 const size_t max_addrs = SIZE(server->addr);
3684 for (size_t i = 0; i < dhcp->dns_len && server->addr_count < max_addrs; ++i)
3685 {
3686 server->addr[server->addr_count].in.a4.s_addr = htonl(dhcp->dns[i]);
3687 server->addr[server->addr_count].family = AF_INET;
3688 server->addr_count += 1;
3689 }
3690 for (size_t i = 0; i < dhcp->dns6_len && server->addr_count < max_addrs; ++i)
3691 {
3692 server->addr[server->addr_count].in.a6 = dhcp->dns6[i];
3693 server->addr[server->addr_count].family = AF_INET6;
3694 server->addr_count += 1;
3695 }
3696 }
3697 }
3698 else if (o->up_script && !dns_updown_user_set(dns) && !dns_updown_forced(dns))
3699 {
3700 /* Set foreign option env vars from --dns config */
3701 const struct dns_domain *d = dns->search_domains;
3702 while (d)
3703 {
3704 setenv_foreign_option(o, "DOMAIN", d->name, es);
3705 d = d->next;
3706 }
3707
3708 const struct dns_server *s = dns->servers;
3709 while (s)
3710 {
3711 bool non_standard_server_port = false;
3712 for (int i = 0; i < s->addr_count; ++i)
3713 {
3714 if (s->addr[i].port && s->addr[i].port != 53)
3715 {
3716 non_standard_server_port = true;
3717 break;
3718 }
3719 }
3720 if ((s->transport && s->transport != DNS_TRANSPORT_PLAIN)
3721 || (s->dnssec && s->dnssec != DNS_SECURITY_NO) || non_standard_server_port)
3722 {
3723 /* Skip servers requiring unsupported config to be set */
3724 s = s->next;
3725 }
3726 else
3727 {
3728 for (int i = 0; i < s->addr_count; ++i)
3729 {
3730 const char *option;
3731 const char *value;
3732 if (s->addr[i].family == AF_INET)
3733 {
3734 option = "DNS";
3735 value = print_in_addr_t(s->addr[i].in.a4.s_addr, IA_NET_ORDER, &gc);
3736 }
3737 else
3738 {
3739 option = "DNS6";
3740 value = print_in6_addr(s->addr[i].in.a6, 0, &gc);
3741 }
3742 setenv_foreign_option(o, option, value, es);
3743 }
3744 break;
3745 }
3746 }
3747 }
3748
3749 gc_free(&gc);
3750}
3751#endif /* if defined(_WIN32) || defined(TARGET_ANDROID) */
3752
3753static void
3755{
3756 int i;
3757 /*
3758 * Process helper-type options which map to other, more complex
3759 * sequences of options.
3760 */
3762 /* must be called after helpers that might set --mode */
3766
3770
3773 if (o->ncp_ciphers == NULL)
3774 {
3775 msg(M_USAGE, "--data-ciphers list contains unsupported ciphers or is too long.");
3776 }
3777
3778 if (o->remote_list && !o->connection_list)
3779 {
3780 /*
3781 * Convert remotes into connection list
3782 */
3783 const struct remote_list *rl = o->remote_list;
3784 for (i = 0; i < rl->len; ++i)
3785 {
3786 const struct remote_entry *re = rl->array[i];
3787 struct connection_entry ce = o->ce;
3788 struct connection_entry *ace;
3789
3790 ASSERT(re->remote);
3791 connection_entry_load_re(&ce, re);
3793 ASSERT(ace);
3794 *ace = ce;
3795 }
3796 }
3797 else if (!o->remote_list && !o->connection_list)
3798 {
3799 struct connection_entry *ace;
3801 ASSERT(ace);
3802 *ace = o->ce;
3803 }
3804
3806 for (i = 0; i < o->connection_list->len; ++i)
3807 {
3809 }
3810
3811 if (o->ce.local_list)
3812 {
3813 for (i = 0; i < o->ce.local_list->len; i++)
3814 {
3816 }
3817
3818 for (int i = 0; i < o->ce.local_list->len; i++)
3819 {
3820 if (o->ce.local_list->array[i]->proto == PROTO_TCP)
3821 {
3823 }
3824 else if (o->ce.local_list->array[i]->proto == PROTO_NONE)
3825 {
3826 o->ce.local_list->array[i]->proto = o->ce.proto;
3827 }
3828 }
3829 }
3830 else
3831 {
3832 /* if no 'local' directive was specified, convert the global port
3833 * setting to a listen entry */
3834 struct local_entry *e = alloc_local_entry(&o->ce, M_USAGE, &o->gc);
3835 ASSERT(e);
3836 e->port = o->ce.local_port;
3837 e->proto = o->ce.proto;
3838 }
3839
3840 /* use the same listen list for every outgoing connection */
3841 for (i = 0; i < o->connection_list->len; ++i)
3842 {
3844 }
3845
3846 if (o->tls_server)
3847 {
3848 if (o->dh_file && streq(o->dh_file, "none"))
3849 {
3850 o->dh_file = NULL;
3851 }
3852 }
3853 else if (o->dh_file)
3854 {
3855 /* DH file is only meaningful in a tls-server context. */
3856 msg(M_WARN, "WARNING: Ignoring option 'dh' in tls-client mode, please only "
3857 "include this in your server configuration");
3858 o->dh_file = NULL;
3859 }
3860#if ENABLE_MANAGEMENT
3861 if (o->http_proxy_override)
3862 {
3864 }
3865#endif
3866 if (!o->ca_file && !o->ca_path && o->verify_hash && o->verify_hash_depth == 0)
3867 {
3868 msg(M_INFO, "Using certificate fingerprint to verify peer (no CA "
3869 "option set). ");
3870 o->verify_hash_no_ca = true;
3871 }
3872
3873 if (o->config && streq(o->config, "stdin") && o->remap_sigusr1 == SIGHUP)
3874 {
3875 msg(M_USAGE, "Options 'config stdin' and 'remap-usr1 SIGHUP' are "
3876 "incompatible with each other.");
3877 }
3878
3879 if (dco_enabled(o))
3880 {
3881 /* check if any option should force disabling DCO */
3883 }
3884#ifdef USE_COMP
3885 if (dco_enabled(o))
3886 {
3888 }
3889#endif
3890
3891#ifdef _WIN32
3892 if (dco_enabled(o))
3893 {
3895 }
3896 else
3897 {
3899 }
3900#else /* _WIN32 */
3901 if (dco_enabled(o) && o->dev_node)
3902 {
3903 msg(M_WARN, "Note: ignoring --dev-node as it has no effect when using "
3904 "data channel offload");
3905 o->dev_node = NULL;
3906 }
3907#endif /* _WIN32 */
3908
3909 /* this depends on o->windows_driver, which is set above */
3911
3912 /* check that compression settings in the options are okay */
3914
3915 /*
3916 * Save certain parms before modifying options during connect, especially
3917 * when using --pull
3918 */
3919 if (o->pull)
3920 {
3922 }
3923 else
3924 {
3925#if defined(_WIN32) || defined(TARGET_ANDROID)
3927#else
3928 dhcp_options_postprocess_dns(o, es);
3929#endif
3930 }
3932 {
3934 }
3936}
3937
3938/*
3939 * Check file/directory sanity
3940 *
3941 */
3942/* Expect people using the stripped down version to know what they do */
3943#ifndef ENABLE_SMALL
3944
3945#define CHKACC_FILE (1 << 0)
3946#define CHKACC_DIRPATH (1 << 1)
3947#define CHKACC_FILEXSTWR (1 << 2)
3948#define CHKACC_ACPTSTDIN (1 << 3)
3949#define CHKACC_PRIVATE (1 << 4)
3950#define CHKACC_ACCEPT_URI (1 << 5)
3952static bool
3953check_file_access(const int type, const char *file, const int mode, const char *opt)
3954{
3955 int errcode = 0;
3956
3957 /* If no file configured, no errors to look for */
3958 if (!file)
3959 {
3960 return false;
3961 }
3962
3963 /* If stdin is allowed and the file name is 'stdin', then do no
3964 * further checks as stdin is always available
3965 */
3966 if ((type & CHKACC_ACPTSTDIN) && streq(file, "stdin"))
3967 {
3968 return false;
3969 }
3970
3971 /* file name is a URI if its first segment has ":" (i.e., before any "/")
3972 * Then no checks done if CHKACC_ACCEPT_URI is set and the URI does not start with "file:"
3973 */
3974 if ((type & CHKACC_ACCEPT_URI) && strchr(file, ':'))
3975 {
3976 if (!strncmp(file, "file:", 5))
3977 {
3978 file += 5;
3979 }
3980 else if (!strchr(file, '/') || strchr(file, '/') > strchr(file, ':'))
3981 {
3982 return false;
3983 }
3984 }
3985
3986 /* Is the directory path leading to the given file accessible? */
3987 if (type & CHKACC_DIRPATH)
3988 {
3989 char *fullpath =
3990 string_alloc(file, NULL); /* POSIX dirname() implementation may modify its arguments */
3991 char *dirpath = dirname(fullpath);
3992
3993 if (platform_access(dirpath, mode | X_OK) != 0)
3994 {
3995 errcode = errno;
3996 }
3997 free(fullpath);
3998 }
3999
4000 /* Is the file itself accessible? */
4001 if (!errcode && (type & CHKACC_FILE) && (platform_access(file, mode) != 0))
4002 {
4003 errcode = errno;
4004 }
4005
4006 /* If the file exists and is accessible, is it writable? */
4007 if (!errcode && (type & CHKACC_FILEXSTWR) && (platform_access(file, F_OK) == 0))
4008 {
4009 if (platform_access(file, W_OK) != 0)
4010 {
4011 errcode = errno;
4012 }
4013 }
4014
4015 /* Warn if a given private file is group/others accessible. */
4016 if (type & CHKACC_PRIVATE)
4017 {
4018 platform_stat_t st;
4019 if (platform_stat(file, &st))
4020 {
4021 msg(M_WARN | M_ERRNO, "WARNING: cannot stat file '%s'", file);
4022 }
4023#ifndef _WIN32
4024 else
4025 {
4026 if (st.st_mode & (S_IRWXG | S_IRWXO))
4027 {
4028 msg(M_WARN, "WARNING: file '%s' is group or others accessible", file);
4029 }
4030 }
4031#endif
4032 }
4033
4034 /* Scream if an error is found */
4035 if (errcode > 0)
4036 {
4037 msg(M_NOPREFIX | M_OPTERR | M_ERRNO, "%s fails with '%s'", opt, file);
4038 }
4039
4040 /* Return true if an error occurred */
4041 return (errcode != 0 ? true : false);
4042}
4043
4044/* A wrapper for check_file_access() which also takes a chroot directory.
4045 * If chroot is NULL, behaviour is exactly the same as calling check_file_access() directly,
4046 * otherwise it will look for the file inside the given chroot directory instead.
4047 */
4048static bool
4049check_file_access_chroot(const char *chroot, const int type, const char *file, const int mode,
4050 const char *opt)
4051{
4052 bool ret = false;
4053
4054 /* If no file configured, no errors to look for */
4055 if (!file)
4056 {
4057 return false;
4058 }
4059
4060 /* If chroot is set, look for the file/directory inside the chroot */
4061 if (chroot)
4062 {
4063 struct gc_arena gc = gc_new();
4064 struct buffer chroot_file;
4065
4066 chroot_file = prepend_dir(chroot, file, &gc);
4067 ret = check_file_access(type, BSTR(&chroot_file), mode, opt);
4068 gc_free(&gc);
4069 }
4070 else
4071 {
4072 /* No chroot in play, just call core file check function */
4073 ret = check_file_access(type, file, mode, opt);
4074 }
4075 return ret;
4076}
4077
4082static bool
4083check_file_access_chroot_inline(bool is_inline, const char *chroot, const int type,
4084 const char *file, const int mode, const char *opt)
4085{
4086 if (is_inline)
4087 {
4088 return false;
4089 }
4090
4091 return check_file_access_chroot(chroot, type, file, mode, opt);
4092}
4093
4098static bool
4099check_file_access_inline(bool is_inline, const int type, const char *file, const int mode,
4100 const char *opt)
4101{
4102 if (is_inline)
4103 {
4104 return false;
4105 }
4106
4107 return check_file_access(type, file, mode, opt);
4108}
4109
4110/*
4111 * Verifies that the path in the "command" that comes after certain script options (e.g., --up) is a
4112 * valid file with appropriate permissions.
4113 *
4114 * "command" consists of a path, optionally followed by a space, which may be
4115 * followed by arbitrary arguments. It is NOT a full shell command line -- shell expansion is not
4116 * performed.
4117 *
4118 * The path and arguments in "command" may be single- or double-quoted or escaped.
4119 *
4120 * The path is extracted from "command", then check_file_access() is called to check it. The
4121 * arguments, if any, are ignored.
4122 *
4123 * Note that the type, mode, and opt arguments to this routine are the same as the corresponding
4124 * check_file_access() arguments.
4125 */
4126static bool
4127check_cmd_access(const char *command, const char *opt, const char *chroot)
4128{
4129 struct argv argv;
4130 bool return_code;
4131
4132 /* If no command was set, there are no errors to look for */
4133 if (!command)
4134 {
4135 return false;
4136 }
4137
4138 /* Extract executable path and arguments */
4139 argv = argv_new();
4140 argv_parse_cmd(&argv, command);
4141
4142 /* if an executable is specified then check it; otherwise, complain */
4143 if (argv.argv[0])
4144 {
4145 /* Scripts requires R_OK as well, but that might fail on binaries which
4146 * only requires X_OK to function on Unix - a scenario not unlikely to
4147 * be seen on suid binaries.
4148 */
4149 return_code = check_file_access_chroot(chroot, CHKACC_FILE, argv.argv[0], X_OK, opt);
4150 }
4151 else
4152 {
4153 msg(M_NOPREFIX | M_OPTERR, "%s fails with '%s': No path to executable.", opt, command);
4154 return_code = true;
4155 }
4156
4157 argv_free(&argv);
4158
4159 return return_code;
4160}
4161
4162/*
4163 * Sanity check of all file/dir options. Checks that file/dir
4164 * is accessible by OpenVPN
4165 */
4166static void
4168{
4169 bool errs = false;
4170
4171 /* ** SSL/TLS/crypto related files ** */
4173 "--dh");
4174
4176 {
4178 R_OK, "--ca");
4179 }
4180
4182 "--capath");
4183
4185 options->cert_file, R_OK, "--cert");
4186
4188 options->extra_certs_file, R_OK, "--extra-certs");
4189
4191 {
4194 options->priv_key_file, R_OK, "--key");
4195 }
4196
4198 options->pkcs12_file, R_OK, "--pkcs12");
4199
4201 {
4203 R_OK | X_OK, "--crl-verify directory");
4204 }
4205 else
4206 {
4207 errs |=
4209 CHKACC_FILE, options->crl_file, R_OK, "--crl-verify");
4210 }
4211
4213 {
4214 errs |=
4216 options->tls_export_peer_cert_dir, W_OK, "--tls-export-cert");
4217 }
4218
4220 for (int i = 0; i < options->connection_list->len; ++i)
4221 {
4223
4225 ce->tls_auth_file, R_OK, "--tls-auth");
4227 ce->tls_crypt_file, R_OK, "--tls-crypt");
4229 ce->tls_crypt_v2_file, R_OK, "--tls-crypt-v2");
4230 }
4231
4232 errs |=
4234 options->shared_secret_file, R_OK, "--secret");
4235
4237 R_OK | W_OK, "--replay-persist");
4238
4239 /* ** Password files ** */
4241 options->key_pass_file, R_OK, "--askpass");
4242#ifdef ENABLE_MANAGEMENT
4243 errs |=
4245 options->management_user_pass, R_OK, "--management user/password file");
4246#endif /* ENABLE_MANAGEMENT */
4249 options->auth_user_pass_file, R_OK, "--auth-user-pass");
4250 /* ** System related ** */
4251 errs |= check_file_access(CHKACC_FILE, options->chroot_dir, R_OK | X_OK, "--chroot directory");
4253 "--writepid");
4254
4255 /* ** Log related ** */
4257 "--status");
4258
4259 /* ** Config related ** */
4261 R_OK | X_OK, "--client-config-dir");
4263 R_OK | W_OK | X_OK, "Temporary directory (--tmp-dir)");
4264
4265 if (errs)
4266 {
4267 msg(M_USAGE, "Please correct these errors.");
4268 }
4269}
4270#endif /* !ENABLE_SMALL */
4271
4272/*
4273 * Sanity check on options.
4274 * Also set some options based on other
4275 * options.
4276 */
4277void
4279{
4282#ifndef ENABLE_SMALL
4284#endif /* !ENABLE_SMALL */
4285}
4286
4287/*
4288 * Sanity check on options after more options were pulled from server.
4289 * Also time to modify some options based on other options.
4290 */
4291bool
4293{
4294 bool success = dns_options_verify(D_PUSH_ERRORS, &o->dns_options);
4295 if (success)
4296 {
4298#if defined(_WIN32) || defined(TARGET_ANDROID)
4300#else
4301 dhcp_options_postprocess_dns(o, es);
4302#endif
4303 }
4304 return success;
4305}
4306
4307/*
4308 * Build an options string to represent data channel encryption options.
4309 * This string must match exactly between peers. The keysize is checked
4310 * separately by read_key().
4311 *
4312 * The following options must match on both peers:
4313 *
4314 * Tunnel options:
4315 *
4316 * --dev tun|tap [unit number need not match]
4317 * --dev-type tun|tap
4318 * --link-mtu
4319 * --udp-mtu
4320 * --tun-mtu
4321 * --proto udp
4322 * --proto tcp-client [matched with --proto tcp-server
4323 * on the other end of the connection]
4324 * --proto tcp-server [matched with --proto tcp-client on
4325 * the other end of the connection]
4326 * --tun-ipv6
4327 * --ifconfig x y [matched with --ifconfig y x on
4328 * the other end of the connection]
4329 *
4330 * --comp-lzo
4331 * --compress alg
4332 * --fragment
4333 *
4334 * Crypto Options:
4335 *
4336 * --cipher
4337 * --auth
4338 * --secret
4339 *
4340 * SSL Options:
4341 *
4342 * --tls-auth
4343 * --tls-client [matched with --tls-server on
4344 * the other end of the connection]
4345 * --tls-server [matched with --tls-client on
4346 * the other end of the connection]
4347 */
4348char *
4349options_string(const struct options *o, const struct frame *frame, struct tuntap *tt,
4350 openvpn_net_ctx_t *ctx, bool remote, struct gc_arena *gc)
4351{
4352 struct buffer out = alloc_buf(OPTION_LINE_SIZE);
4353 bool tt_local = false;
4354
4355 buf_printf(&out, "V4");
4356
4357 /*
4358 * Tunnel Options
4359 */
4360
4361 buf_printf(&out, ",dev-type %s", dev_type_string(o->dev, o->dev_type));
4362 /* the link-mtu that we send has only a meaning if have a fixed
4363 * cipher (p2p) or have a fallback cipher configured for older non
4364 * ncp clients. But not sending it will make even 2.4 complain
4365 * about it being missing. So still send it. */
4366 buf_printf(&out, ",link-mtu %u", (unsigned int)calc_options_string_link_mtu(o, frame));
4367
4368 if (o->ce.occ_mtu != 0)
4369 {
4370 buf_printf(&out, ",tun-mtu %d", o->ce.occ_mtu);
4371 }
4372 else
4373 {
4374 buf_printf(&out, ",tun-mtu %d", frame->tun_mtu);
4375 }
4376
4377 buf_printf(&out, ",proto %s", proto_remote(o->ce.proto, remote));
4378
4379 bool p2p_nopull = o->mode == MODE_POINT_TO_POINT && !PULL_DEFINED(o);
4380 /* send tun_ipv6 only in peer2peer mode - in client/server mode, it
4381 * is usually pushed by the server, triggering a non-helpful warning
4382 */
4383 if (o->ifconfig_ipv6_local && p2p_nopull)
4384 {
4385 buf_printf(&out, ",tun-ipv6");
4386 }
4387
4388 /*
4389 * Try to get ifconfig parameters into the options string.
4390 * If tt is undefined, make a temporary instantiation.
4391 */
4392 if (!tt)
4393 {
4394 tt = init_tun(o->dev, o->dev_type, o->topology, o->ifconfig_local,
4395 o->ifconfig_remote_netmask, o->ifconfig_ipv6_local, o->ifconfig_ipv6_netbits,
4396 o->ifconfig_ipv6_remote, NULL, NULL, false, NULL, ctx, NULL);
4397 if (tt)
4398 {
4399 tt_local = true;
4400 }
4401 }
4402
4403 if (tt && p2p_nopull)
4404 {
4405 const char *ios = ifconfig_options_string(tt, remote, o->ifconfig_nowarn, gc);
4406 if (ios && strlen(ios))
4407 {
4408 buf_printf(&out, ",ifconfig %s", ios);
4409 }
4410 }
4411 if (tt_local)
4412 {
4413 free(tt);
4414 tt = NULL;
4415 }
4416
4417#ifdef USE_COMP
4418 if (o->comp.alg != COMP_ALG_UNDEF)
4419 {
4420 buf_printf(&out, ",comp-lzo"); /* for compatibility, this simply indicates that compression
4421 context is active, not necessarily LZO per-se */
4422 }
4423#endif
4424
4425#ifdef ENABLE_FRAGMENT
4426 if (o->ce.fragment)
4427 {
4428 buf_printf(&out, ",mtu-dynamic");
4429 }
4430#endif
4431
4432#define TLS_CLIENT (o->tls_client)
4433#define TLS_SERVER (o->tls_server)
4434
4435 /*
4436 * Key direction
4437 */
4438 {
4439 const char *kd = keydirection2ascii(o->key_direction, remote, false);
4440 if (kd)
4441 {
4442 buf_printf(&out, ",keydir %s", kd);
4443 }
4444 }
4445
4446 /*
4447 * Crypto Options
4448 */
4449 if (o->shared_secret_file || TLS_CLIENT || TLS_SERVER)
4450 {
4451 struct key_type kt;
4452
4453 ASSERT((o->shared_secret_file != NULL) + (TLS_CLIENT == true) + (TLS_SERVER == true) <= 1);
4454
4455 /* Skip resolving BF-CBC to allow SSL libraries without BF-CBC
4456 * to work here in the default configuration */
4457 const char *ciphername = o->ciphername;
4458 int keysize = 0;
4459
4460 if (strcmp(o->ciphername, "BF-CBC") == 0)
4461 {
4462 init_key_type(&kt, "none", o->authname, true, false);
4463 keysize = 128;
4464 }
4465 else
4466 {
4467 init_key_type(&kt, o->ciphername, o->authname, true, false);
4468 ciphername = cipher_kt_name(kt.cipher);
4469 if (cipher_defined(o->ciphername))
4470 {
4471 keysize = cipher_kt_key_size(kt.cipher) * 8;
4472 }
4473 }
4474 /* Only announce the cipher to our peer if we are willing to
4475 * support it */
4476 if (p2p_nopull || tls_item_in_cipher_list(ciphername, o->ncp_ciphers))
4477 {
4478 buf_printf(&out, ",cipher %s", ciphername);
4479 }
4480 buf_printf(&out, ",auth %s", md_kt_name(kt.digest));
4481 buf_printf(&out, ",keysize %d", keysize);
4482 if (o->shared_secret_file)
4483 {
4484 buf_printf(&out, ",secret");
4485 }
4486
4487#ifdef ENABLE_PREDICTION_RESISTANCE
4488 if (o->use_prediction_resistance)
4489 {
4490 buf_printf(&out, ",use-prediction-resistance");
4491 }
4492#endif
4493 }
4494
4495 /*
4496 * SSL Options
4497 */
4498 {
4499 if (TLS_CLIENT || TLS_SERVER)
4500 {
4501 if (o->ce.tls_auth_file)
4502 {
4503 buf_printf(&out, ",tls-auth");
4504 }
4505 /* Not adding tls-crypt here, because we won't reach this code if
4506 * tls-auth/tls-crypt does not match. Removing tls-auth here would
4507 * break stuff, so leaving that in place. */
4508
4509 buf_printf(&out, ",key-method %d", KEY_METHOD_2);
4510 }
4511
4512 if (remote)
4513 {
4514 if (TLS_CLIENT)
4515 {
4516 buf_printf(&out, ",tls-server");
4517 }
4518 else if (TLS_SERVER)
4519 {
4520 buf_printf(&out, ",tls-client");
4521 }
4522 }
4523 else
4524 {
4525 if (TLS_CLIENT)
4526 {
4527 buf_printf(&out, ",tls-client");
4528 }
4529 else if (TLS_SERVER)
4530 {
4531 buf_printf(&out, ",tls-server");
4532 }
4533 }
4534 }
4535
4536#undef TLS_CLIENT
4537#undef TLS_SERVER
4538
4539 return BSTR(&out);
4540}
4541
4542/*
4543 * Compare option strings for equality.
4544 * If the first two chars of the strings differ, it means that
4545 * we are looking at different versions of the options string,
4546 * therefore don't compare them and return true.
4547 */
4548
4549bool
4550options_cmp_equal(char *actual, const char *expected)
4551{
4552 return options_cmp_equal_safe(actual, expected, strlen(actual) + 1);
4553}
4554
4555void
4556options_warning(char *actual, const char *expected)
4557{
4558 options_warning_safe(actual, expected, strlen(actual) + 1);
4559}
4560
4561static const char *
4562options_warning_extract_parm1(const char *option_string, struct gc_arena *gc_ret)
4563{
4564 struct gc_arena gc = gc_new();
4566 char *p = gc_malloc(OPTION_PARM_SIZE, false, &gc);
4567 const char *ret;
4568
4569 buf_parse(&b, ' ', p, OPTION_PARM_SIZE);
4570 ret = string_alloc(p, gc_ret);
4571 gc_free(&gc);
4572 return ret;
4573}
4574
4575static void
4577 const bool report_inconsistent, const char *p1,
4578 const struct buffer *b2_src, const char *b1_name,
4579 const char *b2_name)
4580{
4581 /* We will stop sending 'key-method', 'keydir', 'proto' and 'tls-auth' in
4582 * OCC in a future version (because it's not useful). To reduce questions
4583 * when interoperating, we no longer printing a warning about it.
4584 */
4585 if (strprefix(p1, "key-method ") || strprefix(p1, "keydir ") || strprefix(p1, "proto ")
4586 || streq(p1, "tls-auth") || strprefix(p1, "tun-ipv6") || strprefix(p1, "cipher "))
4587 {
4588 return;
4589 }
4590
4591 if (strlen(p1) > 0)
4592 {
4593 struct gc_arena gc = gc_new();
4594 struct buffer b2 = *b2_src;
4596 char *p2 = gc_malloc(OPTION_PARM_SIZE, false, &gc);
4597
4598 while (buf_parse(&b2, delim, p2, OPTION_PARM_SIZE))
4599 {
4600 if (strlen(p2))
4601 {
4603
4604 if (!strcmp(p1, p2))
4605 {
4606 goto done;
4607 }
4608 if (!strcmp(p1_prefix, p2_prefix))
4609 {
4611 {
4612 msg(msglevel, "WARNING: '%s' is used inconsistently, %s='%s', %s='%s'",
4614 safe_print(p2, &gc));
4615 }
4616 goto done;
4617 }
4618 }
4619 }
4620
4621 msg(msglevel, "WARNING: '%s' is present in %s config but missing in %s config, %s='%s'",
4623
4624done:
4625 gc_free(&gc);
4626 }
4627}
4628
4629static void
4631 const bool report_inconsistent, const struct buffer *b1_src,
4632 const struct buffer *b2_src, const char *b1_name, const char *b2_name)
4633{
4634 struct gc_arena gc = gc_new();
4635 struct buffer b = *b1_src;
4636 char *p = gc_malloc(OPTION_PARM_SIZE, true, &gc);
4637
4638 while (buf_parse(&b, delim, p, OPTION_PARM_SIZE))
4639 {
4641 b2_name);
4642 }
4643
4644 gc_free(&gc);
4645}
4646
4647static void
4648options_warning_safe_ml(const msglvl_t msglevel, char *actual, const char *expected, size_t actual_n)
4649{
4650 struct gc_arena gc = gc_new();
4651
4652 if (actual_n > 0)
4653 {
4654 struct buffer local = alloc_buf_gc(OPTION_PARM_SIZE + 16, &gc);
4655 struct buffer remote = alloc_buf_gc(OPTION_PARM_SIZE + 16, &gc);
4656 actual[actual_n - 1] = 0;
4657
4658 buf_printf(&local, "version %s", expected);
4659 buf_printf(&remote, "version %s", actual);
4660
4661 options_warning_safe_scan1(msglevel, ',', true, &local, &remote, "local", "remote");
4662
4663 options_warning_safe_scan1(msglevel, ',', false, &remote, &local, "remote", "local");
4664 }
4665
4666 gc_free(&gc);
4667}
4668
4669bool
4670options_cmp_equal_safe(char *actual, const char *expected, size_t actual_n)
4671{
4672 struct gc_arena gc = gc_new();
4673 bool ret = true;
4674
4675 if (actual_n > 0)
4676 {
4677 actual[actual_n - 1] = 0;
4678 if (strncmp(actual, expected, 2))
4679 {
4680 msg(D_SHOW_OCC, "NOTE: Options consistency check may be skewed by version differences");
4681 options_warning_safe_ml(D_SHOW_OCC, actual, expected, actual_n);
4682 }
4683 else
4684 {
4685 ret = !strcmp(actual, expected);
4686 }
4687 }
4688 gc_free(&gc);
4689 return ret;
4690}
4691
4692void
4693options_warning_safe(char *actual, const char *expected, size_t actual_n)
4694{
4695 options_warning_safe_ml(D_SHOW_OCC, actual, expected, actual_n);
4696}
4697
4698const char *
4699options_string_version(const char *s, struct gc_arena *gc)
4700{
4701 struct buffer out = alloc_buf_gc(4, gc);
4702 strncpynt((char *)BPTR(&out), s, 3);
4703 return BSTR(&out);
4704}
4705
4706char *
4708{
4709 char *ret = NULL;
4710 const size_t opt_name_len = strlen(opt_name);
4711
4712 const char *p = options_string;
4713 while (p)
4714 {
4715 if (0 == strncmp(p, opt_name, opt_name_len) && strlen(p) > (opt_name_len + 1)
4716 && p[opt_name_len] == ' ')
4717 {
4718 /* option found, extract value */
4719 const char *start = &p[opt_name_len + 1];
4720 const char *end = strchr(p, ',');
4721 size_t val_len = end ? end - start : strlen(start);
4722 ret = gc_malloc(val_len + 1, true, gc);
4723 memcpy(ret, start, val_len);
4724 break;
4725 }
4726 p = strchr(p, ',');
4727 if (p)
4728 {
4729 p++; /* skip delimiter */
4730 }
4731 }
4732 return ret;
4733}
4734
4735/*
4736 * parse/print topology coding
4737 */
4738
4739int
4740parse_topology(const char *str, const msglvl_t msglevel)
4741{
4742 if (streq(str, "net30"))
4743 {
4744 return TOP_NET30;
4745 }
4746 else if (streq(str, "p2p"))
4747 {
4748 return TOP_P2P;
4749 }
4750 else if (streq(str, "subnet"))
4751 {
4752 return TOP_SUBNET;
4753 }
4754 else
4755 {
4756 msg(msglevel, "--topology must be net30, p2p, or subnet");
4757 return TOP_UNDEF;
4758 }
4759}
4760
4761const char *
4762print_topology(const int topology)
4763{
4764 switch (topology)
4765 {
4766 case TOP_UNDEF:
4767 return "undef";
4768
4769 case TOP_NET30:
4770 return "net30";
4771
4772 case TOP_P2P:
4773 return "p2p";
4774
4775 case TOP_SUBNET:
4776 return "subnet";
4777
4778 default:
4779 return "unknown";
4780 }
4781}
4782
4783/*
4784 * Manage auth-retry variable
4785 */
4786
4787static int global_auth_retry; /* GLOBAL */
4788
4789int
4791{
4792 return global_auth_retry;
4793}
4794
4795bool
4796auth_retry_set(const msglvl_t msglevel, const char *option)
4797{
4798 if (streq(option, "interact"))
4799 {
4801 }
4802 else if (streq(option, "nointeract"))
4803 {
4805 }
4806 else if (streq(option, "none"))
4807 {
4809 }
4810 else
4811 {
4812 msg(msglevel, "--auth-retry method must be 'interact', 'nointeract', or 'none'");
4813 return false;
4814 }
4815 return true;
4816}
4817
4818const char *
4820{
4821 switch (global_auth_retry)
4822 {
4823 case AR_NONE:
4824 return "none";
4825
4826 case AR_NOINTERACT:
4827 return "nointeract";
4828
4829 case AR_INTERACT:
4830 return "interact";
4831
4832 default:
4833 return "???";
4834 }
4835}
4836
4837/*
4838 * Print the help message.
4839 */
4840void
4842{
4843 FILE *fp = msg_fp(0);
4844
4845#ifdef ENABLE_SMALL
4846
4847 fprintf(fp, "Usage message not available\n");
4848
4849#else
4850
4851 struct options o;
4852 init_options(&o, true);
4853
4859 fflush(fp);
4860
4861#endif /* ENABLE_SMALL */
4862
4863 openvpn_exit(OPENVPN_EXIT_STATUS_USAGE); /* exit point */
4864}
4865
4866void
4868{
4869 msg(M_WARN | M_NOPREFIX, "Use --help for more information.");
4870 openvpn_exit(OPENVPN_EXIT_STATUS_USAGE); /* exit point */
4871}
4872
4873#ifdef _WIN32
4874void
4875show_windows_version(const unsigned int flags)
4876{
4877 struct gc_arena gc = gc_new();
4878 msg(flags, "Windows version: %s", win32_version_string(&gc));
4879 gc_free(&gc);
4880}
4881#endif
4882
4883void
4884show_dco_version(const unsigned int flags)
4885{
4886#ifdef ENABLE_DCO
4887 struct gc_arena gc = gc_new();
4888 msg(flags, "DCO version: %s", dco_version_string(&gc));
4889 gc_free(&gc);
4890#endif
4891}
4892
4893void
4894show_library_versions(const unsigned int flags)
4895{
4896#ifdef ENABLE_LZO
4897#define LZO_LIB_VER_STR ", LZO ", lzo_version_string()
4898#else
4899#define LZO_LIB_VER_STR "", ""
4900#endif
4901
4902 msg(flags, "library versions: %s%s%s", get_ssl_library_version(), LZO_LIB_VER_STR);
4903
4904#undef LZO_LIB_VER_STR
4905}
4906
4907static void
4909{
4912#ifdef _WIN32
4914#endif
4916 msg(M_INFO | M_NOPREFIX, "Originally developed by James Yonan");
4917 msg(M_INFO | M_NOPREFIX, "Copyright (C) 2002-2025 OpenVPN Inc <sales@openvpn.net>");
4918#ifndef ENABLE_SMALL
4919#ifdef CONFIGURE_DEFINES
4920 msg(M_INFO | M_NOPREFIX, "Compile time defines: %s", CONFIGURE_DEFINES);
4921#endif
4922#ifdef CONFIGURE_SPECIAL_BUILD
4923 msg(M_INFO | M_NOPREFIX, "special build: %s", CONFIGURE_SPECIAL_BUILD);
4924#endif
4925#endif
4927}
4928
4929void
4930notnull(const char *arg, const char *description)
4931{
4932 if (!arg)
4933 {
4934 msg(M_USAGE, "You must define %s", description);
4935 }
4936}
4937
4938bool
4939string_defined_equal(const char *s1, const char *s2)
4940{
4941 if (s1 && s2)
4942 {
4943 return !strcmp(s1, s2);
4944 }
4945 else
4946 {
4947 return false;
4948 }
4949}
4950
4951#if 0
4952static void
4953ping_rec_err(msglvl_t msglevel)
4954{
4955 msg(msglevel, "only one of --ping-exit or --ping-restart options may be specified");
4956}
4957#endif
4958
4959#ifdef _WIN32 /* This function is only used when compiling on Windows */
4960static unsigned int
4961atou(const char *str)
4962{
4963 unsigned int val = 0;
4964 sscanf(str, "%u", &val);
4965 return val;
4966}
4967#endif
4968
4969#define VERIFY_PERMISSION(mask) \
4970 { \
4971 if (!verify_permission(p[0], file, line, (mask), permission_mask, option_types_found, \
4972 msglevel, options, is_inline)) \
4973 { \
4974 goto err; \
4975 } \
4976 }
4977
4978static bool
4979verify_permission(const char *name, const char *file, int line, const unsigned int type,
4980 const unsigned int allowed, unsigned int *found, const msglvl_t msglevel,
4981 struct options *options, bool is_inline)
4982{
4983 if (!(type & allowed))
4984 {
4985 msg(msglevel, "option '%s' cannot be used in this context (%s)", name, file);
4986 return false;
4987 }
4988
4989 if (is_inline && !(type & OPT_P_INLINE))
4990 {
4991 msg(msglevel, "option '%s' is not expected to be inline (%s:%d)", name, file, line);
4992 return false;
4993 }
4994
4995 if (found)
4996 {
4997 *found |= type;
4998 }
4999
5000#ifndef ENABLE_SMALL
5001 /* Check if this options is allowed in connection block,
5002 * but we are currently not in a connection block
5003 * unless this is a pushed option.
5004 * Parsing a connection block uses a temporary options struct without
5005 * connection_list
5006 */
5007
5008 if ((type & OPT_P_CONNECTION) && options->connection_list && !(allowed & OPT_P_PULL_MODE))
5009 {
5010 if (file)
5011 {
5012 msg(M_WARN, "Option '%s' in %s:%d is ignored by previous <connection> blocks ", name,
5013 file, line);
5014 }
5015 else
5016 {
5017 msg(M_WARN, "Option '%s' is ignored by previous <connection> blocks", name);
5018 }
5019 }
5020#endif
5021 return true;
5022}
5023
5024/*
5025 * Check that an option doesn't have too
5026 * many parameters.
5027 */
5028
5029#define NM_QUOTE_HINT (1 << 0)
5030
5031static bool
5032no_more_than_n_args(const msglvl_t msglevel, char *p[], const int max, const unsigned int flags)
5033{
5034 const int len = string_array_len((const char **)p);
5035
5036 if (!len)
5037 {
5038 return false;
5039 }
5040
5041 if (len > max)
5042 {
5043 msg(msglevel, "the --%s directive should have at most %d parameter%s.%s", p[0], max - 1,
5044 max >= 3 ? "s" : "",
5045 (flags & NM_QUOTE_HINT)
5046 ? " To pass a list of arguments as one of the parameters, try enclosing them in double quotes (\"\")."
5047 : "");
5048 return false;
5049 }
5050 else
5051 {
5052 return true;
5053 }
5054}
5055
5056static inline msglvl_t
5058{
5059 return options->forward_compatible ? M_WARN : msglevel;
5060}
5061
5062#define RESET_OPTION_ROUTES(option_ptr, field) \
5063 if (option_ptr) \
5064 { \
5065 option_ptr->field = NULL; \
5066 option_ptr->flags = 0; \
5067 }
5068
5069void
5070remove_option(struct context *c, struct options *options, char *p[], bool is_inline,
5071 const char *file, int line, const msglvl_t msglevel,
5072 const unsigned int permission_mask, unsigned int *option_types_found,
5073 struct env_set *es)
5074{
5075 msglvl_t msglevel_fc = msglevel_forward_compatible(options, msglevel);
5076
5077 if (streq(p[0], "ifconfig") && !p[1])
5078 {
5080 options->ifconfig_local = NULL;
5082 }
5083 else if (streq(p[0], "ifconfig-ipv6") && !p[1])
5084 {
5089 }
5090 else if (streq(p[0], "route") && !p[1])
5091 {
5093 if (c->c1.route_list)
5094 {
5096 &c->net_ctx);
5098 }
5099 }
5100 else if (streq(p[0], "route-ipv6") && !p[1])
5101 {
5103 if (c->c1.route_ipv6_list)
5104 {
5106 es, &c->net_ctx);
5108 }
5109 }
5110 else if (streq(p[0], "route-gateway") && !p[1])
5111 {
5115 }
5116 else if (streq(p[0], "route-metric") && !p[1])
5117 {
5120 }
5121 else if (streq(p[0], "push-continuation") && !p[1])
5122 {
5125 }
5126 else if ((streq(p[0], "redirect-gateway") || streq(p[0], "redirect-private")) && !p[1])
5127 {
5129 if (options->routes)
5130 {
5131 options->routes->flags = 0;
5132 }
5133 if (options->routes_ipv6)
5134 {
5136 }
5137 env_set_del(es, "route_redirect_gateway_ipv4");
5138 env_set_del(es, "route_redirect_gateway_ipv6");
5139 }
5140 else if (streq(p[0], "dns") && !p[1])
5141 {
5145 }
5146 else if (streq(p[0], "topology") && !p[1])
5147 {
5151 }
5152 else if (streq(p[0], "tun-mtu") && !p[1])
5153 {
5156 options->ce.tun_mtu_defined = false;
5157 options->ce.occ_mtu = 0;
5158 }
5159 else if (streq(p[0], "block-ipv6") && !p[1])
5160 {
5162 options->block_ipv6 = false;
5163 }
5164#if defined(_WIN32) || defined(TARGET_ANDROID)
5165 else if (streq(p[0], "dhcp-option") && !p[1])
5166 {
5169
5170 o->domain = NULL;
5171 o->netbios_scope = NULL;
5172 o->netbios_node_type = 0;
5173 o->dns6_len = 0;
5174 memset(o->dns6, 0, sizeof(o->dns6));
5175 o->dns_len = 0;
5176 memset(o->dns, 0, sizeof(o->dns));
5177 o->wins_len = 0;
5178 memset(o->wins, 0, sizeof(o->wins));
5179 o->ntp_len = 0;
5180 memset(o->ntp, 0, sizeof(o->ntp));
5181 o->nbdd_len = 0;
5182 memset(o->nbdd, 0, sizeof(o->nbdd));
5183 while (o->domain_search_list_len-- > 0)
5184 {
5186 }
5187 o->disable_nbt = 0;
5188 o->dhcp_options = 0;
5189#if defined(TARGET_ANDROID)
5190 o->http_proxy_port = 0;
5191 o->http_proxy = NULL;
5192#endif
5193 }
5194#endif /* if defined(_WIN32) || defined(TARGET_ANDROID) */
5195#ifdef _WIN32
5196 else if (streq(p[0], "block-outside-dns") && !p[1])
5197 {
5199 options->block_outside_dns = false;
5200 }
5201#else /* ifdef _WIN32 */
5202 else if (streq(p[0], "dhcp-option") && !p[1])
5203 {
5205 delete_all_dhcp_fo(options, &es->list);
5206 }
5207#endif
5208 else
5209 {
5210 msglvl_t msglevel_unknown = msglevel_fc;
5211 /* Check if an option is in --ignore-unknown-option and
5212 * set warning level to non fatal */
5213 for (int i = 0; options->ignore_unknown_option && options->ignore_unknown_option[i]; i++)
5214 {
5215 if (streq(p[0], options->ignore_unknown_option[i]))
5216 {
5217 msglevel_unknown = M_WARN;
5218 break;
5219 }
5220 }
5221 msg(msglevel_unknown,
5222 "Unrecognized option or missing or extra parameter(s) in %s:%d: -%s (%s)", file, line,
5223 p[0], PACKAGE_VERSION);
5224 }
5225 return;
5226err:
5227 msg(msglevel, "Error occurred trying to remove %s option", p[0]);
5228}
5229
5230
5231static bool
5232check_route_option(struct options *options, char *p[], const msglvl_t msglevel, bool pull_mode)
5233{
5235 if (pull_mode)
5236 {
5238 && !is_special_addr(p[1])) /* FQDN -- may be DNS name */
5239 {
5240 msg(msglevel, "route parameter network/IP '%s' must be a valid address", p[1]);
5241 return false;
5242 }
5243 if (p[2] && !ip_addr_dotted_quad_safe(p[2])) /* FQDN -- must be IP address */
5244 {
5245 msg(msglevel, "route parameter netmask '%s' must be an IP address", p[2]);
5246 return false;
5247 }
5248 if (p[3] && !ip_or_dns_addr_safe(p[3], options->allow_pull_fqdn)
5249 && !is_special_addr(p[3])) /* FQDN -- may be DNS name */
5250 {
5251 msg(msglevel, "route parameter gateway '%s' must be a valid address", p[3]);
5252 return false;
5253 }
5254 }
5255 return true;
5256}
5257
5258
5259static bool
5260check_route6_option(struct options *options, char *p[], const msglvl_t msglevel, bool pull_mode)
5261{
5263 if (pull_mode)
5264 {
5265 if (!ipv6_addr_safe_hexplusbits(p[1]))
5266 {
5267 msg(msglevel, "route-ipv6 parameter network/IP '%s' must be a valid address", p[1]);
5268 return false;
5269 }
5270 if (p[2] && !ipv6_addr_safe(p[2]))
5271 {
5272 msg(msglevel, "route-ipv6 parameter gateway '%s' must be a valid address", p[2]);
5273 return false;
5274 }
5275 /* p[3] is metric, if present */
5276 }
5277 return true;
5278}
5279
5280static bool
5281check_dns_option(struct options *options, char *p[], const msglvl_t msglevel, bool pull_mode)
5282{
5283 if (streq(p[1], "search-domains") && p[2])
5284 {
5287 {
5288 msg(msglevel, "--dns %s contain invalid characters", p[1]);
5289 return false;
5290 }
5291 }
5292 else if (streq(p[1], "server") && p[2] && p[3] && p[4])
5293 {
5294 long priority;
5295 if (!dns_server_priority_parse(&priority, p[2], pull_mode))
5296 {
5297 msg(msglevel, "--dns server: invalid priority value '%s'", p[2]);
5298 return false;
5299 }
5300
5301 struct dns_server *server =
5303
5304 if (streq(p[3], "address") && p[4])
5305 {
5306 for (int i = 4; p[i]; ++i)
5307 {
5308 if (!dns_server_addr_parse(server, p[i]))
5309 {
5310 msg(msglevel, "--dns server %ld: malformed address or maximum exceeded '%s'",
5311 priority, p[i]);
5312 return false;
5313 }
5314 }
5315 }
5316 else if (streq(p[3], "resolve-domains"))
5317 {
5318 if (!dns_domain_list_append(&server->domains, &p[4], &options->dns_options.gc))
5319 {
5320 msg(msglevel, "--dns server %ld: %s contain invalid characters", priority, p[3]);
5321 return false;
5322 }
5323 }
5324 else if (streq(p[3], "dnssec") && !p[5])
5325 {
5326 if (streq(p[4], "yes"))
5327 {
5328 server->dnssec = DNS_SECURITY_YES;
5329 }
5330 else if (streq(p[4], "no"))
5331 {
5332 server->dnssec = DNS_SECURITY_NO;
5333 }
5334 else if (streq(p[4], "optional"))
5335 {
5336 server->dnssec = DNS_SECURITY_OPTIONAL;
5337 }
5338 else
5339 {
5340 msg(msglevel, "--dns server %ld: malformed dnssec value '%s'", priority, p[4]);
5341 return false;
5342 }
5343 }
5344 else if (streq(p[3], "transport") && !p[5])
5345 {
5346 if (streq(p[4], "plain"))
5347 {
5349 }
5350 else if (streq(p[4], "DoH"))
5351 {
5353 }
5354 else if (streq(p[4], "DoT"))
5355 {
5356 server->transport = DNS_TRANSPORT_TLS;
5357 }
5358 else
5359 {
5360 msg(msglevel, "--dns server %ld: malformed transport value '%s'", priority, p[4]);
5361 return false;
5362 }
5363 }
5364 else if (streq(p[3], "sni") && !p[5])
5365 {
5366 if (!validate_domain(p[4]))
5367 {
5368 msg(msglevel, "--dns server %ld: %s contains invalid characters", priority, p[3]);
5369 return false;
5370 }
5371 server->sni = p[4];
5372 }
5373 else
5374 {
5375 msg(msglevel,
5376 "--dns server %ld: unknown option type '%s' or missing or unknown parameter",
5377 priority, p[3]);
5378 return false;
5379 }
5380 }
5381 else
5382 {
5383 msg(msglevel, "--dns: unknown option type '%s' or missing or unknown parameter", p[1]);
5384 return false;
5385 }
5386 return true;
5387}
5388
5389void
5390update_option(struct context *c, struct options *options, char *p[], bool is_inline,
5391 const char *file, int line, const int level, const msglvl_t msglevel,
5392 const unsigned int permission_mask, unsigned int *option_types_found,
5393 struct env_set *es)
5394{
5395 const bool pull_mode = BOOL_CAST(permission_mask & OPT_P_PULL_MODE);
5396 ASSERT(MAX_PARMS >= 7);
5397
5398 if (streq(p[0], "route") && p[1] && !p[5])
5399 {
5401 {
5403 if (!check_route_option(options, p, msglevel, pull_mode))
5404 {
5405 goto err;
5406 }
5407 if (c->c1.route_list)
5408 {
5410 es, &c->net_ctx);
5412 }
5414 }
5415 }
5416 else if (streq(p[0], "route-ipv6") && p[1] && !p[4])
5417 {
5419 {
5421 if (!check_route6_option(options, p, msglevel, pull_mode))
5422 {
5423 goto err;
5424 }
5425 if (c->c1.route_ipv6_list)
5426 {
5430 }
5432 }
5433 }
5434 else if (streq(p[0], "redirect-gateway") || streq(p[0], "redirect-private"))
5435 {
5437 {
5439 if (options->routes)
5440 {
5441 options->routes->flags = 0;
5442 }
5443 if (options->routes_ipv6)
5444 {
5446 }
5447 env_set_del(es, "route_redirect_gateway_ipv4");
5448 env_set_del(es, "route_redirect_gateway_ipv6");
5450 }
5451 }
5452 else if (streq(p[0], "dns") && p[1])
5453 {
5455 {
5457 if (!check_dns_option(options, p, msglevel, pull_mode))
5458 {
5459 goto err;
5460 }
5464 }
5465 }
5466#if defined(_WIN32) || defined(TARGET_ANDROID)
5467 else if (streq(p[0], "dhcp-option") && p[1] && !p[3])
5468 {
5470 {
5473
5474 o->domain = NULL;
5475 o->netbios_scope = NULL;
5476 o->netbios_node_type = 0;
5477 o->dns6_len = 0;
5478 CLEAR(o->dns6);
5479 o->dns_len = 0;
5480 CLEAR(o->dns);
5481 o->wins_len = 0;
5482 CLEAR(o->wins);
5483 o->ntp_len = 0;
5484 CLEAR(o->ntp);
5485 o->nbdd_len = 0;
5486 CLEAR(o->nbdd);
5487 while (o->domain_search_list_len-- > 0)
5488 {
5490 }
5491 o->disable_nbt = 0;
5492 o->dhcp_options = 0;
5493
5495#if defined(TARGET_ANDROID)
5496 o->http_proxy_port = 0;
5497 o->http_proxy = NULL;
5498#endif
5500 }
5501 }
5502#else /* if defined(_WIN32) || defined(TARGET_ANDROID) */
5503 else if (streq(p[0], "dhcp-option") && p[1] && !p[3])
5504 {
5506 {
5508 delete_all_dhcp_fo(options, &es->list);
5510 }
5511 }
5512#endif /* if defined(_WIN32) || defined(TARGET_ANDROID) */
5513 add_option(options, p, is_inline, file, line, level, msglevel, permission_mask,
5514 option_types_found, es);
5515 return;
5516err:
5517 msg(msglevel, "Error occurred trying to update %s option", p[0]);
5518}
5519
5520static void
5521set_user_script(struct options *options, const char **script, const char *new_script,
5522 const char *type, bool in_chroot)
5523{
5524 if (*script)
5525 {
5526 msg(M_WARN,
5527 "Multiple --%s scripts defined. "
5528 "The previously configured script is overridden.",
5529 type);
5530 }
5531 *script = new_script;
5532 options->user_script_used = true;
5533
5534#ifndef ENABLE_SMALL
5535 {
5536 char script_name[100];
5537 snprintf(script_name, sizeof(script_name), "--%s script", type);
5538
5539 if (check_cmd_access(*script, script_name, (in_chroot ? options->chroot_dir : NULL)))
5540 {
5541 msg(M_USAGE, "Please correct this error.");
5542 }
5543 }
5544#endif
5545}
5546
5547static void
5549{
5550 if (comp_non_stub_enabled(info))
5551 {
5552 msg(M_WARN, "WARNING: Compression for receiving enabled. "
5553 "Compression has been used in the past to break encryption. "
5554 "Compression support is deprecated and we recommend to disable "
5555 "it completely.");
5556 }
5557}
5558
5559bool
5561{
5562 bool ret = false;
5563 ret = ret || (options->management_flags & MF_EXTERNAL_KEY);
5564#ifdef ENABLE_PKCS11
5565 ret = ret || (options->pkcs11_providers[0] != NULL);
5566#endif
5567#ifdef ENABLE_CRYPTOAPI
5568 ret = ret || options->cryptoapi_cert;
5569#endif
5570
5571 return ret;
5572}
5573
5574void
5575add_option(struct options *options, char *p[], bool is_inline, const char *file, int line,
5576 const int level, const msglvl_t msglevel, const unsigned int permission_mask,
5577 unsigned int *option_types_found, struct env_set *es)
5578{
5579 struct gc_arena gc = gc_new();
5580 const bool pull_mode = BOOL_CAST(permission_mask & OPT_P_PULL_MODE);
5581 msglvl_t msglevel_fc = msglevel_forward_compatible(options, msglevel);
5582
5583 ASSERT(MAX_PARMS >= 7);
5584
5585 /*
5586 * If directive begins with "setenv opt" prefix, don't raise an error if
5587 * directive is unrecognized.
5588 */
5589 if (streq(p[0], "setenv") && p[1] && streq(p[1], "opt") && !(permission_mask & OPT_P_PULL_MODE))
5590 {
5591 if (!p[2])
5592 {
5593 p[2] = "setenv opt"; /* will trigger an error that includes setenv opt */
5594 }
5595 p += 2;
5596 msglevel_fc = M_WARN;
5597 }
5598
5599 if (!file)
5600 {
5601 file = "[CMD-LINE]";
5602 line = 1;
5603 }
5604 if (streq(p[0], "help"))
5605 {
5607 usage();
5608 if (p[1])
5609 {
5610 msg(msglevel, "--help does not accept any parameters");
5611 goto err;
5612 }
5613 }
5614 if (streq(p[0], "version") && !p[1])
5615 {
5617 usage_version();
5618 }
5619 else if (streq(p[0], "config") && p[1] && !p[2])
5620 {
5622
5623 /* save first config file only in options */
5624 if (!options->config)
5625 {
5626 options->config = p[1];
5627 }
5628
5629 read_config_file(options, p[1], level, file, line, msglevel, permission_mask,
5630 option_types_found, es);
5631 }
5632#if defined(ENABLE_DEBUG) && !defined(ENABLE_SMALL)
5633 else if (streq(p[0], "show-gateway") && !p[2])
5634 {
5635 struct route_gateway_info rgi;
5636 struct route_ipv6_gateway_info rgi6;
5637 in_addr_t remote_ipv4 = 0;
5638 struct in6_addr remote_ipv6 = IN6ADDR_ANY_INIT;
5639 openvpn_net_ctx_t net_ctx;
5641 if (p[1])
5642 {
5643 /* try parsing the argument as a v4 or v6 address - if
5644 * possible, the output will show the exact route there, and
5645 * "the default route" for the other protocol
5646 */
5647 remote_ipv4 = get_ip_addr(p[1], M_WARN, NULL);
5648 get_ipv6_addr(p[1], &remote_ipv6, NULL, M_WARN);
5649 }
5650 net_ctx_init(NULL, &net_ctx);
5651 get_default_gateway(&rgi, remote_ipv4, &net_ctx);
5652 get_default_gateway_ipv6(&rgi6, &remote_ipv6, &net_ctx);
5653 print_default_gateway(M_INFO, &rgi, &rgi6);
5654 openvpn_exit(OPENVPN_EXIT_STATUS_GOOD); /* exit point */
5655 }
5656#endif
5657 else if (streq(p[0], "echo") || streq(p[0], "parameter"))
5658 {
5659 struct buffer string = alloc_buf_gc(OPTION_PARM_SIZE, &gc);
5660 int j;
5661 bool good = true;
5662
5664
5665 for (j = 1; j < MAX_PARMS; ++j)
5666 {
5667 if (!p[j])
5668 {
5669 break;
5670 }
5671 if (j > 1)
5672 {
5673 good &= buf_printf(&string, " ");
5674 }
5675 good &= buf_printf(&string, "%s", p[j]);
5676 }
5677 if (good)
5678 {
5679 /* only message-related ECHO are logged, since other ECHOs
5680 * can potentially include security-sensitive strings */
5681 if (p[1] && strncmp(p[1], "msg", 3) == 0)
5682 {
5683 msg(M_INFO, "%s:%s", pull_mode ? "ECHO-PULL" : "ECHO", BSTR(&string));
5684 }
5685#ifdef ENABLE_MANAGEMENT
5686 if (management)
5687 {
5689 }
5690#endif
5691 }
5692 else
5693 {
5694 msg(M_WARN, "echo/parameter option overflow");
5695 }
5696 }
5697#ifdef ENABLE_MANAGEMENT
5698 else if (streq(p[0], "management") && p[1] && p[2] && !p[4])
5699 {
5701 if (streq(p[2], "unix"))
5702 {
5703#if UNIX_SOCK_SUPPORT
5705#else
5706 msg(msglevel, "MANAGEMENT: this platform does not support unix domain sockets");
5707 goto err;
5708#endif
5709 }
5710
5713 if (p[3])
5714 {
5716 }
5717 }
5718 else if (streq(p[0], "management-client-user") && p[1] && !p[2])
5719 {
5722 }
5723 else if (streq(p[0], "management-client-group") && p[1] && !p[2])
5724 {
5727 }
5728 else if (streq(p[0], "management-query-passwords") && !p[1])
5729 {
5732 }
5733 else if (streq(p[0], "management-query-remote") && !p[1])
5734 {
5737 }
5738 else if (streq(p[0], "management-query-proxy") && !p[1])
5739 {
5742 }
5743 else if (streq(p[0], "management-hold") && !p[1])
5744 {
5747 }
5748 else if (streq(p[0], "management-signal") && !p[1])
5749 {
5752 }
5753 else if (streq(p[0], "management-forget-disconnect") && !p[1])
5754 {
5757 }
5758 else if (streq(p[0], "management-up-down") && !p[1])
5759 {
5762 }
5763 else if (streq(p[0], "management-client") && !p[1])
5764 {
5767 }
5768 else if (streq(p[0], "management-external-key"))
5769 {
5771 for (int j = 1; j < MAX_PARMS && p[j] != NULL; ++j)
5772 {
5773 if (streq(p[j], "nopadding"))
5774 {
5776 }
5777 else if (streq(p[j], "pkcs1"))
5778 {
5780 }
5781 else if (streq(p[j], "pss"))
5782 {
5784 }
5785 else if (streq(p[j], "digest"))
5786 {
5788 }
5789 else
5790 {
5791 msg(msglevel, "Unknown management-external-key flag: %s", p[j]);
5792 }
5793 }
5794 /*
5795 * When no option is present, assume that only PKCS1
5796 * padding is supported
5797 */
5799 {
5801 }
5803 }
5804 else if (streq(p[0], "management-external-cert") && p[1] && !p[2])
5805 {
5809 }
5810 else if (streq(p[0], "management-client-auth") && !p[1])
5811 {
5814 }
5815 else if (streq(p[0], "management-log-cache") && p[1] && !p[2])
5816 {
5819 p[0], 1, INT_MAX, msglevel))
5820 {
5821 goto err;
5822 }
5823 }
5824#endif /* ifdef ENABLE_MANAGEMENT */
5825#ifdef ENABLE_PLUGIN
5826 else if (streq(p[0], "plugin") && p[1])
5827 {
5829 if (!options->plugin_list)
5830 {
5832 }
5834 {
5835 msg(msglevel, "plugin add failed: %s", p[1]);
5836 goto err;
5837 }
5838 }
5839#endif
5840 else if (streq(p[0], "mode") && p[1] && !p[2])
5841 {
5843 if (streq(p[1], "p2p"))
5844 {
5846 }
5847 else if (streq(p[1], "server"))
5848 {
5850 }
5851 else
5852 {
5853 msg(msglevel, "Bad --mode parameter: %s", p[1]);
5854 goto err;
5855 }
5856 }
5857 else if (streq(p[0], "dev") && p[1] && !p[2])
5858 {
5860 options->dev = p[1];
5861 }
5862 else if (streq(p[0], "dev-type") && p[1] && !p[2])
5863 {
5865 options->dev_type = p[1];
5866 }
5867#ifdef _WIN32
5868 else if (streq(p[0], "windows-driver") && p[1] && !p[2])
5869 {
5871 msg(M_WARN,
5872 "DEPRECATED OPTION: windows-driver: In OpenVPN 2.7, the default Windows driver is ovpn-dco. "
5873 "If incompatible options are used, OpenVPN will fall back to tap-windows6. Wintun support has been removed.");
5874 }
5875#endif
5876 else if (streq(p[0], "disable-dco"))
5877 {
5878 options->disable_dco = true;
5879 }
5880 else if (streq(p[0], "dev-node") && p[1] && !p[2])
5881 {
5883 options->dev_node = p[1];
5884 }
5885 else if (streq(p[0], "lladdr") && p[1] && !p[2])
5886 {
5888 if (mac_addr_safe(p[1])) /* MAC address only */
5889 {
5890 options->lladdr = p[1];
5891 }
5892 else
5893 {
5894 msg(msglevel, "lladdr parm '%s' must be a MAC address", p[1]);
5895 goto err;
5896 }
5897 }
5898 else if (streq(p[0], "topology") && p[1] && !p[2])
5899 {
5901 options->topology = parse_topology(p[1], msglevel);
5902 }
5903 else if (streq(p[0], "tun-ipv6") && !p[1])
5904 {
5905 if (!pull_mode)
5906 {
5907 msg(M_WARN,
5908 "Note: option tun-ipv6 is ignored because modern operating systems do not need special IPv6 tun handling anymore.");
5909 }
5910 }
5911#ifdef ENABLE_IPROUTE
5912 else if (streq(p[0], "iproute") && p[1] && !p[2])
5913 {
5915 iproute_path = p[1];
5916 }
5917#endif
5918 else if (streq(p[0], "ifconfig") && p[1] && p[2] && !p[3])
5919 {
5922 && ip_or_dns_addr_safe(p[2], options->allow_pull_fqdn)) /* FQDN -- may be DNS name */
5923 {
5924 options->ifconfig_local = p[1];
5926 }
5927 else
5928 {
5929 msg(msglevel, "ifconfig parms '%s' and '%s' must be valid addresses", p[1], p[2]);
5930 goto err;
5931 }
5932 }
5933 else if (streq(p[0], "ifconfig-ipv6") && p[1] && p[2] && !p[3])
5934 {
5935 unsigned int netbits;
5936
5938 if (get_ipv6_addr(p[1], NULL, &netbits, msglevel) && ipv6_addr_safe(p[2]))
5939 {
5941 {
5942 msg(msglevel, "ifconfig-ipv6: /netbits must be between 64 and 124, not '/%d'",
5943 netbits);
5944 goto err;
5945 }
5946
5948 options->ifconfig_ipv6_netbits = netbits;
5950 }
5951 else
5952 {
5953 msg(msglevel, "ifconfig-ipv6 parms '%s' and '%s' must be valid addresses", p[1], p[2]);
5954 goto err;
5955 }
5956 }
5957 else if (streq(p[0], "ifconfig-noexec") && !p[1])
5958 {
5960 options->ifconfig_noexec = true;
5961 }
5962 else if (streq(p[0], "ifconfig-nowarn") && !p[1])
5963 {
5965 options->ifconfig_nowarn = true;
5966 }
5967 else if (streq(p[0], "local") && p[1] && !p[4])
5968 {
5969 struct local_entry *e;
5970
5972
5974 ASSERT(e);
5975
5976 /* '*' is treated as 'ask the system to get some socket',
5977 * therefore force binding on a particular address only when
5978 * actually specified. */
5979 if (strcmp(p[1], "*") != 0)
5980 {
5981 e->local = p[1];
5982 }
5983
5984 if (p[2])
5985 {
5986 e->port = p[2];
5987 }
5988
5989 if (p[3])
5990 {
5991 e->proto = ascii2proto(p[3]);
5992 }
5993 }
5994 else if (streq(p[0], "remote-random") && !p[1])
5995 {
5997 options->remote_random = true;
5998 }
5999 else if (streq(p[0], "connection") && p[1] && !p[3])
6000 {
6002 if (is_inline)
6003 {
6004 struct options sub;
6005 struct connection_entry *e;
6006
6007 init_options(&sub, true);
6008 sub.ce = options->ce;
6009 read_config_string("[CONNECTION-OPTIONS]", &sub, p[1], msglevel, OPT_P_CONNECTION,
6010 option_types_found, es);
6011 if (!sub.ce.remote)
6012 {
6013 msg(msglevel,
6014 "Each 'connection' block must contain exactly one 'remote' directive");
6015 uninit_options(&sub);
6016 goto err;
6017 }
6018
6019 e = alloc_connection_entry(options, msglevel);
6020 if (!e)
6021 {
6022 uninit_options(&sub);
6023 goto err;
6024 }
6025 *e = sub.ce;
6026 gc_transfer(&options->gc, &sub.gc);
6027 uninit_options(&sub);
6028 }
6029 }
6030 else if (streq(p[0], "ignore-unknown-option") && p[1])
6031 {
6032 int i;
6033 int j;
6034 int numignored = 0;
6035 const char **ignore;
6036
6038 /* Find out how many options to be ignored */
6039 for (i = 1; p[i]; i++)
6040 {
6041 numignored++;
6042 }
6043
6044 /* add number of options already ignored */
6046 {
6047 numignored++;
6048 }
6049
6050 /* Allocate array */
6051 ALLOC_ARRAY_GC(ignore, const char *, numignored + 1, &options->gc);
6053 {
6054 ignore[i] = options->ignore_unknown_option[i];
6055 }
6056
6058
6059 for (j = 1; p[j]; j++)
6060 {
6061 /* Allow the user to specify ignore-unknown-option --opt too */
6062 if (p[j][0] == '-' && p[j][1] == '-')
6063 {
6064 options->ignore_unknown_option[i] = (p[j] + 2);
6065 }
6066 else
6067 {
6068 options->ignore_unknown_option[i] = p[j];
6069 }
6070 i++;
6071 }
6072
6073 options->ignore_unknown_option[i] = NULL;
6074 }
6075#if ENABLE_MANAGEMENT
6076 else if (streq(p[0], "http-proxy-override") && p[1] && p[2] && !p[4])
6077 {
6081 {
6082 goto err;
6083 }
6084 }
6085#endif
6086 else if (streq(p[0], "remote") && p[1] && !p[4])
6087 {
6088 struct remote_entry re;
6089 re.remote = re.remote_port = NULL;
6090 re.proto = -1;
6091 re.af = 0;
6092
6094 re.remote = p[1];
6095 if (p[2])
6096 {
6097 re.remote_port = p[2];
6098 if (p[3])
6099 {
6100 const int proto = ascii2proto(p[3]);
6101 const sa_family_t af = ascii2af(p[3]);
6102 if (proto < 0)
6103 {
6104 msg(msglevel, "remote: bad protocol associated with host %s: '%s'", p[1], p[3]);
6105 goto err;
6106 }
6107 re.proto = proto;
6108 re.af = af;
6109 }
6110 }
6111 if (permission_mask & OPT_P_GENERAL)
6112 {
6113 struct remote_entry *e = alloc_remote_entry(options, msglevel);
6114 if (!e)
6115 {
6116 goto err;
6117 }
6118 *e = re;
6119 }
6120 else if (permission_mask & OPT_P_CONNECTION)
6121 {
6123 }
6124 }
6125 else if (streq(p[0], "resolv-retry") && p[1] && !p[2])
6126 {
6128 if (streq(p[1], "infinite"))
6129 {
6131 }
6132 else
6133 {
6134 options->resolve_retry_seconds = positive_atoi(p[1], msglevel);
6135 }
6136 }
6137 else if ((streq(p[0], "preresolve") || streq(p[0], "ip-remote-hint")) && !p[2])
6138 {
6141 /* Note the ip-remote-hint and the argument p[1] are for
6142 * backward compatibility */
6143 if (p[1])
6144 {
6145 options->ip_remote_hint = p[1];
6146 }
6147 }
6148 else if (streq(p[0], "connect-retry") && p[1] && !p[3])
6149 {
6151 options->ce.connect_retry_seconds = positive_atoi(p[1], msglevel);
6152 /*
6153 * Limit the base value of retry wait interval to 16 bits to avoid
6154 * overflow when scaled up for exponential backoff
6155 */
6156 if (options->ce.connect_retry_seconds > 0xFFFF)
6157 {
6159 msg(M_WARN, "connect retry wait interval truncated to %d",
6161 }
6162
6163 if (p[2])
6164 {
6167 }
6168 }
6169 else if ((streq(p[0], "connect-timeout") || streq(p[0], "server-poll-timeout")) && p[1]
6170 && !p[2])
6171 {
6173 options->ce.connect_timeout = positive_atoi(p[1], msglevel);
6174 }
6175 else if (streq(p[0], "connect-retry-max") && p[1] && !p[2])
6176 {
6178 options->connect_retry_max = positive_atoi(p[1], msglevel);
6179 }
6180 else if (streq(p[0], "ipchange") && p[1])
6181 {
6183 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
6184 {
6185 goto err;
6186 }
6188 string_substitute(p[1], ',', ' ', &options->gc), "ipchange", true);
6189 }
6190 else if (streq(p[0], "float") && !p[1])
6191 {
6193 options->ce.remote_float = true;
6194 }
6195#ifdef ENABLE_DEBUG
6196 else if (streq(p[0], "gremlin") && p[1] && !p[2])
6197 {
6199 options->gremlin = positive_atoi(p[1], msglevel);
6200 }
6201#endif
6202 else if (streq(p[0], "chroot") && p[1] && !p[2])
6203 {
6205 options->chroot_dir = p[1];
6206 }
6207 else if (streq(p[0], "cd") && p[1] && !p[2])
6208 {
6210 if (platform_chdir(p[1]))
6211 {
6212 msg(M_ERR, "cd to '%s' failed", p[1]);
6213 goto err;
6214 }
6215 options->cd_dir = p[1];
6216 }
6217#ifdef ENABLE_SELINUX
6218 else if (streq(p[0], "setcon") && p[1] && !p[2])
6219 {
6221 options->selinux_context = p[1];
6222 }
6223#endif
6224 else if (streq(p[0], "writepid") && p[1] && !p[2])
6225 {
6227 options->writepid = p[1];
6228 }
6229 else if (streq(p[0], "up") && p[1])
6230 {
6232 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
6233 {
6234 goto err;
6235 }
6236 set_user_script(options, &options->up_script, p[1], "up", false);
6237 }
6238 else if (streq(p[0], "down") && p[1])
6239 {
6241 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
6242 {
6243 goto err;
6244 }
6245 set_user_script(options, &options->down_script, p[1], "down", true);
6246 }
6247 else if (streq(p[0], "down-pre") && !p[1])
6248 {
6250 options->down_pre = true;
6251 }
6252 else if (streq(p[0], "up-delay") && !p[1])
6253 {
6255 options->up_delay = true;
6256 }
6257 else if (streq(p[0], "up-restart") && !p[1])
6258 {
6260 options->up_restart = true;
6261 }
6262 else if (streq(p[0], "syslog") && !p[2])
6263 {
6265 open_syslog(p[1], false);
6266 }
6267 else if (streq(p[0], "daemon") && !p[2])
6268 {
6269 bool didit = false;
6271 if (!options->daemon)
6272 {
6273 options->daemon = didit = true;
6274 open_syslog(p[1], false);
6275 }
6276 if (p[1])
6277 {
6278 if (!didit)
6279 {
6280 msg(M_WARN,
6281 "WARNING: Multiple --daemon directives specified, ignoring --daemon %s. (Note that initscripts sometimes add their own --daemon directive.)",
6282 p[1]);
6283 goto err;
6284 }
6285 }
6286 }
6287 else if (streq(p[0], "log") && p[1] && !p[2])
6288 {
6290 options->log = true;
6291 redirect_stdout_stderr(p[1], false);
6292 }
6293 else if (streq(p[0], "suppress-timestamps") && !p[1])
6294 {
6298 }
6299 else if (streq(p[0], "machine-readable-output") && !p[1])
6300 {
6304 }
6305 else if (streq(p[0], "log-append") && p[1] && !p[2])
6306 {
6308 options->log = true;
6309 redirect_stdout_stderr(p[1], true);
6310 }
6311 else if (streq(p[0], "mlock") && !p[1])
6312 {
6314 options->mlock = true;
6315 }
6316#if ENABLE_IP_PKTINFO
6317 else if (streq(p[0], "multihome") && !p[2])
6318 {
6321 if (p[1] && streq(p[1], "same-interface"))
6322 {
6324 }
6325 else if (p[1])
6326 {
6327 msg(msglevel, "Unknown parameter to --multihome: %s", p[1]);
6328 }
6329 }
6330#endif
6331 else if (streq(p[0], "verb") && p[1] && !p[2])
6332 {
6334 options->verbosity = positive_atoi(p[1], msglevel);
6336 {
6337 /* We pass this flag to the SSL library to avoid
6338 * mbed TLS always generating debug level logging */
6340 }
6341#if !defined(ENABLE_DEBUG) && !defined(ENABLE_SMALL)
6342 /* Warn when a debug verbosity is supplied when built without debug support */
6343 if (options->verbosity >= 7)
6344 {
6345 msg(M_WARN,
6346 "NOTE: debug verbosity (--verb %d) is enabled but this build lacks debug support.",
6348 }
6349#endif
6350 }
6351 else if (streq(p[0], "mute") && p[1] && !p[2])
6352 {
6354 options->mute = positive_atoi(p[1], msglevel);
6355 }
6356 else if (streq(p[0], "errors-to-stderr") && !p[1])
6357 {
6360 }
6361 else if (streq(p[0], "status") && p[1] && !p[3])
6362 {
6364 options->status_file = p[1];
6365 if (p[2])
6366 {
6368 }
6369 }
6370 else if (streq(p[0], "status-version") && p[1] && !p[2])
6371 {
6373 if (!atoi_constrained(p[1], &options->status_file_version, p[0], 1, 3, msglevel))
6374 {
6375 goto err;
6376 }
6377 }
6378 else if (streq(p[0], "remap-usr1") && p[1] && !p[2])
6379 {
6381 if (streq(p[1], "SIGHUP"))
6382 {
6384 }
6385 else if (streq(p[1], "SIGTERM"))
6386 {
6388 }
6389 else
6390 {
6391 msg(msglevel, "--remap-usr1 parm must be 'SIGHUP' or 'SIGTERM'");
6392 goto err;
6393 }
6394 }
6395 else if ((streq(p[0], "link-mtu") || streq(p[0], "udp-mtu")) && p[1] && !p[2])
6396 {
6398 options->ce.link_mtu = positive_atoi(p[1], msglevel);
6399 options->ce.link_mtu_defined = true;
6400 }
6401 else if (streq(p[0], "tun-mtu") && p[1] && !p[3])
6402 {
6404 options->ce.tun_mtu = positive_atoi(p[1], msglevel);
6405 options->ce.tun_mtu_defined = true;
6406 if (p[2])
6407 {
6408 options->ce.occ_mtu = positive_atoi(p[2], msglevel);
6409 }
6410 else
6411 {
6412 options->ce.occ_mtu = 0;
6413 }
6414 }
6415 else if (streq(p[0], "tun-mtu-max") && p[1] && !p[2])
6416 {
6418 atoi_constrained(p[1], &options->ce.tun_mtu_max, p[0], TUN_MTU_MAX_MIN, 65536, msglevel);
6419 }
6420 else if (streq(p[0], "tun-mtu-extra") && p[1] && !p[2])
6421 {
6423 if (atoi_constrained(p[1], &options->ce.tun_mtu_extra, p[0], 0, 65536, msglevel))
6424 {
6426 }
6427 }
6428 else if (streq(p[0], "max-packet-size") && p[1] && !p[2])
6429 {
6431 int maxmtu = positive_atoi(p[1], msglevel);
6433
6434 if (maxmtu < TLS_CHANNEL_MTU_MIN || maxmtu > TLS_CHANNEL_BUF_SIZE)
6435 {
6436 msg(M_WARN,
6437 "Note: max-packet-size value outside of allowed "
6438 "control channel packet size (%d to %d), will use %d "
6439 "instead.",
6441 }
6442
6443 /* also set mssfix maxmtu mtu */
6444 options->ce.mssfix = maxmtu;
6445 options->ce.mssfix_default = false;
6446 options->ce.mssfix_encap = true;
6447 }
6448#ifdef ENABLE_FRAGMENT
6449 else if (streq(p[0], "mtu-dynamic"))
6450 {
6452 msg(msglevel, "--mtu-dynamic has been replaced by --fragment");
6453 goto err;
6454 }
6455 else if (streq(p[0], "fragment") && p[1] && !p[3])
6456 {
6458 if (!atoi_constrained(p[1], &options->ce.fragment, p[0], 68, INT_MAX, msglevel))
6459 {
6460 goto err;
6461 }
6462
6463 if (p[2] && streq(p[2], "mtu"))
6464 {
6465 options->ce.fragment_encap = true;
6466 }
6467 else if (p[2])
6468 {
6469 msg(msglevel, "Unknown parameter to --fragment: %s", p[2]);
6470 }
6471 }
6472#endif /* ifdef ENABLE_FRAGMENT */
6473 else if (streq(p[0], "mtu-disc") && p[1] && !p[2])
6474 {
6477 }
6478 else if (streq(p[0], "mtu-test") && !p[1])
6479 {
6481 options->mtu_test = true;
6482 }
6483 else if (streq(p[0], "nice") && p[1] && !p[2])
6484 {
6486 options->nice = atoi_warn(p[1], msglevel);
6487 }
6488 else if (streq(p[0], "rcvbuf") && p[1] && !p[2])
6489 {
6491 options->rcvbuf = positive_atoi(p[1], msglevel);
6492 }
6493 else if (streq(p[0], "sndbuf") && p[1] && !p[2])
6494 {
6496 options->sndbuf = positive_atoi(p[1], msglevel);
6497 }
6498 else if (streq(p[0], "mark") && p[1] && !p[2])
6499 {
6500#if defined(TARGET_LINUX)
6502 options->mark = atoi_warn(p[1], msglevel);
6503#endif
6504 }
6505 else if (streq(p[0], "socket-flags"))
6506 {
6507 int j;
6509 for (j = 1; j < MAX_PARMS && p[j]; ++j)
6510 {
6511 if (streq(p[j], "TCP_NODELAY"))
6512 {
6514 }
6515 else
6516 {
6517 msg(msglevel, "unknown socket flag: %s", p[j]);
6518 }
6519 }
6520 }
6521#ifdef TARGET_LINUX
6522 else if (streq(p[0], "bind-dev") && p[1])
6523 {
6525 options->bind_dev = p[1];
6526 }
6527#endif
6528 else if (streq(p[0], "txqueuelen") && p[1] && !p[2])
6529 {
6531#ifdef TARGET_LINUX
6532 options->tuntap_options.txqueuelen = positive_atoi(p[1], msglevel);
6533#else
6534 msg(msglevel, "--txqueuelen not supported on this OS");
6535 goto err;
6536#endif
6537 }
6538 else if (streq(p[0], "shaper") && p[1] && !p[2])
6539 {
6541 if (!atoi_constrained(p[1], &options->shaper, p[0], SHAPER_MIN, SHAPER_MAX, msglevel))
6542 {
6543 goto err;
6544 }
6545 }
6546 else if (streq(p[0], "port") && p[1] && !p[2])
6547 {
6550 }
6551 else if (streq(p[0], "lport") && p[1] && !p[2])
6552 {
6554
6555 /* only trigger bind() if port is not 0 (or --local is used) */
6556 if (!streq(p[1], "0"))
6557 {
6559 }
6560 options->ce.local_port = p[1];
6561 }
6562 else if (streq(p[0], "rport") && p[1] && !p[2])
6563 {
6565 options->ce.remote_port = p[1];
6566 }
6567 else if (streq(p[0], "bind") && !p[2])
6568 {
6570 options->ce.bind_defined = true;
6571 if (p[1] && streq(p[1], "ipv6only"))
6572 {
6573 options->ce.bind_ipv6_only = true;
6574 }
6575 }
6576 else if (streq(p[0], "nobind") && !p[1])
6577 {
6579 options->ce.bind_local = false;
6580 }
6581 else if (streq(p[0], "fast-io") && !p[1])
6582 {
6584 msg(M_WARN, "DEPRECATED OPTION: --fast-io option ignored.");
6585 }
6586 else if (streq(p[0], "inactive") && p[1] && !p[3])
6587 {
6589 options->inactivity_timeout = positive_atoi(p[1], msglevel);
6590 if (p[2])
6591 {
6592 positive_atoll(p[2], &options->inactivity_minimum_bytes, p[0], msglevel);
6593 if (options->inactivity_minimum_bytes > INT_MAX)
6594 {
6595 msg(M_WARN,
6596 "WARNING: '--inactive' with a 'bytes' value"
6597 " >2 Gbyte was silently ignored in older versions. If "
6598 " your VPN exits unexpectedly with 'Inactivity timeout'"
6599 " in %d seconds, revisit this value.",
6601 }
6602 }
6603 }
6604 else if (streq(p[0], "session-timeout") && p[1] && !p[2])
6605 {
6607 options->session_timeout = positive_atoi(p[1], msglevel);
6608 }
6609 else if (streq(p[0], "proto") && p[1] && !p[2])
6610 {
6611 int proto;
6614 proto = ascii2proto(p[1]);
6615 af = ascii2af(p[1]);
6616 if (proto < 0)
6617 {
6618 msg(msglevel, "Bad protocol: '%s'. Allowed protocols with --proto option: %s", p[1],
6620 goto err;
6621 }
6622 options->ce.proto = proto;
6623 options->ce.af = af;
6624 }
6625 else if (streq(p[0], "proto-force") && p[1] && !p[2])
6626 {
6627 int proto_force;
6629 proto_force = ascii2proto(p[1]);
6630 if (proto_force < 0)
6631 {
6632 msg(msglevel, "Bad --proto-force protocol: '%s'", p[1]);
6633 goto err;
6634 }
6635 options->proto_force = proto_force;
6636 }
6637 else if (streq(p[0], "http-proxy") && p[1] && !p[5])
6638 {
6639 struct http_proxy_options *ho;
6640
6642
6643 {
6644 if (!p[2])
6645 {
6646 msg(msglevel, "http-proxy port number not defined");
6647 goto err;
6648 }
6649
6651
6652 ho->server = p[1];
6653 ho->port = p[2];
6654 }
6655
6656 if (p[3])
6657 {
6658 /* auto -- try to figure out proxy addr, port, and type automatically */
6659 /* auto-nct -- disable proxy auth cleartext protocols (i.e. basic auth) */
6660 if (streq(p[3], "auto"))
6661 {
6662 ho->auth_retry = PAR_ALL;
6663 }
6664 else if (streq(p[3], "auto-nct"))
6665 {
6666 ho->auth_retry = PAR_NCT;
6667 }
6668 else
6669 {
6670 ho->auth_method_string = "basic";
6671 ho->auth_file = p[3];
6672
6673 if (p[4])
6674 {
6675 ho->auth_method_string = p[4];
6676 }
6677 }
6678 }
6679 else
6680 {
6681 ho->auth_method_string = "none";
6682 }
6683 }
6684 else if (streq(p[0], "http-proxy-user-pass") && p[1])
6685 {
6686 struct http_proxy_options *ho;
6689 ho->auth_file_up = p[1];
6690 ho->inline_creds = is_inline;
6691 }
6692 else if (streq(p[0], "http-proxy-retry") || streq(p[0], "socks-proxy-retry") || streq(p[0], "http-proxy-timeout"))
6693 {
6695 msg(M_WARN, "DEPRECATED OPTION: %s option ignored.", p[0]);
6696 }
6697 else if (streq(p[0], "http-proxy-option") && p[1] && !p[4])
6698 {
6699 struct http_proxy_options *ho;
6700
6703
6704 if (streq(p[1], "VERSION") && p[2] && !p[3])
6705 {
6706 ho->http_version = p[2];
6707 }
6708 else if (streq(p[1], "AGENT") && p[2] && !p[3])
6709 {
6710 ho->user_agent = p[2];
6711 }
6712 else if ((streq(p[1], "EXT1") || streq(p[1], "EXT2") || streq(p[1], "CUSTOM-HEADER"))
6713 && p[2])
6714 {
6715 /* In the wild patched versions use both EXT1/2 and CUSTOM-HEADER
6716 * with either two argument or one */
6717
6718 struct http_custom_header *custom_header = NULL;
6719 int i;
6720 /* Find the first free header */
6721 for (i = 0; i < MAX_CUSTOM_HTTP_HEADER; i++)
6722 {
6723 if (!ho->custom_headers[i].name)
6724 {
6725 custom_header = &ho->custom_headers[i];
6726 break;
6727 }
6728 }
6729 if (!custom_header)
6730 {
6731 msg(msglevel, "Cannot use more than %d http-proxy-option CUSTOM-HEADER : '%s'",
6733 }
6734 else
6735 {
6736 /* We will save p[2] and p[3], the proxy code will detect if
6737 * p[3] is NULL */
6738 custom_header->name = p[2];
6739 custom_header->content = p[3];
6740 }
6741 }
6742 else
6743 {
6744 msg(msglevel, "Bad http-proxy-option or missing or extra parameter: '%s'", p[1]);
6745 }
6746 }
6747 else if (streq(p[0], "socks-proxy") && p[1] && !p[4])
6748 {
6750
6751 if (p[2])
6752 {
6753 options->ce.socks_proxy_port = p[2];
6754 }
6755 else
6756 {
6757 options->ce.socks_proxy_port = "1080";
6758 }
6760 options->ce.socks_proxy_authfile = p[3]; /* might be NULL */
6761 }
6762 else if (streq(p[0], "keepalive") && p[1] && p[2] && !p[3])
6763 {
6765 options->keepalive_ping = atoi_warn(p[1], msglevel);
6766 options->keepalive_timeout = atoi_warn(p[2], msglevel);
6767 }
6768 else if (streq(p[0], "ping") && p[1] && !p[2])
6769 {
6771 options->ping_send_timeout = positive_atoi(p[1], msglevel);
6772 }
6773 else if (streq(p[0], "ping-exit") && p[1] && !p[2])
6774 {
6776 options->ping_rec_timeout = positive_atoi(p[1], msglevel);
6778 }
6779 else if (streq(p[0], "ping-restart") && p[1] && !p[2])
6780 {
6782 options->ping_rec_timeout = positive_atoi(p[1], msglevel);
6784 }
6785 else if (streq(p[0], "ping-timer-rem") && !p[1])
6786 {
6788 options->ping_timer_remote = true;
6789 }
6790 else if (streq(p[0], "explicit-exit-notify") && !p[2])
6791 {
6793 if (p[1])
6794 {
6796 }
6797 else
6798 {
6800 }
6801 }
6802 else if (streq(p[0], "persist-tun") && !p[1])
6803 {
6805 options->persist_tun = true;
6806 }
6807 else if (streq(p[0], "persist-key") && !p[1])
6808 {
6810 msg(M_WARN, "DEPRECATED OPTION: --persist-key option ignored. "
6811 "Keys are now always persisted across restarts. ");
6812 }
6813 else if (streq(p[0], "persist-local-ip") && !p[1])
6814 {
6816 options->persist_local_ip = true;
6817 }
6818 else if (streq(p[0], "persist-remote-ip") && !p[1])
6819 {
6821 options->persist_remote_ip = true;
6822 }
6823 else if (streq(p[0], "client-nat") && p[1] && p[2] && p[3] && p[4] && !p[5])
6824 {
6827 add_client_nat_to_option_list(options->client_nat, p[1], p[2], p[3], p[4], msglevel);
6828 }
6829 else if (streq(p[0], "route-table") && p[1] && !p[2])
6830 {
6831#ifndef ENABLE_SITNL
6832 msg(M_WARN, "NOTE: --route-table is supported only on Linux when SITNL is built-in");
6833#endif
6835 options->route_default_table_id = positive_atoi(p[1], msglevel);
6836 }
6837 else if (streq(p[0], "route") && p[1] && !p[5])
6838 {
6840 if (!check_route_option(options, p, msglevel, pull_mode))
6841 {
6842 goto err;
6843 }
6844 add_route_to_option_list(options->routes, p[1], p[2], p[3], p[4],
6846 }
6847 else if (streq(p[0], "route-ipv6") && p[1] && !p[4])
6848 {
6850 if (!check_route6_option(options, p, msglevel, pull_mode))
6851 {
6852 goto err;
6853 }
6856 }
6857 else if (streq(p[0], "max-routes") && !p[2])
6858 {
6859 msg(M_WARN, "DEPRECATED OPTION: --max-routes option ignored.");
6860 }
6861 else if (streq(p[0], "route-gateway") && p[1] && !p[2])
6862 {
6864 if (streq(p[1], "dhcp"))
6865 {
6867 }
6868 else
6869 {
6871 || is_special_addr(p[1])) /* FQDN -- may be DNS name */
6872 {
6874 }
6875 else
6876 {
6877 msg(msglevel, "route-gateway parm '%s' must be a valid address", p[1]);
6878 goto err;
6879 }
6880 }
6881 }
6882 else if (streq(p[0], "route-ipv6-gateway") && p[1] && !p[2])
6883 {
6884 if (ipv6_addr_safe(p[1]))
6885 {
6887 }
6888 else
6889 {
6890 msg(msglevel, "route-ipv6-gateway parm '%s' must be a valid address", p[1]);
6891 goto err;
6892 }
6893 }
6894 else if (streq(p[0], "route-metric") && p[1] && !p[2])
6895 {
6897 options->route_default_metric = positive_atoi(p[1], msglevel);
6898 }
6899 else if (streq(p[0], "route-delay") && !p[3])
6900 {
6903 if (p[1])
6904 {
6905 options->route_delay = positive_atoi(p[1], msglevel);
6906 if (p[2])
6907 {
6908 options->route_delay_window = positive_atoi(p[2], msglevel);
6909 }
6910 }
6911 else
6912 {
6913 options->route_delay = 0;
6914 }
6915 }
6916 else if (streq(p[0], "route-up") && p[1])
6917 {
6919 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
6920 {
6921 goto err;
6922 }
6923 set_user_script(options, &options->route_script, p[1], "route-up", false);
6924 }
6925 else if (streq(p[0], "route-pre-down") && p[1])
6926 {
6928 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
6929 {
6930 goto err;
6931 }
6932 set_user_script(options, &options->route_predown_script, p[1], "route-pre-down", true);
6933 }
6934 else if (streq(p[0], "route-noexec") && !p[1])
6935 {
6937 options->route_noexec = true;
6938 }
6939 else if (streq(p[0], "route-nopull") && !p[1])
6940 {
6942 options->route_nopull = true;
6943 }
6944 else if (streq(p[0], "pull-filter") && p[1] && p[2] && !p[3])
6945 {
6946 struct pull_filter *f;
6949
6950 if (strcmp("accept", p[1]) == 0)
6951 {
6952 f->type = PUF_TYPE_ACCEPT;
6953 }
6954 else if (strcmp("ignore", p[1]) == 0)
6955 {
6956 f->type = PUF_TYPE_IGNORE;
6957 }
6958 else if (strcmp("reject", p[1]) == 0)
6959 {
6960 f->type = PUF_TYPE_REJECT;
6961 }
6962 else
6963 {
6964 msg(msglevel, "Unknown --pull-filter type: %s", p[1]);
6965 goto err;
6966 }
6967 f->pattern = p[2];
6968 f->size = strlen(p[2]);
6969 }
6970 else if (streq(p[0], "allow-pull-fqdn") && !p[1])
6971 {
6973 options->allow_pull_fqdn = true;
6974 }
6975 else if (streq(p[0], "redirect-gateway") || streq(p[0], "redirect-private"))
6976 {
6977 int j;
6980
6981 if (options->routes->flags & RG_ENABLE)
6982 {
6983 msg(M_WARN, "WARNING: You have specified redirect-gateway and "
6984 "redirect-private at the same time (or the same option "
6985 "multiple times). This is not well supported and may lead to "
6986 "unexpected results");
6987 }
6988
6990
6991 if (streq(p[0], "redirect-gateway"))
6992 {
6994 }
6995 for (j = 1; j < MAX_PARMS && p[j] != NULL; ++j)
6996 {
6997 if (streq(p[j], "local"))
6998 {
7000 }
7001 else if (streq(p[j], "autolocal"))
7002 {
7004 }
7005 else if (streq(p[j], "def1"))
7006 {
7008 }
7009 else if (streq(p[j], "bypass-dhcp"))
7010 {
7012 }
7013 else if (streq(p[j], "bypass-dns"))
7014 {
7016 }
7017 else if (streq(p[j], "block-local"))
7018 {
7020 }
7021 else if (streq(p[j], "ipv6"))
7022 {
7025 }
7026 else if (streq(p[j], "!ipv4"))
7027 {
7029 }
7030 else
7031 {
7032 msg(msglevel, "unknown --%s flag: %s", p[0], p[j]);
7033 goto err;
7034 }
7035 }
7037 {
7038 setenv_int(es, "route_redirect_gateway_ipv4",
7039 options->routes->flags & RG_BLOCK_LOCAL ? 2 : 1);
7040 }
7042 {
7043 setenv_int(es, "route_redirect_gateway_ipv6",
7044 options->routes->flags & RG_BLOCK_LOCAL ? 2 : 1);
7045 }
7046#ifdef _WIN32
7047 /* we need this here to handle pushed --redirect-gateway */
7049#endif
7050 }
7051 else if (streq(p[0], "block-ipv6") && !p[1])
7052 {
7054 options->block_ipv6 = true;
7055 }
7056 else if (streq(p[0], "remote-random-hostname") && !p[1])
7057 {
7060 }
7061 else if (streq(p[0], "setenv") && p[1] && !p[3])
7062 {
7064 if (streq(p[1], "REMOTE_RANDOM_HOSTNAME") && !p[2])
7065 {
7067 }
7068 else if (streq(p[1], "GENERIC_CONFIG"))
7069 {
7070 msg(msglevel, "this is a generic configuration and cannot directly be used");
7071 goto err;
7072 }
7073 else if (streq(p[1], "PUSH_PEER_INFO") && !p[2])
7074 {
7075 options->push_peer_info = true;
7076 }
7077 else if (streq(p[1], "SERVER_POLL_TIMEOUT") && p[2])
7078 {
7079 options->ce.connect_timeout = positive_atoi(p[2], msglevel);
7080 }
7081 else
7082 {
7083 if (streq(p[1], "FORWARD_COMPATIBLE") && p[2] && streq(p[2], "1"))
7084 {
7086 msglevel_fc = msglevel_forward_compatible(options, msglevel);
7087 }
7088 setenv_str(es, p[1], p[2] ? p[2] : "");
7089 }
7090 }
7091 else if (streq(p[0], "compat-mode") && p[1] && !p[3])
7092 {
7093 unsigned int major, minor, patch;
7094 if (!(sscanf(p[1], "%u.%u.%u", &major, &minor, &patch) == 3))
7095 {
7096 msg(msglevel, "cannot parse version number for --compat-mode: %s", p[1]);
7097 goto err;
7098 }
7099
7100 options->backwards_compatible = major * 10000 + minor * 100 + patch;
7101 }
7102 else if (streq(p[0], "setenv-safe") && p[1] && !p[3])
7103 {
7105 setenv_str_safe(es, p[1], p[2] ? p[2] : "");
7106 }
7107 else if (streq(p[0], "script-security") && p[1] && !p[2])
7108 {
7110 int security;
7111 if (atoi_constrained(p[1], &security, p[0], SSEC_NONE, SSEC_PW_ENV, msglevel))
7112 {
7113 script_security_set(security);
7114 }
7115 }
7116 else if (streq(p[0], "mssfix") && !p[3])
7117 {
7119 if (p[1])
7120 {
7121 int mssfix;
7122 if (!atoi_constrained(p[1], &mssfix, p[0], 0, UINT16_MAX, msglevel))
7123 {
7124 goto err;
7125 }
7126 if (mssfix != 0 && mssfix < TLS_CHANNEL_MTU_MIN)
7127 {
7128 msg(msglevel, "mssfix needs to be >= %d, not %d", TLS_CHANNEL_MTU_MIN, mssfix);
7129 goto err;
7130 }
7131
7132 /* value specified, assume encapsulation is not
7133 * included unless "mtu" follows later */
7134 options->ce.mssfix = mssfix;
7135 options->ce.mssfix_encap = false;
7136 options->ce.mssfix_default = false;
7137 }
7138 else
7139 {
7140 /* Set MTU to default values */
7141 options->ce.mssfix_default = true;
7142 options->ce.mssfix_encap = true;
7143 options->ce.mssfix_fixed = false;
7144 }
7145
7146 if (p[2] && streq(p[2], "mtu"))
7147 {
7148 options->ce.mssfix_encap = true;
7149 }
7150 else if (p[2] && streq(p[2], "fixed"))
7151 {
7152 options->ce.mssfix_fixed = true;
7153 }
7154 else if (p[2])
7155 {
7156 msg(msglevel, "Unknown parameter to --mssfix: %s", p[2]);
7157 }
7158 }
7159 else if (streq(p[0], "disable-occ") && !p[1])
7160 {
7162 options->occ = false;
7163 }
7164 else if (streq(p[0], "server") && p[1] && p[2] && !p[4])
7165 {
7166 const int lev = M_WARN;
7167 bool error = false;
7168 in_addr_t network, netmask;
7169
7171 network = get_ip_addr(p[1], lev, &error);
7172 netmask = get_ip_addr(p[2], lev, &error);
7173 if (error || !network || !netmask)
7174 {
7175 msg(msglevel, "error parsing --server parameters");
7176 goto err;
7177 }
7178 options->server_defined = true;
7179 options->server_network = network;
7180 options->server_netmask = netmask;
7181
7182 if (p[3])
7183 {
7184 if (streq(p[3], "nopool"))
7185 {
7187 }
7188 else
7189 {
7190 msg(msglevel, "error parsing --server: %s is not a recognized flag", p[3]);
7191 goto err;
7192 }
7193 }
7194 }
7195 else if (streq(p[0], "server-ipv6") && p[1] && !p[2])
7196 {
7197 const int lev = M_WARN;
7198 struct in6_addr network;
7199 unsigned int netbits = 0;
7200
7202 if (!get_ipv6_addr(p[1], &network, &netbits, lev))
7203 {
7204 msg(msglevel, "error parsing --server-ipv6 parameter");
7205 goto err;
7206 }
7207 if (netbits < 64 || netbits > 124)
7208 {
7209 msg(msglevel, "--server-ipv6 settings: network must be between /64 and /124 (not /%d)",
7210 netbits);
7211
7212 goto err;
7213 }
7215 options->server_network_ipv6 = network;
7216 options->server_netbits_ipv6 = netbits;
7217 }
7218 else if (streq(p[0], "server-bridge") && p[1] && p[2] && p[3] && p[4] && !p[5])
7219 {
7220 const int lev = M_WARN;
7221 bool error = false;
7222 in_addr_t ip, netmask, pool_start, pool_end;
7223
7225 ip = get_ip_addr(p[1], lev, &error);
7226 netmask = get_ip_addr(p[2], lev, &error);
7227 pool_start = get_ip_addr(p[3], lev, &error);
7228 pool_end = get_ip_addr(p[4], lev, &error);
7229 if (error || !ip || !netmask || !pool_start || !pool_end)
7230 {
7231 msg(msglevel, "error parsing --server-bridge parameters");
7232 goto err;
7233 }
7236 options->server_bridge_netmask = netmask;
7237 options->server_bridge_pool_start = pool_start;
7238 options->server_bridge_pool_end = pool_end;
7239 }
7240 else if (streq(p[0], "server-bridge") && p[1] && streq(p[1], "nogw") && !p[2])
7241 {
7245 }
7246 else if (streq(p[0], "server-bridge") && !p[1])
7247 {
7250 }
7251 else if (streq(p[0], "push") && p[1] && !p[2])
7252 {
7254 push_options(options, &p[1], msglevel, &options->gc);
7255 }
7256 else if (streq(p[0], "push-reset") && !p[1])
7257 {
7260 }
7261 else if (streq(p[0], "push-remove") && p[1] && !p[2])
7262 {
7264 msg(D_PUSH, "PUSH_REMOVE '%s'", p[1]);
7266 }
7267 else if (streq(p[0], "ifconfig-pool") && p[1] && p[2] && !p[4])
7268 {
7269 const int lev = M_WARN;
7270 bool error = false;
7271 in_addr_t start, end, netmask = 0;
7272
7274 start = get_ip_addr(p[1], lev, &error);
7275 end = get_ip_addr(p[2], lev, &error);
7276 if (p[3])
7277 {
7278 netmask = get_ip_addr(p[3], lev, &error);
7279 }
7280 if (error)
7281 {
7282 msg(msglevel, "error parsing --ifconfig-pool parameters");
7283 goto err;
7284 }
7285 if (!ifconfig_pool_verify_range(msglevel, start, end))
7286 {
7287 goto err;
7288 }
7289
7293 if (netmask)
7294 {
7295 options->ifconfig_pool_netmask = netmask;
7296 }
7297 }
7298 else if (streq(p[0], "ifconfig-pool-persist") && p[1] && !p[3])
7299 {
7302 if (p[2])
7303 {
7305 }
7306 }
7307 else if (streq(p[0], "ifconfig-ipv6-pool") && p[1] && !p[2])
7308 {
7309 const int lev = M_WARN;
7310 struct in6_addr network;
7311 unsigned int netbits = 0;
7312
7314 if (!get_ipv6_addr(p[1], &network, &netbits, lev))
7315 {
7316 msg(msglevel, "error parsing --ifconfig-ipv6-pool parameters");
7317 goto err;
7318 }
7319 if (netbits < 64 || netbits > 124)
7320 {
7321 msg(msglevel,
7322 "--ifconfig-ipv6-pool settings: network must be between /64 and /124 (not /%d)",
7323 netbits);
7324 goto err;
7325 }
7326
7330 }
7331 else if (streq(p[0], "hash-size") && p[1] && p[2] && !p[3])
7332 {
7333 int real, virtual;
7334
7336 if (!atoi_constrained(p[1], &real, "hash-size real", 1, INT_MAX, msglevel)
7337 || !atoi_constrained(p[2], &virtual, "hash-size virtual", 1, INT_MAX, msglevel))
7338 {
7339 goto err;
7340 }
7341 options->real_hash_size = (uint32_t)real;
7342 options->virtual_hash_size = (uint32_t)virtual;
7343 }
7344 else if (streq(p[0], "connect-freq") && p[1] && p[2] && !p[3])
7345 {
7346 int cf_max, cf_per;
7347
7349 if (!atoi_constrained(p[1], &cf_max, "connect-freq n", 1, INT_MAX, msglevel)
7350 || !atoi_constrained(p[2], &cf_per, "connect-freq seconds", 1, INT_MAX, msglevel))
7351 {
7352 goto err;
7353 }
7354 options->cf_max = cf_max;
7355 options->cf_per = cf_per;
7356 }
7357 else if (streq(p[0], "connect-freq-initial") && p[1] && p[2] && !p[3])
7358 {
7359 int cf_max, cf_per;
7360
7362 if (!atoi_constrained(p[1], &cf_max, "connect-freq-initial n", 1, INT_MAX, msglevel)
7363 || !atoi_constrained(p[2], &cf_per, "connect-freq-initial seconds", 1, INT_MAX, msglevel))
7364 {
7365 goto err;
7366 }
7367 options->cf_initial_max = cf_max;
7368 options->cf_initial_per = cf_per;
7369 }
7370 else if (streq(p[0], "max-clients") && p[1] && !p[2])
7371 {
7373 if (!atoi_constrained(p[1], &options->max_clients, p[0], 1, MAX_PEER_ID, msglevel))
7374 {
7375 goto err;
7376 }
7377 }
7378 else if (streq(p[0], "max-routes-per-client") && p[1] && !p[2])
7379 {
7381 atoi_constrained(p[1], &options->max_routes_per_client, p[0], 1, INT_MAX, msglevel);
7382 }
7383 else if (streq(p[0], "client-cert-not-required") && !p[1])
7384 {
7386 msg(M_FATAL,
7387 "REMOVED OPTION: --client-cert-not-required, use '--verify-client-cert none' instead");
7388 }
7389 else if (streq(p[0], "verify-client-cert") && !p[2])
7390 {
7392
7393 /* Reset any existing flags */
7394 options->ssl_flags &= ~SSLF_CLIENT_CERT_OPTIONAL;
7395 options->ssl_flags &= ~SSLF_CLIENT_CERT_NOT_REQUIRED;
7396 if (p[1])
7397 {
7398 if (streq(p[1], "none"))
7399 {
7401 }
7402 else if (streq(p[1], "optional"))
7403 {
7405 }
7406 else if (!streq(p[1], "require"))
7407 {
7408 msg(msglevel,
7409 "parameter to --verify-client-cert must be 'none', 'optional' or 'require'");
7410 goto err;
7411 }
7412 }
7413 }
7414 else if (streq(p[0], "username-as-common-name") && !p[1])
7415 {
7418 }
7419 else if (streq(p[0], "auth-user-pass-optional") && !p[1])
7420 {
7423 }
7424 else if (streq(p[0], "opt-verify") && !p[1])
7425 {
7427 msg(M_INFO, "DEPRECATED OPTION: --opt-verify was removed in OpenVPN 2.7.");
7428 }
7429 else if (streq(p[0], "auth-user-pass-verify") && p[1])
7430 {
7432 if (!no_more_than_n_args(msglevel, p, 3, NM_QUOTE_HINT))
7433 {
7434 goto err;
7435 }
7436 if (p[2])
7437 {
7438 if (streq(p[2], "via-env"))
7439 {
7441 }
7442 else if (streq(p[2], "via-file"))
7443 {
7445 }
7446 else
7447 {
7448 msg(msglevel,
7449 "second parm to --auth-user-pass-verify must be 'via-env' or 'via-file'");
7450 goto err;
7451 }
7452 }
7453 else
7454 {
7455 msg(msglevel,
7456 "--auth-user-pass-verify requires a second parameter ('via-env' or 'via-file')");
7457 goto err;
7458 }
7460 "auth-user-pass-verify", true);
7461 }
7462 else if (streq(p[0], "auth-gen-token"))
7463 {
7466 options->auth_token_lifetime = p[1] ? positive_atoi(p[1], msglevel) : 0;
7467
7468 for (int i = 2; i < MAX_PARMS && p[i] != NULL; i++)
7469 {
7470 /* the second parameter can be the renewal time */
7471 if (i == 2 && valid_integer(p[i], true))
7472 {
7473 options->auth_token_renewal = positive_atoi(p[i], msglevel);
7474 }
7475 else if (streq(p[i], "external-auth"))
7476 {
7478 }
7479 else
7480 {
7481 msg(msglevel, "Invalid argument to auth-gen-token: %s (%d)", p[i], i);
7482 }
7483 }
7484 }
7485 else if (streq(p[0], "auth-gen-token-secret") && p[1] && !p[2])
7486 {
7490 }
7491 else if (streq(p[0], "client-connect") && p[1])
7492 {
7494 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
7495 {
7496 goto err;
7497 }
7498 set_user_script(options, &options->client_connect_script, p[1], "client-connect", true);
7499 }
7500 else if (streq(p[0], "client-crresponse") && p[1])
7501 {
7503 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
7504 {
7505 goto err;
7506 }
7507 set_user_script(options, &options->client_crresponse_script, p[1], "client-crresponse",
7508 true);
7509 }
7510 else if (streq(p[0], "client-disconnect") && p[1])
7511 {
7513 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
7514 {
7515 goto err;
7516 }
7517 set_user_script(options, &options->client_disconnect_script, p[1], "client-disconnect",
7518 true);
7519 }
7520 else if (streq(p[0], "learn-address") && p[1])
7521 {
7523 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
7524 {
7525 goto err;
7526 }
7527 set_user_script(options, &options->learn_address_script, p[1], "learn-address", true);
7528 }
7529 else if (streq(p[0], "tmp-dir") && p[1] && !p[2])
7530 {
7532 options->tmp_dir = p[1];
7533 }
7534 else if (streq(p[0], "client-config-dir") && p[1] && !p[2])
7535 {
7537 options->client_config_dir = p[1];
7538 }
7539 else if (streq(p[0], "ccd-exclusive") && !p[1])
7540 {
7542 options->ccd_exclusive = true;
7543 }
7544 else if (streq(p[0], "bcast-buffers") && p[1] && !p[2])
7545 {
7547 atoi_constrained(p[1], &options->n_bcast_buf, p[0], 1, MBUF_SIZE_MAX, msglevel);
7548 }
7549 else if (streq(p[0], "tcp-queue-limit") && p[1] && !p[2])
7550 {
7552 atoi_constrained(p[1], &options->tcp_queue_limit, p[0], 1, INT_MAX, msglevel);
7553 }
7554#if PORT_SHARE
7555 else if (streq(p[0], "port-share") && p[1] && p[2] && !p[4])
7556 {
7558 options->port_share_host = p[1];
7559 options->port_share_port = p[2];
7560 options->port_share_journal_dir = p[3];
7561 }
7562#endif
7563 else if (streq(p[0], "client-to-client") && !p[1])
7564 {
7566 options->enable_c2c = true;
7567 }
7568 else if (streq(p[0], "duplicate-cn") && !p[1])
7569 {
7571 options->duplicate_cn = true;
7572 }
7573 else if (streq(p[0], "iroute") && p[1] && !p[3])
7574 {
7576 option_iroute(options, p[1], p[2], msglevel);
7577 }
7578 else if (streq(p[0], "iroute-ipv6") && p[1] && !p[2])
7579 {
7581 option_iroute_ipv6(options, p[1], msglevel);
7582 }
7583 else if (streq(p[0], "ifconfig-push") && p[1] && p[2] && !p[4])
7584 {
7585 in_addr_t local, remote_netmask;
7586
7588 local = getaddr(GETADDR_HOST_ORDER | GETADDR_RESOLVE, p[1], 0, NULL, NULL);
7589 remote_netmask = getaddr(GETADDR_HOST_ORDER | GETADDR_RESOLVE, p[2], 0, NULL, NULL);
7590 if (local && remote_netmask)
7591 {
7594 options->push_ifconfig_remote_netmask = remote_netmask;
7595 if (p[3])
7596 {
7598 getaddr(GETADDR_HOST_ORDER | GETADDR_RESOLVE, p[3], 0, NULL, NULL);
7599 }
7600 }
7601 else
7602 {
7603 msg(msglevel, "cannot parse --ifconfig-push addresses");
7604 goto err;
7605 }
7606 }
7607 else if (streq(p[0], "ifconfig-push-constraint") && p[1] && p[2] && !p[3])
7608 {
7609 in_addr_t network, netmask;
7610
7612 network = getaddr(GETADDR_HOST_ORDER | GETADDR_RESOLVE, p[1], 0, NULL, NULL);
7613 netmask = getaddr(GETADDR_HOST_ORDER, p[2], 0, NULL, NULL);
7614 if (network && netmask)
7615 {
7619 }
7620 else
7621 {
7622 msg(msglevel, "cannot parse --ifconfig-push-constraint addresses");
7623 goto err;
7624 }
7625 }
7626 else if (streq(p[0], "ifconfig-ipv6-push") && p[1] && !p[3])
7627 {
7628 struct in6_addr local, remote;
7629 unsigned int netbits;
7630
7632
7633 if (!get_ipv6_addr(p[1], &local, &netbits, msglevel))
7634 {
7635 msg(msglevel, "cannot parse --ifconfig-ipv6-push addresses");
7636 goto err;
7637 }
7638
7639 if (p[2])
7640 {
7641 if (!get_ipv6_addr(p[2], &remote, NULL, msglevel))
7642 {
7643 msg(msglevel, "cannot parse --ifconfig-ipv6-push addresses");
7644 goto err;
7645 }
7646 }
7647 else
7648 {
7650 || !get_ipv6_addr(options->ifconfig_ipv6_local, &remote, NULL, msglevel))
7651 {
7652 msg(msglevel,
7653 "second argument to --ifconfig-ipv6-push missing and no global --ifconfig-ipv6 address set");
7654 goto err;
7655 }
7656 }
7657
7663 }
7664 else if (streq(p[0], "disable") && !p[1])
7665 {
7667 options->disable = true;
7668 }
7669 else if (streq(p[0], "override-username") && p[1] && !p[2])
7670 {
7672 if (strlen(p[1]) > USER_PASS_LEN)
7673 {
7674 msg(msglevel,
7675 "override-username exceeds the maximum length of %d "
7676 "characters",
7678
7679 /* disable the connection since ignoring the request to
7680 * set another username might cause serious problems */
7681 options->disable = true;
7682 }
7683 else
7684 {
7685 options->override_username = p[1];
7686 }
7687 }
7688 else if (streq(p[0], "tcp-nodelay") && !p[1])
7689 {
7692 }
7693 else if (streq(p[0], "stale-routes-check") && p[1] && !p[3])
7694 {
7695 int ageing_time, check_interval;
7696
7698 if (!atoi_constrained(p[1], &ageing_time, "stale-routes-check age", 1, INT_MAX, msglevel))
7699 {
7700 goto err;
7701 }
7702
7703 if (p[2])
7704 {
7705 if (!atoi_constrained(p[2], &check_interval,
7706 "stale-routes-check interval", 1, INT_MAX, msglevel))
7707 {
7708 goto err;
7709 }
7710 }
7711 else
7712 {
7713 check_interval = ageing_time;
7714 }
7715
7716 options->stale_routes_ageing_time = ageing_time;
7717 options->stale_routes_check_interval = check_interval;
7718 }
7719
7720 else if (streq(p[0], "client") && !p[1])
7721 {
7723 options->client = true;
7724 }
7725 else if (streq(p[0], "pull") && !p[1])
7726 {
7728 options->pull = true;
7729 }
7730 else if (streq(p[0], "push-continuation") && p[1] && !p[2])
7731 {
7733 atoi_constrained(p[1], &options->push_continuation, p[0], 0, 2, msglevel);
7734 }
7735 else if (streq(p[0], "auth-user-pass") && !p[2])
7736 {
7738 if (p[1])
7739 {
7742 }
7743 else
7744 {
7745 options->auth_user_pass_file = "stdin";
7746 }
7747 }
7748 else if (streq(p[0], "auth-retry") && p[1] && !p[2])
7749 {
7751 auth_retry_set(msglevel, p[1]);
7752 }
7753#ifdef ENABLE_MANAGEMENT
7754 else if (streq(p[0], "static-challenge") && p[1] && p[2] && !p[4])
7755 {
7758 if (atoi_warn(p[2], msglevel))
7759 {
7761 }
7762 if (p[3] && streq(p[3], "concat"))
7763 {
7765 }
7766 else if (p[3] && !streq(p[3], "scrv1"))
7767 {
7768 msg(msglevel, "--static-challenge: unknown format indicator '%s'", p[3]);
7769 goto err;
7770 }
7771 }
7772#endif
7773 else if (streq(p[0], "msg-channel") && p[1])
7774 {
7775#ifdef _WIN32
7777 HANDLE process = GetCurrentProcess();
7778 HANDLE handle = (HANDLE)((intptr_t)atoll(p[1]));
7779 if (!DuplicateHandle(process, handle, process, &options->msg_channel, 0, FALSE,
7780 DUPLICATE_CLOSE_SOURCE | DUPLICATE_SAME_ACCESS))
7781 {
7782 msg(msglevel, "could not duplicate service pipe handle");
7783 goto err;
7784 }
7786#else /* ifdef _WIN32 */
7787 msg(msglevel, "--msg-channel is only supported on Windows");
7788 goto err;
7789#endif
7790 }
7791#ifdef _WIN32
7792 else if (streq(p[0], "win-sys") && p[1] && !p[2])
7793 {
7795 if (streq(p[1], "env"))
7796 {
7797 msg(M_INFO, "NOTE: --win-sys env is default from OpenVPN 2.3. "
7798 "This entry will now be ignored. "
7799 "Please remove this entry from your configuration file.");
7800 }
7801 else
7802 {
7803 set_win_sys_path(p[1], es);
7804 }
7805 }
7806 else if (streq(p[0], "route-method") && p[1] && !p[2])
7807 {
7809 if (streq(p[1], "adaptive"))
7810 {
7812 }
7813 else if (streq(p[1], "ipapi"))
7814 {
7816 }
7817 else if (streq(p[1], "exe"))
7818 {
7820 }
7821 else
7822 {
7823 msg(msglevel, "--route method must be 'adaptive', 'ipapi', or 'exe'");
7824 goto err;
7825 }
7826 }
7827 else if (streq(p[0], "ip-win32") && p[1] && !p[4])
7828 {
7829 const int index = ascii2ipset(p[1]);
7830 struct tuntap_options *to = &options->tuntap_options;
7831
7833
7834 if (index < 0)
7835 {
7836 msg(msglevel, "Bad --ip-win32 method: '%s'. Allowed methods: %s", p[1],
7838 goto err;
7839 }
7840
7841 if (index == IPW32_SET_ADAPTIVE)
7842 {
7844 }
7845
7846 if (index == IPW32_SET_DHCP_MASQ)
7847 {
7848 if (p[2])
7849 {
7850 if (!streq(p[2], "default"))
7851 {
7852 int offset;
7853
7854 if (!atoi_constrained(p[2], &offset, "ip-win32 offset", -256, 256, msglevel))
7855 {
7856 goto err;
7857 }
7858 to->dhcp_masq_custom_offset = true;
7859 to->dhcp_masq_offset = offset;
7860 }
7861
7862 if (p[3])
7863 {
7864 if (!atoi_constrained(p[3], &to->dhcp_lease_time,
7865 "ip-win32 lease time", 30, INT_MAX, msglevel))
7866 {
7867 goto err;
7868 }
7869 }
7870 }
7871 }
7872 to->ip_win32_type = index;
7873 to->ip_win32_defined = true;
7874 }
7875#endif /* ifdef _WIN32 */
7876 else if (streq(p[0], "dns-updown") && p[1])
7877 {
7879 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
7880 {
7881 goto err;
7882 }
7883 struct dns_options *dns = &options->dns_options;
7884 if (streq(p[1], "disable"))
7885 {
7886 dns->updown = NULL;
7888 }
7889 else if (streq(p[1], "force"))
7890 {
7891 /* force dns-updown run, even if a --up script is defined */
7892 if (!dns_updown_user_set(dns))
7893 {
7894 dns->updown = DEFAULT_DNS_UPDOWN;
7896 }
7897 }
7898 else
7899 {
7900 if (streq(dns->updown, DEFAULT_DNS_UPDOWN))
7901 {
7902 /* Unset the default command to prevent warnings */
7903 dns->updown = NULL;
7904 }
7905 set_user_script(options, &dns->updown, p[1], p[0], false);
7907 }
7908 }
7909 else if (streq(p[0], "dns") && p[1])
7910 {
7912 if (!check_dns_option(options, p, msglevel, pull_mode))
7913 {
7914 goto err;
7915 }
7916 }
7917 else if (streq(p[0], "dhcp-option") && p[1])
7918 {
7920#if defined(_WIN32) || defined(TARGET_ANDROID)
7922#endif
7924
7925 bool dhcp_optional = false;
7926
7927 if ((streq(p[1], "DOMAIN") || streq(p[1], "ADAPTER_DOMAIN_SUFFIX")) && p[2] && !p[3])
7928 {
7929 if (!validate_domain(p[2]))
7930 {
7931 msg(msglevel, "--dhcp-option %s contains invalid characters", p[1]);
7932 goto err;
7933 }
7934
7935 dhcp->domain = p[2];
7936 dhcp_optional = true;
7937 }
7938 else if (streq(p[1], "DOMAIN-SEARCH") && p[2] && !p[3])
7939 {
7940 if (!validate_domain(p[2]))
7941 {
7942 msg(msglevel, "--dhcp-option %s contains invalid characters", p[1]);
7943 goto err;
7944 }
7945
7946 if (dhcp->domain_search_list_len < N_SEARCH_LIST_LEN)
7947 {
7948 dhcp->domain_search_list[dhcp->domain_search_list_len++] = p[2];
7949 }
7950 else
7951 {
7952 msg(msglevel, "--dhcp-option %s: maximum of %d search entries can be specified",
7953 p[1], N_SEARCH_LIST_LEN);
7954 }
7955 dhcp_optional = true;
7956 }
7957 else if ((streq(p[1], "DNS") || streq(p[1], "DNS6")) && p[2] && !p[3]
7958 && (!strstr(p[2], ":") || ipv6_addr_safe(p[2])))
7959 {
7960 if (strstr(p[2], ":"))
7961 {
7962 dhcp_option_dns6_parse(p[2], dhcp->dns6, &dhcp->dns6_len, msglevel);
7963 }
7964 else
7965 {
7966 dhcp_option_address_parse("DNS", p[2], dhcp->dns, &dhcp->dns_len, msglevel);
7967 dhcp_optional = true;
7968 }
7969 }
7970#if defined(_WIN32) || defined(TARGET_ANDROID)
7971 else if (streq(p[1], "NBS") && p[2] && !p[3])
7972 {
7973 o->netbios_scope = p[2];
7975 }
7976 else if (streq(p[1], "NBT") && p[2] && !p[3])
7977 {
7978 int t = atoi_warn(p[2], msglevel);
7979 if (!(t == 1 || t == 2 || t == 4 || t == 8))
7980 {
7981 msg(msglevel, "--dhcp-option NBT: parameter (%d) must be 1, 2, 4, or 8", t);
7982 goto err;
7983 }
7984 o->netbios_node_type = (uint8_t)t;
7986 }
7987 else if (streq(p[1], "WINS") && p[2] && !p[3])
7988 {
7989 dhcp_option_address_parse("WINS", p[2], o->wins, &o->wins_len, msglevel);
7991 }
7992 else if (streq(p[1], "NTP") && p[2] && !p[3])
7993 {
7994 dhcp_option_address_parse("NTP", p[2], o->ntp, &o->ntp_len, msglevel);
7996 }
7997 else if (streq(p[1], "NBDD") && p[2] && !p[3])
7998 {
7999 dhcp_option_address_parse("NBDD", p[2], o->nbdd, &o->nbdd_len, msglevel);
8001 }
8002 else if (streq(p[1], "DISABLE-NBT") && !p[2])
8003 {
8004 o->disable_nbt = 1;
8006 }
8007#if defined(TARGET_ANDROID)
8008 else if (streq(p[1], "PROXY_HTTP") && p[3] && !p[4])
8009 {
8010 o->http_proxy_port = positive_atoi(p[3], msglevel);
8011 o->http_proxy = p[2];
8012 }
8013#endif
8014 else
8015 {
8016 msg(msglevel, "--dhcp-option: unknown option type '%s' or missing or unknown parameter",
8017 p[1]);
8018 goto err;
8019 }
8020#else /* if defined(_WIN32) || defined(TARGET_ANDROID) */
8021 setenv_foreign_option(options, p[1], p[2], es);
8022#endif /* if defined(_WIN32) || defined(TARGET_ANDROID) */
8023
8024 if (dhcp_optional)
8025 {
8026#if defined(_WIN32) || defined(TARGET_ANDROID)
8028#endif
8029 }
8030 }
8031#ifdef _WIN32
8032 else if (streq(p[0], "show-adapters") && !p[1])
8033 {
8036 openvpn_exit(OPENVPN_EXIT_STATUS_GOOD); /* exit point */
8037 }
8038 else if (streq(p[0], "show-net") && !p[1])
8039 {
8043 openvpn_exit(OPENVPN_EXIT_STATUS_GOOD); /* exit point */
8044 }
8045 else if (streq(p[0], "show-net-up") && !p[1])
8046 {
8048 options->show_net_up = true;
8049 }
8050 else if (streq(p[0], "tap-sleep") && p[1] && !p[2])
8051 {
8053 if (!atoi_constrained(p[1], &options->tuntap_options.tap_sleep, p[0], 0, 255, msglevel))
8054 {
8055 goto err;
8056 }
8057 }
8058 else if (streq(p[0], "dhcp-renew") && !p[1])
8059 {
8062 }
8063 else if (streq(p[0], "dhcp-pre-release") && !p[1])
8064 {
8068 }
8069 else if (streq(p[0], "dhcp-release") && !p[1])
8070 {
8071 msg(M_WARN, "Obsolete option --dhcp-release detected. This is now on by default");
8072 }
8073 else if (streq(p[0], "dhcp-internal") && p[1] && !p[2]) /* standalone method for internal use */
8074 {
8075 unsigned int adapter_index;
8078 adapter_index = atou(p[1]);
8081 {
8082 dhcp_release_by_adapter_index(adapter_index);
8083 }
8085 {
8086 dhcp_renew_by_adapter_index(adapter_index);
8087 }
8088 openvpn_exit(OPENVPN_EXIT_STATUS_GOOD); /* exit point */
8089 }
8090 else if (streq(p[0], "register-dns") && !p[1])
8091 {
8094 }
8095 else if (streq(p[0], "block-outside-dns") && !p[1])
8096 {
8098 options->block_outside_dns = true;
8099 }
8100 else if (streq(p[0], "rdns-internal") && !p[1])
8101 /* standalone method for internal use
8102 *
8103 * (if --register-dns is set, openvpn needs to call itself in a
8104 * sub-process to execute the required functions in a non-blocking
8105 * way, and uses --rdns-internal to signal that to itself)
8106 */
8107 {
8111 {
8113 }
8114 openvpn_exit(OPENVPN_EXIT_STATUS_GOOD); /* exit point */
8115 }
8116 else if (streq(p[0], "show-valid-subnets") && !p[1])
8117 {
8120 openvpn_exit(OPENVPN_EXIT_STATUS_GOOD); /* exit point */
8121 }
8122 else if (streq(p[0], "pause-exit") && !p[1])
8123 {
8126 }
8127 else if (streq(p[0], "service") && p[1] && !p[3])
8128 {
8130 options->exit_event_name = p[1];
8131 if (p[2])
8132 {
8133 options->exit_event_initial_state = (atoi_warn(p[2], msglevel) != 0);
8134 }
8135 }
8136 else if (streq(p[0], "allow-nonadmin") && !p[2])
8137 {
8140 openvpn_exit(OPENVPN_EXIT_STATUS_GOOD); /* exit point */
8141 }
8142 else if (streq(p[0], "user") && p[1] && !p[2])
8143 {
8145 msg(M_WARN, "NOTE: --user option is not implemented on Windows");
8146 }
8147 else if (streq(p[0], "group") && p[1] && !p[2])
8148 {
8150 msg(M_WARN, "NOTE: --group option is not implemented on Windows");
8151 }
8152#else /* ifdef _WIN32 */
8153 else if (streq(p[0], "user") && p[1] && !p[2])
8154 {
8156 options->username = p[1];
8157 }
8158 else if (streq(p[0], "group") && p[1] && !p[2])
8159 {
8161 options->groupname = p[1];
8162 }
8163 else if (streq(p[0], "dhcp-option") && p[1] && !p[3])
8164 {
8166 setenv_foreign_option(options, p[1], p[2], es);
8167 }
8168 else if (streq(p[0], "route-method") && p[1] && !p[2])
8169 {
8171 /* ignore when pushed to non-Windows OS */
8172 }
8173#endif /* ifdef _WIN32 */
8174#if PASSTOS_CAPABILITY
8175 else if (streq(p[0], "passtos") && !p[1])
8176 {
8178 options->passtos = true;
8179 }
8180#endif
8181 else if (streq(p[0], "allow-compression") && p[1] && !p[2])
8182 {
8184
8185 if (streq(p[1], "no"))
8186 {
8189 {
8190 msg(msglevel, "'--allow-compression no' conflicts with "
8191 " enabling compression");
8192 }
8193 }
8195 {
8196 /* Also printed on a push to hint at configuration problems */
8197 msg(msglevel,
8198 "Cannot set allow-compression to '%s' "
8199 "after set to 'no'",
8200 p[1]);
8201 goto err;
8202 }
8203 else if (streq(p[1], "asym"))
8204 {
8206 }
8207 else if (streq(p[1], "yes"))
8208 {
8209 msg(M_WARN,
8210 "DEPRECATED OPTION: \"--allow-compression yes\" has been removed. "
8211 "We will use \"asym\" mode instead. See the manual page for more information.");
8212
8214 }
8215 else
8216 {
8217 msg(msglevel,
8218 "bad allow-compression option: %s -- "
8219 "must be 'yes', 'no', or 'asym'",
8220 p[1]);
8221 goto err;
8222 }
8223 }
8224 else if (streq(p[0], "comp-lzo") && !p[2])
8225 {
8227
8228 /* All lzo variants do not use swap */
8229 options->comp.flags &= ~COMP_F_SWAP;
8231
8232 if (p[1])
8233 {
8234 if (streq(p[1], "no"))
8235 {
8237 }
8238 /* There is no actual difference anymore between these variants.
8239 * We never compress. On the server side we replace this with
8240 * --compress migrate later anyway.
8241 */
8242 else if (!(streq(p[1], "yes") || streq(p[1], "adaptive")))
8243 {
8244 msg(msglevel, "bad comp-lzo option: %s -- must be 'yes', 'no', or 'adaptive'",
8245 p[1]);
8246 goto err;
8247 }
8248 }
8250 }
8251 else if (streq(p[0], "comp-noadapt") && !p[1])
8252 {
8253 /* NO-OP since we never compress anymore */
8254 }
8255 else if (streq(p[0], "compress") && !p[2])
8256 {
8258 const char *alg = "stub";
8259 if (p[1])
8260 {
8261 alg = p[1];
8262 }
8263
8264 if (streq(alg, "stub"))
8265 {
8268 }
8269 else if (streq(alg, "stub-v2"))
8270 {
8273 }
8274 else if (streq(alg, "migrate"))
8275 {
8278 }
8279 else if (streq(alg, "lzo"))
8280 {
8282 options->comp.flags &= ~COMP_F_SWAP;
8283 }
8284 else if (streq(alg, "lz4"))
8285 {
8288 }
8289 else if (streq(alg, "lz4-v2"))
8290 {
8292 }
8293 else
8294 {
8295 msg(msglevel, "bad comp option: %s", alg);
8296 goto err;
8297 }
8298
8300 }
8301 else if (streq(p[0], "show-ciphers") && !p[1])
8302 {
8304 options->show_ciphers = true;
8305 }
8306 else if (streq(p[0], "show-digests") && !p[1])
8307 {
8309 options->show_digests = true;
8310 }
8311 else if (streq(p[0], "show-engines") && !p[1])
8312 {
8314 options->show_engines = true;
8315 }
8316 else if (streq(p[0], "key-direction") && p[1] && !p[2])
8317 {
8318 int key_direction;
8319
8321
8322 key_direction = ascii2keydirection(msglevel, p[1]);
8323 if (key_direction >= 0)
8324 {
8325 if (permission_mask & OPT_P_GENERAL)
8326 {
8327 options->key_direction = key_direction;
8328 }
8329 else if (permission_mask & OPT_P_CONNECTION)
8330 {
8331 options->ce.key_direction = key_direction;
8332 }
8333 }
8334 else
8335 {
8336 goto err;
8337 }
8338 }
8339 else if (streq(p[0], "secret") && p[1] && !p[3])
8340 {
8341 msg(M_WARN, "DEPRECATED OPTION: The option --secret is deprecated.");
8345 if (!is_inline && p[2])
8346 {
8347 int key_direction;
8348
8349 key_direction = ascii2keydirection(msglevel, p[2]);
8350 if (key_direction >= 0)
8351 {
8352 options->key_direction = key_direction;
8353 }
8354 else
8355 {
8356 goto err;
8357 }
8358 }
8359 }
8360 else if (streq(p[0], "allow-deprecated-insecure-static-crypto"))
8361 {
8364 }
8365 else if (streq(p[0], "genkey") && !p[4])
8366 {
8368 options->genkey = true;
8369 if (!p[1])
8370 {
8372 }
8373 else
8374 {
8375 if (streq(p[1], "secret") || streq(p[1], "tls-auth") || streq(p[1], "tls-crypt"))
8376 {
8378 }
8379 else if (streq(p[1], "tls-crypt-v2-server"))
8380 {
8382 }
8383 else if (streq(p[1], "tls-crypt-v2-client"))
8384 {
8386 if (p[3])
8387 {
8388 options->genkey_extra_data = p[3];
8389 }
8390 }
8391 else if (streq(p[1], "auth-token"))
8392 {
8394 }
8395 else
8396 {
8397 msg(msglevel, "unknown --genkey type: %s", p[1]);
8398 }
8399 }
8400 if (p[2])
8401 {
8402 options->genkey_filename = p[2];
8403 }
8404 }
8405 else if (streq(p[0], "auth") && p[1] && !p[2])
8406 {
8408 options->authname = p[1];
8409 }
8410 else if (streq(p[0], "cipher") && p[1] && !p[2])
8411 {
8413 options->ciphername = p[1];
8414 }
8415 else if (streq(p[0], "data-ciphers-fallback") && p[1] && !p[2])
8416 {
8418 options->ciphername = p[1];
8420 }
8421 else if ((streq(p[0], "data-ciphers") || streq(p[0], "ncp-ciphers")) && p[1] && !p[2])
8422 {
8424 if (streq(p[0], "ncp-ciphers"))
8425 {
8426 msg(M_INFO, "Note: Treating option '--ncp-ciphers' as "
8427 " '--data-ciphers' (renamed in OpenVPN 2.5).");
8428 }
8429 options->ncp_ciphers = p[1];
8430 }
8431 else if (streq(p[0], "key-derivation") && p[1])
8432 {
8433 /* NCP only option that is pushed by the server to enable EKM,
8434 * should not be used by normal users in config files*/
8436 if (streq(p[1], "tls-ekm"))
8437 {
8439 }
8440 else
8441 {
8442 msg(msglevel, "Unknown key-derivation method %s", p[1]);
8443 }
8444 }
8445 else if (streq(p[0], "protocol-flags") && p[1])
8446 {
8447 /* NCP only option that is pushed by the server to enable protocol
8448 * features that are negotiated, should not be used by normal users
8449 * in config files */
8451 for (size_t j = 1; j < MAX_PARMS && p[j] != NULL; j++)
8452 {
8453 if (streq(p[j], "cc-exit"))
8454 {
8456 }
8457 else if (streq(p[j], "tls-ekm"))
8458 {
8460 }
8461 else if (streq(p[j], "dyn-tls-crypt"))
8462 {
8464 }
8465 else if (streq(p[j], "aead-epoch"))
8466 {
8468 }
8469 else
8470 {
8471 msg(msglevel, "Unknown protocol-flags flag: %s", p[j]);
8472 }
8473 }
8474 }
8475 else if (streq(p[0], "force-tls-key-material-export"))
8476 {
8479 }
8480 else if (streq(p[0], "prng") && p[1] && !p[3])
8481 {
8482 msg(M_WARN, "NOTICE: --prng option ignored (SSL library PRNG is used)");
8483 }
8484 else if (streq(p[0], "no-replay") && !p[1])
8485 {
8487 /* always error out, this breaks the connection */
8488 msg(M_FATAL, "--no-replay was removed in OpenVPN 2.7. "
8489 "Update your configuration.");
8490 }
8491 else if (streq(p[0], "replay-window") && !p[3])
8492 {
8494 if (p[1])
8495 {
8496 if (!atoi_constrained(p[1], &options->replay_window, "replay-window windows size",
8498 {
8499 goto err;
8500 }
8501
8502 if (p[2])
8503 {
8504 if (!atoi_constrained(p[2], &options->replay_time, "replay-window time window",
8506 {
8507 goto err;
8508 }
8509 }
8510 }
8511 else
8512 {
8513 msg(msglevel, "replay-window option is missing window size parameter");
8514 goto err;
8515 }
8516 }
8517 else if (streq(p[0], "mute-replay-warnings") && !p[1])
8518 {
8521 }
8522 else if (streq(p[0], "replay-persist") && p[1] && !p[2])
8523 {
8525 options->packet_id_file = p[1];
8526 }
8527 else if (streq(p[0], "test-crypto") && !p[1])
8528 {
8530 options->test_crypto = true;
8531 }
8532#ifndef ENABLE_CRYPTO_MBEDTLS
8533 else if (streq(p[0], "engine") && !p[2])
8534 {
8536 if (p[1])
8537 {
8538 options->engine = p[1];
8539 }
8540 else
8541 {
8542 options->engine = "auto";
8543 }
8544 }
8545#endif /* ENABLE_CRYPTO_MBEDTLS */
8546 else if (streq(p[0], "providers") && p[1])
8547 {
8548 for (size_t j = 1; j < MAX_PARMS && p[j] != NULL; j++)
8549 {
8550 options->providers.names[j] = p[j];
8551 }
8552 }
8553#ifdef ENABLE_PREDICTION_RESISTANCE
8554 else if (streq(p[0], "use-prediction-resistance") && !p[1])
8555 {
8557 options->use_prediction_resistance = true;
8558 }
8559#endif
8560 else if (streq(p[0], "show-tls") && !p[1])
8561 {
8563 options->show_tls_ciphers = true;
8564 }
8565 else if ((streq(p[0], "show-curves") || streq(p[0], "show-groups")) && !p[1])
8566 {
8568 options->show_curves = true;
8569 }
8570 else if (streq(p[0], "ecdh-curve") && p[1] && !p[2])
8571 {
8573 msg(M_WARN, "Consider setting groups/curves preference with "
8574 "tls-groups instead of forcing a specific curve with "
8575 "ecdh-curve.");
8576 options->ecdh_curve = p[1];
8577 }
8578 else if (streq(p[0], "tls-server") && !p[1])
8579 {
8581 options->tls_server = true;
8582 }
8583 else if (streq(p[0], "tls-client") && !p[1])
8584 {
8586 options->tls_client = true;
8587 }
8588 else if (streq(p[0], "ca") && p[1] && !p[2])
8589 {
8591 options->ca_file = p[1];
8592 options->ca_file_inline = is_inline;
8593 }
8594#ifndef ENABLE_CRYPTO_MBEDTLS
8595 else if (streq(p[0], "capath") && p[1] && !p[2])
8596 {
8598 options->ca_path = p[1];
8599 }
8600#endif /* ENABLE_CRYPTO_MBEDTLS */
8601 else if (streq(p[0], "dh") && p[1] && !p[2])
8602 {
8604 options->dh_file = p[1];
8605 options->dh_file_inline = is_inline;
8606 }
8607 else if (streq(p[0], "cert") && p[1] && !p[2])
8608 {
8610 options->cert_file = p[1];
8611 options->cert_file_inline = is_inline;
8612 }
8613 else if (streq(p[0], "extra-certs") && p[1] && !p[2])
8614 {
8616 options->extra_certs_file = p[1];
8617 options->extra_certs_file_inline = is_inline;
8618 }
8619 else if ((streq(p[0], "verify-hash") && p[1] && !p[3])
8620 || (streq(p[0], "peer-fingerprint") && p[1] && !p[2]))
8621 {
8623
8624 int verify_hash_depth = 0;
8625 if (streq(p[0], "verify-hash"))
8626 {
8627 msg(M_WARN, "DEPRECATED OPTION: The option --verify-hash is deprecated. "
8628 "You should switch to the either use the level 1 certificate as "
8629 "--ca option, use --tls-verify or use --peer-fingerprint");
8630 /* verify level 1 cert, i.e. the CA that signed the leaf cert */
8631 verify_hash_depth = 1;
8632 }
8633
8635
8636 int digest_len = SHA256_DIGEST_LENGTH;
8637
8638 if (options->verify_hash && options->verify_hash_depth != verify_hash_depth)
8639 {
8640 msg(msglevel,
8641 "ERROR: Setting %s not allowed. --verify-hash and"
8642 " --peer-fingerprint are mutually exclusive",
8643 p[0]);
8644 goto err;
8645 }
8646
8647 if (streq(p[0], "verify-hash"))
8648 {
8649 if ((!p[2] && !is_inline) || (p[2] && streq(p[2], "SHA1")))
8650 {
8652 digest_len = SHA_DIGEST_LENGTH;
8653 }
8654 else if (p[2] && !streq(p[2], "SHA256"))
8655 {
8656 msg(msglevel,
8657 "invalid or unsupported hashing algorithm: %s "
8658 "(only SHA1 and SHA256 are supported)",
8659 p[2]);
8660 goto err;
8661 }
8662 }
8663
8664 struct verify_hash_list *newlist;
8665 newlist = parse_hash_fingerprint_multiline(p[1], digest_len, msglevel, &options->gc);
8666
8667 /* Append the new list to the end of our current list */
8668 if (!options->verify_hash)
8669 {
8670 options->verify_hash = newlist;
8671 options->verify_hash_depth = verify_hash_depth;
8672 }
8673 else
8674 {
8675 /* since both the old and new list can have multiple entries
8676 * we need to go to the end of one of them to concatenate them */
8677 struct verify_hash_list *listend = options->verify_hash;
8678 while (listend->next)
8679 {
8680 listend = listend->next;
8681 }
8682 listend->next = newlist;
8683 }
8684 }
8685#if defined(ENABLE_CRYPTOAPI) && defined(HAVE_XKEY_PROVIDER)
8686 else if (streq(p[0], "cryptoapicert") && p[1] && !p[2])
8687 {
8689 options->cryptoapi_cert = p[1];
8690 }
8691#endif
8692 else if (streq(p[0], "key") && p[1] && !p[2])
8693 {
8695 options->priv_key_file = p[1];
8696 options->priv_key_file_inline = is_inline;
8697 }
8698 else if (streq(p[0], "tls-version-min") && p[1] && !p[3])
8699 {
8701 int ver = tls_version_parse(p[1], p[2]);
8702 if (ver == TLS_VER_BAD)
8703 {
8704 msg(msglevel, "unknown tls-version-min parameter: %s", p[1]);
8705 goto err;
8706 }
8707
8708#ifdef ENABLE_CRYPTO_MBEDTLS
8709 if (ver < TLS_VER_1_2)
8710 {
8711 msg(M_WARN, "--tls-version-min %s is not supported by mbedtls, using 1.2", p[1]);
8712 ver = TLS_VER_1_2;
8713 }
8714#endif
8715
8717 options->ssl_flags |= ((unsigned int)ver << SSLF_TLS_VERSION_MIN_SHIFT);
8718 }
8719 else if (streq(p[0], "tls-version-max") && p[1] && !p[2])
8720 {
8722 int ver = tls_version_parse(p[1], NULL);
8723 if (ver == TLS_VER_BAD)
8724 {
8725 msg(msglevel, "unknown tls-version-max parameter: %s", p[1]);
8726 goto err;
8727 }
8729 options->ssl_flags |= ((unsigned int)ver << SSLF_TLS_VERSION_MAX_SHIFT);
8730 }
8731#ifndef ENABLE_CRYPTO_MBEDTLS
8732 else if (streq(p[0], "pkcs12") && p[1] && !p[2])
8733 {
8735 options->pkcs12_file = p[1];
8736 options->pkcs12_file_inline = is_inline;
8737 }
8738#endif /* ENABLE_CRYPTO_MBEDTLS */
8739 else if (streq(p[0], "askpass") && !p[2])
8740 {
8742 if (p[1])
8743 {
8744 options->key_pass_file = p[1];
8745 }
8746 else
8747 {
8748 options->key_pass_file = "stdin";
8749 }
8750 }
8751 else if (streq(p[0], "auth-nocache") && !p[1])
8752 {
8755 }
8756 else if (streq(p[0], "auth-token") && p[1] && !p[2])
8757 {
8759 ssl_set_auth_token(p[1]);
8760#ifdef ENABLE_MANAGEMENT
8761 if (management)
8762 {
8764 }
8765#endif
8766 }
8767 else if (streq(p[0], "auth-token-user") && p[1] && !p[2])
8768 {
8771 }
8772 else if (streq(p[0], "single-session") && !p[1])
8773 {
8775 options->single_session = true;
8776 }
8777 else if (streq(p[0], "push-peer-info") && !p[1])
8778 {
8780 options->push_peer_info = true;
8781 }
8782 else if (streq(p[0], "tls-exit") && !p[1])
8783 {
8785 options->tls_exit = true;
8786 }
8787 else if (streq(p[0], "tls-cipher") && p[1] && !p[2])
8788 {
8790 options->cipher_list = p[1];
8791 }
8792 else if (streq(p[0], "tls-cert-profile") && p[1] && !p[2])
8793 {
8795 options->tls_cert_profile = p[1];
8796 }
8797 else if (streq(p[0], "tls-ciphersuites") && p[1] && !p[2])
8798 {
8800 options->cipher_list_tls13 = p[1];
8801 }
8802 else if (streq(p[0], "tls-groups") && p[1] && !p[2])
8803 {
8805 options->tls_groups = p[1];
8806 }
8807 else if (streq(p[0], "crl-verify") && p[1] && ((p[2] && streq(p[2], "dir")) || !p[2]))
8808 {
8810 if (p[2] && streq(p[2], "dir"))
8811 {
8813 }
8814 options->crl_file = p[1];
8815 options->crl_file_inline = is_inline;
8816 }
8817 else if (streq(p[0], "tls-verify") && p[1])
8818 {
8820 if (!no_more_than_n_args(msglevel, p, 2, NM_QUOTE_HINT))
8821 {
8822 goto err;
8823 }
8825 string_substitute(p[1], ',', ' ', &options->gc), "tls-verify", true);
8826 }
8827 else if (streq(p[0], "tls-export-cert") && p[1] && !p[2])
8828 {
8831 }
8832 else if (streq(p[0], "compat-names"))
8833 {
8835 msg(msglevel, "--compat-names was removed in OpenVPN 2.5. "
8836 "Update your configuration.");
8837 goto err;
8838 }
8839 else if (streq(p[0], "no-name-remapping") && !p[1])
8840 {
8842 msg(msglevel, "--no-name-remapping was removed in OpenVPN 2.5. "
8843 "Update your configuration.");
8844 goto err;
8845 }
8846 else if (streq(p[0], "verify-x509-name") && p[1] && strlen(p[1]) && !p[3])
8847 {
8848 int type = VERIFY_X509_SUBJECT_DN;
8850 if (p[2])
8851 {
8852 if (streq(p[2], "subject"))
8853 {
8855 }
8856 else if (streq(p[2], "name"))
8857 {
8859 }
8860 else if (streq(p[2], "name-prefix"))
8861 {
8863 }
8864 else
8865 {
8866 msg(msglevel, "unknown X.509 name type: %s", p[2]);
8867 goto err;
8868 }
8869 }
8870 options->verify_x509_type = type;
8871 options->verify_x509_name = p[1];
8872 }
8873 else if (streq(p[0], "ns-cert-type") && p[1] && !p[2])
8874 {
8875#ifdef ENABLE_CRYPTO_MBEDTLS
8876 msg(msglevel, "--ns-cert-type is not available with mbedtls.");
8877 goto err;
8878#else
8880 if (streq(p[1], "server"))
8881 {
8883 }
8884 else if (streq(p[1], "client"))
8885 {
8887 }
8888 else
8889 {
8890 msg(msglevel, "--ns-cert-type must be 'client' or 'server'");
8891 goto err;
8892 }
8893#endif /* ENABLE_CRYPTO_MBEDTLS */
8894 }
8895 else if (streq(p[0], "remote-cert-ku"))
8896 {
8898
8899 size_t j;
8900 for (j = 1; j < MAX_PARMS && p[j] != NULL; ++j)
8901 {
8902 sscanf(p[j], "%x", &(options->remote_cert_ku[j - 1]));
8903 }
8904 if (j == 1)
8905 {
8906 /* No specific KU required, but require KU to be present */
8908 }
8909 }
8910 else if (streq(p[0], "remote-cert-eku") && p[1] && !p[2])
8911 {
8913 options->remote_cert_eku = p[1];
8914 }
8915 else if (streq(p[0], "remote-cert-tls") && p[1] && !p[2])
8916 {
8918
8919 if (streq(p[1], "server"))
8920 {
8922 options->remote_cert_eku = "TLS Web Server Authentication";
8923 }
8924 else if (streq(p[1], "client"))
8925 {
8927 options->remote_cert_eku = "TLS Web Client Authentication";
8928 }
8929 else
8930 {
8931 msg(msglevel, "--remote-cert-tls must be 'client' or 'server'");
8932 goto err;
8933 }
8934 }
8935 else if (streq(p[0], "tls-timeout") && p[1] && !p[2])
8936 {
8938 options->tls_timeout = positive_atoi(p[1], msglevel);
8939 }
8940 else if (streq(p[0], "reneg-bytes") && p[1] && !p[2])
8941 {
8943 if (!positive_atoll(p[1], &options->renegotiate_bytes, p[0], msglevel))
8944 {
8945 goto err;
8946 }
8947 }
8948 else if (streq(p[0], "reneg-pkts") && p[1] && !p[2])
8949 {
8951 if (!positive_atoll(p[1], &options->renegotiate_packets, p[0], msglevel))
8952 {
8953 goto err;
8954 }
8955 }
8956 else if (streq(p[0], "reneg-sec") && p[1] && !p[3])
8957 {
8959 options->renegotiate_seconds = positive_atoi(p[1], msglevel);
8960 if (p[2])
8961 {
8963 }
8964 }
8965 else if (streq(p[0], "hand-window") && p[1] && !p[2])
8966 {
8968 options->handshake_window = positive_atoi(p[1], msglevel);
8969 }
8970 else if (streq(p[0], "tran-window") && p[1] && !p[2])
8971 {
8973 options->transition_window = positive_atoi(p[1], msglevel);
8974 }
8975 else if (streq(p[0], "tls-auth") && p[1] && !p[3])
8976 {
8977 int key_direction = -1;
8978
8980
8981 if (permission_mask & OPT_P_GENERAL)
8982 {
8983 options->tls_auth_file = p[1];
8984 options->tls_auth_file_inline = is_inline;
8985
8986 if (!is_inline && p[2])
8987 {
8988 key_direction = ascii2keydirection(msglevel, p[2]);
8989 if (key_direction < 0)
8990 {
8991 goto err;
8992 }
8993 options->key_direction = key_direction;
8994 }
8995 }
8996 else if (permission_mask & OPT_P_CONNECTION)
8997 {
8998 options->ce.tls_auth_file = p[1];
8999 options->ce.tls_auth_file_inline = is_inline;
9001
9002 if (!is_inline && p[2])
9003 {
9004 key_direction = ascii2keydirection(msglevel, p[2]);
9005 if (key_direction < 0)
9006 {
9007 goto err;
9008 }
9009 options->ce.key_direction = key_direction;
9010 }
9011 }
9012 }
9013 else if (streq(p[0], "tls-crypt") && p[1] && !p[3])
9014 {
9016 if (permission_mask & OPT_P_GENERAL)
9017 {
9018 options->tls_crypt_file = p[1];
9019 options->tls_crypt_file_inline = is_inline;
9020 }
9021 else if (permission_mask & OPT_P_CONNECTION)
9022 {
9023 options->ce.tls_crypt_file = p[1];
9024 options->ce.tls_crypt_file_inline = is_inline;
9025 }
9026 }
9027 else if (streq(p[0], "tls-crypt-v2") && p[1] && !p[3])
9028 {
9030 if (permission_mask & OPT_P_GENERAL)
9031 {
9032 options->tls_crypt_v2_file = p[1];
9033 options->tls_crypt_v2_file_inline = is_inline;
9034 }
9035 else if (permission_mask & OPT_P_CONNECTION)
9036 {
9038 options->ce.tls_crypt_v2_file_inline = is_inline;
9039 }
9040
9041 if (p[2] && streq(p[2], "force-cookie"))
9042 {
9044 }
9045 else if (p[2] && streq(p[2], "allow-noncookie"))
9046 {
9048 }
9049 else if (p[2])
9050 {
9051 msg(msglevel, "Unsupported tls-crypt-v2 argument: %s", p[2]);
9052 }
9053 }
9054 else if (streq(p[0], "tls-crypt-v2-verify") && p[1] && !p[2])
9055 {
9058 }
9059 else if (streq(p[0], "tls-crypt-v2-max-age") && p[1])
9060 {
9062 if (!atoi_constrained(p[1], &options->tls_crypt_v2_max_age, "tls-crypt-v2-max-age", 1, INT_MAX, msglevel))
9063 {
9064 goto err;
9065 }
9066 }
9067 else if (streq(p[0], "x509-track") && p[1] && !p[2])
9068 {
9070 x509_track_add(&options->x509_track, p[1], msglevel, &options->gc);
9071 }
9072#ifdef ENABLE_X509ALTUSERNAME
9073 else if (streq(p[0], "x509-username-field") && p[1])
9074 {
9076 for (size_t j = 1; j < MAX_PARMS && p[j] != NULL; ++j)
9077 {
9078 char *s = p[j];
9079
9080 if (strncmp("ext:", s, 4) == 0 && !x509_username_field_ext_supported(s + 4))
9081 {
9082 msg(msglevel, "Unsupported x509-username-field extension: %s", s);
9083 }
9084 options->x509_username_field[j - 1] = p[j];
9085 }
9086 }
9087#endif /* ENABLE_X509ALTUSERNAME */
9088#ifdef ENABLE_PKCS11
9089 else if (streq(p[0], "show-pkcs11-ids") && !p[3])
9090 {
9091 char *provider = p[1];
9092 bool cert_private = (p[2] == NULL ? false : (atoi_warn(p[2], msglevel) != 0));
9093
9094#ifdef DEFAULT_PKCS11_MODULE
9095 if (!provider)
9096 {
9097 provider = DEFAULT_PKCS11_MODULE;
9098 }
9099 else if (!p[2])
9100 {
9101 char *endp = NULL;
9102 long i = strtol(provider, &endp, 10);
9103
9104 if (*endp == 0)
9105 {
9106 /* There was one argument, and it was purely numeric.
9107 * Interpret it as the cert_private argument */
9108 provider = DEFAULT_PKCS11_MODULE;
9109 cert_private = i;
9110 }
9111 }
9112#else /* ifdef DEFAULT_PKCS11_MODULE */
9113 if (!provider)
9114 {
9115 msg(msglevel, "--show-pkcs11-ids requires a provider parameter");
9116 goto err;
9117 }
9118#endif /* ifdef DEFAULT_PKCS11_MODULE */
9120
9122 show_pkcs11_ids(provider, cert_private);
9123 openvpn_exit(OPENVPN_EXIT_STATUS_GOOD); /* exit point */
9124 }
9125 else if (streq(p[0], "pkcs11-providers") && p[1])
9126 {
9127 int j;
9128
9130
9131 for (j = 1; j < MAX_PARMS && p[j] != NULL; ++j)
9132 {
9133 options->pkcs11_providers[j - 1] = p[j];
9134 }
9135 }
9136 else if (streq(p[0], "pkcs11-protected-authentication"))
9137 {
9138 int j;
9139
9141
9142 for (j = 1; j < MAX_PARMS && p[j] != NULL; ++j)
9143 {
9144 options->pkcs11_protected_authentication[j - 1] =
9145 atoi_warn(p[j], msglevel) != 0 ? 1 : 0;
9146 }
9147 }
9148 else if (streq(p[0], "pkcs11-private-mode") && p[1])
9149 {
9150 int j;
9151
9153
9154 for (j = 1; j < MAX_PARMS && p[j] != NULL; ++j)
9155 {
9156 sscanf(p[j], "%x", &(options->pkcs11_private_mode[j - 1]));
9157 }
9158 }
9159 else if (streq(p[0], "pkcs11-cert-private"))
9160 {
9161 int j;
9162
9164
9165 for (j = 1; j < MAX_PARMS && p[j] != NULL; ++j)
9166 {
9167 options->pkcs11_cert_private[j - 1] = (bool)(atoi_warn(p[j], msglevel));
9168 }
9169 }
9170 else if (streq(p[0], "pkcs11-pin-cache") && p[1] && !p[2])
9171 {
9173 options->pkcs11_pin_cache_period = positive_atoi(p[1], msglevel);
9174 }
9175 else if (streq(p[0], "pkcs11-id") && p[1] && !p[2])
9176 {
9178 options->pkcs11_id = p[1];
9179 }
9180 else if (streq(p[0], "pkcs11-id-management") && !p[1])
9181 {
9183 options->pkcs11_id_management = true;
9184 }
9185#endif /* ifdef ENABLE_PKCS11 */
9186 else if (streq(p[0], "rmtun") && !p[1])
9187 {
9189 options->persist_config = true;
9190 options->persist_mode = 0;
9191 }
9192 else if (streq(p[0], "mktun") && !p[1])
9193 {
9195 options->persist_config = true;
9196 options->persist_mode = 1;
9197 }
9198 else if (streq(p[0], "peer-id") && p[1] && !p[2])
9199 {
9201 options->use_peer_id = true;
9202 options->peer_id = atoi_warn(p[1], msglevel);
9203 }
9204 else if (streq(p[0], "keying-material-exporter") && p[1] && p[2])
9205 {
9207
9208 if (strncmp(p[1], "EXPORTER", 8))
9209 {
9210 msg(msglevel, "Keying material exporter label must begin with "
9211 "\"EXPORTER\"");
9212 goto err;
9213 }
9214 if (streq(p[1], EXPORT_KEY_DATA_LABEL))
9215 {
9216 msg(msglevel,
9217 "Keying material exporter label must not be '" EXPORT_KEY_DATA_LABEL "'.");
9218 }
9219
9221 p[0], 16, 4095, msglevel))
9222 {
9223 goto err;
9224 }
9225
9227 }
9228 else if (streq(p[0], "allow-recursive-routing") && !p[1])
9229 {
9232 }
9233 else if (streq(p[0], "vlan-tagging") && !p[1])
9234 {
9236 options->vlan_tagging = true;
9237 }
9238 else if (streq(p[0], "vlan-accept") && p[1] && !p[2])
9239 {
9241 if (streq(p[1], "tagged"))
9242 {
9244 }
9245 else if (streq(p[1], "untagged"))
9246 {
9248 }
9249 else if (streq(p[1], "all"))
9250 {
9252 }
9253 else
9254 {
9255 msg(msglevel, "--vlan-accept must be 'tagged', 'untagged' or 'all'");
9256 goto err;
9257 }
9258 }
9259 else if (streq(p[0], "vlan-pvid") && p[1] && !p[2])
9260 {
9261 int vlan_pvid;
9263 if (!atoi_constrained(p[1], &vlan_pvid, p[0],
9265 {
9266 goto err;
9267 }
9268 options->vlan_pvid = (uint16_t)vlan_pvid;
9269 }
9270 else
9271 {
9272 int i;
9273 msglvl_t msglevel_unknown = msglevel_fc;
9274 /* Check if an option is in --ignore-unknown-option and
9275 * set warning level to non fatal */
9277 {
9278 if (streq(p[0], options->ignore_unknown_option[i]))
9279 {
9280 msglevel_unknown = M_WARN;
9281 break;
9282 }
9283 }
9284 if (file)
9285 {
9286 msg(msglevel_unknown,
9287 "Unrecognized option or missing or extra parameter(s) in %s:%d: %s (%s)", file,
9288 line, p[0], PACKAGE_VERSION);
9289 }
9290 else
9291 {
9292 msg(msglevel_unknown, "Unrecognized option or missing or extra parameter(s): --%s (%s)",
9293 p[0], PACKAGE_VERSION);
9294 }
9295 }
9296err:
9297 gc_free(&gc);
9298}
9299
9300bool
9302{
9303 if (options->ce.local_list)
9304 {
9305 for (int i = 0; i < options->ce.local_list->len; i++)
9306 {
9308 {
9309 return true;
9310 }
9311 }
9312 }
9313
9314 return false;
9315}
void argv_parse_cmd(struct argv *argres, const char *cmdstr)
Parses a command string, tokenizes it and puts each element into a separate struct argv argument slot...
Definition argv.c:481
void argv_free(struct argv *a)
Frees all memory allocations allocated by the struct argv related functions.
Definition argv.c:101
struct argv argv_new(void)
Allocates a new struct argv and ensures it is initialised.
Definition argv.c:87
void buf_clear(struct buffer *buf)
Definition buffer.c:163
bool buf_printf(struct buffer *buf, const char *format,...)
Definition buffer.c:241
void gc_transfer(struct gc_arena *dest, struct gc_arena *src)
Definition buffer.c:460
void * gc_realloc(void *ptr, size_t size, struct gc_arena *a)
allows to realloc a pointer previously allocated by gc_malloc or gc_realloc
Definition buffer.c:370
void * gc_malloc(size_t size, bool clear, struct gc_arena *a)
Definition buffer.c:336
struct buffer alloc_buf_gc(size_t size, struct gc_arena *gc)
Definition buffer.c:89
char * format_hex_ex(const uint8_t *data, size_t size, size_t maxoutput, unsigned int space_break_flags, const char *separator, struct gc_arena *gc)
Definition buffer.c:483
struct buffer alloc_buf(size_t size)
Definition buffer.c:63
int string_array_len(const char **array)
Definition buffer.c:702
struct buffer buffer_read_from_file(const char *filename, struct gc_arena *gc)
buffer_read_from_file - copy the content of a file into a buffer
Definition buffer.c:1352
bool buf_parse(struct buffer *buf, const int delim, char *line, const int size)
Definition buffer.c:824
char * string_alloc(const char *str, struct gc_arena *gc)
Definition buffer.c:648
struct buffer string_alloc_buf(const char *str, struct gc_arena *gc)
Definition buffer.c:751
static void gc_detach(struct gc_arena *a)
Definition buffer.h:1011
#define BSTR(buf)
Definition buffer.h:128
#define BPTR(buf)
Definition buffer.h:123
#define ALLOC_ARRAY_GC(dptr, type, n, gc)
Definition buffer.h:1075
static bool buf_valid(const struct buffer *buf)
Definition buffer.h:234
static void gc_init(struct gc_arena *a)
Definition buffer.h:1004
#define ALLOC_OBJ_CLEAR_GC(dptr, type, gc)
Definition buffer.h:1101
#define ALLOC_OBJ_GC(dptr, type, gc)
Definition buffer.h:1096
static void strncpynt(char *dest, const char *src, size_t maxlen)
Definition buffer.h:361
static void gc_free(struct gc_arena *a)
Definition buffer.h:1025
static bool strprefix(const char *str, const char *prefix)
Return true iff str starts with prefix.
Definition buffer.h:969
static struct gc_arena gc_new(void)
Definition buffer.h:1017
void add_client_nat_to_option_list(struct client_nat_option_list *dest, const char *type, const char *network, const char *netmask, const char *foreign_network, msglvl_t msglevel)
Definition clinat.c:102
void print_client_nat_list(const struct client_nat_option_list *list, msglvl_t msglevel)
Definition clinat.c:50
struct client_nat_option_list * new_client_nat_list(struct gc_arena *gc)
Definition clinat.c:71
struct client_nat_option_list * clone_client_nat_option_list(const struct client_nat_option_list *src, struct gc_arena *gc)
Definition clinat.c:79
void copy_client_nat_option_list(struct client_nat_option_list *dest, const struct client_nat_option_list *src)
Definition clinat.c:88
#define TLS_CHANNEL_BUF_SIZE
Definition common.h:70
#define TLS_CHANNEL_MTU_MIN
Definition common.h:83
bool check_compression_settings_valid(struct compress_options *info, msglvl_t msglevel)
Checks if the compression settings are valid.
Definition comp.c:162
#define COMP_F_ALLOW_STUB_ONLY
Only accept stub compression, even with COMP_F_ADVERTISE_STUBS_ONLY we still accept other compression...
Definition comp.h:45
#define COMP_F_SWAP
initial command byte is swapped with last byte in buffer to preserve payload alignment
Definition comp.h:40
#define COMP_ALG_LZ4
LZ4 algorithm.
Definition comp.h:59
#define COMP_ALGV2_LZ4
Definition comp.h:64
#define COMP_F_ALLOW_NOCOMP_ONLY
Do not allow compression framing (breaks DCO)
Definition comp.h:51
#define COMP_F_ALLOW_ASYM
Compression was explicitly set to allow asymetric compression.
Definition comp.h:49
#define COMP_ALGV2_UNCOMPRESSED
Definition comp.h:63
#define COMP_ALG_STUB
support compression command byte and framing without actual compression
Definition comp.h:56
#define COMP_ALG_LZO
LZO algorithm.
Definition comp.h:57
#define COMP_F_ADVERTISE_STUBS_ONLY
tell server that we only support compression stubs
Definition comp.h:42
#define COMP_F_MIGRATE
push stub-v2 or comp-lzo no when we see a client with comp-lzo in occ
Definition comp.h:47
static bool comp_non_stub_enabled(const struct compress_options *info)
Definition comp.h:81
#define COMP_ALG_UNDEF
Definition comp.h:54
int daemon(int nochdir, int noclose)
char * dirname(char *path)
char * strsep(char **stringp, const char *delim)
void init_key_type(struct key_type *kt, const char *ciphername, const char *authname, bool tls_mode, bool warn)
Initialize a key_type structure with.
Definition crypto.c:875
int ascii2keydirection(msglvl_t msglevel, const char *str)
Definition crypto.c:1632
const char * keydirection2ascii(int kd, bool remote, bool humanreadable)
Definition crypto.c:1655
bool check_tls_prf_working(void)
Checks if the current TLS library supports the TLS 1.0 PRF with MD5+SHA1 that OpenVPN uses when TLS K...
Definition crypto.c:1915
void test_crypto(struct crypto_options *co, struct frame *frame)
Definition crypto.c:1199
Data Channel Cryptography Module.
#define CO_USE_TLS_KEY_MATERIAL_EXPORT
Bit-flag indicating that data channel key derivation is done using TLS keying material export [RFC570...
Definition crypto.h:359
#define CO_USE_DYNAMIC_TLS_CRYPT
Bit-flag indicating that renegotiations are using tls-crypt with a TLS-EKM derived key.
Definition crypto.h:375
#define CO_EPOCH_DATA_KEY_FORMAT
Bit-flag indicating the epoch the data format.
Definition crypto.h:379
#define KEY_DIRECTION_BIDIRECTIONAL
Definition crypto.h:231
#define CO_USE_CC_EXIT_NOTIFY
Bit-flag indicating that explicit exit notifies should be sent via the control channel instead of usi...
Definition crypto.h:371
@ MD_SHA256
@ MD_SHA1
static bool cipher_defined(const char *ciphername)
Checks if the cipher is defined and is not the null (none) cipher.
const char * md_kt_name(const char *mdname)
Retrieve a string describing the digest digest (e.g.
const char * cipher_kt_name(const char *ciphername)
Retrieve a normalised string describing the cipher (e.g.
int cipher_kt_key_size(const char *ciphername)
Returns the size of keys used by the cipher, in bytes.
#define SHA_DIGEST_LENGTH
#define SHA256_DIGEST_LENGTH
static bool dco_check_startup_option(msglvl_t msglevel, const struct options *o)
Definition dco.h:280
static bool dco_check_option(msglvl_t msglevel, const struct options *o)
Definition dco.h:274
static const char * dco_version_string(struct gc_arena *gc)
Definition dco.h:268
bool dns_options_verify(msglvl_t msglevel, const struct dns_options *o)
Checks validity of DNS options.
Definition dns.c:212
void dns_options_postprocess_pull(struct dns_options *o)
Merges pulled DNS servers with static ones into an ordered list.
Definition dns.c:289
bool dns_server_addr_parse(struct dns_server *server, const char *addr)
Parses a string IPv4 or IPv6 address and optional colon separated port, into a in_addr or in6_addr re...
Definition dns.c:62
bool dns_domain_list_append(struct dns_domain **entry, char **domains, struct gc_arena *gc)
Appends safe DNS domain parameters to a linked list.
Definition dns.c:148
struct dns_server * dns_server_get(struct dns_server **entry, long priority, struct gc_arena *gc)
Find or create DNS server with priority in a linked list.
Definition dns.c:190
bool dns_server_priority_parse(long *priority, const char *str, bool pulled)
Parses a string DNS server priority and validates it.
Definition dns.c:175
struct dns_options clone_dns_options(const struct dns_options *o, struct gc_arena *gc)
Makes a deep copy of the passed DNS options.
Definition dns.c:266
void show_dns_options(const struct dns_options *o)
Prints configured DNS options.
Definition dns.c:780
void dns_options_preprocess_pull(struct dns_options *o)
Saves and resets the server options, so that pulled ones don't mix in.
Definition dns.c:282
static bool dns_updown_user_set(const struct dns_options *o)
Returns whether dns-updown is user defined.
Definition dns.h:218
@ DNS_UPDOWN_FORCED
Definition dns.h:50
@ DNS_UPDOWN_NO_FLAGS
Definition dns.h:48
@ DNS_UPDOWN_USER_SET
Definition dns.h:49
@ DNS_SECURITY_NO
Definition dns.h:33
@ DNS_SECURITY_YES
Definition dns.h:34
@ DNS_SECURITY_OPTIONAL
Definition dns.h:35
static bool dns_updown_forced(const struct dns_options *o)
Returns whether dns-updown is forced to run.
Definition dns.h:229
@ DNS_TRANSPORT_PLAIN
Definition dns.h:41
@ DNS_TRANSPORT_TLS
Definition dns.h:43
@ DNS_TRANSPORT_HTTPS
Definition dns.h:42
static bool validate_domain(const char *domain)
void setenv_int(struct env_set *es, const char *name, int value)
Definition env_set.c:291
void setenv_str_i(struct env_set *es, const char *name, const char *value, const int i)
Definition env_set.c:423
void setenv_str(struct env_set *es, const char *name, const char *value)
Definition env_set.c:307
const char * env_set_get(const struct env_set *es, const char *name)
Definition env_set.c:201
void setenv_str_safe(struct env_set *es, const char *name, const char *value)
Definition env_set.c:313
bool env_set_del(struct env_set *es, const char *str)
Definition env_set.c:183
void setenv_long_long(struct env_set *es, const char *name, long long value)
Definition env_set.c:299
#define D_SHOW_OCC
Definition errlevel.h:150
#define D_PUSH
Definition errlevel.h:82
#define D_TLS_DEBUG_MED
Definition errlevel.h:156
#define D_DCO
Definition errlevel.h:93
#define D_SHOW_PARMS
Definition errlevel.h:95
#define D_PUSH_ERRORS
Definition errlevel.h:66
#define D_TLS_ERRORS
Definition errlevel.h:58
#define M_INFO
Definition errlevel.h:54
Interface functions to the internal and external multiplexers.
void helper_setdefault_topology(struct options *o)
Set –topology default depending on –mode.
Definition helper.c:137
void helper_tcp_nodelay(struct options *o)
Definition helper.c:608
void helper_client_server(struct options *o)
Definition helper.c:165
void helper_keepalive(struct options *o)
Definition helper.c:548
static int max_int(int x, int y)
Definition integer.h:92
static int constrain_int(int x, int min, int max)
Definition integer.h:118
static int tls_verify(struct openvpn_plugin_args_func_in const *args)
void management_auth_token(struct management *man, const char *token)
Definition manage.c:3115
void management_echo(struct management *man, const char *string, const bool pull)
Definition manage.c:3036
#define MF_FORGET_DISCONNECT
Definition manage.h:31
#define MF_EXTERNAL_KEY_PKCS1PAD
Definition manage.h:38
#define MF_CLIENT_AUTH
Definition manage.h:33
#define MF_EXTERNAL_KEY_PSSPAD
Definition manage.h:43
#define MF_EXTERNAL_KEY_NOPADDING
Definition manage.h:37
#define MF_QUERY_PROXY
Definition manage.h:41
#define MF_EXTERNAL_KEY
Definition manage.h:36
#define MF_QUERY_REMOTE
Definition manage.h:40
#define MF_QUERY_PASSWORDS
Definition manage.h:28
#define MF_EXTERNAL_CERT
Definition manage.h:42
#define MF_EXTERNAL_KEY_DIGEST
Definition manage.h:44
#define MF_UP_DOWN
Definition manage.h:39
#define MF_HOLD
Definition manage.h:29
#define MF_SIGNAL
Definition manage.h:30
#define MF_UNIX_SOCK
Definition manage.h:35
#define MF_CONNECT_AS_CLIENT
Definition manage.h:32
#define MBUF_SIZE_MAX
Definition mbuf.h:40
struct buffer prepend_dir(const char *dir, const char *path, struct gc_arena *gc)
Prepend a directory to a path.
Definition misc.c:777
const char * safe_print(const char *str, struct gc_arena *gc)
Definition misc.c:543
#define USER_PASS_LEN
Definition misc.h:64
#define SC_CONCAT
Definition misc.h:92
#define SC_ECHO
Definition misc.h:91
int translate_mtu_discover_type_name(const char *name)
Definition mtu.c:253
size_t calc_options_string_link_mtu(const struct options *o, const struct frame *frame)
Calculate the link-mtu to advertise to our peer.
Definition mtu.c:147
#define MSSFIX_DEFAULT
Definition mtu.h:84
#define TUN_MTU_MAX_MIN
Definition mtu.h:74
#define TAP_MTU_EXTRA_DEFAULT
Definition mtu.h:79
#define LINK_MTU_DEFAULT
Definition mtu.h:64
#define TUN_MTU_DEFAULT
Definition mtu.h:69
#define TLS_MTU_DEFAULT
Definition mtu.h:89
static bool learn_address_script(const struct multi_context *m, const struct multi_instance *mi, const char *op, const struct mroute_addr *addr)
Definition multi.c:83
static int net_ctx_init(struct context *c, openvpn_net_ctx_t *ctx)
Definition networking.h:47
void * openvpn_net_ctx_t
Definition networking.h:38
#define BOOL_CAST(x)
Definition basic.h:26
#define CLEAR(x)
Definition basic.h:32
#define SIZE(x)
Definition basic.h:29
void errors_to_stderr(void)
Definition error.c:179
void open_syslog(const char *pgmname, bool stdio_to_null)
Definition error.c:442
void redirect_stdout_stderr(const char *file, bool append)
Definition error.c:491
void openvpn_exit(const int status)
Definition error.c:700
static bool machine_readable_output
Definition error.c:74
void set_suppress_timestamps(bool suppressed)
Definition error.c:143
void set_machine_readable_output(bool parsable)
Definition error.c:149
FILE * msg_fp(const msglvl_t flags)
Definition error.c:188
bool set_debug_level(const int level, const unsigned int flags)
Definition error.c:101
static bool suppress_timestamps
Definition error.c:77
#define M_OPTERR
Definition error.h:101
#define SDL_CONSTRAIN
Definition error.h:201
#define M_NOPREFIX
Definition error.h:98
#define M_DEBUG_LEVEL
Definition error.h:88
#define M_USAGE
Definition error.h:107
#define OPENVPN_EXIT_STATUS_USAGE
Definition error.h:54
#define OPENVPN_EXIT_STATUS_GOOD
Definition error.h:52
#define M_FATAL
Definition error.h:90
#define M_ERR
Definition error.h:106
#define msg(flags,...)
Definition error.h:152
unsigned int msglvl_t
Definition error.h:77
#define ASSERT(x)
Definition error.h:219
#define M_WARN
Definition error.h:92
#define M_ERRNO
Definition error.h:95
#define MAX_PEER_ID
Definition openvpn.h:550
bool options_cmp_equal(char *actual, const char *expected)
Definition options.c:4550
#define RESET_OPTION_ROUTES(option_ptr, field)
Definition options.c:5062
static void rol6_check_alloc(struct options *options)
Definition options.c:1573
#define CHKACC_PRIVATE
Warn if this (private) file is group/others accessible.
Definition options.c:3949
static bool check_file_access_chroot_inline(bool is_inline, const char *chroot, const int type, const char *file, const int mode, const char *opt)
A wrapper for check_file_access_chroot() that returns false immediately if the file is inline (and th...
Definition options.c:4083
static bool check_file_access_chroot(const char *chroot, const int type, const char *file, const int mode, const char *opt)
Definition options.c:4049
static void options_postprocess_verify_ce(const struct options *options, const struct connection_entry *ce)
Definition options.c:2271
#define NM_QUOTE_HINT
Definition options.c:5029
static void options_postprocess_mutate_ce(struct options *o, struct connection_entry *ce)
Definition options.c:2922
static void usage_version(void)
Definition options.c:4908
static in_addr_t get_ip_addr(const char *ip_string, msglvl_t msglevel, bool *error)
Definition options.c:1106
static struct pull_filter * alloc_pull_filter(struct options *o)
Definition options.c:2175
#define USAGE_VALID_SERVER_PROTOS
#define SHOW_BOOL(var)
Definition options.c:978
#define CHKACC_DIRPATH
Check for directory presence where a file should reside.
Definition options.c:3946
static void pre_connect_save(struct options *o)
Definition options.c:3113
#define CHKACC_ACPTSTDIN
If filename is stdin, it's allowed and "exists".
Definition options.c:3948
#define TLS_CLIENT
static void setenv_connection_entry(struct env_set *es, const struct connection_entry *e, const int i)
Definition options.c:983
static int global_auth_retry
Definition options.c:4787
bool options_postprocess_pull(struct options *o, struct env_set *es)
Definition options.c:4292
void uninit_options(struct options *o)
Definition options.c:930
static void dhcp_option_dns6_parse(const char *parm, struct in6_addr *dns6_list, int *len, msglvl_t msglevel)
Definition options.c:1329
static void connection_entry_load_re(struct connection_entry *ce, const struct remote_entry *re)
Definition options.c:2196
#define SHOW_STR(var)
Definition options.c:971
int parse_topology(const char *str, const msglvl_t msglevel)
Definition options.c:4740
void show_windows_version(const unsigned int flags)
Definition options.c:4875
#define VERIFY_PERMISSION(mask)
Definition options.c:4969
static const char * options_warning_extract_parm1(const char *option_string, struct gc_arena *gc_ret)
Definition options.c:4562
bool key_is_external(const struct options *options)
Definition options.c:5560
static char * string_substitute(const char *src, char from, char to, struct gc_arena *gc)
Definition options.c:1158
static void check_ca_required(const struct options *options)
Definition options.c:2233
static struct http_proxy_options * parse_http_proxy_override(const char *server, const char *port, const char *flags, struct gc_arena *gc)
Definition options.c:1989
static bool verify_permission(const char *name, const char *file, int line, const unsigned int type, const unsigned int allowed, unsigned int *found, const msglvl_t msglevel, struct options *options, bool is_inline)
Definition options.c:4979
#define CHKACC_FILEXSTWR
If file exists, is it writable?
Definition options.c:3947
static void tuntap_options_postprocess_dns(struct options *o)
Postprocess DNS related settings.
Definition options.c:3497
static char * get_ipv6_addr_no_netbits(const char *addr, struct gc_arena *gc)
Returns newly allocated string containing address part without "/nn".
Definition options.c:1131
static void option_iroute_ipv6(struct options *o, const char *prefix_str, msglvl_t msglevel)
Definition options.c:1507
static bool check_route_option(struct options *options, char *p[], const msglvl_t msglevel, bool pull_mode)
Definition options.c:5232
void show_dco_version(const unsigned int flags)
Definition options.c:4884
void rol_check_alloc(struct options *options)
Definition options.c:1564
static struct local_list * alloc_local_list_if_undef(struct connection_entry *ce, struct gc_arena *gc)
Definition options.c:2052
#define SHOW_UNSIGNED(var)
Definition options.c:977
void show_settings(const struct options *o)
Definition options.c:1688
static void set_user_script(struct options *options, const char **script, const char *new_script, const char *type, bool in_chroot)
Definition options.c:5521
void remove_option(struct context *c, struct options *options, char *p[], bool is_inline, const char *file, int line, const msglvl_t msglevel, const unsigned int permission_mask, unsigned int *option_types_found, struct env_set *es)
Resets options found in the PUSH_UPDATE message that are preceded by the - flag.
Definition options.c:5070
static struct verify_hash_list * parse_hash_fingerprint_multiline(const char *str, int nbytes, msglvl_t msglevel, struct gc_arena *gc)
Parses a string consisting of multiple lines of hexstrings and checks if each string has the correct ...
Definition options.c:1239
#define LZO_LIB_VER_STR
static bool no_more_than_n_args(const msglvl_t msglevel, char *p[], const int max, const unsigned int flags)
Definition options.c:5032
static void show_dhcp_option_list(const char *name, const char *const *array, int len)
Definition options.c:1281
static void show_connection_entries(const struct options *o)
Definition options.c:1649
static void options_postprocess_mutate_le(struct connection_entry *ce, struct local_entry *le, int mode)
Definition options.c:3079
bool options_cmp_equal_safe(char *actual, const char *expected, size_t actual_n)
Definition options.c:4670
bool string_defined_equal(const char *s1, const char *s2)
Definition options.c:4939
static bool check_file_access_inline(bool is_inline, const int type, const char *file, const int mode, const char *opt)
A wrapper for check_file_access() that returns false immediately if the file is inline (and therefore...
Definition options.c:4099
void options_postprocess(struct options *options, struct env_set *es)
Definition options.c:4278
void update_option(struct context *c, struct options *options, char *p[], bool is_inline, const char *file, int line, const int level, const msglvl_t msglevel, const unsigned int permission_mask, unsigned int *option_types_found, struct env_set *es)
Processes an option to update.
Definition options.c:5390
static void show_dhcp_option_addrs(const char *name, const in_addr_t *array, int len)
Definition options.c:1291
void usage_small(void)
Definition options.c:4867
const char * auth_retry_print(void)
Definition options.c:4819
static void show_http_proxy_options(const struct http_proxy_options *o)
Definition options.c:1525
static void options_postprocess_filechecks(struct options *options)
Definition options.c:4167
static struct remote_entry * alloc_remote_entry(struct options *options, const msglvl_t msglevel)
Definition options.c:2139
static void show_connection_entry(const struct connection_entry *o)
Definition options.c:1592
void options_warning_safe(char *actual, const char *expected, size_t actual_n)
Definition options.c:4693
void show_library_versions(const unsigned int flags)
Definition options.c:4894
void setenv_settings(struct env_set *es, const struct options *o)
Definition options.c:1009
#define CHKACC_ACCEPT_URI
Do not check URIs, unless they start with file:
Definition options.c:3950
static const char usage_message[]
Definition options.c:122
static void options_warning_safe_scan1(const msglvl_t msglevel, const int delim, const bool report_inconsistent, const struct buffer *b1_src, const struct buffer *b2_src, const char *b1_name, const char *b2_name)
Definition options.c:4630
static struct connection_list * alloc_connection_list_if_undef(struct options *options)
Definition options.c:2093
static bool check_cmd_access(const char *command, const char *opt, const char *chroot)
Definition options.c:4127
#define SHOW_INT64(var)
Definition options.c:976
static bool check_file_access(const int type, const char *file, const int mode, const char *opt)
Definition options.c:3953
static void show_p2mp_parms(const struct options *o)
Definition options.c:1388
static const char * pull_filter_type_name(int type)
Definition options.c:950
void add_option(struct options *options, char *p[], bool is_inline, const char *file, int line, const int level, const msglvl_t msglevel, const unsigned int permission_mask, unsigned int *option_types_found, struct env_set *es)
Definition options.c:5575
static void cnol_check_alloc(struct options *options)
Definition options.c:1582
static void options_postprocess_mutate(struct options *o, struct env_set *es)
Definition options.c:3754
void options_detach(struct options *o)
Definition options.c:1555
static void options_warning_safe_ml(const msglvl_t msglevel, char *actual, const char *expected, size_t actual_n)
Definition options.c:4648
static unsigned int atou(const char *str)
Definition options.c:4961
void pre_connect_restore(struct options *o, struct gc_arena *gc)
Definition options.c:3158
static struct pull_filter_list * alloc_pull_filter_list(struct options *o)
Definition options.c:2165
const char * print_topology(const int topology)
Definition options.c:4762
char * options_string_extract_option(const char *options_string, const char *opt_name, struct gc_arena *gc)
Given an OpenVPN options string, extract the value of an option.
Definition options.c:4707
static struct verify_hash_list * parse_hash_fingerprint(const char *str, int nbytes, msglvl_t msglevel, struct gc_arena *gc)
Parses a hexstring and checks if the string has the correct length.
Definition options.c:1186
static bool check_dns_option(struct options *options, char *p[], const msglvl_t msglevel, bool pull_mode)
Definition options.c:5281
#define SHOW_STR_INLINE(var)
Definition options.c:972
static void options_warning_safe_scan2(const msglvl_t msglevel, const int delim, const bool report_inconsistent, const char *p1, const struct buffer *b2_src, const char *b1_name, const char *b2_name)
Definition options.c:4576
static void options_postprocess_cipher(struct options *o)
Definition options.c:3331
static void options_set_backwards_compatible_options(struct options *o)
Changes default values so that OpenVPN can be compatible with the user specified version.
Definition options.c:3401
static void show_tuntap_options(const struct tuntap_options *o)
Definition options.c:1303
void init_options(struct options *o, const bool init_gc)
Definition options.c:802
#define MUST_BE_FALSE(condition, parm_name)
Definition options.c:2264
#define MUST_BE_UNDEF(parm, parm_name)
Definition options.c:2259
static const char * print_vlan_accept(enum vlan_acceptable_frames mode)
Definition options.c:1371
#define SHOW_PARM(name, value, format)
Definition options.c:970
static void options_postprocess_http_proxy_override(struct options *o)
Definition options.c:2017
void options_warning(char *actual, const char *expected)
Definition options.c:4556
static void show_pull_filter_list(const struct pull_filter_list *l)
Definition options.c:1670
#define CHKACC_FILE
Check for a file/directory presence.
Definition options.c:3945
const char * options_string_version(const char *s, struct gc_arena *gc)
Definition options.c:4699
static void options_postprocess_mutate_invariant(struct options *options)
Definition options.c:3231
static bool ipv6_addr_safe_hexplusbits(const char *ipv6_prefix_spec)
Definition options.c:1149
const char title_string[]
Definition options.c:72
static void setenv_local_entry(struct env_set *es, const struct local_entry *e, const int i)
Definition options.c:1001
static void remap_redirect_gateway_flags(struct options *opt)
Definition options.c:3097
#define TLS_SERVER
static msglvl_t msglevel_forward_compatible(struct options *options, const msglvl_t msglevel)
Definition options.c:5057
bool auth_retry_set(const msglvl_t msglevel, const char *option)
Definition options.c:4796
int auth_retry_get(void)
Definition options.c:4790
static void dhcp_option_address_parse(const char *name, const char *parm, in_addr_t *array, int *len, msglvl_t msglevel)
Definition options.c:1343
static struct remote_list * alloc_remote_list_if_undef(struct options *options)
Definition options.c:2129
static bool check_route6_option(struct options *options, char *p[], const msglvl_t msglevel, bool pull_mode)
Definition options.c:5260
void notnull(const char *arg, const char *description)
Definition options.c:4930
void usage(void)
Definition options.c:4841
static struct local_entry * alloc_local_entry(struct connection_entry *ce, const msglvl_t msglevel, struct gc_arena *gc)
Definition options.c:2062
static void show_compression_warning(struct compress_options *info)
Definition options.c:5548
static void options_process_mutate_prf(struct options *o)
Definition options.c:3469
bool has_udp_in_local_list(const struct options *options)
Definition options.c:9301
char * options_string(const struct options *o, const struct frame *frame, struct tuntap *tt, openvpn_net_ctx_t *ctx, bool remote, struct gc_arena *gc)
Definition options.c:4349
static void option_iroute(struct options *o, const char *network_str, const char *netmask_str, msglvl_t msglevel)
Definition options.c:1480
static void options_postprocess_verify(const struct options *o)
Definition options.c:3294
static void connection_entry_preload_key(const char **key_file, bool *key_inline, struct gc_arena *gc)
Definition options.c:2217
static struct connection_entry * alloc_connection_entry(struct options *options, const msglvl_t msglevel)
Definition options.c:2103
#define SHOW_INT(var)
Definition options.c:974
static bool need_compatibility_before(const struct options *o, unsigned int version)
The option –compat-mode is used to set up default settings to values used on the specified openvpn ve...
Definition options.c:3391
#define MODE_POINT_TO_POINT
Definition options.h:263
#define OPT_P_SCRIPT
Definition options.h:735
#define PUF_TYPE_ACCEPT
filter type to accept a matching option
Definition options.h:800
#define OPT_P_PUSH
Definition options.h:747
#define SF_TCP_NODELAY_HELPER
Definition options.h:474
#define OPT_P_UP
Definition options.h:732
#define OPT_P_CONNECTION
Definition options.h:758
#define OPT_P_INSTANCE
allowed in ccd, client-connect etc
Definition options.h:748
#define OPT_P_NCP
Negotiable crypto parameters.
Definition options.h:743
void read_config_file(struct options *options, const char *file, int level, const char *top_file, const int top_line, const msglvl_t msglevel, const unsigned int permission_mask, unsigned int *option_types_found, struct env_set *es)
#define OPT_P_ECHO
Definition options.h:751
#define OPT_P_ROUTE_TABLE
Definition options.h:762
#define OPT_P_CONFIG
Definition options.h:749
#define MODE_SERVER
Definition options.h:264
#define CONNECTION_LIST_SIZE
Definition options.h:190
#define streq(x, y)
Definition options.h:726
#define OPT_P_U_REDIR_GATEWAY
Definition options.h:795
#define OPT_P_EXPLICIT_NOTIFY
Definition options.h:750
#define PUF_TYPE_IGNORE
filter type to ignore a matching option
Definition options.h:801
#define AR_INTERACT
Definition options.h:971
#define OPT_P_SHAPER
Definition options.h:737
#define OPT_P_U_ROUTE6
Definition options.h:792
static bool dco_enabled(const struct options *o)
Returns whether the current configuration has dco enabled.
Definition options.h:992
#define OPT_P_SOCKFLAGS
Definition options.h:757
#define SF_NOPOOL
Definition options.h:473
#define PUF_TYPE_REJECT
filter type to reject and trigger SIGUSR1
Definition options.h:802
#define OPT_P_MESSAGES
Definition options.h:742
#define OPT_P_SETENV
Definition options.h:736
#define OPT_P_SOCKBUF
Definition options.h:756
#define OPT_P_PLUGIN
Definition options.h:755
#define OPTION_PARM_SIZE
Definition options.h:56
#define OPT_P_TIMER
Definition options.h:738
#define OPT_P_GENERAL
Definition options.h:731
#define PING_RESTART
Definition options.h:355
#define OPT_P_DHCPDNS
Definition options.h:734
#define OPT_P_PULL_MODE
Definition options.h:754
@ GENKEY_AUTH_TOKEN
Definition options.h:242
@ GENKEY_SECRET
Definition options.h:239
@ GENKEY_TLS_CRYPTV2_SERVER
Definition options.h:241
@ GENKEY_TLS_CRYPTV2_CLIENT
Definition options.h:240
#define OPT_P_PUSH_MTU
Definition options.h:761
#define AR_NONE
Definition options.h:970
#define AR_NOINTERACT
Definition options.h:972
#define SF_NO_PUSH_ROUTE_GATEWAY
Definition options.h:475
#define OPT_P_PERSIST
Definition options.h:739
#define MAX_PARMS
Definition options.h:51
#define PULL_DEFINED(opt)
Definition options.h:766
#define OPT_P_U_DNS
Definition options.h:793
#define PLUGIN_OPTION_LIST(opt)
Definition options.h:777
#define ROUTE_OPTION_FLAGS(o)
Definition options.h:769
#define OPTION_LINE_SIZE
Definition options.h:57
#define OPT_P_U_ROUTE
Definition options.h:791
#define PING_EXIT
Definition options.h:354
#define OPT_P_COMP
Definition options.h:741
#define OPT_P_PERSIST_IP
Definition options.h:740
#define OPT_P_MTU
Definition options.h:745
#define OPT_P_ROUTE_EXTRAS
Definition options.h:753
#define OPT_P_U_DHCP
Definition options.h:794
#define OPT_P_NICE
Definition options.h:746
#define OPT_P_PEER_ID
Definition options.h:759
#define OPT_P_INHERIT
Definition options.h:752
#define OPT_P_TLS_PARMS
Definition options.h:744
#define OPT_P_ROUTE
Definition options.h:733
void read_config_string(const char *prefix, struct options *options, const char *config, const msglvl_t msglevel, const unsigned int permission_mask, unsigned int *option_types_found, struct env_set *es)
#define MAN_CLIENT_AUTH_ENABLED(opt)
Definition options.h:783
#define CE_DISABLED
Definition options.h:153
#define OPT_P_INLINE
Definition options.h:760
vlan_acceptable_frames
Definition options.h:223
@ VLAN_ONLY_UNTAGGED_OR_PRIORITY
Definition options.h:225
@ VLAN_ALL
Definition options.h:226
@ VLAN_ONLY_TAGGED
Definition options.h:224
int atoi_warn(const char *str, msglvl_t msglevel)
Converts a str to an integer if the string can be represented as an integer number.
int positive_atoi(const char *str, msglvl_t msglevel)
Converts a str to a positive number if the string represents a postive integer number.
bool positive_atoll(const char *str, int64_t *value, const char *name, msglvl_t msglevel)
Converts a str to an integer if the string can be represented as an integer number and is >= 0.
bool valid_integer(const char *str, bool positive)
Checks if the string is a valid integer by checking if it can be converted to an integer.
bool atoi_constrained(const char *str, int *value, const char *name, int min, int max, msglvl_t msglevel)
Converts a str to an integer if the string can be represented as an integer number and is between min...
#define MAX_SEQ_BACKTRACK
Definition packet_id.h:85
#define MIN_SEQ_BACKTRACK
Definition packet_id.h:84
#define DEFAULT_SEQ_BACKTRACK
Definition packet_id.h:86
#define MAX_TIME_BACKTRACK
Definition packet_id.h:94
#define DEFAULT_TIME_BACKTRACK
Definition packet_id.h:95
#define MIN_TIME_BACKTRACK
Definition packet_id.h:93
unsigned int platform_getpid(void)
Definition platform.c:333
int platform_access(const char *path, int mode)
Definition platform.c:457
int platform_chdir(const char *dir)
Definition platform.c:392
int platform_stat(const char *path, platform_stat_t *buf)
Definition platform.c:526
struct _stat platform_stat_t
Definition platform.h:118
struct plugin_option_list * plugin_option_list_new(struct gc_arena *gc)
Definition plugin.c:159
bool plugin_option_list_add(struct plugin_option_list *list, char **p, struct gc_arena *gc)
Definition plugin.c:167
void plugin_option_list_print(const struct plugin_option_list *list, msglvl_t msglevel)
Definition plugin.c:187
bool ifconfig_pool_verify_range(const msglvl_t msglevel, const in_addr_t start, const in_addr_t end)
Definition pool.c:117
#define OPENVPN_8021Q_MIN_VID
Definition proto.h:316
#define OPENVPN_8021Q_MAX_VID
Definition proto.h:317
#define DEV_TYPE_TAP
Definition proto.h:36
#define TOP_UNDEF
Definition proto.h:40
#define DEV_TYPE_UNDEF
Definition proto.h:34
#define TOP_NET30
Definition proto.h:41
#define DEV_TYPE_TUN
Definition proto.h:35
#define TOP_P2P
Definition proto.h:42
#define TOP_SUBNET
Definition proto.h:43
struct http_proxy_options * init_http_proxy_options_once(struct http_proxy_options **hpo, struct gc_arena *gc)
Definition proxy.c:45
#define PAR_NCT
Definition proxy.h:51
#define MAX_CUSTOM_HTTP_HEADER
Definition proxy.h:43
#define PAR_ALL
Definition proxy.h:50
void push_reset(struct options *o)
Definition push.c:943
void push_options(struct options *o, char **p, msglvl_t msglevel, struct gc_arena *gc)
Definition push.c:917
void clone_push_list(struct options *o)
Definition push.c:902
void push_remove_option(struct options *o, const char *p)
Definition push.c:949
void print_route_options(const struct route_option_list *rol, msglvl_t msglevel)
Definition route.c:1238
bool is_special_addr(const char *addr_str)
Definition route.c:299
struct route_option_list * clone_route_option_list(const struct route_option_list *src, struct gc_arena *a)
Definition route.c:153
int netmask_to_netbits2(in_addr_t netmask)
Definition route.c:3909
struct route_ipv6_option_list * new_route_ipv6_option_list(struct gc_arena *a)
Definition route.c:137
void delete_routes_v6(struct route_ipv6_list *rl6, const struct tuntap *tt, unsigned int flags, const struct env_set *es, openvpn_net_ctx_t *ctx)
Definition route.c:1196
void get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6, const struct in6_addr *dest, openvpn_net_ctx_t *ctx)
Definition route.c:2668
void add_route_ipv6_to_option_list(struct route_ipv6_option_list *l, const char *prefix, const char *gateway, const char *metric, int table_id)
Definition route.c:507
void copy_route_option_list(struct route_option_list *dest, const struct route_option_list *src, struct gc_arena *a)
Definition route.c:171
void copy_route_ipv6_option_list(struct route_ipv6_option_list *dest, const struct route_ipv6_option_list *src, struct gc_arena *a)
Definition route.c:179
void print_default_gateway(const msglvl_t msglevel, const struct route_gateway_info *rgi, const struct route_ipv6_gateway_info *rgi6)
Definition route.c:1252
void get_default_gateway(struct route_gateway_info *rgi, in_addr_t dest, openvpn_net_ctx_t *ctx)
Retrieves the best gateway for a given destination based on the routing table.
Definition route.c:2570
struct route_ipv6_option_list * clone_route_ipv6_option_list(const struct route_ipv6_option_list *src, struct gc_arena *a)
Definition route.c:162
struct route_option_list * new_route_option_list(struct gc_arena *a)
Definition route.c:128
void show_routes(msglvl_t msglevel)
Definition route.c:3071
void delete_routes_v4(struct route_list *rl, const struct tuntap *tt, unsigned int flags, const struct env_set *es, openvpn_net_ctx_t *ctx)
Definition route.c:1174
void add_route_to_option_list(struct route_option_list *l, const char *network, const char *netmask, const char *gateway, const char *metric, int table_id)
Definition route.c:492
#define RG_LOCAL
Definition route.h:87
#define RG_BYPASS_DHCP
Definition route.h:89
#define ROUTE_METHOD_SERVICE
Definition route.h:42
#define ROUTE_METHOD_IPAPI
Definition route.h:40
#define ROUTE_METHOD_EXE
Definition route.h:41
#define RG_DEF1
Definition route.h:88
#define RG_BYPASS_DNS
Definition route.h:90
#define RG_ENABLE
Definition route.h:86
#define RG_REROUTE_GW
Definition route.h:91
#define ROUTE_METHOD_ADAPTIVE
Definition route.h:39
#define RG_AUTO_LOCAL
Definition route.h:92
#define RG_BLOCK_LOCAL
Definition route.h:93
void script_security_set(int level)
Definition run_command.c:48
#define SSEC_PW_ENV
allow calling of built-in programs and user-defined scripts that may receive a password as an environ...
Definition run_command.h:38
#define SSEC_NONE
strictly no calling of external programs
Definition run_command.h:31
#define SHAPER_MAX
Definition shaper.h:40
#define SHAPER_MIN
Definition shaper.h:39
static void bind_local(struct link_socket *sock, const sa_family_t ai_family)
Definition socket.c:669
bool get_ipv6_addr(const char *hostname, struct in6_addr *network, unsigned int *netbits, msglvl_t msglevel)
Translate an IPv6 addr or hostname from string form to in6_addr.
Definition socket.c:229
in_addr_t getaddr(unsigned int flags, const char *hostname, int resolve_retry_seconds, bool *succeeded, struct signal_info *sig_info)
Translate an IPv4 addr or hostname from string form to in_addr_t.
Definition socket.c:202
#define SF_TCP_NODELAY
Definition socket.h:192
#define RESOLV_RETRY_INFINITE
Definition socket.h:48
#define OPENVPN_PORT
Definition socket.h:42
#define SF_USE_IP_PKTINFO
Definition socket.h:191
#define SF_HOST_RANDOMIZE
Definition socket.h:194
#define SF_PKTINFO_COPY_IIF
Definition socket.h:198
const char * proto2ascii(int proto, sa_family_t af, bool display_form)
bool mac_addr_safe(const char *mac_addr)
const char * proto2ascii_all(struct gc_arena *gc)
sa_family_t ascii2af(const char *proto_name)
const char * proto_remote(int proto, bool remote)
bool ipv6_addr_safe(const char *ipv6_text_addr)
const char * print_in6_addr(struct in6_addr a6, unsigned int flags, struct gc_arena *gc)
bool ip_or_dns_addr_safe(const char *addr, const bool allow_fqdn)
int ascii2proto(const char *proto_name)
const char * print_in_addr_t(in_addr_t addr, unsigned int flags, struct gc_arena *gc)
bool ip_addr_dotted_quad_safe(const char *dotted_quad)
static bool proto_is_net(int proto)
static bool proto_is_udp(int proto)
Returns if the protocol being used is UDP.
#define GETADDR_FATAL
@ PROTO_NONE
@ PROTO_UDP
@ PROTO_TCP
@ PROTO_TCP_CLIENT
@ PROTO_TCP_SERVER
#define GETADDR_HOST_ORDER
static bool proto_is_dgram(int proto)
Return if the protocol is datagram (UDP)
#define GETADDR_RESOLVE
#define IA_NET_ORDER
Definition socket_util.h:90
void ssl_set_auth_token_user(const char *username)
Definition ssl.c:361
void ssl_set_auth_nocache(void)
Definition ssl.c:336
int tls_version_parse(const char *vstr, const char *extra)
Definition ssl.c:420
void ssl_set_auth_token(const char *token)
Definition ssl.c:355
bool ssl_get_auth_nocache(void)
Definition ssl.c:346
static bool push_peer_info(struct buffer *buf, struct tls_session *session)
Prepares the IV_ and UV_ variables that are part of the exchange to signal the peer's capabilities.
Definition ssl.c:1872
Control Channel SSL/Data channel negotiation module.
#define X509_USERNAME_FIELD_DEFAULT
Definition ssl.h:120
#define KEY_METHOD_2
Definition ssl.h:122
const char * get_ssl_library_version(void)
return a pointer to a static memory area containing the name and version number of the SSL library in...
#define TLS_VER_BAD
Parse a TLS version specifier.
#define TLS_VER_1_0
#define EXPORT_KEY_DATA_LABEL
#define TLS_VER_1_2
#define TLS_VER_1_3
int tls_version_max(void)
Return the maximum TLS version (as a TLS_VER_x constant) supported by current SSL implementation.
#define SSLF_TLS_VERSION_MAX_SHIFT
Definition ssl_common.h:435
#define SSLF_CLIENT_CERT_OPTIONAL
Definition ssl_common.h:428
#define SSLF_AUTH_USER_PASS_OPTIONAL
Definition ssl_common.h:430
#define SSLF_CLIENT_CERT_NOT_REQUIRED
Definition ssl_common.h:427
#define SSLF_CRL_VERIFY_DIR
Definition ssl_common.h:432
#define SSLF_TLS_DEBUG_ENABLED
Definition ssl_common.h:437
#define SSLF_TLS_VERSION_MAX_MASK
Definition ssl_common.h:436
#define SSLF_TLS_VERSION_MIN_SHIFT
Definition ssl_common.h:433
#define SSLF_TLS_VERSION_MIN_MASK
Definition ssl_common.h:434
#define SSLF_USERNAME_AS_COMMON_NAME
Definition ssl_common.h:429
void options_postprocess_setdefault_ncpciphers(struct options *o)
Checks for availibility of Chacha20-Poly1305 and sets the ncp_cipher to either AES-256-GCM:AES-128-GC...
Definition ssl_ncp.c:584
bool tls_item_in_cipher_list(const char *item, const char *list)
Return true iff item is present in the colon-separated zero-terminated cipher list.
Definition ssl_ncp.c:206
void append_cipher_to_ncp_list(struct options *o, const char *ciphername)
Appends the cipher specified by the ciphernamer parameter to to the o->ncp_ciphers list.
Definition ssl_ncp.c:195
char * mutate_ncp_cipher_list(const char *list, struct gc_arena *gc)
Check whether the ciphers in the supplied list are supported.
Definition ssl_ncp.c:96
Control Channel SSL/Data dynamic negotiation Module This file is split from ssl.h to be able to unit ...
Control Channel Verification Module.
#define OPENVPN_KU_REQUIRED
Require keyUsage to be present in cert (0xFFFF is an invalid KU value)
Definition ssl_verify.h:257
#define VERIFY_X509_SUBJECT_DN
Definition ssl_verify.h:69
#define VERIFY_X509_SUBJECT_RDN
Definition ssl_verify.h:70
#define NS_CERT_CHECK_CLIENT
Do not perform Netscape certificate type verification.
Definition ssl_verify.h:254
#define VERIFY_X509_SUBJECT_RDN_PREFIX
Definition ssl_verify.h:71
#define NS_CERT_CHECK_SERVER
Do not perform Netscape certificate type verification.
Definition ssl_verify.h:252
void x509_track_add(const struct x509_track **ll_head, const char *name, msglvl_t msglevel, struct gc_arena *gc)
Definition argv.h:35
char ** argv
Definition argv.h:39
Wrapper structure for dynamically allocated memory.
Definition buffer.h:60
uint8_t * data
Pointer to the allocated memory.
Definition buffer.h:67
int len
Length in bytes of the actual content within the allocated memory.
Definition buffer.h:65
unsigned int flags
Definition comp.h:77
Definition options.h:107
struct local_list * local_list
Definition options.h:108
int tun_mtu_max
Definition options.h:129
int connect_retry_seconds
Definition options.h:119
bool tls_crypt_v2_force_cookie
Definition options.h:179
int link_mtu
Definition options.h:134
bool link_mtu_defined
Definition options.h:135
int tun_mtu_extra
Definition options.h:132
int connect_retry_seconds_max
Definition options.h:120
bool bind_local
Definition options.h:118
int mssfix
Definition options.h:144
const char * tls_crypt_file
Definition options.h:170
const char * tls_crypt_v2_file
Definition options.h:175
bool tun_mtu_extra_defined
Definition options.h:133
const char * remote
Definition options.h:114
int connect_timeout
Definition options.h:121
const char * socks_proxy_port
Definition options.h:124
bool mssfix_default
Definition options.h:145
bool mssfix_encap
Definition options.h:146
int occ_mtu
Definition options.h:128
struct http_proxy_options * http_proxy_options
Definition options.h:122
bool tls_crypt_file_inline
Definition options.h:171
bool tls_auth_file_inline
Definition options.h:166
bool bind_ipv6_only
Definition options.h:117
bool tun_mtu_defined
Definition options.h:131
bool remote_float
Definition options.h:115
int tls_mtu
Definition options.h:136
int explicit_exit_notification
Definition options.h:150
const char * socks_proxy_authfile
Definition options.h:125
const char * remote_port
Definition options.h:113
bool fragment_encap
Definition options.h:142
const char * socks_proxy_server
Definition options.h:123
int fragment
Definition options.h:141
int mtu_discover_type
Definition options.h:139
int proto
Definition options.h:109
sa_family_t af
Definition options.h:110
const char * tls_auth_file
Definition options.h:165
bool local_port_defined
Definition options.h:112
int tun_mtu
Definition options.h:127
bool bind_defined
Definition options.h:116
const char * local_port
Definition options.h:111
int key_direction
Definition options.h:167
bool tls_crypt_v2_file_inline
Definition options.h:176
unsigned int flags
Definition options.h:162
bool mssfix_fixed
Definition options.h:148
struct connection_entry ** array
Definition options.h:204
struct route_list * route_list
List of routing information.
Definition openvpn.h:177
struct route_ipv6_list * route_ipv6_list
Definition openvpn.h:182
struct tuntap * tuntap
Tun/tap virtual network interface.
Definition openvpn.h:172
Contains all state information for one tunnel.
Definition openvpn.h:471
openvpn_net_ctx_t net_ctx
Networking API opaque context.
Definition openvpn.h:498
struct options options
Options loaded from command line or configuration file.
Definition openvpn.h:472
struct context_1 c1
Level 1 context.
Definition openvpn.h:513
in_addr_t dns[N_DHCP_ADDR]
Definition dns.h:101
Definition dhcp.h:62
struct dns_domain * next
Definition dns.h:55
const char * name
Definition dns.h:56
struct dns_server * servers
Definition dns.h:117
const char * updown
Definition dns.h:119
struct dhcp_options from_dhcp
Definition dns.h:114
struct gc_arena gc
Definition dns.h:118
enum dns_updown_flags updown_flags
Definition dns.h:120
struct dns_domain * search_domains
Definition dns.h:115
struct in_addr a4
Definition dns.h:63
union dns_server_addr::@0 in
sa_family_t family
Definition dns.h:66
struct in6_addr a6
Definition dns.h:64
in_port_t port
Definition dns.h:67
struct dns_server_addr addr[8]
Definition dns.h:75
enum dns_security dnssec
Definition dns.h:77
struct dns_server * next
Definition dns.h:72
long priority
Definition dns.h:73
size_t addr_count
Definition dns.h:74
struct dns_domain * domains
Definition dns.h:76
enum dns_server_transport transport
Definition dns.h:78
const char * sni
Definition dns.h:79
char * string
Definition env_set.h:38
struct env_item * next
Definition env_set.h:39
struct env_item * list
Definition env_set.h:45
Structure for reassembling one incoming fragmented packet.
Definition fragment.h:65
Packet geometry parameters.
Definition mtu.h:103
int tun_mtu
the (user) configured tun-mtu.
Definition mtu.h:137
Garbage collection arena used to keep track of dynamically allocated memory.
Definition buffer.h:116
Definition list.h:53
const char * name
Definition proxy.h:39
const char * content
Definition proxy.h:40
const char * auth_file
Definition proxy.h:55
const char * http_version
Definition proxy.h:57
const char * port
Definition proxy.h:47
bool inline_creds
Definition proxy.h:60
const char * user_agent
Definition proxy.h:58
const char * auth_method_string
Definition proxy.h:54
struct http_custom_header custom_headers[MAX_CUSTOM_HTTP_HEADER]
Definition proxy.h:59
const char * auth_file_up
Definition proxy.h:56
const char * server
Definition proxy.h:46
struct iroute_ipv6 * next
Definition route.h:271
unsigned int netbits
Definition route.h:270
struct in6_addr network
Definition route.h:269
in_addr_t network
Definition route.h:262
int netbits
Definition route.h:263
struct iroute * next
Definition route.h:264
const char * cipher
const name of the cipher
Definition crypto.h:142
const char * digest
Message digest static parameters.
Definition crypto.h:143
Definition options.h:100
const char * port
Definition options.h:102
int proto
Definition options.h:103
const char * local
Definition options.h:101
struct local_entry ** array
Definition options.h:196
int capacity
Definition options.h:194
struct tuntap_options tuntap_options
Definition options.h:65
int ping_rec_timeout_action
Definition options.h:89
bool tuntap_options_defined
Definition options.h:64
bool routes_ipv6_defined
Definition options.h:73
struct route_option_list * routes
Definition options.h:71
struct compress_options comp
Definition options.h:92
const char * ciphername
Definition options.h:84
const char * ifconfig_local
Definition options.h:67
struct dns_options dns_options
Definition options.h:82
const char * route_default_gateway
Definition options.h:76
const char * ifconfig_ipv6_local
Definition options.h:68
const char * authname
Definition options.h:85
struct route_ipv6_option_list * routes_ipv6
Definition options.h:74
bool client_nat_defined
Definition options.h:79
struct client_nat_option_list * client_nat
Definition options.h:80
const char * route_ipv6_default_gateway
Definition options.h:77
int resolve_retry_seconds
Definition options.h:366
int rcvbuf
Definition options.h:412
bool resolve_in_advance
Definition options.h:367
bool route_nopull
Definition options.h:436
const char * genkey_extra_data
Definition options.h:289
struct compress_options comp
Definition options.h:409
struct http_proxy_options * http_proxy_override
Definition options.h:312
int push_ifconfig_ipv6_netbits
Definition options.h:522
int proto_force
Definition options.h:335
bool persist_config
Definition options.h:277
struct connection_list * connection_list
Definition options.h:294
const char * management_port
Definition options.h:446
bool tls_crypt_file_inline
Definition options.h:668
const char * ifconfig_ipv6_remote
Definition options.h:330
int max_routes_per_client
Definition options.h:535
const char * ncp_ciphers_conf
The original ncp_ciphers specified by the user in the configuration.
Definition options.h:577
int status_file_version
Definition options.h:406
enum vlan_acceptable_frames vlan_accept
Definition options.h:713
int auth_token_renewal
Definition options.h:544
in_addr_t push_ifconfig_constraint_network
Definition options.h:517
const char * tmp_dir
Definition options.h:465
bool push_peer_info
Definition options.h:684
bool daemon
Definition options.h:390
struct options_pre_connect * pre_connect
Definition options.h:561
int route_default_metric
Definition options.h:428
int renegotiate_seconds_min
Definition options.h:648
const char * auth_token_secret_file
Definition options.h:545
unsigned int imported_protocol_flags
Definition options.h:723
const char * tls_export_peer_cert_dir
Definition options.h:613
bool crl_file_inline
Definition options.h:617
const char * cryptoapi_cert
Definition options.h:639
const char * down_script
Definition options.h:385
unsigned int backwards_compatible
What version we should try to be compatible with as major * 10000 + minor * 100 + patch,...
Definition options.h:271
hash_algo_type verify_hash_algo
Definition options.h:623
int scheduled_exit_interval
Definition options.h:563
int stale_routes_ageing_time
Definition options.h:537
bool pkcs12_file_inline
Definition options.h:606
int replay_time
Definition options.h:584
unsigned int push_option_types_found
Definition options.h:557
int management_state_buffer_size
Definition options.h:450
const char * ca_file
Definition options.h:594
const char * tls_auth_file
Definition options.h:663
struct provider_list providers
Definition options.h:581
bool duplicate_cn
Definition options.h:526
struct in6_addr server_network_ipv6
Definition options.h:470
int shaper
Definition options.h:333
int management_echo_buffer_size
Definition options.h:449
in_addr_t server_network
Definition options.h:467
uint32_t real_hash_size
Definition options.h:498
bool show_net_up
Definition options.h:697
bool verify_hash_no_ca
Definition options.h:625
bool allow_pull_fqdn
Definition options.h:438
bool use_peer_id
Definition options.h:703
unsigned remote_cert_ku[MAX_PARMS]
Definition options.h:620
bool server_bridge_defined
Definition options.h:480
const char * keying_material_exporter_label
Definition options.h:707
const char * status_file
Definition options.h:405
unsigned int ssl_flags
Definition options.h:626
bool route_noexec
Definition options.h:429
bool ifconfig_nowarn
Definition options.h:332
const char * remote_cert_eku
Definition options.h:621
in_addr_t ifconfig_pool_netmask
Definition options.h:490
in_addr_t server_netmask
Definition options.h:468
int tls_timeout
Definition options.h:642
bool test_crypto
Definition options.h:586
bool up_delay
Definition options.h:388
bool server_bridge_proxy_dhcp
Definition options.h:478
bool allow_recursive_routing
Definition options.h:720
const char * authname
Definition options.h:579
const char * exit_event_name
Definition options.h:695
const char * ifconfig_ipv6_local
Definition options.h:328
int cf_max
Definition options.h:528
bool dh_file_inline
Definition options.h:598
unsigned int push_update_options_found
Definition options.h:558
int replay_window
Definition options.h:583
bool disable
Definition options.h:506
int mute
Definition options.h:399
bool auth_user_pass_verify_script_via_file
Definition options.h:540
const char * dev_type
Definition options.h:322
int persist_mode
Definition options.h:278
int ifconfig_pool_persist_refresh_freq
Definition options.h:492
bool show_digests
Definition options.h:282
const char * up_script
Definition options.h:384
bool single_session
Definition options.h:682
bool push_ifconfig_defined
Definition options.h:512
bool ifconfig_pool_defined
Definition options.h:487
int verify_hash_depth
Definition options.h:624
bool route_delay_defined
Definition options.h:432
const char * packet_id_file
Definition options.h:585
const char * tls_crypt_v2_file
Definition options.h:672
int management_log_history_cache
Definition options.h:448
in_addr_t server_bridge_netmask
Definition options.h:482
const char * ip_remote_hint
Definition options.h:368
bool vlan_tagging
Definition options.h:712
uint32_t peer_id
Definition options.h:704
struct route_option_list * routes
Definition options.h:433
in_addr_t ifconfig_pool_end
Definition options.h:489
int keepalive_timeout
Definition options.h:342
const char * writepid
Definition options.h:383
int64_t inactivity_minimum_bytes
Definition options.h:345
bool ifconfig_ipv6_pool_defined
Definition options.h:494
unsigned int server_flags
Definition options.h:476
bool block_outside_dns
Definition options.h:699
bool push_ifconfig_ipv6_blocked
Definition options.h:524
bool tls_exit
Definition options.h:686
const char * pkcs12_file
Definition options.h:605
const char * client_disconnect_script
Definition options.h:501
bool show_engines
Definition options.h:283
struct remote_list * remote_list
Definition options.h:296
HANDLE msg_channel
Definition options.h:694
const char * key_pass_file
Definition options.h:280
bool mute_replay_warnings
Definition options.h:582
const char * tls_crypt_file
Definition options.h:667
int inactivity_timeout
Definition options.h:344
int n_bcast_buf
Definition options.h:508
int handshake_window
Definition options.h:652
bool server_defined
Definition options.h:466
const char * ifconfig_local
Definition options.h:326
struct connection_entry ce
Definition options.h:293
struct iroute_ipv6 * iroutes_ipv6
Definition options.h:511
struct push_list push_list
Definition options.h:486
bool user_script_used
Definition options.h:386
const char * tls_groups
Definition options.h:609
bool show_tls_ciphers
Definition options.h:284
struct tuntap_options tuntap_options
Definition options.h:370
int route_method
Definition options.h:698
struct verify_hash_list * verify_hash
Definition options.h:622
const char * tls_cert_profile
Definition options.h:610
int64_t renegotiate_packets
Definition options.h:646
unsigned int management_flags
Definition options.h:458
int push_continuation
Definition options.h:556
const char * route_default_gateway
Definition options.h:425
in_addr_t push_ifconfig_local_alias
Definition options.h:515
struct dns_options dns_options
Definition options.h:317
bool exit_event_initial_state
Definition options.h:696
struct static_challenge_info sc_info
Definition options.h:566
bool auth_token_call_auth
Definition options.h:542
const char * ipchange
Definition options.h:320
int topology
Definition options.h:325
bool disable_dco
Definition options.h:373
const char * ncp_ciphers
Definition options.h:578
bool genkey
Definition options.h:286
uint32_t virtual_hash_size
Definition options.h:499
const char * learn_address_script
Definition options.h:502
const char * ciphername
Definition options.h:573
const char * auth_user_pass_file
Definition options.h:559
int tls_crypt_v2_max_age
Definition options.h:679
bool forward_compatible
Definition options.h:268
const char * username
Definition options.h:376
int cf_initial_max
Definition options.h:531
int stale_routes_check_interval
Definition options.h:536
struct plugin_option_list * plugin_list
Definition options.h:461
int auth_token_lifetime
Definition options.h:543
uint16_t vlan_pvid
Definition options.h:714
int ns_cert_type
Definition options.h:619
const char * tls_crypt_v2_verify_script
Definition options.h:677
int mode
Definition options.h:265
bool tls_server
Definition options.h:592
const char * auth_user_pass_verify_script
Definition options.h:539
int connect_retry_max
Definition options.h:292
char * bind_dev
Definition options.h:417
const char * extra_certs_file
Definition options.h:601
bool client
Definition options.h:554
bool pull
Definition options.h:555
int ifconfig_ipv6_pool_netbits
Definition options.h:496
in_addr_t push_ifconfig_constraint_netmask
Definition options.h:518
bool show_curves
Definition options.h:285
const char * route_ipv6_default_gateway
Definition options.h:426
bool tls_client
Definition options.h:593
bool ping_timer_remote
Definition options.h:351
bool auth_token_generate
Definition options.h:541
bool priv_key_file_inline
Definition options.h:604
const char * tls_verify
Definition options.h:612
const char * crl_file
Definition options.h:616
int ping_rec_timeout_action
Definition options.h:356
bool auth_user_pass_file_inline
Definition options.h:560
bool show_ciphers
Definition options.h:281
bool enable_ncp_fallback
If defined fall back to ciphername if NCP fails.
Definition options.h:574
const char * route_predown_script
Definition options.h:424
const char * dh_file
Definition options.h:597
int route_delay_window
Definition options.h:431
in_addr_t push_ifconfig_local
Definition options.h:513
bool mlock
Definition options.h:339
const char ** ignore_unknown_option
Definition options.h:274
int sndbuf
Definition options.h:413
int foreign_option_index
Definition options.h:691
struct gc_arena gc
Definition options.h:256
bool gc_owned
Definition options.h:257
bool down_pre
Definition options.h:387
bool persist_tun
Definition options.h:358
int route_default_table_id
Definition options.h:427
bool ca_file_inline
Definition options.h:595
bool auth_token_secret_file_inline
Definition options.h:546
bool block_ipv6
Definition options.h:435
const char * config
Definition options.h:260
bool extra_certs_file_inline
Definition options.h:602
bool push_ifconfig_constraint_defined
Definition options.h:516
int mark
Definition options.h:416
int cf_initial_per
Definition options.h:532
int keying_material_exporter_length
Definition options.h:708
bool suppress_timestamps
Definition options.h:395
bool force_key_material_export
Definition options.h:710
bool mtu_test
Definition options.h:337
struct iroute * iroutes
Definition options.h:510
int verify_x509_type
Definition options.h:614
const char * cipher_list_tls13
Definition options.h:608
const char * ecdh_curve
Definition options.h:611
int status_file_update_freq
Definition options.h:407
const char * management_client_user
Definition options.h:452
const char * cipher_list
Definition options.h:607
bool ccd_exclusive
Definition options.h:505
bool allow_deprecated_insecure_static_crypto
Definition options.h:571
struct pull_filter_list * pull_filter_list
Definition options.h:716
const char * management_certificate
Definition options.h:455
const char * genkey_filename
Definition options.h:288
const struct x509_track * x509_track
Definition options.h:688
const char * chroot_dir
Definition options.h:378
bool log
Definition options.h:394
bool shared_secret_file_inline
Definition options.h:570
struct in6_addr push_ifconfig_ipv6_remote
Definition options.h:523
const char * ca_path
Definition options.h:596
int renegotiate_seconds
Definition options.h:647
int ping_rec_timeout
Definition options.h:350
unsigned int sockflags
Definition options.h:420
const char * engine
Definition options.h:580
const char * management_addr
Definition options.h:445
const char * client_connect_script
Definition options.h:500
const char * verify_x509_name
Definition options.h:615
int ping_send_timeout
Definition options.h:349
bool route_gateway_via_dhcp
Definition options.h:437
bool remote_random
Definition options.h:319
bool push_ifconfig_ipv6_defined
Definition options.h:520
int tcp_queue_limit
Definition options.h:509
int route_delay
Definition options.h:430
const char * dev_node
Definition options.h:323
const char * override_username
Definition options.h:507
const char * client_crresponse_script
Definition options.h:503
struct route_ipv6_option_list * routes_ipv6
Definition options.h:434
bool machine_readable_output
Definition options.h:396
int key_direction
Definition options.h:572
bool server_ipv6_defined
Definition options.h:469
const char * priv_key_file
Definition options.h:603
bool persist_remote_ip
Definition options.h:360
bool up_restart
Definition options.h:389
int keepalive_ping
Definition options.h:341
bool tls_auth_file_inline
Definition options.h:664
bool tls_crypt_v2_file_inline
Definition options.h:673
const char * groupname
Definition options.h:377
in_addr_t server_bridge_pool_start
Definition options.h:483
const char * cd_dir
Definition options.h:379
struct client_nat_option_list * client_nat
Definition options.h:439
struct in6_addr push_ifconfig_ipv6_local
Definition options.h:521
int nice
Definition options.h:397
int max_clients
Definition options.h:534
int transition_window
Definition options.h:660
const char * ifconfig_remote_netmask
Definition options.h:327
const char * lladdr
Definition options.h:324
int verbosity
Definition options.h:398
int session_timeout
Definition options.h:347
const char * cert_file
Definition options.h:599
bool enable_c2c
Definition options.h:525
in_addr_t server_bridge_pool_end
Definition options.h:484
int cf_per
Definition options.h:529
enum tun_driver_type windows_driver
Definition options.h:700
bool cert_file_inline
Definition options.h:600
int remap_sigusr1
Definition options.h:392
int64_t renegotiate_bytes
Definition options.h:645
const char * route_script
Definition options.h:423
in_addr_t ifconfig_pool_start
Definition options.h:488
const char * management_user_pass
Definition options.h:447
unsigned int server_netbits_ipv6
Definition options.h:471
in_addr_t push_ifconfig_remote_netmask
Definition options.h:514
bool occ
Definition options.h:442
in_addr_t server_bridge_ip
Definition options.h:481
const char * shared_secret_file
Definition options.h:569
bool ifconfig_noexec
Definition options.h:331
const char * dev
Definition options.h:321
const char * management_client_group
Definition options.h:453
struct in6_addr ifconfig_ipv6_pool_base
Definition options.h:495
const char * client_config_dir
Definition options.h:504
enum genkey_type genkey_type
Definition options.h:287
const char * ifconfig_pool_persist_filename
Definition options.h:491
int ifconfig_ipv6_netbits
Definition options.h:329
bool persist_local_ip
Definition options.h:359
const char * names[MAX_PARMS]
Definition options.h:217
struct pull_filter * tail
Definition options.h:812
struct pull_filter * head
Definition options.h:811
struct pull_filter * next
Definition options.h:806
char * pattern
Definition options.h:805
size_t size
Definition options.h:804
Definition pushlist.h:29
struct push_entry * next
Definition pushlist.h:30
bool enable
Definition pushlist.h:31
const char * option
Definition pushlist.h:32
struct push_entry * head
Definition pushlist.h:37
Definition options.h:183
int proto
Definition options.h:186
const char * remote
Definition options.h:184
const char * remote_port
Definition options.h:185
sa_family_t af
Definition options.h:187
struct remote_entry ** array
Definition options.h:211
int capacity
Definition options.h:209
unsigned int flags
Definition route.h:113
unsigned int flags
Definition route.h:97
unsigned int flags
Definition misc.h:93
const char * challenge_text
Definition misc.h:95
int wins_len
Definition tun.h:118
struct in6_addr dns6[N_DHCP_ADDR]
Definition tun.h:142
in_addr_t nbdd[N_DHCP_ADDR]
Definition tun.h:125
int dns_len
Definition tun.h:114
int dns6_len
Definition tun.h:143
in_addr_t ntp[N_DHCP_ADDR]
Definition tun.h:121
int ntp_len
Definition tun.h:122
in_addr_t wins[N_DHCP_ADDR]
Definition tun.h:117
int tap_sleep
Definition tun.h:97
uint8_t netbios_node_type
Definition tun.h:107
int dhcp_lease_time
Definition tun.h:94
in_addr_t dns[N_DHCP_ADDR]
Definition tun.h:113
const char * netbios_scope
Definition tun.h:105
int nbdd_len
Definition tun.h:126
bool ip_win32_defined
Definition tun.h:77
bool dhcp_masq_custom_offset
Definition tun.h:92
const char * domain
Definition tun.h:103
int domain_search_list_len
Definition tun.h:132
bool dhcp_renew
Definition tun.h:137
const char * domain_search_list[N_SEARCH_LIST_LEN]
Definition tun.h:131
int dhcp_masq_offset
Definition tun.h:93
int ip_win32_type
Definition tun.h:85
bool dhcp_pre_release
Definition tun.h:138
bool register_dns
Definition tun.h:140
bool disable_nbt
Definition tun.h:135
int dhcp_options
Definition tun.h:101
Definition tun.h:183
struct verify_hash_list * next
Definition options.h:250
uint8_t hash[SHA256_DIGEST_LENGTH]
Definition options.h:249
#define SIGHUP
Definition syshead.h:55
unsigned short sa_family_t
Definition syshead.h:409
#define SIGTERM
Definition syshead.h:59
#define sleep(x)
Definition syshead.h:42
uint32_t in_addr_t
Definition syshead.h:52
struct env_set * es
static bool pkcs11_id_management
struct gc_arena gc
Definition test_ssl.c:131
void ipconfig_register_dns(const struct env_set *es)
Definition tun.c:4872
int dev_type_enum(const char *dev, const char *dev_type)
Definition tun.c:521
void show_tap_win_adapters(msglvl_t msglevel, msglvl_t warnlevel)
Definition tun.c:3798
bool dhcp_renew_by_adapter_index(const DWORD adapter_index)
Definition tun.c:4805
int ascii2ipset(const char *name)
Definition tun.c:6233
struct tuntap * init_tun(const char *dev, const char *dev_type, int topology, const char *ifconfig_local_parm, const char *ifconfig_remote_netmask_parm, const char *ifconfig_ipv6_local_parm, int ifconfig_ipv6_netbits_parm, const char *ifconfig_ipv6_remote_parm, struct addrinfo *local_public, struct addrinfo *remote_public, const bool strict_warn, struct env_set *es, openvpn_net_ctx_t *ctx, struct tuntap *tt)
Definition tun.c:830
bool dhcp_release_by_adapter_index(const DWORD adapter_index)
Definition tun.c:4764
const char * dev_type_string(const char *dev, const char *dev_type)
Definition tun.c:540
void tap_allow_nonadmin_access(const char *dev_node)
Definition tun.c:4684
void show_adapters(msglvl_t msglevel)
Definition tun.c:4635
static bool dhcp_renew(const struct tuntap *tt)
Definition tun.c:4831
const char * ifconfig_options_string(const struct tuntap *tt, bool remote, bool disable, struct gc_arena *gc)
Definition tun.c:694
const char * ipset2ascii_all(struct gc_arena *gc)
Definition tun.c:6262
void show_valid_win32_tun_subnets(void)
Definition tun.c:3765
const char * print_tun_backend_driver(enum tun_driver_type driver)
Return a string representation of the tun backed driver type.
Definition tun.c:59
#define IPW32_SET_NETSH
Definition tun.h:80
#define IPW32_SET_ADAPTIVE
Definition tun.h:83
#define DHCP_OPTIONS_DHCP_REQUIRED
Definition tun.h:72
#define N_SEARCH_LIST_LEN
Definition tun.h:128
#define IPW32_SET_DHCP_MASQ
Definition tun.h:82
#define IPW32_SET_MANUAL
Definition tun.h:79
@ WINDOWS_DRIVER_UNSPECIFIED
Definition tun.h:45
@ WINDOWS_DRIVER_TAP_WINDOWS6
Definition tun.h:46
@ DRIVER_DCO
Definition tun.h:53
#define IPW32_SET_ADAPTIVE_DELAY_WINDOW
Definition tun.h:67
#define N_DHCP_ADDR
Definition tun.h:110
#define DHCP_OPTIONS_DHCP_OPTIONAL
Definition tun.h:71
static bool is_tun_afunix(const char *devnode)
Checks whether a –dev-node parameter specifies a AF_UNIX device.
Definition tun_afunix.h:61
const char * win_get_tempdir(void)
Definition win32-util.c:150
void set_win_sys_path(const char *newpath, struct env_set *es)
Definition win32.c:1116
const char * win32_version_string(struct gc_arena *gc)
Get Windows version string with architecture info.
Definition win32.c:1381
void set_pause_exit_win32(void)
Definition win32.c:144