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