32#ifdef HAVE_CONFIG_VERSION_H
33#include "config-version.h"
72#ifdef CONFIGURE_GIT_REVISION
73 " [git:" CONFIGURE_GIT_REVISION CONFIGURE_GIT_FLAGS
"]"
76#if defined(ENABLE_CRYPTO_MBEDTLS)
78#elif defined(ENABLE_CRYPTO_OPENSSL)
90#ifdef ENABLE_COMP_STUB
97#ifdef PRODUCT_TAP_DEBUG
104#if defined(HAVE_IN_PKTINFO) && defined(HAVE_IPI_SPEC_DST)
106#elif defined(IP_RECVDSTADDR)
114#ifdef CONFIGURE_GIT_REVISION
115 " built on " __DATE__
125 "--config file : Read configuration options from file.\n"
126 "--help : Show options.\n"
127 "--version : Show copyright and version information.\n"
130 "--local host|* [port]: Local host name or IP address and port for bind.\n"
131 " If specified, OpenVPN will bindto this address. If unspecified,\n"
132 " OpenVPN will bind to all interfaces. '*' can be used as hostname\n"
133 " and means 'any host' (OpenVPN will listen on what is returned by the OS).\n"
134 " On a client, or in point-to-point mode, this can only be specified once (1 socket).\n"
135 " On an OpenVPN setup running as ``--server``, this can be specified multiple times\n"
136 " to open multiple listening sockets on different addresses and/or different ports.\n"
137 " In order to specify multiple listen ports without specifying an address, use '*'\n"
138 " to signal 'use what the operating system gives you as default', for\n"
139 " 'all IPv4 addresses' use '0.0.0.0', for 'all IPv6 addresses' use '::'.\n"
140 " ``--local`` implies ``--bind``.\n"
141 "--remote host [port] : Remote host name or ip address.\n"
142 "--remote-random : If multiple --remote options specified, choose one randomly.\n"
143 "--remote-random-hostname : Add a random string to remote DNS name.\n"
144 "--mode m : Major mode, m = 'p2p' (default, point-to-point) or 'server'.\n"
145 "--proto p : Use protocol p for communicating with peer.\n"
146 " p = udp (default), tcp-server, tcp-client\n"
147 " udp4, tcp4-server, tcp4-client\n"
148 " udp6, tcp6-server, tcp6-client\n"
149 "--proto-force p : only consider protocol p in list of connection profiles.\n"
151 "--connect-retry n [m] : For client, number of seconds to wait between\n"
152 " connection retries (default=%d). On repeated retries\n"
153 " the wait time is exponentially increased to a maximum of m\n"
155 "--connect-retry-max n : Maximum connection attempt retries, default infinite.\n"
156 "--http-proxy s p [up] [auth] : Connect to remote host\n"
157 " through an HTTP proxy at address s and port p.\n"
158 " If proxy authentication is required,\n"
159 " up is a file containing username/password on 2 lines, or\n"
160 " 'stdin' to prompt from console. Add auth='ntlm2' if\n"
161 " the proxy requires NTLM authentication.\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"
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"
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"
203 "--iproute cmd : Use this command instead of default " IPROUTE_PATH
".\n"
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"
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"
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"
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"
284 "--ping n : Ping remote once every n seconds over TCP/UDP port.\n"
286 "--multihome : Configure a multi-homed UDP server.\n"
288 "--fast-io : Optimize TUN/TAP/UDP writes.\n"
289 "--remap-usr1 s : On SIGUSR1 signals, remap signal (s='SIGHUP' or 'SIGTERM').\n"
290 "--persist-tun : Keep tun/tap device open across SIGUSR1 or --ping-restart.\n"
291 "--persist-remote-ip : Keep remote IP address across SIGUSR1 or --ping-restart.\n"
292 "--persist-local-ip : Keep local IP address across SIGUSR1 or --ping-restart.\n"
293#if PASSTOS_CAPABILITY
294 "--passtos : TOS passthrough (applies to IPv4 only).\n"
296 "--tun-mtu n : Take the tun/tap device MTU to be n and derive the\n"
297 " TCP/UDP MTU from it (default=%d).\n"
298 "--tun-mtu-extra n : Assume that tun/tap device might return as many\n"
299 " as n bytes more than the tun-mtu size on read\n"
300 " (default TUN=0 TAP=%d).\n"
301 "--tun-mtu-max n : Maximum pushable MTU (default and minimum=%d).\n"
302 "--link-mtu n : Take the TCP/UDP device MTU to be n and derive the tun MTU\n"
304 "--mtu-disc type : Should we do Path MTU discovery on TCP/UDP channel?\n"
305 " 'no' -- Never send DF (Don't Fragment) frames\n"
306 " 'maybe' -- Use per-route hints\n"
307 " 'yes' -- Always DF (Don't Fragment)\n"
308 "--mtu-test : Empirically measure and report MTU.\n"
309#ifdef ENABLE_FRAGMENT
310 "--fragment max : Enable internal datagram fragmentation so that no UDP\n"
311 " datagrams are sent which are larger than max bytes.\n"
312 " Adds 4 bytes of overhead per datagram.\n"
314 "--mssfix [n] : Set upper bound on TCP MSS, default = tun-mtu size\n"
315 " or --fragment max value, whichever is lower.\n"
316 "--sndbuf size : Set the TCP/UDP send buffer size.\n"
317 "--rcvbuf size : Set the TCP/UDP receive buffer size.\n"
318#if defined(TARGET_LINUX)
319 "--mark value : Mark encrypted packets being sent with value. The mark value\n"
320 " can be matched in policy routing and packetfilter rules.\n"
321 "--bind-dev dev : Bind to the given device when making connection to a peer or\n"
322 " listening for connections. This allows sending encrypted packets\n"
323 " via a VRF present on the system.\n"
325 "--txqueuelen n : Set the tun/tap TX queue length to n (Linux only).\n"
326 "--mlock : Disable Paging -- ensures key material and tunnel\n"
327 " data will never be written to disk.\n"
328 "--up cmd : Run command cmd after successful tun device open.\n"
329 " Execute as: cmd tun/tap-dev tun-mtu link-mtu \\\n"
330 " ifconfig-local-ip ifconfig-remote-ip\n"
331 " (pre --user or --group UID/GID change)\n"
332 "--up-delay : Delay tun/tap open and possible --up script execution\n"
333 " until after TCP/UDP connection establishment with peer.\n"
334 "--down cmd : Run command cmd after tun device close.\n"
335 " (post --user/--group UID/GID change and/or --chroot)\n"
336 " (command parameters are same as --up option)\n"
337 "--down-pre : Run --down command before TUN/TAP close.\n"
338 "--up-restart : Run up/down commands for all restarts including those\n"
339 " caused by --ping-restart or SIGUSR1\n"
340 "--user user : Set UID to user after initialization.\n"
341 "--group group : Set GID to group after initialization.\n"
342 "--chroot dir : Chroot to this directory after initialization.\n"
344 "--setcon context: Apply this SELinux context after initialization.\n"
346 "--cd dir : Change to this directory before initialization.\n"
347 "--daemon [name] : Become a daemon after initialization.\n"
348 " The optional 'name' parameter will be passed\n"
349 " as the program name to the system logger.\n"
350 "--syslog [name] : Output to syslog, but do not become a daemon.\n"
351 " See --daemon above for a description of the 'name' parm.\n"
352 "--log file : Output log to file which is created/truncated on open.\n"
353 "--log-append file : Append log to file, or create file if nonexistent.\n"
354 "--suppress-timestamps : Don't log timestamps to stdout/stderr.\n"
355 "--machine-readable-output : Always log timestamp, message flags to stdout/stderr.\n"
356 "--writepid file : Write main process ID to file.\n"
357 "--nice n : Change process priority (>0 = lower, <0 = higher).\n"
358 "--echo [parms ...] : Echo parameters to log output.\n"
359 "--verb n : Set output verbosity to n (default=%d):\n"
360 " (Level 3 is recommended if you want a good summary\n"
361 " of what's happening without being swamped by output).\n"
362 " : 0 -- no output except fatal errors\n"
363 " : 1 -- startup info + connection initiated messages +\n"
364 " non-fatal encryption & net errors\n"
365 " : 2,3 -- show TLS negotiations & route info\n"
366 " : 4 -- show parameters\n"
367 " : 5 -- show 'RrWw' chars on console for each packet sent\n"
368 " and received from TCP/UDP (caps) or tun/tap (lc)\n"
369 " : 6 to 11 -- debug messages of increasing verbosity\n"
370 "--mute n : Log at most n consecutive messages in the same category.\n"
371 "--status file [n] : Write operational status to file every n seconds.\n"
372 "--status-version [n] : Choose the status file format version number.\n"
373 " Currently, n can be 1, 2, or 3 (default=1).\n"
374 "--disable-occ : (DEPRECATED) Disable options consistency check between peers.\n"
376 "--gremlin mask : Special stress testing mode (for debugging only).\n"
379 "--compress alg : Use compression algorithm alg\n"
380 "--allow-compression: Specify whether compression should be allowed\n"
381#if defined(ENABLE_LZO)
382 "--comp-lzo : Use LZO compression -- may add up to 1 byte per\n"
383 " packet for incompressible data.\n"
384 "--comp-noadapt : Don't use adaptive compression when --comp-lzo\n"
388#ifdef ENABLE_MANAGEMENT
389 "--management ip port [pass] : Enable a TCP server on ip:port to handle\n"
390 " management functions. pass is a password file\n"
391 " or 'stdin' to prompt from console.\n"
393 " To listen on a unix domain socket, specific the pathname\n"
394 " in place of ip and use 'unix' as the port number.\n"
396 "--management-client : Management interface will connect as a TCP client to\n"
397 " ip/port rather than listen as a TCP server.\n"
398 "--management-query-passwords : Query management channel for private key\n"
399 " and auth-user-pass passwords.\n"
400 "--management-query-proxy : Query management channel for proxy information.\n"
401 "--management-query-remote : Query management channel for --remote directive.\n"
402 "--management-hold : Start " PACKAGE_NAME
" in a hibernating state, until a client\n"
403 " of the management interface explicitly starts it.\n"
404 "--management-signal : Issue SIGUSR1 when management disconnect event occurs.\n"
405 "--management-forget-disconnect : Forget passwords when management disconnect\n"
407 "--management-up-down : Report tunnel up/down events to management interface.\n"
408 "--management-log-cache n : Cache n lines of log file history for usage\n"
409 " by the management channel.\n"
411 "--management-client-user u : When management interface is a unix socket, only\n"
412 " allow connections from user u.\n"
413 "--management-client-group g : When management interface is a unix socket, only\n"
414 " allow connections from group g.\n"
416 "--management-client-auth : gives management interface client the responsibility\n"
417 " to authenticate clients after their client certificate\n"
418 " has been verified.\n"
421 "--plugin m [str]: Load plug-in module m passing str as an argument\n"
422 " to its initialization function.\n"
424 "--vlan-tagging : Enable 802.1Q-based VLAN tagging.\n"
425 "--vlan-accept tagged|untagged|all : Set VLAN tagging mode. Default is 'all'.\n"
426 "--vlan-pvid v : Sets the Port VLAN Identifier. Defaults to 1.\n"
428 "Multi-Client Server options (when --mode server is used):\n"
429 "--server network netmask : Helper option to easily configure server mode.\n"
430 "--server-ipv6 network/bits : Configure IPv6 server mode.\n"
431 "--server-bridge [IP netmask pool-start-IP pool-end-IP] : Helper option to\n"
432 " easily configure ethernet bridging server mode.\n"
433 "--push \"option\" : Push a config file option back to the peer for remote\n"
434 " execution. Peer must specify --pull in its config file.\n"
435 "--push-reset : Don't inherit global push list for specific\n"
436 " client instance.\n"
437 "--push-remove opt : Remove options matching 'opt' from the push list for\n"
438 " a specific client instance.\n"
439 "--ifconfig-pool start-IP end-IP [netmask] : Set aside a pool of subnets\n"
440 " to be dynamically allocated to connecting clients.\n"
441 "--ifconfig-pool-persist file [seconds] : Persist/unpersist ifconfig-pool\n"
442 " data to file, at seconds intervals (default=600).\n"
443 " If seconds=0, file will be treated as read-only.\n"
444 "--ifconfig-ipv6-pool base-IP/bits : set aside an IPv6 network block\n"
445 " to be dynamically allocated to connecting clients.\n"
446 "--ifconfig-push local remote-netmask : Push an ifconfig option to remote,\n"
447 " overrides --ifconfig-pool dynamic allocation.\n"
448 " Only valid in a client-specific config file.\n"
449 "--ifconfig-ipv6-push local/bits remote : Push an ifconfig-ipv6 option to\n"
450 " remote, overrides --ifconfig-ipv6-pool allocation.\n"
451 " Only valid in a client-specific config file.\n"
452 "--iroute network [netmask] : Route subnet to client.\n"
453 "--iroute-ipv6 network/bits : Route IPv6 subnet to client.\n"
454 " Sets up internal routes only.\n"
455 " Only valid in a client-specific config file.\n"
456 "--disable : Client is disabled.\n"
457 " Only valid in a client-specific config file.\n"
458 "--override-username: Overrides the client-specific username to be used.\n"
459 " Only valid in a client-specific config file.\n"
460 "--verify-client-cert [none|optional|require] : perform no, optional or\n"
461 " mandatory client certificate verification.\n"
462 " Default is to require the client to supply a certificate.\n"
463 "--username-as-common-name : For auth-user-pass authentication, use\n"
464 " the authenticated username as the common name,\n"
465 " rather than the common name from the client cert.\n"
466 "--auth-user-pass-verify cmd method: Query client for username/password and\n"
467 " run command cmd to verify. If method='via-env', pass\n"
468 " user/pass via environment, if method='via-file', pass\n"
469 " user/pass via temporary file.\n"
470 "--auth-gen-token [lifetime] Generate a random authentication token which is pushed\n"
471 " to each client, replacing the password. Useful when\n"
472 " OTP based two-factor auth mechanisms are in use and\n"
473 " --reneg-* options are enabled. Optionally a lifetime in seconds\n"
474 " for generated tokens can be set.\n"
475 "--auth-user-pass-optional : Allow connections by clients that don't\n"
476 " specify a username/password.\n"
477 "--client-to-client : Internally route client-to-client traffic.\n"
478 "--duplicate-cn : Allow multiple clients with the same common name to\n"
479 " concurrently connect.\n"
480 "--client-connect cmd : Run command cmd on client connection.\n"
481 "--client-disconnect cmd : Run command cmd on client disconnection.\n"
482 "--client-config-dir dir : Directory for custom client config files.\n"
483 "--ccd-exclusive : Refuse connection unless custom client config is found.\n"
484 "--tmp-dir dir : Temporary directory, used for --client-connect return file and plugin communication.\n"
485 "--hash-size r v : Set the size of the real address hash table to r and the\n"
486 " virtual address table to v.\n"
487 "--bcast-buffers n : Allocate n broadcast buffers.\n"
488 "--tcp-queue-limit n : Maximum number of queued TCP output packets.\n"
489 "--tcp-nodelay : Macro that sets TCP_NODELAY socket flag on the server\n"
490 " as well as pushes it to connecting clients.\n"
491 "--learn-address cmd : Run command cmd to validate client virtual addresses.\n"
492 "--connect-freq n s : Allow a maximum of n new connections per s seconds.\n"
493 "--connect-freq-initial n s : Allow a maximum of n replies for initial connections attempts per s seconds.\n"
494 "--max-clients n : Allow a maximum of n simultaneously connected clients.\n"
495 "--max-routes-per-client n : Allow a maximum of n internal routes per client.\n"
496 "--stale-routes-check n [t] : Remove routes with a last activity timestamp\n"
497 " older than n seconds. Run this check every t\n"
498 " seconds (defaults to n).\n"
499 "--explicit-exit-notify [n] : In UDP server mode send [RESTART] command on exit/restart to connected\n"
500 " clients. n = 1 - reconnect to same server,\n"
501 " 2 - advance to next server, default=1.\n"
503 "--port-share host port [dir] : When run in TCP mode, proxy incoming HTTPS\n"
504 " sessions to a web server at host:port. dir specifies an\n"
505 " optional directory to write origin IP:port data.\n"
508 "Client options (when connecting to a multi-client server):\n"
509 "--client : Helper option to easily configure client mode.\n"
510 "--auth-user-pass [up] : Authenticate with server using username/password.\n"
511 " up is a file containing the username on the first line,\n"
512 " and a password on the second. If either the password or both\n"
513 " the username and the password are omitted OpenVPN will prompt\n"
514 " for them from console.\n"
515 "--pull : Accept certain config file options from the peer as if they\n"
516 " were part of the local config file. Must be specified\n"
517 " when connecting to a '--mode server' remote host.\n"
518 "--pull-filter accept|ignore|reject t : Filter each option received from the\n"
519 " server if it starts with the text t. The action flag accept,\n"
520 " ignore or reject causes the option to be allowed, removed or\n"
521 " rejected with error. May be specified multiple times, and\n"
522 " each filter is applied in the order of appearance.\n"
523 "--dns server <n> <option> <value> [value ...] : Configure option for DNS server #n\n"
524 " Valid options are :\n"
525 " address <addr[:port]> [addr[:port] ...] : server addresses 4/6\n"
526 " resolve-domains <domain> [domain ...] : split domains\n"
527 " dnssec <yes|no|optional> : option to use DNSSEC\n"
528 " transport <DoH|DoT> : query server over HTTPS / TLS\n"
529 " sni <domain> : DNS server name indication\n"
530 "--dns search-domains <domain> [domain ...]:\n"
531 " Add domains to DNS domain search list\n"
532 "--dns-updown cmd|force|disable : Run cmd as user defined dns config command,\n"
533 " force running the default script or disable running it.\n"
534 "--auth-retry t : How to handle auth failures. Set t to\n"
535 " none (default), interact, or nointeract.\n"
536 "--static-challenge t e [<scrv1|concat>]: Enable static challenge/response protocol using\n"
537 " challenge text t, with e indicating echo flag (0|1)\n"
538 " and optional argument scrv1 or concat to use SCRV1 protocol or"
539 " concatenate response with password. Default is scrv1.\n"
540 "--connect-timeout n : when polling possible remote servers to connect to\n"
541 " in a round-robin fashion, spend no more than n seconds\n"
542 " waiting for a response before trying the next server.\n"
543 "--allow-recursive-routing : When this option is set, OpenVPN will not drop\n"
544 " incoming tun packets with same destination as host.\n"
545 "--explicit-exit-notify [n] : On exit/restart, send exit signal to\n"
546 " server/remote. n = # of retries, default=1.\n"
548 "Data Channel Encryption Options (must be compatible between peers):\n"
549 "(These options are meaningful for both Static Key & TLS-mode)\n"
550 "--auth alg : Authenticate packets with HMAC using message\n"
551 " digest algorithm alg (default=%s).\n"
552 " (usually adds 16 or 20 bytes per packet)\n"
553 " Set alg=none to disable authentication.\n"
554 "--cipher alg : Encrypt packets with cipher algorithm alg.\n"
555 " You should usually use --data-ciphers instead.\n"
556 " Set alg=none to disable encryption.\n"
557 "--data-ciphers list : List of ciphers that are allowed to be negotiated.\n"
558#ifndef ENABLE_CRYPTO_MBEDTLS
559 "--engine [name] : Enable OpenSSL hardware crypto engine functionality.\n"
561 "--mute-replay-warnings : Silence the output of replay warnings to log file.\n"
562 "--replay-window n [t] : Use a replay protection sliding window of size n\n"
563 " and a time window of t seconds.\n"
564 " Default n=%d t=%d\n"
565 "--replay-persist file : Persist replay-protection state across sessions\n"
567 "--test-crypto : Run a self-test of crypto features enabled.\n"
568 " For debugging only.\n"
569#ifdef ENABLE_PREDICTION_RESISTANCE
570 "--use-prediction-resistance: Enable prediction resistance on the random\n"
571 " number generator.\n"
574 "TLS Key Negotiation Options:\n"
575 "(These options are meaningful only for TLS-mode)\n"
576 "--tls-server : Enable TLS and assume server role during TLS handshake.\n"
577 "--tls-client : Enable TLS and assume client role during TLS handshake.\n"
578 "--ca file : Certificate authority file in .pem format containing\n"
579 " root certificate.\n"
580#ifndef ENABLE_CRYPTO_MBEDTLS
581 "--capath dir : A directory of trusted certificates (CAs"
584 "--dh file : File containing Diffie Hellman parameters\n"
585 " in .pem format (for --tls-server only).\n"
586 " Use \"openssl dhparam -out dh1024.pem 1024\" to generate.\n"
587 "--cert file : Local certificate in .pem format or a URI -- must be signed\n"
588 " by a Certificate Authority in --ca file used by the peer.\n"
589 "--extra-certs file : one or more PEM certs that complete the cert chain.\n"
590 "--key file : Local private key in .pem format or a URI.\n"
591 "--tls-version-min <version> ['or-highest'] : sets the minimum TLS version we\n"
592 " will accept from the peer. If version is unrecognized and 'or-highest'\n"
593 " is specified, require max TLS version supported by SSL implementation.\n"
594 "--tls-version-max <version> : sets the maximum TLS version we will use.\n"
595#ifndef ENABLE_CRYPTO_MBEDTLS
596 "--pkcs12 file : PKCS#12 file containing local private key, local certificate\n"
597 " and optionally the root CA certificate.\n"
599#ifdef ENABLE_X509ALTUSERNAME
600 "--x509-username-field : Field in x509 certificate containing the username.\n"
601 " Default is CN in the Subject field.\n"
603 "--verify-hash hash [algo] : Specify fingerprint for level-1 certificate.\n"
604 " Valid algo flags are SHA1 and SHA256. \n"
606 "--cryptoapicert select-string : Load the certificate and private key from the\n"
607 " Windows Certificate System Store.\n"
609 "--tls-cipher l : A list l of allowable TLS ciphers separated by : (optional).\n"
610 "--tls-ciphersuites l: A list of allowed TLS 1.3 cipher suites separated by : (optional)\n"
611 " : Use --show-tls to see a list of supported TLS ciphers (suites).\n"
612 "--tls-cert-profile p : Set the allowed certificate crypto algorithm profile\n"
613 " (default=legacy).\n"
614 "--providers l : A list l of OpenSSL providers to load.\n"
615 "--tls-timeout n : Packet retransmit timeout on TLS control channel\n"
616 " if no ACK from remote within n seconds (default=%d).\n"
617 "--reneg-bytes n : Renegotiate data chan. key after n bytes sent and recvd.\n"
618 "--reneg-pkts n : Renegotiate data chan. key after n packets sent and recvd.\n"
619 "--reneg-sec max [min] : Renegotiate data chan. key after at most max (default=%d)\n"
620 " and at least min (defaults to 90%% of max on servers and equal\n"
621 " to max on clients).\n"
622 "--hand-window n : Data channel key exchange must finalize within n seconds\n"
623 " of handshake initiation by any peer (default=%d).\n"
624 "--tran-window n : Transition window -- old key can live this many seconds\n"
625 " after new key renegotiation begins (default=%d).\n"
626 "--single-session: Allow only one session (reset state on restart).\n"
627 "--tls-exit : Exit on TLS negotiation failure.\n"
628 "--tls-auth f [d]: Add an additional layer of authentication on top of the TLS\n"
629 " control channel to protect against attacks on the TLS stack\n"
630 " and DoS attacks.\n"
631 " f (required) is a shared-secret key file.\n"
632 " The optional d parameter controls key directionality.\n"
633 "--tls-crypt key : Add an additional layer of authenticated encryption on top\n"
634 " of the TLS control channel to hide the TLS certificate,\n"
635 " provide basic post-quantum security and protect against\n"
636 " attacks on the TLS stack and DoS attacks.\n"
637 " key (required) provides the pre-shared key file.\n"
638 "--tls-crypt-v2 key : For clients: use key as a client-specific tls-crypt key.\n"
639 " For servers: use key to decrypt client-specific keys. For\n"
640 " key generation (--genkey tls-crypt-v2-client): use key to\n"
641 " encrypt generated client-specific key. (See --tls-crypt.)\n"
642 "--genkey tls-crypt-v2-client [keyfile] [base64 metadata]: Generate a\n"
643 " fresh tls-crypt-v2 client key, and store to\n"
644 " keyfile. If supplied, include metadata in wrapped key.\n"
645 "--genkey tls-crypt-v2-server [keyfile] [base64 metadata]: Generate a\n"
646 " fresh tls-crypt-v2 server key, and store to keyfile\n"
647 "--tls-crypt-v2-verify cmd : Run command cmd to verify the metadata of the\n"
648 " client-supplied tls-crypt-v2 client key\n"
649 "--tls-crypt-v2-max-age n : Only accept tls-crypt-v2 client keys that have a\n"
650 " timestamp which is at most n days old.\n"
651 "--askpass [file]: Get PEM password from controlling tty before we daemonize.\n"
652 "--auth-nocache : Don't cache --askpass or --auth-user-pass passwords.\n"
653 "--crl-verify crl ['dir']: Check peer certificate against a CRL.\n"
654 "--tls-verify cmd: Run command cmd to verify the X509 name of a\n"
655 " pending TLS connection that has otherwise passed all other\n"
656 " tests of certification. cmd should return 0 to allow\n"
657 " TLS handshake to proceed, or 1 to fail. (cmd is\n"
658 " executed as 'cmd certificate_depth subject')\n"
659 "--verify-x509-name name: Accept connections only from a host with X509 subject\n"
660 " DN name. The remote host must also pass all other tests\n"
661 " of verification.\n"
662#ifndef ENABLE_CRYPTO_MBEDTLS
663 "--ns-cert-type t: (DEPRECATED) Require that peer certificate was signed with \n"
664 " an explicit nsCertType designation t = 'client' | 'server'.\n"
666 "--x509-track x : Save peer X509 attribute x in environment for use by\n"
667 " plugins and management interface.\n"
668 "--keying-material-exporter label len : Save Exported Keying Material (RFC5705)\n"
669 " of len bytes (min. 16 bytes) using label in environment for use by plugins.\n"
670 "--remote-cert-ku v ... : Require that the peer certificate was signed with\n"
671 " explicit key usage, you can specify more than one value.\n"
672 " value should be given in hex format.\n"
673 "--remote-cert-eku oid : Require that the peer certificate was signed with\n"
674 " explicit extended key usage. Extended key usage can be encoded\n"
675 " as an object identifier or OpenSSL string representation.\n"
676 "--remote-cert-tls t: Require that peer certificate was signed with explicit\n"
677 " key usage and extended key usage based on RFC3280 TLS rules.\n"
678 " t = 'client' | 'server'.\n"
682 "--pkcs11-providers provider ... : PKCS#11 provider to load.\n"
683 "--pkcs11-protected-authentication [0|1] ... : Use PKCS#11 protected authentication\n"
684 " path. Set for each provider.\n"
685 "--pkcs11-private-mode hex ... : PKCS#11 private key mode mask.\n"
686 " 0 : Try to determine automatically (default).\n"
688 " 2 : Use SignRecover.\n"
689 " 4 : Use Decrypt.\n"
691 "--pkcs11-cert-private [0|1] ... : Set if login should be performed before\n"
692 " certificate can be accessed. Set for each provider.\n"
693 "--pkcs11-pin-cache seconds : Number of seconds to cache PIN. The default is -1\n"
694 " cache until token is removed.\n"
695 "--pkcs11-id-management : Acquire identity from management interface.\n"
696 "--pkcs11-id serialized-id 'id' : Identity to use, get using standalone --show-pkcs11-ids\n"
699 "SSL Library information:\n"
700 "--show-ciphers : Show cipher algorithms to use with --cipher option.\n"
701 "--show-digests : Show message digest algorithms to use with --auth option.\n"
702 "--show-engines : Show hardware crypto accelerator engines (if available).\n"
703 "--show-tls : Show all TLS ciphers (TLS used only as a control channel).\n"
706 "Windows Specific:\n"
707 "--win-sys path : Pathname of Windows system directory. Default is the pathname\n"
708 " from SystemRoot environment variable.\n"
709 "--ip-win32 method : When using --ifconfig on Windows, set TAP-Windows adapter\n"
710 " IP address using method = manual, netsh, ipapi,\n"
711 " dynamic, or adaptive (default = adaptive).\n"
712 " Dynamic method allows two optional parameters:\n"
713 " offset: DHCP server address offset (> -256 and < 256).\n"
714 " If 0, use network address, if >0, take nth\n"
715 " address forward from network address, if <0,\n"
716 " take nth address backward from broadcast\n"
719 " lease-time: Lease time in seconds.\n"
720 " Default is one year.\n"
721 "--route-method : Which method to use for adding routes on Windows?\n"
722 " adaptive (default) -- Try ipapi then fall back to exe.\n"
723 " ipapi -- Use IP helper API.\n"
724 " exe -- Call the route.exe shell command.\n"
725 "--dhcp-option type [parm] : Set extended TAP-Windows properties, must\n"
726 " be used with --ip-win32 dynamic. For options\n"
727 " which allow multiple addresses,\n"
728 " --dhcp-option must be repeated.\n"
729 " DOMAIN name : Set DNS suffix\n"
730 " DOMAIN-SEARCH entry : Add entry to DNS domain search list\n"
731 " DNS addr : Set domain name server address(es) (IPv4 and IPv6)\n"
732 " NTP : Set NTP server address(es)\n"
733 " NBDD : Set NBDD server address(es)\n"
734 " WINS addr : Set WINS server address(es)\n"
735 " NBT type : Set NetBIOS over TCP/IP Node type\n"
736 " 1: B, 2: P, 4: M, 8: H\n"
737 " NBS id : Set NetBIOS scope ID\n"
738 " DISABLE-NBT : Disable Netbios-over-TCP/IP.\n"
739 "--dhcp-renew : Ask Windows to renew the TAP adapter lease on startup.\n"
740 "--dhcp-pre-release : Ask Windows to release the previous TAP adapter lease on\n"
742 "--register-dns : Run ipconfig /flushdns and ipconfig /registerdns\n"
743 " on connection initiation.\n"
744 "--tap-sleep n : Sleep for n seconds after TAP adapter open before\n"
745 " attempting to set adapter properties.\n"
746 "--pause-exit : When run from a console window, pause before exiting.\n"
747 "--service ex [0|1] : For use when " PACKAGE_NAME
" is being instantiated by a\n"
748 " service, and should not be used directly by end-users.\n"
749 " ex is the name of an event object which, when\n"
750 " signaled, will cause " PACKAGE_NAME
" to exit. A second\n"
751 " optional parameter controls the initial state of ex.\n"
752 "--show-net-up : Show " PACKAGE_NAME
"'s view of routing table and net adapter list\n"
753 " after TAP adapter is up and routes have been added.\n"
754 "--block-outside-dns : Block DNS on other network adapters to prevent DNS leaks\n"
755 "Windows Standalone Options:\n"
757 "--show-adapters : Show all TAP-Windows adapters.\n"
758 "--show-net : Show " PACKAGE_NAME
"'s view of routing table and net adapter list.\n"
759 "--show-valid-subnets : Show valid subnets for --dev tun emulation.\n"
760 "--allow-nonadmin [TAP-adapter] : Allow " PACKAGE_NAME
" running without admin privileges\n"
761 " to access TAP adapter.\n"
764 "Generate a new key :\n"
765 "--genkey tls-auth file : Generate a new random key of type and write to file\n"
766 " (for use with --tls-auth or --tls-crypt)."
767#ifdef ENABLE_FEATURE_TUN_PERSIST
769 "Tun/tap config mode:\n"
770 "--mktun : Create a persistent tunnel.\n"
771 "--rmtun : Remove a persistent tunnel.\n"
772 "--dev tunX|tapX : tun/tap device\n"
773 "--dev-type dt : Device type. See tunnel options above for details.\n"
774 "--user user : User to set privilege to.\n"
775 "--group group : Group to set privilege to.\n"
779 "PKCS#11 standalone options:\n"
780#ifdef DEFAULT_PKCS11_MODULE
781 "--show-pkcs11-ids [provider] [cert_private] : Show PKCS#11 available ids.\n"
783 "--show-pkcs11-ids provider [cert_private] : Show PKCS#11 available ids.\n"
785 " --verb option can be added *BEFORE* this.\n"
788 "General Standalone Options:\n"
790 "--show-gateway [address]: Show info about gateway [to v4/v6 address].\n"
814 o->
ce.
af = AF_UNSPEC;
839#ifdef ENABLE_MANAGEMENT
844#ifdef ENABLE_FEATURE_TUN_PERSIST
877#ifdef ENABLE_PREDICTION_RESISTANCE
878 o->use_prediction_resistance =
false;
888#ifdef ENABLE_X509ALTUSERNAME
892 o->pkcs11_pin_cache_period = -1;
907 msg(
M_USAGE,
"Could not find a suitable temporary directory."
908 " (GetTempPath() failed). Consider using --tmp-dir");
924#ifdef ENABLE_DNS_UPDOWN_BY_DEFAULT
970#define SHOW_PARM(name, value, format) msg(D_SHOW_PARMS, " " #name " = " format, (value))
971#define SHOW_STR(var) SHOW_PARM(var, (o->var ? o->var : "[UNDEF]"), "'%s'")
972#define SHOW_STR_INLINE(var) \
973 SHOW_PARM(var, o->var##_inline ? "[INLINE]" : (o->var ? o->var : "[UNDEF]"), "'%s'")
974#define SHOW_INT(var) SHOW_PARM(var, o->var, "%d")
975#define SHOW_UINT(var) SHOW_PARM(var, o->var, "%u")
976#define SHOW_INT64(var) SHOW_PARM(var, o->var, "%" PRIi64)
977#define SHOW_UNSIGNED(var) SHOW_PARM(var, o->var, "0x%08x")
978#define SHOW_BOOL(var) SHOW_PARM(var, (o->var ? "ENABLED" : "DISABLED"), "%s");
1042setenv_foreign_option(
struct options *o,
const char *option,
const char *value,
struct env_set *
es)
1061 ++
o->foreign_option_index;
1065 msg(
M_WARN,
"foreign_option: name/value overflow");
1077 for (current = *list, prev = NULL; current != NULL; current = current->
next)
1079 char *tmp_value = NULL;
1080 if (!strncmp(current->
string,
"foreign_option_",
sizeof(
"foreign_option_") - 1))
1082 tmp_value = strchr(current->
string,
'=');
1083 if (tmp_value && ++tmp_value)
1085 if (!strncmp(tmp_value,
"dhcp-option ",
sizeof(
"dhcp-option ") - 1))
1093 *list = current->
next;
1109 bool succeeded =
false;
1117 ret =
getaddr(flags, ip_string, 0, &succeeded, NULL);
1118 if (!succeeded && error)
1133 const char *end = strchr(addr,
'/');
1141 size_t len = end - addr;
1143 memcpy(ret, addr, len);
1151 struct in6_addr t_addr;
1152 unsigned int t_bits;
1157#if defined(__GNUC__) || defined(__clang__)
1158#pragma GCC diagnostic push
1159#pragma GCC diagnostic ignored "-Wconversion"
1165 char *ret = (
char *)
gc_malloc(strlen(src) + 1,
true,
gc);
1194 const char *cp = str;
1202 while (*cp && i < nbytes)
1205 if (!isxdigit(cp[0]) || !isxdigit(cp[1]) || (cp[2] !=
':' && cp[2] !=
'\0')
1206 || sscanf(cp,
"%x", &
byte) != 1)
1208 msg(msglevel,
"format error in hash fingerprint: %s", str);
1212 ret->
hash[i++] = (uint8_t)
byte;
1223 msg(msglevel,
"hash fingerprint is wrong length - expected %d bytes, got %d: %s", nbytes, i,
1226 else if (term !=
'\0')
1228 msg(msglevel,
"hash fingerprint too long - expected only %d bytes: %s", nbytes, str);
1253 while ((line =
strsep(&lines,
"\n")))
1256 while (isspace(*line))
1261 if (strlen(line) == 0 || *line ==
'#' || *line ==
';')
1289 for (i = 0; i < len; ++i)
1300 for (i = 0; i < len; ++i)
1336 struct in6_addr addr;
1339 msg(msglevel,
"--dhcp-option DNS: maximum of %d IPv6 dns servers can be specified",
1344 dns6_list[(*len)++] = addr;
1353 msg(msglevel,
"--dhcp-option %s: maximum of %d %s servers can be specified", name,
1364 array[(*len)++] = addr;
1369 msg(msglevel,
"dhcp-option parameter %s '%s' must be an IP address", name, parm);
1426 SHOW_STR(ifconfig_pool_persist_filename);
1427 SHOW_INT(ifconfig_pool_persist_refresh_freq);
1431 SHOW_INT(ifconfig_ipv6_pool_netbits);
1438 SHOW_STR(client_disconnect_script);
1439 SHOW_STR(client_crresponse_script);
1461 SHOW_STR(auth_user_pass_verify_script);
1462 SHOW_BOOL(auth_user_pass_verify_script_via_file);
1501 msg(msglevel,
"in --iroute %s %s : Bad network/subnet specification", network_str,
1520 msg(msglevel,
"in --iroute-ipv6 %s: Bad IPv6 prefix specification", prefix_str);
1637#ifdef ENABLE_FRAGMENT
1644 SHOW_INT(explicit_exit_notification);
1660 for (
i = 0;
i <
l->len; ++
i)
1702#ifdef ENABLE_FEATURE_TUN_PERSIST
1724#if defined(ENABLE_DCO)
1756#if PASSTOS_CAPABILITY
1767#ifdef ENABLE_SELINUX
1793#if defined(TARGET_LINUX)
1828#ifdef ENABLE_MANAGEMENT
1832 SHOW_INT(management_log_history_cache);
1833 SHOW_INT(management_echo_buffer_size);
1850#ifndef ENABLE_CRYPTO_MBEDTLS
1858#ifdef ENABLE_PREDICTION_RESISTANCE
1869 SHOW_PARM(
"cert_file",
"EXTERNAL_CERT",
"%s");
1879 SHOW_PARM(
"priv_key_file",
"EXTERNAL_PRIVATE_KEY",
"%s");
1885#ifndef ENABLE_CRYPTO_MBEDTLS
1888#ifdef ENABLE_CRYPTOAPI
1895 SHOW_STR(tls_export_peer_cert_dir);
1944 for (i = 0; i <
MAX_PARMS && o->pkcs11_providers[i] != NULL; i++)
1946 SHOW_PARM(pkcs11_providers, o->pkcs11_providers[i],
"%s");
1953 SHOW_PARM(pkcs11_protected_authentication,
1954 o->pkcs11_protected_authentication[i] ?
"ENABLED" :
"DISABLED",
"%s");
1961 SHOW_PARM(pkcs11_private_mode, o->pkcs11_private_mode[i],
"%08x");
1968 SHOW_PARM(pkcs11_cert_private, o->pkcs11_cert_private[i] ?
"ENABLED" :
"DISABLED",
1993#ifdef ENABLE_MANAGEMENT
2005 if (flags && !strcmp(flags,
"nct"))
2029 for (
i = 0;
i <
l->len; ++
i)
2040 for (i = 0; i < l->
len; ++i)
2052 "Note: option http-proxy-override ignored because no TCP-based connection profiles are defined");
2076 const int new_cap = l->
capacity + 1;
2077 const size_t elem_size =
sizeof(*l->
array);
2083 "Unable to process more local options: out of memory. Number of entries = %d",
2088 l->
array = new_array;
2123 "Unable to process more connection options: out of memory. Number of entries = %d",
2159 "Unable to process more remote options: out of memory. Number of entries = %d",
2226 if (key_file && *key_file && !(*key_inline))
2242#ifdef ENABLE_CRYPTO_MBEDTLS
2245 msg(
M_USAGE,
"Parameter --capath cannot be used with the mbed TLS version of OpenVPN.");
2258 const char *
const str =
"You must define CA file (--ca)"
2259#ifndef ENABLE_CRYPTO_MBEDTLS
2260 " or CA path (--capath)"
2262 " and/or peer fingerprint verification (--peer-fingerprint)";
2266#define MUST_BE_UNDEF(parm, parm_name) \
2267 if (options->parm != defaults.parm) \
2269 msg(M_USAGE, use_err, parm_name); \
2271#define MUST_BE_FALSE(condition, parm_name) \
2274 msg(M_USAGE, use_err, parm_name); \
2306 msg(
M_USAGE,
"--proto tcp is ambiguous in this context. Please specify "
2307 "--proto tcp-server or --proto tcp-client");
2316 msg(
M_USAGE,
"multiple --local statements only allowed in --server mode");
2321 msg(
M_USAGE,
"--lladdr can only be used in --dev tap mode");
2329 msg(
M_USAGE,
"only one of --tun-mtu or --link-mtu may be defined");
2334 msg(
M_USAGE,
"--mtu-test only makes sense with --proto udp");
2347 msg(
M_USAGE,
"--local and --remote addresses must be distinct from --ifconfig "
2353 msg(
M_USAGE,
"local and remote/netmask --ifconfig addresses must be different");
2358 msg(
M_USAGE,
"--bind and --nobind can't be used together");
2363 msg(
M_USAGE,
"--lport and --nobind don't make sense when used together");
2368 msg(
M_USAGE,
"--nobind doesn't make sense unless used with --remote");
2378 msg(
M_USAGE,
"--remote and one of the --local addresses are the same");
2384 msg(
M_USAGE,
"--local addresses must be distinct from --ifconfig addresses");
2389 msg(
M_USAGE,
"--local and --nobind don't make sense when used together");
2396#ifdef ENABLE_MANAGEMENT
2402 "--management is not specified, however one or more options which modify the behavior of --management were specified");
2408 msg(
M_USAGE,
"--management-client-(user|group) can only be used on unix domain sockets");
2414 msg(
M_WARN,
"WARNING: Using --management on a TCP port WITHOUT "
2415 "passwords is STRONGLY discouraged and considered insecure");
2420#if !defined(HAVE_XKEY_PROVIDER)
2424 msg(
M_FATAL,
"management-external-key with TLS 1.3 or later requires "
2425 "nopadding argument/support");
2436 msg(
M_USAGE,
"On Windows, --ifconfig is required when --dev tun is used");
2442 msg(
M_USAGE,
"On Windows, --ip-win32 doesn't make sense unless --ifconfig is also used");
2447 const char *prefix =
"Some --dhcp-option or --dns options require DHCP server";
2450 msg(
M_USAGE,
"%s, which is not supported by the selected %s driver", prefix,
2456 msg(
M_USAGE,
"%s, which requires --ip-win32 dynamic or adaptive", prefix);
2465#ifdef ENABLE_FRAGMENT
2468 msg(
M_USAGE,
"--fragment can only be used with --proto udp");
2474 msg(
M_USAGE,
"--remote MUST be used in TCP Client mode");
2479 msg(
M_USAGE,
"--http-proxy MUST be used in TCP Client mode (i.e. --proto "
2485 msg(
M_USAGE,
"--http-proxy not specified but other http proxy options present");
2490 msg(
M_USAGE,
"--http-proxy can not be used together with --socks-proxy");
2495 msg(
M_USAGE,
"--socks-proxy can not be used in TCP Server mode");
2500 msg(
M_USAGE,
"TCP server mode allows at most one --remote address");
2508 const char use_err[] =
"--%s cannot be used with --mode server.";
2510#define USAGE_VALID_SERVER_PROTOS \
2511 "--mode server currently only supports " \
2512 "--proto values of udp, tcp-server, tcp4-server, or tcp6-server"
2513#ifdef TARGET_ANDROID
2514 msg(
M_FATAL,
"--mode server not supported on Android");
2518 msg(
M_USAGE,
"--mode server only works with --dev tun or --dev tap");
2523 msg(
M_WARN,
"--pull-filter ignored for --mode server");
2533 msg(
M_USAGE,
"--port-share only works in TCP server mode "
2534 "(--proto values of tcp-server, tcp4-server, or tcp6-server)");
2539 msg(
M_USAGE,
"--mode server requires --tls-server");
2550 msg(
M_USAGE,
"<connection> cannot be used with --mode server");
2556 msg(
M_USAGE,
"--ipchange cannot be used with --mode server (use "
2557 "--client-connect instead)");
2566 "--connect-freq only works with --mode server --proto udp. Try --max-clients instead.");
2572 "The third parameter to --ifconfig-pool (netmask) is only valid in --dev tap mode");
2577 "--redirect-gateway cannot be used with --mode server (however --push \"redirect-gateway\" is fine)");
2585 "--ifconfig-pool-persist must be used with --ifconfig-pool or --ifconfig-ipv6-pool");
2589 msg(
M_USAGE,
"--ifconfig-ipv6-pool needs --ifconfig-ipv6");
2591 MUST_BE_UNDEF(allow_recursive_routing,
"allow-recursive-routing");
2595 "--auth-user-pass cannot be used with --mode server (it should be used on the client side only)");
2599 msg(
M_USAGE,
"--ccd-exclusive must be used with --client-config-dir");
2603 msg(
M_USAGE,
"--auth-gen-token needs a non-infinite "
2604 "--renegotiate_seconds setting");
2610 "--auth-gen-token renewal time needs to be at least "
2611 " two times --hand-window (%d).",
2617 const char *use_err =
2618 "--%s must be used with --management-client-auth, an --auth-user-pass-verify script, or plugin";
2622 "verify-client-cert none|optional");
2624 "username-as-common-name");
2626 "auth-user-pass-optional");
2631 msg(
M_USAGE,
"--vlan-tagging must be used with --dev tap");
2635 const char use_err[] =
"--%s requires --vlan-tagging";
2642 const char use_err[] =
"--%s requires --mode server";
2648 MUST_BE_UNDEF(ifconfig_pool_persist_filename,
"ifconfig-pool-persist");
2649 MUST_BE_UNDEF(ifconfig_ipv6_pool_defined,
"ifconfig-ipv6-pool");
2654 MUST_BE_UNDEF(client_crresponse_script,
"client-crresponse");
2655 MUST_BE_UNDEF(client_disconnect_script,
"client-disconnect");
2664 "verify-client-cert");
2669 msg(
M_WARN,
"WARNING: setting tcp-nodelay on the client side will not "
2670 "affect the server. To have TCP_NODELAY in both direction use "
2671 "tcp-nodelay in the server configuration instead.");
2673 MUST_BE_UNDEF(auth_user_pass_verify_script,
"auth-user-pass-verify");
2679 "--port-share requires TCP server mode (--mode server --proto tcp-server)");
2682 MUST_BE_UNDEF(stale_routes_check_interval,
"stale-routes-check");
2686 MUST_BE_UNDEF(force_key_material_export,
"force-key-material-export");
2690 msg(
M_WARN,
"Note: Using --push without --mode server is an "
2691 "unsupported configuration. Negotiation of OpenVPN "
2692 "features is expected to fail.");
2701 msg(
M_USAGE,
"specify only one of --tls-server, --tls-client, or --secret");
2712 msg(msglevel,
"DEPRECATION: No tls-client or tls-server option in "
2713 "configuration detected. OpenVPN 2.8 will remove the "
2714 "functionality to run a VPN without TLS. "
2715 "See the examples section in the manual page for "
2716 "examples of a similar quick setup with peer-fingerprint. "
2717 "OpenVPN 2.7 allows using this configuration when using "
2718 "--allow-deprecated-insecure-static-crypto but you should move "
2719 "to a proper configuration using TLS as soon as possible.");
2724 msg(
M_WARN,
"WARNING: POTENTIALLY DANGEROUS OPTION "
2725 "--verify-client-cert none|optional "
2726 "may accept clients which do not present a certificate");
2731 const unsigned int tls_version_min =
2736 msg(
M_USAGE,
"--tls-version-min bigger than --tls-version-max");
2745 msg(
M_WARN,
"Option pkcs11-id is ignored as no pkcs11-providers are specified");
2747 else if (!
options->pkcs11_providers[0] &&
options->pkcs11_id_management)
2750 "Option pkcs11-id-management is ignored as no pkcs11-providers are specified");
2753 if (
options->pkcs11_providers[0])
2758 "Parameter --pkcs11-id cannot be used when --pkcs11-id-management is also specified.");
2760 if (!
options->pkcs11_id_management &&
options->pkcs11_id == NULL)
2763 "Parameter --pkcs11-id or --pkcs11-id-management should be specified.");
2765 const char use_err[] =
2766 "Parameter --%s cannot be used when --pkcs11-provider is also specified.";
2772#ifdef ENABLE_CRYPTOAPI
2778#ifdef ENABLE_CRYPTOAPI
2781 const char use_err[] =
2782 "Parameter --%s cannot be used when --cryptoapicert is also specified.";
2793#ifdef ENABLE_CRYPTO_MBEDTLS
2794 msg(
M_USAGE,
"Parameter --pkcs12 cannot be used with the mbed TLS version of OpenVPN.");
2796 const char use_err[] =
"Parameter --%s cannot be used when --pkcs12 is also specified.";
2808 msg(
M_USAGE,
"--key and --management-external-key are mutually exclusive");
2814 msg(
M_USAGE,
"--cert and --management-external-cert are mutually exclusive");
2819 "--management-external-cert must be used with --management-external-key");
2833 msg(
M_USAGE,
"No client-side authentication method is "
2834 "specified. You must use either "
2835 "--cert/--key, --pkcs12, or "
2836 "--auth-user-pass");
2841 msg(
M_USAGE,
"If you use one of --cert or --key, you must use them both");
2849 "certificate file (--cert) or PKCS#12 file (--pkcs12)");
2854 "private key file (--key) or PKCS#12 file (--pkcs12)");
2860 msg(
M_USAGE,
"--tls-auth and --tls-crypt are mutually exclusive");
2866 "--tls-crypt-v2, --tls-auth and --tls-crypt are mutually exclusive in client mode");
2876 const char use_err[] =
"Parameter %s can only be specified in TLS-mode, "
2877 "i.e. where --tls-server or --tls-client is also specified.";
2884#ifndef ENABLE_CRYPTO_MBEDTLS
2911 MUST_BE_UNDEF(pkcs11_private_mode[0],
"pkcs11-private-mode");
2923 msg(
M_USAGE,
"--auth-user-pass requires --pull");
2992 if (ce->
af == AF_INET6)
2994 msg(
M_INFO,
"WARNING: '--proto udp6' is not compatible with "
2995 "'--socks-proxy' today. Forcing IPv4 mode.");
2999 msg(
M_INFO,
"NOTICE: dual-stack mode for '--proto udp' does not "
3000 "work correctly with '--socks-proxy' today. Forcing IPv4.");
3027#ifdef ENABLE_FRAGMENT
3084 msg(
M_WARN,
"NOTICE: --explicit-exit-notify ignored for --proto tcp");
3113 msg(
M_INFO,
"Flag 'def1' added to --redirect-gateway (iservice is in use)");
3292#ifdef DEFAULT_PKCS11_MODULE
3298 options->pkcs11_providers[0] = DEFAULT_PKCS11_MODULE;
3325 msg(
M_WARN,
"Note: --client-to-client has no effect when using data "
3326 "channel offload: packets are always sent to the VPN "
3327 "interface and then routed based on the system routing table");
3332 msg(
M_WARN,
"Note: '--reneg-bytes' and '--reneg-pkts' are not supported "
3333 "by data channel offload; automatic key renegotiation "
3334 "mechanisms are sufficient for modern ciphers. "
3335 "Ignoring these options.");
3367 "Note: --cipher is not set. OpenVPN versions before 2.5 "
3368 "defaulted to BF-CBC as fallback when cipher negotiation "
3369 "failed in this case. If you need this fallback please add "
3370 "'--data-ciphers-fallback BF-CBC' to your configuration "
3371 "and/or add BF-CBC to --data-ciphers. E.g. "
3372 "--data-ciphers %s:BF-CBC",
3378 "DEPRECATED OPTION: --cipher set to '%s' but missing in "
3379 "--data-ciphers (%s). OpenVPN ignores --cipher for cipher "
3415 if (tls_ver_min == 0)
3423 else if (tls_ver_max == 0 || tls_ver_max >=
TLS_VER_1_2)
3484 "supported by the TLS library. Your system does not support this "
3485 "calculation anymore or your security policy (e.g. FIPS 140-2) "
3486 "forbids it. Connections will only work with peers running "
3487 "OpenVPN 2.6.0 or higher)");
3490 msg(
M_WARN,
"Automatically enabling option "
3491 "--force-tls-key-material-export");
3497#if defined(_WIN32) || defined(TARGET_ANDROID)
3557 msg(
M_WARN,
"WARNING: couldn't copy all --dns search-domains to TUN/TAP");
3566 bool non_standard_server_port =
false;
3571 non_standard_server_port =
true;
3583 bool overflow =
false;
3601 msg(
M_WARN,
"WARNING: couldn't copy all --dns server addresses to TUN/TAP");
3640 const int fo_count =
o->foreign_option_index;
3641 o->foreign_option_index = 0;
3665 buf_printf(&name,
"foreign_option_%d", ++
o->foreign_option_index);
3676 if (
dhcp->dns_len ||
dhcp->dns6_len)
3684 for (
size_t i = 0; i <
dhcp->domain_search_list_len; ++i)
3688 new->
name =
dhcp->domain_search_list[i];
3693 const size_t max_addrs =
SIZE(server->
addr);
3694 for (
size_t i = 0; i <
dhcp->dns_len && server->
addr_count < max_addrs; ++i)
3700 for (
size_t i = 0; i <
dhcp->dns6_len && server->
addr_count < max_addrs; ++i)
3714 setenv_foreign_option(o,
"DOMAIN", d->
name,
es);
3721 bool non_standard_server_port =
false;
3726 non_standard_server_port =
true;
3752 setenv_foreign_option(o, option, value,
es);
3785 msg(
M_USAGE,
"--data-ciphers list contains unsupported ciphers or is too long.");
3794 for (
i = 0;
i <
rl->len; ++
i)
3866 msg(
M_WARN,
"WARNING: Ignoring option 'dh' in tls-client mode, please only "
3867 "include this in your server configuration");
3870#if ENABLE_MANAGEMENT
3878 msg(
M_INFO,
"Using certificate fingerprint to verify peer (no CA "
3885 msg(
M_USAGE,
"Options 'config stdin' and 'remap-usr1 SIGHUP' are "
3886 "incompatible with each other.");
3911 "Option --windows-driver ovpn-dco is ignored because Data Channel Offload is disabled");
3922 msg(
M_WARN,
"Note: ignoring --dev-node as it has no effect when using "
3923 "data channel offload");
3944#if defined(_WIN32) || defined(TARGET_ANDROID)
3947 dhcp_options_postprocess_dns(o,
es);
3964#define CHKACC_FILE (1 << 0)
3965#define CHKACC_DIRPATH (1 << 1)
3966#define CHKACC_FILEXSTWR (1 << 2)
3967#define CHKACC_ACPTSTDIN (1 << 3)
3968#define CHKACC_PRIVATE (1 << 4)
3969#define CHKACC_ACCEPT_URI (1 << 5)
3995 if (!strncmp(file,
"file:", 5))
3999 else if (!strchr(file,
'/') || strchr(file,
'/') > strchr(file,
':'))
4010 char *dirpath =
dirname(fullpath);
4045 if (st.st_mode & (S_IRWXG | S_IRWXO))
4047 msg(
M_WARN,
"WARNING: file '%s' is group or others accessible", file);
4060 return (errcode != 0 ?
true :
false);
4103 const char *file,
const int mode,
const char *opt)
4222 R_OK | X_OK,
"--crl-verify directory");
4256 R_OK | W_OK,
"--replay-persist");
4261#ifdef ENABLE_MANAGEMENT
4280 R_OK | X_OK,
"--client-config-dir");
4282 R_OK | W_OK | X_OK,
"Temporary directory (--tmp-dir)");
4286 msg(
M_USAGE,
"Please correct these errors.");
4317#if defined(_WIN32) || defined(TARGET_ANDROID)
4320 dhcp_options_postprocess_dns(o,
es);
4387 if (
o->ce.occ_mtu != 0)
4413 tt =
init_tun(
o->dev,
o->dev_type,
o->topology,
o->ifconfig_local,
4414 o->ifconfig_remote_netmask,
o->ifconfig_ipv6_local,
o->ifconfig_ipv6_netbits,
4444#ifdef ENABLE_FRAGMENT
4451#define TLS_CLIENT (o->tls_client)
4452#define TLS_SERVER (o->tls_server)
4506#ifdef ENABLE_PREDICTION_RESISTANCE
4507 if (o->use_prediction_resistance)
4509 buf_printf(&out,
",use-prediction-resistance");
4631 msg(msglevel,
"WARNING: '%s' is used inconsistently, %s='%s', %s='%s'",
4640 msg(msglevel,
"WARNING: '%s' is present in %s config but missing in %s config, %s='%s'",
4696 actual[actual_n - 1] = 0;
4697 if (strncmp(actual, expected, 2))
4699 msg(
D_SHOW_OCC,
"NOTE: Options consistency check may be skewed by version differences");
4704 ret = !strcmp(actual, expected);
4739 const char *end =
strchr(
p,
',');
4775 msg(msglevel,
"--topology must be net30, p2p, or subnet");
4817 if (
streq(option,
"interact"))
4821 else if (
streq(option,
"nointeract"))
4825 else if (
streq(option,
"none"))
4831 msg(msglevel,
"--auth-retry method must be 'interact', 'nointeract', or 'none'");
4846 return "nointeract";
4866 fprintf(fp,
"Usage message not available\n");
4916#define LZO_LIB_VER_STR ", LZO ", lzo_version_string()
4918#define LZO_LIB_VER_STR "", ""
4923#undef LZO_LIB_VER_STR
4938#ifdef CONFIGURE_DEFINES
4941#ifdef CONFIGURE_SPECIAL_BUILD
4953 msg(
M_USAGE,
"You must define %s", description);
4962 return !strcmp(s1, s2);
4974 msg(msglevel,
"only one of --ping-exit or --ping-restart options may be specified");
4982 unsigned int val = 0;
4983 sscanf(str,
"%u", &val);
4988#define VERIFY_PERMISSION(mask) \
4990 if (!verify_permission(p[0], file, line, (mask), permission_mask, option_types_found, \
4991 msglevel, options, is_inline)) \
4999 const unsigned int allowed,
unsigned int *found,
const msglvl_t msglevel,
5002 if (!(type & allowed))
5004 msg(msglevel,
"option '%s' cannot be used in this context (%s)", name, file);
5010 msg(msglevel,
"option '%s' is not expected to be inline (%s:%d)", name, file, line);
5031 msg(
M_WARN,
"Option '%s' in %s:%d is ignored by previous <connection> blocks ", name,
5036 msg(
M_WARN,
"Option '%s' is ignored by previous <connection> blocks", name);
5048#define NM_QUOTE_HINT (1 << 0)
5062 msg(msglevel,
"the --%s directive should have at most %d parameter%s.%s", p[0], max - 1,
5063 max >= 3 ?
"s" :
"",
5065 ?
" To pass a list of arguments as one of the parameters, try enclosing them in double quotes (\"\")."
5081#define RESET_OPTION_ROUTES(option_ptr, field) \
5084 option_ptr->field = NULL; \
5085 option_ptr->flags = 0; \
5090 const char *file,
int line,
const msglvl_t msglevel,
5091 const unsigned int permission_mask,
unsigned int *option_types_found,
5096 if (
streq(p[0],
"ifconfig") && !p[1])
5102 else if (
streq(p[0],
"ifconfig-ipv6") && !p[1])
5109 else if (
streq(p[0],
"route") && !p[1])
5119 else if (
streq(p[0],
"route-ipv6") && !p[1])
5129 else if (
streq(p[0],
"route-gateway") && !p[1])
5135 else if (
streq(p[0],
"route-metric") && !p[1])
5140 else if (
streq(p[0],
"push-continuation") && !p[1])
5145 else if ((
streq(p[0],
"redirect-gateway") ||
streq(p[0],
"redirect-private")) && !p[1])
5159 else if (
streq(p[0],
"dns") && !p[1])
5165 else if (
streq(p[0],
"topology") && !p[1])
5171 else if (
streq(p[0],
"tun-mtu") && !p[1])
5178 else if (
streq(p[0],
"block-ipv6") && !p[1])
5183#if defined(_WIN32) || defined(TARGET_ANDROID)
5184 else if (
streq(p[0],
"dhcp-option") && !p[1])
5193 memset(o->
dns6, 0,
sizeof(o->
dns6));
5195 memset(o->
dns, 0,
sizeof(o->
dns));
5197 memset(o->
wins, 0,
sizeof(o->
wins));
5199 memset(o->
ntp, 0,
sizeof(o->
ntp));
5201 memset(o->
nbdd, 0,
sizeof(o->
nbdd));
5208#if defined(TARGET_ANDROID)
5209 o->http_proxy_port = 0;
5210 o->http_proxy = NULL;
5215 else if (
streq(p[0],
"block-outside-dns") && !p[1])
5221 else if (
streq(p[0],
"dhcp-option") && !p[1])
5229 msglvl_t msglevel_unknown = msglevel_fc;
5236 msglevel_unknown =
M_WARN;
5240 msg(msglevel_unknown,
5241 "Unrecognized option or missing or extra parameter(s) in %s:%d: -%s (%s)", file, line,
5242 p[0], PACKAGE_VERSION);
5246 msg(msglevel,
"Error occurred trying to remove %s option", p[0]);
5259 msg(msglevel,
"route parameter network/IP '%s' must be a valid address", p[1]);
5264 msg(msglevel,
"route parameter netmask '%s' must be an IP address", p[2]);
5270 msg(msglevel,
"route parameter gateway '%s' must be a valid address", p[3]);
5286 msg(msglevel,
"route-ipv6 parameter network/IP '%s' must be a valid address", p[1]);
5291 msg(msglevel,
"route-ipv6 parameter gateway '%s' must be a valid address", p[2]);
5302 if (
streq(p[1],
"search-domains") && p[2])
5307 msg(msglevel,
"--dns %s contain invalid characters", p[1]);
5311 else if (
streq(p[1],
"server") && p[2] && p[3] && p[4])
5316 msg(msglevel,
"--dns server: invalid priority value '%s'", p[2]);
5323 if (
streq(p[3],
"address") && p[4])
5325 for (
int i = 4; p[i]; ++i)
5329 msg(msglevel,
"--dns server %ld: malformed address or maximum exceeded '%s'",
5335 else if (
streq(p[3],
"resolve-domains"))
5339 msg(msglevel,
"--dns server %ld: %s contain invalid characters",
priority, p[3]);
5343 else if (
streq(p[3],
"dnssec") && !p[5])
5345 if (
streq(p[4],
"yes"))
5349 else if (
streq(p[4],
"no"))
5353 else if (
streq(p[4],
"optional"))
5359 msg(msglevel,
"--dns server %ld: malformed dnssec value '%s'",
priority, p[4]);
5363 else if (
streq(p[3],
"transport") && !p[5])
5365 if (
streq(p[4],
"plain"))
5369 else if (
streq(p[4],
"DoH"))
5373 else if (
streq(p[4],
"DoT"))
5379 msg(msglevel,
"--dns server %ld: malformed transport value '%s'",
priority, p[4]);
5383 else if (
streq(p[3],
"sni") && !p[5])
5387 msg(msglevel,
"--dns server %ld: %s contains invalid characters",
priority, p[3]);
5395 "--dns server %ld: unknown option type '%s' or missing or unknown parameter",
5402 msg(msglevel,
"--dns: unknown option type '%s' or missing or unknown parameter", p[1]);
5410 const char *file,
int line,
const int level,
const msglvl_t msglevel,
5411 const unsigned int permission_mask,
unsigned int *option_types_found,
5412 struct env_set *
es,
unsigned int *update_options_found)
5417 if (
streq(p[0],
"route") && p[1] && !p[5])
5435 else if (
streq(p[0],
"route-ipv6") && p[1] && !p[4])
5453 else if (
streq(p[0],
"redirect-gateway") ||
streq(p[0],
"redirect-private"))
5471 else if (
streq(p[0],
"dns") && p[1])
5485#if defined(_WIN32) || defined(TARGET_ANDROID)
5486 else if (
streq(p[0],
"dhcp-option") && p[1] && !p[3])
5514#if defined(TARGET_ANDROID)
5515 o->http_proxy_port = 0;
5516 o->http_proxy = NULL;
5522 else if (
streq(p[0],
"dhcp-option") && p[1] && !p[3])
5533 option_types_found,
es);
5536 msg(msglevel,
"Error occurred trying to update %s option", p[0]);
5541 const char *type,
bool in_chroot)
5546 "Multiple --%s scripts defined. "
5547 "The previously configured script is overridden.",
5550 *script = new_script;
5555 char script_name[100];
5556 snprintf(script_name,
sizeof(script_name),
"--%s script", type);
5571 msg(
M_WARN,
"WARNING: Compression for receiving enabled. "
5572 "Compression has been used in the past to break encryption. "
5573 "Compression support is deprecated and we recommend to disable "
5584 ret = ret || (
options->pkcs11_providers[0] != NULL);
5586#ifdef ENABLE_CRYPTOAPI
5595 const int level,
const msglvl_t msglevel,
const unsigned int permission_mask,
5596 unsigned int *option_types_found,
struct env_set *
es)
5612 p[2] =
"setenv opt";
5620 file =
"[CMD-LINE]";
5623 if (
streq(p[0],
"help"))
5629 msg(msglevel,
"--help does not accept any parameters");
5633 if (
streq(p[0],
"version") && !p[1])
5638 else if (
streq(p[0],
"config") && p[1] && !p[2])
5649 option_types_found,
es);
5651#if defined(ENABLE_DEBUG) && !defined(ENABLE_SMALL)
5652 else if (
streq(p[0],
"show-gateway") && !p[2])
5657 struct in6_addr remote_ipv6 = IN6ADDR_ANY_INIT;
5676 else if (
streq(p[0],
"echo") ||
streq(p[0],
"parameter"))
5700 if (
p[1] &&
strncmp(
p[1],
"msg", 3) == 0)
5704#ifdef ENABLE_MANAGEMENT
5713 msg(
M_WARN,
"echo/parameter option overflow");
5716#ifdef ENABLE_MANAGEMENT
5717 else if (
streq(
p[0],
"management") &&
p[1] &&
p[2] && !
p[4])
5722#if UNIX_SOCK_SUPPORT
5725 msg(msglevel,
"MANAGEMENT: this platform does not support unix domain sockets");
5737 else if (
streq(
p[0],
"management-client-user") &&
p[1] && !
p[2])
5742 else if (
streq(
p[0],
"management-client-group") &&
p[1] && !
p[2])
5747 else if (
streq(
p[0],
"management-query-passwords") && !
p[1])
5752 else if (
streq(
p[0],
"management-query-remote") && !
p[1])
5757 else if (
streq(
p[0],
"management-query-proxy") && !
p[1])
5762 else if (
streq(
p[0],
"management-hold") && !
p[1])
5767 else if (
streq(
p[0],
"management-signal") && !
p[1])
5772 else if (
streq(
p[0],
"management-forget-disconnect") && !
p[1])
5777 else if (
streq(
p[0],
"management-up-down") && !
p[1])
5782 else if (
streq(
p[0],
"management-client") && !
p[1])
5787 else if (
streq(
p[0],
"management-external-key"))
5796 else if (
streq(
p[
j],
"pkcs1"))
5804 else if (
streq(
p[
j],
"digest"))
5810 msg(msglevel,
"Unknown management-external-key flag: %s",
p[
j]);
5823 else if (
streq(
p[0],
"management-external-cert") &&
p[1] && !
p[2])
5829 else if (
streq(
p[0],
"management-client-auth") && !
p[1])
5834 else if (
streq(
p[0],
"management-log-cache") &&
p[1] && !
p[2])
5845 else if (
streq(
p[0],
"plugin") &&
p[1])
5854 msg(msglevel,
"plugin add failed: %s",
p[1]);
5859 else if (
streq(
p[0],
"mode") &&
p[1] && !
p[2])
5866 else if (
streq(
p[1],
"server"))
5872 msg(msglevel,
"Bad --mode parameter: %s",
p[1]);
5876 else if (
streq(
p[0],
"dev") &&
p[1] && !
p[2])
5881 else if (
streq(
p[0],
"dev-type") &&
p[1] && !
p[2])
5887 else if (
streq(
p[0],
"windows-driver") &&
p[1] && !
p[2])
5891 "DEPRECATED OPTION: windows-driver: In OpenVPN 2.7, the default Windows driver is ovpn-dco. "
5892 "If incompatible options are used, OpenVPN will fall back to tap-windows6. Wintun support has been removed.");
5895 else if (
streq(
p[0],
"disable-dco"))
5899 else if (
streq(
p[0],
"dev-node") &&
p[1] && !
p[2])
5904 else if (
streq(
p[0],
"lladdr") &&
p[1] && !
p[2])
5913 msg(msglevel,
"lladdr parm '%s' must be a MAC address",
p[1]);
5917 else if (
streq(
p[0],
"topology") &&
p[1] && !
p[2])
5922 else if (
streq(
p[0],
"tun-ipv6") && !
p[1])
5927 "Note: option tun-ipv6 is ignored because modern operating systems do not need special IPv6 tun handling anymore.");
5930#ifdef ENABLE_IPROUTE
5931 else if (
streq(
p[0],
"iproute") &&
p[1] && !
p[2])
5937 else if (
streq(
p[0],
"ifconfig") &&
p[1] &&
p[2] && !
p[3])
5948 msg(msglevel,
"ifconfig parms '%s' and '%s' must be valid addresses",
p[1],
p[2]);
5952 else if (
streq(
p[0],
"ifconfig-ipv6") &&
p[1] &&
p[2] && !
p[3])
5954 unsigned int netbits;
5961 msg(msglevel,
"ifconfig-ipv6: /netbits must be between 64 and 124, not '/%d'",
5972 msg(msglevel,
"ifconfig-ipv6 parms '%s' and '%s' must be valid addresses",
p[1],
p[2]);
5976 else if (
streq(
p[0],
"ifconfig-noexec") && !
p[1])
5981 else if (
streq(
p[0],
"ifconfig-nowarn") && !
p[1])
5986 else if (
streq(
p[0],
"local") &&
p[1] && !
p[4])
5998 if (strcmp(p[1],
"*") != 0)
6013 else if (
streq(p[0],
"remote-random") && !p[1])
6018 else if (
streq(p[0],
"connection") && p[1] && !p[3])
6029 option_types_found,
es);
6033 "Each 'connection' block must contain exactly one 'remote' directive");
6049 else if (
streq(p[0],
"ignore-unknown-option") && p[1])
6054 const char **ignore;
6058 for (i = 1; p[i]; i++)
6078 for (j = 1; p[j]; j++)
6081 if (p[j][0] ==
'-' && p[j][1] ==
'-')
6094#if ENABLE_MANAGEMENT
6095 else if (
streq(p[0],
"http-proxy-override") && p[1] && p[2] && !p[4])
6105 else if (
streq(p[0],
"remote") && p[1] && !p[4])
6123 msg(msglevel,
"remote: bad protocol associated with host %s: '%s'", p[1], p[3]);
6144 else if (
streq(p[0],
"resolv-retry") && p[1] && !p[2])
6147 if (
streq(p[1],
"infinite"))
6156 else if ((
streq(p[0],
"preresolve") ||
streq(p[0],
"ip-remote-hint")) && !p[2])
6167 else if (
streq(p[0],
"connect-retry") && p[1] && !p[3])
6178 msg(
M_WARN,
"connect retry wait interval truncated to %d",
6188 else if ((
streq(p[0],
"connect-timeout") ||
streq(p[0],
"server-poll-timeout")) && p[1]
6194 else if (
streq(p[0],
"connect-retry-max") && p[1] && !p[2])
6199 else if (
streq(p[0],
"ipchange") && p[1])
6209 else if (
streq(p[0],
"float") && !p[1])
6215 else if (
streq(p[0],
"gremlin") && p[1] && !p[2])
6221 else if (
streq(p[0],
"chroot") && p[1] && !p[2])
6226 else if (
streq(p[0],
"cd") && p[1] && !p[2])
6231 msg(
M_ERR,
"cd to '%s' failed", p[1]);
6236#ifdef ENABLE_SELINUX
6237 else if (
streq(p[0],
"setcon") && p[1] && !p[2])
6240 options->selinux_context = p[1];
6243 else if (
streq(p[0],
"writepid") && p[1] && !p[2])
6248 else if (
streq(p[0],
"up") && p[1])
6257 else if (
streq(p[0],
"down") && p[1])
6266 else if (
streq(p[0],
"down-pre") && !p[1])
6271 else if (
streq(p[0],
"up-delay") && !p[1])
6276 else if (
streq(p[0],
"up-restart") && !p[1])
6281 else if (
streq(p[0],
"syslog") && !p[2])
6286 else if (
streq(p[0],
"daemon") && !p[2])
6300 "WARNING: Multiple --daemon directives specified, ignoring --daemon %s. (Note that initscripts sometimes add their own --daemon directive.)",
6306 else if (
streq(p[0],
"log") && p[1] && !p[2])
6312 else if (
streq(p[0],
"suppress-timestamps") && !p[1])
6318 else if (
streq(p[0],
"machine-readable-output") && !p[1])
6324 else if (
streq(p[0],
"log-append") && p[1] && !p[2])
6330 else if (
streq(p[0],
"mlock") && !p[1])
6335#if ENABLE_IP_PKTINFO
6336 else if (
streq(p[0],
"multihome") && !p[2])
6340 if (p[1] &&
streq(p[1],
"same-interface"))
6346 msg(msglevel,
"Unknown parameter to --multihome: %s", p[1]);
6350 else if (
streq(p[0],
"verb") && p[1] && !p[2])
6360#if !defined(ENABLE_DEBUG) && !defined(ENABLE_SMALL)
6365 "NOTE: debug verbosity (--verb %d) is enabled but this build lacks debug support.",
6370 else if (
streq(p[0],
"mute") && p[1] && !p[2])
6375 else if (
streq(p[0],
"errors-to-stderr") && !p[1])
6380 else if (
streq(p[0],
"status") && p[1] && !p[3])
6389 else if (
streq(p[0],
"status-version") && p[1] && !p[2])
6397 else if (
streq(p[0],
"remap-usr1") && p[1] && !p[2])
6400 if (
streq(p[1],
"SIGHUP"))
6404 else if (
streq(p[1],
"SIGTERM"))
6410 msg(msglevel,
"--remap-usr1 parm must be 'SIGHUP' or 'SIGTERM'");
6414 else if ((
streq(p[0],
"link-mtu") ||
streq(p[0],
"udp-mtu")) && p[1] && !p[2])
6420 else if (
streq(p[0],
"tun-mtu") && p[1] && !p[3])
6434 else if (
streq(p[0],
"tun-mtu-max") && p[1] && !p[2])
6439 else if (
streq(p[0],
"tun-mtu-extra") && p[1] && !p[2])
6447 else if (
streq(p[0],
"max-packet-size") && p[1] && !p[2])
6456 "Note: max-packet-size value outside of allowed "
6457 "control channel packet size (%d to %d), will use %d "
6467#ifdef ENABLE_FRAGMENT
6468 else if (
streq(p[0],
"mtu-dynamic"))
6471 msg(msglevel,
"--mtu-dynamic has been replaced by --fragment");
6474 else if (
streq(p[0],
"fragment") && p[1] && !p[3])
6482 if (p[2] &&
streq(p[2],
"mtu"))
6488 msg(msglevel,
"Unknown parameter to --fragment: %s", p[2]);
6492 else if (
streq(p[0],
"mtu-disc") && p[1] && !p[2])
6497 else if (
streq(p[0],
"mtu-test") && !p[1])
6502 else if (
streq(p[0],
"nice") && p[1] && !p[2])
6507 else if (
streq(p[0],
"rcvbuf") && p[1] && !p[2])
6512 else if (
streq(p[0],
"sndbuf") && p[1] && !p[2])
6517 else if (
streq(p[0],
"mark") && p[1] && !p[2])
6519#if defined(TARGET_LINUX)
6524 else if (
streq(p[0],
"socket-flags"))
6530 if (
streq(p[j],
"TCP_NODELAY"))
6536 msg(msglevel,
"unknown socket flag: %s", p[j]);
6541 else if (
streq(p[0],
"bind-dev") && p[1])
6547 else if (
streq(p[0],
"txqueuelen") && p[1] && !p[2])
6553 msg(msglevel,
"--txqueuelen not supported on this OS");
6557 else if (
streq(p[0],
"shaper") && p[1] && !p[2])
6565 else if (
streq(p[0],
"port") && p[1] && !p[2])
6570 else if (
streq(p[0],
"lport") && p[1] && !p[2])
6575 if (!
streq(p[1],
"0"))
6581 else if (
streq(p[0],
"rport") && p[1] && !p[2])
6586 else if (
streq(p[0],
"bind") && !p[2])
6590 if (p[1] &&
streq(p[1],
"ipv6only"))
6595 else if (
streq(p[0],
"nobind") && !p[1])
6600 else if (
streq(p[0],
"fast-io") && !p[1])
6605 else if (
streq(p[0],
"inactive") && p[1] && !p[3])
6615 "WARNING: '--inactive' with a 'bytes' value"
6616 " >2 Gbyte was silently ignored in older versions. If "
6617 " your VPN exits unexpectedly with 'Inactivity timeout'"
6618 " in %d seconds, revisit this value.",
6623 else if (
streq(p[0],
"session-timeout") && p[1] && !p[2])
6628 else if (
streq(p[0],
"proto") && p[1] && !p[2])
6637 msg(msglevel,
"Bad protocol: '%s'. Allowed protocols with --proto option: %s", p[1],
6644 else if (
streq(p[0],
"proto-force") && p[1] && !p[2])
6649 if (proto_force < 0)
6651 msg(msglevel,
"Bad --proto-force protocol: '%s'", p[1]);
6656 else if (
streq(p[0],
"http-proxy") && p[1] && !p[5])
6665 msg(msglevel,
"http-proxy port number not defined");
6679 if (
streq(p[3],
"auto"))
6683 else if (
streq(p[3],
"auto-nct"))
6703 else if (
streq(p[0],
"http-proxy-user-pass") && p[1])
6711 else if (
streq(p[0],
"http-proxy-retry") ||
streq(p[0],
"socks-proxy-retry"))
6714 msg(
M_WARN,
"DEPRECATED OPTION: http-proxy-retry and socks-proxy-retry: "
6715 "In OpenVPN 2.4 proxy connection retries are handled like regular connections. "
6716 "Use connect-retry-max 1 to get a similar behavior as before.");
6718 else if (
streq(p[0],
"http-proxy-timeout") && p[1] && !p[2])
6722 "DEPRECATED OPTION: http-proxy-timeout: In OpenVPN 2.4 the timeout until a connection to a "
6723 "server is established is managed with a single timeout set by connect-timeout");
6725 else if (
streq(p[0],
"http-proxy-option") && p[1] && !p[4])
6732 if (
streq(p[1],
"VERSION") && p[2] && !p[3])
6736 else if (
streq(p[1],
"AGENT") && p[2] && !p[3])
6740 else if ((
streq(p[1],
"EXT1") ||
streq(p[1],
"EXT2") ||
streq(p[1],
"CUSTOM-HEADER"))
6759 msg(msglevel,
"Cannot use more than %d http-proxy-option CUSTOM-HEADER : '%s'",
6766 custom_header->
name = p[2];
6767 custom_header->
content = p[3];
6772 msg(msglevel,
"Bad http-proxy-option or missing or extra parameter: '%s'", p[1]);
6775 else if (
streq(p[0],
"socks-proxy") && p[1] && !p[4])
6790 else if (
streq(p[0],
"keepalive") && p[1] && p[2] && !p[3])
6796 else if (
streq(p[0],
"ping") && p[1] && !p[2])
6801 else if (
streq(p[0],
"ping-exit") && p[1] && !p[2])
6807 else if (
streq(p[0],
"ping-restart") && p[1] && !p[2])
6813 else if (
streq(p[0],
"ping-timer-rem") && !p[1])
6818 else if (
streq(p[0],
"explicit-exit-notify") && !p[2])
6830 else if (
streq(p[0],
"persist-tun") && !p[1])
6835 else if (
streq(p[0],
"persist-key") && !p[1])
6838 msg(
M_WARN,
"DEPRECATED: --persist-key option ignored. "
6839 "Keys are now always persisted across restarts. ");
6841 else if (
streq(p[0],
"persist-local-ip") && !p[1])
6846 else if (
streq(p[0],
"persist-remote-ip") && !p[1])
6851 else if (
streq(p[0],
"client-nat") && p[1] && p[2] && p[3] && p[4] && !p[5])
6857 else if (
streq(p[0],
"route-table") && p[1] && !p[2])
6860 msg(
M_WARN,
"NOTE: --route-table is supported only on Linux when SITNL is built-in");
6865 else if (
streq(p[0],
"route") && p[1] && !p[5])
6875 else if (
streq(p[0],
"route-ipv6") && p[1] && !p[4])
6885 else if (
streq(p[0],
"max-routes") && !p[2])
6887 msg(
M_WARN,
"DEPRECATED OPTION: --max-routes option ignored. "
6888 "The number of routes is unlimited as of OpenVPN 2.4. "
6889 "This option will be removed in a future version, "
6890 "please remove it from your configuration.");
6892 else if (
streq(p[0],
"route-gateway") && p[1] && !p[2])
6895 if (
streq(p[1],
"dhcp"))
6908 msg(msglevel,
"route-gateway parm '%s' must be a valid address", p[1]);
6913 else if (
streq(p[0],
"route-ipv6-gateway") && p[1] && !p[2])
6921 msg(msglevel,
"route-ipv6-gateway parm '%s' must be a valid address", p[1]);
6925 else if (
streq(p[0],
"route-metric") && p[1] && !p[2])
6930 else if (
streq(p[0],
"route-delay") && !p[3])
6947 else if (
streq(p[0],
"route-up") && p[1])
6956 else if (
streq(p[0],
"route-pre-down") && p[1])
6965 else if (
streq(p[0],
"route-noexec") && !p[1])
6970 else if (
streq(p[0],
"route-nopull") && !p[1])
6975 else if (
streq(p[0],
"pull-filter") && p[1] && p[2] && !p[3])
6981 if (strcmp(
"accept", p[1]) == 0)
6985 else if (strcmp(
"ignore", p[1]) == 0)
6989 else if (strcmp(
"reject", p[1]) == 0)
6995 msg(msglevel,
"Unknown --pull-filter type: %s", p[1]);
6999 f->
size = strlen(p[2]);
7001 else if (
streq(p[0],
"allow-pull-fqdn") && !p[1])
7006 else if (
streq(p[0],
"redirect-gateway") ||
streq(p[0],
"redirect-private"))
7014 msg(
M_WARN,
"WARNING: You have specified redirect-gateway and "
7015 "redirect-private at the same time (or the same option "
7016 "multiple times). This is not well supported and may lead to "
7017 "unexpected results");
7022 if (
streq(p[0],
"redirect-gateway"))
7026 for (j = 1; j <
MAX_PARMS && p[j] != NULL; ++j)
7028 if (
streq(p[j],
"local"))
7032 else if (
streq(p[j],
"autolocal"))
7036 else if (
streq(p[j],
"def1"))
7040 else if (
streq(p[j],
"bypass-dhcp"))
7044 else if (
streq(p[j],
"bypass-dns"))
7048 else if (
streq(p[j],
"block-local"))
7052 else if (
streq(p[j],
"ipv6"))
7057 else if (
streq(p[j],
"!ipv4"))
7063 msg(msglevel,
"unknown --%s flag: %s", p[0], p[j]);
7082 else if (
streq(p[0],
"block-ipv6") && !p[1])
7087 else if (
streq(p[0],
"remote-random-hostname") && !p[1])
7092 else if (
streq(p[0],
"setenv") && p[1] && !p[3])
7095 if (
streq(p[1],
"REMOTE_RANDOM_HOSTNAME") && !p[2])
7099 else if (
streq(p[1],
"GENERIC_CONFIG"))
7101 msg(msglevel,
"this is a generic configuration and cannot directly be used");
7104 else if (
streq(p[1],
"PUSH_PEER_INFO") && !p[2])
7108 else if (
streq(p[1],
"SERVER_POLL_TIMEOUT") && p[2])
7114 if (
streq(p[1],
"FORWARD_COMPATIBLE") && p[2] &&
streq(p[2],
"1"))
7122 else if (
streq(p[0],
"compat-mode") && p[1] && !p[3])
7124 unsigned int major, minor, patch;
7125 if (!(sscanf(p[1],
"%u.%u.%u", &major, &minor, &patch) == 3))
7127 msg(msglevel,
"cannot parse version number for --compat-mode: %s", p[1]);
7133 else if (
streq(p[0],
"setenv-safe") && p[1] && !p[3])
7138 else if (
streq(p[0],
"script-security") && p[1] && !p[2])
7147 else if (
streq(p[0],
"mssfix") && !p[3])
7177 if (p[2] &&
streq(p[2],
"mtu"))
7181 else if (p[2] &&
streq(p[2],
"fixed"))
7187 msg(msglevel,
"Unknown parameter to --mssfix: %s", p[2]);
7190 else if (
streq(p[0],
"disable-occ") && !p[1])
7195 else if (
streq(p[0],
"server") && p[1] && p[2] && !p[4])
7204 if (error || !network || !netmask)
7206 msg(msglevel,
"error parsing --server parameters");
7215 if (
streq(p[3],
"nopool"))
7221 msg(msglevel,
"error parsing --server: %s is not a recognized flag", p[3]);
7226 else if (
streq(p[0],
"server-ipv6") && p[1] && !p[2])
7229 struct in6_addr network;
7230 unsigned int netbits = 0;
7235 msg(msglevel,
"error parsing --server-ipv6 parameter");
7238 if (netbits < 64 || netbits > 124)
7240 msg(msglevel,
"--server-ipv6 settings: network must be between /64 and /124 (not /%d)",
7249 else if (
streq(p[0],
"server-bridge") && p[1] && p[2] && p[3] && p[4] && !p[5])
7253 in_addr_t ip, netmask, pool_start, pool_end;
7260 if (error || !ip || !netmask || !pool_start || !pool_end)
7262 msg(msglevel,
"error parsing --server-bridge parameters");
7271 else if (
streq(p[0],
"server-bridge") && p[1] &&
streq(p[1],
"nogw") && !p[2])
7277 else if (
streq(p[0],
"server-bridge") && !p[1])
7282 else if (
streq(p[0],
"push") && p[1] && !p[2])
7287 else if (
streq(p[0],
"push-reset") && !p[1])
7292 else if (
streq(p[0],
"push-remove") && p[1] && !p[2])
7298 else if (
streq(p[0],
"ifconfig-pool") && p[1] && p[2] && !p[4])
7313 msg(msglevel,
"error parsing --ifconfig-pool parameters");
7329 else if (
streq(p[0],
"ifconfig-pool-persist") && p[1] && !p[3])
7338 else if (
streq(p[0],
"ifconfig-ipv6-pool") && p[1] && !p[2])
7341 struct in6_addr network;
7342 unsigned int netbits = 0;
7347 msg(msglevel,
"error parsing --ifconfig-ipv6-pool parameters");
7350 if (netbits < 64 || netbits > 124)
7353 "--ifconfig-ipv6-pool settings: network must be between /64 and /124 (not /%d)",
7362 else if (
streq(p[0],
"hash-size") && p[1] && p[2] && !p[3])
7368 || !
atoi_constrained(p[2], &
virtual,
"hash-size virtual", 1, INT_MAX, msglevel))
7375 else if (
streq(p[0],
"connect-freq") && p[1] && p[2] && !p[3])
7380 if (!
atoi_constrained(p[1], &cf_max,
"connect-freq n", 1, INT_MAX, msglevel)
7381 || !
atoi_constrained(p[2], &cf_per,
"connect-freq seconds", 1, INT_MAX, msglevel))
7388 else if (
streq(p[0],
"connect-freq-initial") && p[1] && p[2] && !p[3])
7393 if (!
atoi_constrained(p[1], &cf_max,
"connect-freq-initial n", 1, INT_MAX, msglevel)
7394 || !
atoi_constrained(p[2], &cf_per,
"connect-freq-initial seconds", 1, INT_MAX, msglevel))
7401 else if (
streq(p[0],
"max-clients") && p[1] && !p[2])
7409 else if (
streq(p[0],
"max-routes-per-client") && p[1] && !p[2])
7414 else if (
streq(p[0],
"client-cert-not-required") && !p[1])
7418 "REMOVED OPTION: --client-cert-not-required, use '--verify-client-cert none' instead");
7420 else if (
streq(p[0],
"verify-client-cert") && !p[2])
7429 if (
streq(p[1],
"none"))
7433 else if (
streq(p[1],
"optional"))
7437 else if (!
streq(p[1],
"require"))
7440 "parameter to --verify-client-cert must be 'none', 'optional' or 'require'");
7445 else if (
streq(p[0],
"username-as-common-name") && !p[1])
7450 else if (
streq(p[0],
"auth-user-pass-optional") && !p[1])
7455 else if (
streq(p[0],
"opt-verify") && !p[1])
7458 msg(
M_INFO,
"DEPRECATED OPTION: --opt-verify was removed in OpenVPN 2.7.");
7460 else if (
streq(p[0],
"auth-user-pass-verify") && p[1])
7469 if (
streq(p[2],
"via-env"))
7473 else if (
streq(p[2],
"via-file"))
7480 "second parm to --auth-user-pass-verify must be 'via-env' or 'via-file'");
7487 "--auth-user-pass-verify requires a second parameter ('via-env' or 'via-file')");
7491 "auth-user-pass-verify",
true);
7493 else if (
streq(p[0],
"auth-gen-token"))
7499 for (
int i = 2; i <
MAX_PARMS && p[i] != NULL; i++)
7506 else if (
streq(p[i],
"external-auth"))
7512 msg(msglevel,
"Invalid argument to auth-gen-token: %s (%d)", p[i], i);
7516 else if (
streq(p[0],
"auth-gen-token-secret") && p[1] && !p[2])
7522 else if (
streq(p[0],
"client-connect") && p[1])
7531 else if (
streq(p[0],
"client-crresponse") && p[1])
7541 else if (
streq(p[0],
"client-disconnect") && p[1])
7551 else if (
streq(p[0],
"learn-address") && p[1])
7560 else if (
streq(p[0],
"tmp-dir") && p[1] && !p[2])
7565 else if (
streq(p[0],
"client-config-dir") && p[1] && !p[2])
7570 else if (
streq(p[0],
"ccd-exclusive") && !p[1])
7575 else if (
streq(p[0],
"bcast-buffers") && p[1] && !p[2])
7580 else if (
streq(p[0],
"tcp-queue-limit") && p[1] && !p[2])
7586 else if (
streq(p[0],
"port-share") && p[1] && p[2] && !p[4])
7589 options->port_share_host = p[1];
7590 options->port_share_port = p[2];
7591 options->port_share_journal_dir = p[3];
7594 else if (
streq(p[0],
"client-to-client") && !p[1])
7599 else if (
streq(p[0],
"duplicate-cn") && !p[1])
7604 else if (
streq(p[0],
"iroute") && p[1] && !p[3])
7609 else if (
streq(p[0],
"iroute-ipv6") && p[1] && !p[2])
7614 else if (
streq(p[0],
"ifconfig-push") && p[1] && p[2] && !p[4])
7621 if (local && remote_netmask)
7634 msg(msglevel,
"cannot parse --ifconfig-push addresses");
7638 else if (
streq(p[0],
"ifconfig-push-constraint") && p[1] && p[2] && !p[3])
7645 if (network && netmask)
7653 msg(msglevel,
"cannot parse --ifconfig-push-constraint addresses");
7657 else if (
streq(p[0],
"ifconfig-ipv6-push") && p[1] && !p[3])
7659 struct in6_addr local, remote;
7660 unsigned int netbits;
7666 msg(msglevel,
"cannot parse --ifconfig-ipv6-push addresses");
7674 msg(msglevel,
"cannot parse --ifconfig-ipv6-push addresses");
7684 "second argument to --ifconfig-ipv6-push missing and no global --ifconfig-ipv6 address set");
7695 else if (
streq(p[0],
"disable") && !p[1])
7700 else if (
streq(p[0],
"override-username") && p[1] && !p[2])
7706 "override-username exceeds the maximum length of %d "
7719 else if (
streq(p[0],
"tcp-nodelay") && !p[1])
7724 else if (
streq(p[0],
"stale-routes-check") && p[1] && !p[3])
7726 int ageing_time, check_interval;
7729 if (!
atoi_constrained(p[1], &ageing_time,
"stale-routes-check age", 1, INT_MAX, msglevel))
7737 "stale-routes-check interval", 1, INT_MAX, msglevel))
7744 check_interval = ageing_time;
7751 else if (
streq(p[0],
"client") && !p[1])
7756 else if (
streq(p[0],
"pull") && !p[1])
7761 else if (
streq(p[0],
"push-continuation") && p[1] && !p[2])
7766 else if (
streq(p[0],
"auth-user-pass") && !p[2])
7779 else if (
streq(p[0],
"auth-retry") && p[1] && !p[2])
7784#ifdef ENABLE_MANAGEMENT
7785 else if (
streq(p[0],
"static-challenge") && p[1] && p[2] && !p[4])
7793 if (p[3] &&
streq(p[3],
"concat"))
7797 else if (p[3] && !
streq(p[3],
"scrv1"))
7799 msg(msglevel,
"--static-challenge: unknown format indicator '%s'", p[3]);
7804 else if (
streq(p[0],
"msg-channel") && p[1])
7808 HANDLE process = GetCurrentProcess();
7809 HANDLE handle = (HANDLE)((intptr_t)atoll(p[1]));
7811 DUPLICATE_CLOSE_SOURCE | DUPLICATE_SAME_ACCESS))
7813 msg(msglevel,
"could not duplicate service pipe handle");
7818 msg(msglevel,
"--msg-channel is only supported on Windows");
7823 else if (
streq(p[0],
"win-sys") && p[1] && !p[2])
7826 if (
streq(p[1],
"env"))
7828 msg(
M_INFO,
"NOTE: --win-sys env is default from OpenVPN 2.3. "
7829 "This entry will now be ignored. "
7830 "Please remove this entry from your configuration file.");
7837 else if (
streq(p[0],
"route-method") && p[1] && !p[2])
7840 if (
streq(p[1],
"adaptive"))
7844 else if (
streq(p[1],
"ipapi"))
7848 else if (
streq(p[1],
"exe"))
7854 msg(msglevel,
"--route method must be 'adaptive', 'ipapi', or 'exe'");
7858 else if (
streq(p[0],
"ip-win32") && p[1] && !p[4])
7867 msg(msglevel,
"Bad --ip-win32 method: '%s'. Allowed methods: %s", p[1],
7881 if (!
streq(p[2],
"default"))
7885 if (!
atoi_constrained(p[2], &offset,
"ip-win32 offset", -256, 256, msglevel))
7896 "ip-win32 lease time", 30, INT_MAX, msglevel))
7907 else if (
streq(p[0],
"dns-updown") && p[1])
7915 if (
streq(p[1],
"disable"))
7920 else if (
streq(p[1],
"force"))
7925 dns->
updown = DEFAULT_DNS_UPDOWN;
7940 else if (
streq(p[0],
"dns") && p[1])
7948 else if (
streq(p[0],
"dhcp-option") && p[1])
7951#if defined(_WIN32) || defined(TARGET_ANDROID)
7956 bool dhcp_optional =
false;
7958 if ((
streq(p[1],
"DOMAIN") ||
streq(p[1],
"ADAPTER_DOMAIN_SUFFIX")) && p[2] && !p[3])
7962 msg(msglevel,
"--dhcp-option %s contains invalid characters", p[1]);
7966 dhcp->domain = p[2];
7967 dhcp_optional =
true;
7969 else if (
streq(p[1],
"DOMAIN-SEARCH") && p[2] && !p[3])
7973 msg(msglevel,
"--dhcp-option %s contains invalid characters", p[1]);
7979 dhcp->domain_search_list[
dhcp->domain_search_list_len++] = p[2];
7983 msg(msglevel,
"--dhcp-option %s: maximum of %d search entries can be specified",
7986 dhcp_optional =
true;
7988 else if ((
streq(p[1],
"DNS") ||
streq(p[1],
"DNS6")) && p[2] && !p[3]
7991 if (strstr(p[2],
":"))
7998 dhcp_optional =
true;
8001#if defined(_WIN32) || defined(TARGET_ANDROID)
8002 else if (
streq(p[1],
"NBS") && p[2] && !p[3])
8007 else if (
streq(p[1],
"NBT") && p[2] && !p[3])
8010 if (!(t == 1 || t == 2 || t == 4 || t == 8))
8012 msg(msglevel,
"--dhcp-option NBT: parameter (%d) must be 1, 2, 4, or 8", t);
8018 else if (
streq(p[1],
"WINS") && p[2] && !p[3])
8023 else if (
streq(p[1],
"NTP") && p[2] && !p[3])
8028 else if (
streq(p[1],
"NBDD") && p[2] && !p[3])
8033 else if (
streq(p[1],
"DISABLE-NBT") && !p[2])
8038#if defined(TARGET_ANDROID)
8039 else if (
streq(p[1],
"PROXY_HTTP") && p[3] && !p[4])
8042 o->http_proxy = p[2];
8047 msg(msglevel,
"--dhcp-option: unknown option type '%s' or missing or unknown parameter",
8052 setenv_foreign_option(
options, p[1], p[2],
es);
8057#if defined(_WIN32) || defined(TARGET_ANDROID)
8063 else if (
streq(p[0],
"show-adapters") && !p[1])
8069 else if (
streq(p[0],
"show-net") && !p[1])
8076 else if (
streq(p[0],
"show-net-up") && !p[1])
8081 else if (
streq(p[0],
"tap-sleep") && p[1] && !p[2])
8089 else if (
streq(p[0],
"dhcp-renew") && !p[1])
8094 else if (
streq(p[0],
"dhcp-pre-release") && !p[1])
8100 else if (
streq(p[0],
"dhcp-release") && !p[1])
8102 msg(
M_WARN,
"Obsolete option --dhcp-release detected. This is now on by default");
8104 else if (
streq(p[0],
"dhcp-internal") && p[1] && !p[2])
8106 unsigned int adapter_index;
8109 adapter_index =
atou(p[1]);
8121 else if (
streq(p[0],
"register-dns") && !p[1])
8126 else if (
streq(p[0],
"block-outside-dns") && !p[1])
8131 else if (
streq(p[0],
"rdns-internal") && !p[1])
8147 else if (
streq(p[0],
"show-valid-subnets") && !p[1])
8153 else if (
streq(p[0],
"pause-exit") && !p[1])
8158 else if (
streq(p[0],
"service") && p[1] && !p[3])
8167 else if (
streq(p[0],
"allow-nonadmin") && !p[2])
8173 else if (
streq(p[0],
"user") && p[1] && !p[2])
8176 msg(
M_WARN,
"NOTE: --user option is not implemented on Windows");
8178 else if (
streq(p[0],
"group") && p[1] && !p[2])
8181 msg(
M_WARN,
"NOTE: --group option is not implemented on Windows");
8184 else if (
streq(p[0],
"user") && p[1] && !p[2])
8189 else if (
streq(p[0],
"group") && p[1] && !p[2])
8194 else if (
streq(p[0],
"dhcp-option") && p[1] && !p[3])
8197 setenv_foreign_option(
options, p[1], p[2],
es);
8199 else if (
streq(p[0],
"route-method") && p[1] && !p[2])
8205#if PASSTOS_CAPABILITY
8206 else if (
streq(p[0],
"passtos") && !p[1])
8212 else if (
streq(p[0],
"allow-compression") && p[1] && !p[2])
8216 if (
streq(p[1],
"no"))
8221 msg(msglevel,
"'--allow-compression no' conflicts with "
8222 " enabling compression");
8229 "Cannot set allow-compression to '%s' "
8230 "after set to 'no'",
8234 else if (
streq(p[1],
"asym"))
8238 else if (
streq(p[1],
"yes"))
8241 "DEPRECATED OPTION: \"--allow-compression yes\" has been removed. "
8242 "We will use \"asym\" mode instead. See the manual page for more information.");
8249 "bad allow-compression option: %s -- "
8250 "must be 'yes', 'no', or 'asym'",
8255 else if (
streq(p[0],
"comp-lzo") && !p[2])
8265 if (
streq(p[1],
"no"))
8273 else if (!(
streq(p[1],
"yes") ||
streq(p[1],
"adaptive")))
8275 msg(msglevel,
"bad comp-lzo option: %s -- must be 'yes', 'no', or 'adaptive'",
8282 else if (
streq(p[0],
"comp-noadapt") && !p[1])
8286 else if (
streq(p[0],
"compress") && !p[2])
8289 const char *alg =
"stub";
8295 if (
streq(alg,
"stub"))
8300 else if (
streq(alg,
"stub-v2"))
8305 else if (
streq(alg,
"migrate"))
8310 else if (
streq(alg,
"lzo"))
8315 else if (
streq(alg,
"lz4"))
8320 else if (
streq(alg,
"lz4-v2"))
8326 msg(msglevel,
"bad comp option: %s", alg);
8332 else if (
streq(p[0],
"show-ciphers") && !p[1])
8337 else if (
streq(p[0],
"show-digests") && !p[1])
8342 else if (
streq(p[0],
"show-engines") && !p[1])
8347 else if (
streq(p[0],
"key-direction") && p[1] && !p[2])
8354 if (key_direction >= 0)
8370 else if (
streq(p[0],
"secret") && p[1] && !p[3])
8372 msg(
M_WARN,
"DEPRECATED OPTION: The option --secret is deprecated.");
8376 if (!is_inline && p[2])
8381 if (key_direction >= 0)
8391 else if (
streq(p[0],
"allow-deprecated-insecure-static-crypto"))
8396 else if (
streq(p[0],
"genkey") && !p[4])
8406 if (
streq(p[1],
"secret") ||
streq(p[1],
"tls-auth") ||
streq(p[1],
"tls-crypt"))
8410 else if (
streq(p[1],
"tls-crypt-v2-server"))
8414 else if (
streq(p[1],
"tls-crypt-v2-client"))
8422 else if (
streq(p[1],
"auth-token"))
8428 msg(msglevel,
"unknown --genkey type: %s", p[1]);
8436 else if (
streq(p[0],
"auth") && p[1] && !p[2])
8441 else if (
streq(p[0],
"cipher") && p[1] && !p[2])
8446 else if (
streq(p[0],
"data-ciphers-fallback") && p[1] && !p[2])
8452 else if ((
streq(p[0],
"data-ciphers") ||
streq(p[0],
"ncp-ciphers")) && p[1] && !p[2])
8455 if (
streq(p[0],
"ncp-ciphers"))
8457 msg(
M_INFO,
"Note: Treating option '--ncp-ciphers' as "
8458 " '--data-ciphers' (renamed in OpenVPN 2.5).");
8462 else if (
streq(p[0],
"key-derivation") && p[1])
8467 if (
streq(p[1],
"tls-ekm"))
8473 msg(msglevel,
"Unknown key-derivation method %s", p[1]);
8476 else if (
streq(p[0],
"protocol-flags") && p[1])
8482 for (
size_t j = 1; j <
MAX_PARMS && p[j] != NULL; j++)
8484 if (
streq(p[j],
"cc-exit"))
8488 else if (
streq(p[j],
"tls-ekm"))
8492 else if (
streq(p[j],
"dyn-tls-crypt"))
8496 else if (
streq(p[j],
"aead-epoch"))
8502 msg(msglevel,
"Unknown protocol-flags flag: %s", p[j]);
8506 else if (
streq(p[0],
"force-tls-key-material-export"))
8511 else if (
streq(p[0],
"prng") && p[1] && !p[3])
8513 msg(
M_WARN,
"NOTICE: --prng option ignored (SSL library PRNG is used)");
8515 else if (
streq(p[0],
"no-replay") && !p[1])
8519 msg(
M_FATAL,
"--no-replay was removed in OpenVPN 2.7. "
8520 "Update your configuration.");
8522 else if (
streq(p[0],
"replay-window") && !p[3])
8544 msg(msglevel,
"replay-window option is missing window size parameter");
8548 else if (
streq(p[0],
"mute-replay-warnings") && !p[1])
8553 else if (
streq(p[0],
"replay-persist") && p[1] && !p[2])
8558 else if (
streq(p[0],
"test-crypto") && !p[1])
8563#ifndef ENABLE_CRYPTO_MBEDTLS
8564 else if (
streq(p[0],
"engine") && !p[2])
8577 else if (
streq(p[0],
"providers") && p[1])
8579 for (
size_t j = 1; j <
MAX_PARMS && p[j] != NULL; j++)
8584#ifdef ENABLE_PREDICTION_RESISTANCE
8585 else if (
streq(p[0],
"use-prediction-resistance") && !p[1])
8588 options->use_prediction_resistance =
true;
8591 else if (
streq(p[0],
"show-tls") && !p[1])
8596 else if ((
streq(p[0],
"show-curves") ||
streq(p[0],
"show-groups")) && !p[1])
8601 else if (
streq(p[0],
"ecdh-curve") && p[1] && !p[2])
8604 msg(
M_WARN,
"Consider setting groups/curves preference with "
8605 "tls-groups instead of forcing a specific curve with "
8609 else if (
streq(p[0],
"tls-server") && !p[1])
8614 else if (
streq(p[0],
"tls-client") && !p[1])
8619 else if (
streq(p[0],
"ca") && p[1] && !p[2])
8625#ifndef ENABLE_CRYPTO_MBEDTLS
8626 else if (
streq(p[0],
"capath") && p[1] && !p[2])
8632 else if (
streq(p[0],
"dh") && p[1] && !p[2])
8638 else if (
streq(p[0],
"cert") && p[1] && !p[2])
8644 else if (
streq(p[0],
"extra-certs") && p[1] && !p[2])
8650 else if ((
streq(p[0],
"verify-hash") && p[1] && !p[3])
8651 || (
streq(p[0],
"peer-fingerprint") && p[1] && !p[2]))
8655 int verify_hash_depth = 0;
8656 if (
streq(p[0],
"verify-hash"))
8658 msg(
M_WARN,
"DEPRECATED OPTION: The option --verify-hash is deprecated. "
8659 "You should switch to the either use the level 1 certificate as "
8660 "--ca option, use --tls-verify or use --peer-fingerprint");
8662 verify_hash_depth = 1;
8672 "ERROR: Setting %s not allowed. --verify-hash and"
8673 " --peer-fingerprint are mutually exclusive",
8678 if (
streq(p[0],
"verify-hash"))
8680 if ((!p[2] && !is_inline) || (p[2] &&
streq(p[2],
"SHA1")))
8685 else if (p[2] && !
streq(p[2],
"SHA256"))
8688 "invalid or unsupported hashing algorithm: %s "
8689 "(only SHA1 and SHA256 are supported)",
8709 while (listend->
next)
8711 listend = listend->
next;
8713 listend->
next = newlist;
8716#if defined(ENABLE_CRYPTOAPI) && defined(HAVE_XKEY_PROVIDER)
8717 else if (
streq(p[0],
"cryptoapicert") && p[1] && !p[2])
8723 else if (
streq(p[0],
"key") && p[1] && !p[2])
8729 else if (
streq(p[0],
"tls-version-min") && p[1] && !p[3])
8735 msg(msglevel,
"unknown tls-version-min parameter: %s", p[1]);
8739#ifdef ENABLE_CRYPTO_MBEDTLS
8742 msg(
M_WARN,
"--tls-version-min %s is not supported by mbedtls, using 1.2", p[1]);
8750 else if (
streq(p[0],
"tls-version-max") && p[1] && !p[2])
8756 msg(msglevel,
"unknown tls-version-max parameter: %s", p[1]);
8762#ifndef ENABLE_CRYPTO_MBEDTLS
8763 else if (
streq(p[0],
"pkcs12") && p[1] && !p[2])
8770 else if (
streq(p[0],
"askpass") && !p[2])
8782 else if (
streq(p[0],
"auth-nocache") && !p[1])
8787 else if (
streq(p[0],
"auth-token") && p[1] && !p[2])
8791#ifdef ENABLE_MANAGEMENT
8798 else if (
streq(p[0],
"auth-token-user") && p[1] && !p[2])
8803 else if (
streq(p[0],
"single-session") && !p[1])
8808 else if (
streq(p[0],
"push-peer-info") && !p[1])
8813 else if (
streq(p[0],
"tls-exit") && !p[1])
8818 else if (
streq(p[0],
"tls-cipher") && p[1] && !p[2])
8823 else if (
streq(p[0],
"tls-cert-profile") && p[1] && !p[2])
8828 else if (
streq(p[0],
"tls-ciphersuites") && p[1] && !p[2])
8833 else if (
streq(p[0],
"tls-groups") && p[1] && !p[2])
8838 else if (
streq(p[0],
"crl-verify") && p[1] && ((p[2] &&
streq(p[2],
"dir")) || !p[2]))
8841 if (p[2] &&
streq(p[2],
"dir"))
8848 else if (
streq(p[0],
"tls-verify") && p[1])
8858 else if (
streq(p[0],
"tls-export-cert") && p[1] && !p[2])
8863 else if (
streq(p[0],
"compat-names"))
8866 msg(msglevel,
"--compat-names was removed in OpenVPN 2.5. "
8867 "Update your configuration.");
8870 else if (
streq(p[0],
"no-name-remapping") && !p[1])
8873 msg(msglevel,
"--no-name-remapping was removed in OpenVPN 2.5. "
8874 "Update your configuration.");
8877 else if (
streq(p[0],
"verify-x509-name") && p[1] && strlen(p[1]) && !p[3])
8883 if (
streq(p[2],
"subject"))
8887 else if (
streq(p[2],
"name"))
8891 else if (
streq(p[2],
"name-prefix"))
8897 msg(msglevel,
"unknown X.509 name type: %s", p[2]);
8904 else if (
streq(p[0],
"ns-cert-type") && p[1] && !p[2])
8906#ifdef ENABLE_CRYPTO_MBEDTLS
8907 msg(msglevel,
"--ns-cert-type is not available with mbedtls.");
8911 if (
streq(p[1],
"server"))
8915 else if (
streq(p[1],
"client"))
8921 msg(msglevel,
"--ns-cert-type must be 'client' or 'server'");
8926 else if (
streq(p[0],
"remote-cert-ku"))
8931 for (j = 1; j <
MAX_PARMS && p[j] != NULL; ++j)
8941 else if (
streq(p[0],
"remote-cert-eku") && p[1] && !p[2])
8946 else if (
streq(p[0],
"remote-cert-tls") && p[1] && !p[2])
8950 if (
streq(p[1],
"server"))
8955 else if (
streq(p[1],
"client"))
8962 msg(msglevel,
"--remote-cert-tls must be 'client' or 'server'");
8966 else if (
streq(p[0],
"tls-timeout") && p[1] && !p[2])
8971 else if (
streq(p[0],
"reneg-bytes") && p[1] && !p[2])
8979 else if (
streq(p[0],
"reneg-pkts") && p[1] && !p[2])
8987 else if (
streq(p[0],
"reneg-sec") && p[1] && !p[3])
8996 else if (
streq(p[0],
"hand-window") && p[1] && !p[2])
9001 else if (
streq(p[0],
"tran-window") && p[1] && !p[2])
9006 else if (
streq(p[0],
"tls-auth") && p[1] && !p[3])
9008 int key_direction = -1;
9017 if (!is_inline && p[2])
9020 if (key_direction < 0)
9033 if (!is_inline && p[2])
9036 if (key_direction < 0)
9044 else if (
streq(p[0],
"tls-crypt") && p[1] && !p[3])
9058 else if (
streq(p[0],
"tls-crypt-v2") && p[1] && !p[3])
9072 if (p[2] &&
streq(p[2],
"force-cookie"))
9076 else if (p[2] &&
streq(p[2],
"allow-noncookie"))
9082 msg(msglevel,
"Unsupported tls-crypt-v2 argument: %s", p[2]);
9085 else if (
streq(p[0],
"tls-crypt-v2-verify") && p[1] && !p[2])
9090 else if (
streq(p[0],
"tls-crypt-v2-max-age") && p[1])
9098 else if (
streq(p[0],
"x509-track") && p[1] && !p[2])
9103#ifdef ENABLE_X509ALTUSERNAME
9104 else if (
streq(p[0],
"x509-username-field") && p[1])
9107 for (
size_t j = 1; j <
MAX_PARMS && p[j] != NULL; ++j)
9111 if (strncmp(
"ext:", s, 4) == 0 && !x509_username_field_ext_supported(s + 4))
9113 msg(msglevel,
"Unsupported x509-username-field extension: %s", s);
9115 options->x509_username_field[j - 1] = p[j];
9120 else if (
streq(p[0],
"show-pkcs11-ids") && !p[3])
9122 char *provider = p[1];
9123 bool cert_private = (p[2] == NULL ? false : (
atoi_warn(p[2], msglevel) != 0));
9125#ifdef DEFAULT_PKCS11_MODULE
9128 provider = DEFAULT_PKCS11_MODULE;
9133 long i = strtol(provider, &endp, 10);
9139 provider = DEFAULT_PKCS11_MODULE;
9146 msg(msglevel,
"--show-pkcs11-ids requires a provider parameter");
9153 show_pkcs11_ids(provider, cert_private);
9156 else if (
streq(p[0],
"pkcs11-providers") && p[1])
9162 for (j = 1; j <
MAX_PARMS && p[j] != NULL; ++j)
9164 options->pkcs11_providers[j - 1] = p[j];
9167 else if (
streq(p[0],
"pkcs11-protected-authentication"))
9173 for (j = 1; j <
MAX_PARMS && p[j] != NULL; ++j)
9175 options->pkcs11_protected_authentication[j - 1] =
9179 else if (
streq(p[0],
"pkcs11-private-mode") && p[1])
9185 for (j = 1; j <
MAX_PARMS && p[j] != NULL; ++j)
9187 sscanf(p[j],
"%x", &(
options->pkcs11_private_mode[j - 1]));
9190 else if (
streq(p[0],
"pkcs11-cert-private"))
9196 for (j = 1; j <
MAX_PARMS && p[j] != NULL; ++j)
9201 else if (
streq(p[0],
"pkcs11-pin-cache") && p[1] && !p[2])
9206 else if (
streq(p[0],
"pkcs11-id") && p[1] && !p[2])
9211 else if (
streq(p[0],
"pkcs11-id-management") && !p[1])
9214 options->pkcs11_id_management =
true;
9217 else if (
streq(p[0],
"rmtun") && !p[1])
9223 else if (
streq(p[0],
"mktun") && !p[1])
9229 else if (
streq(p[0],
"peer-id") && p[1] && !p[2])
9235 else if (
streq(p[0],
"keying-material-exporter") && p[1] && p[2])
9239 if (strncmp(p[1],
"EXPORTER", 8))
9241 msg(msglevel,
"Keying material exporter label must begin with "
9252 p[0], 16, 4095, msglevel))
9259 else if (
streq(p[0],
"allow-recursive-routing") && !p[1])
9264 else if (
streq(p[0],
"vlan-tagging") && !p[1])
9269 else if (
streq(p[0],
"vlan-accept") && p[1] && !p[2])
9272 if (
streq(p[1],
"tagged"))
9276 else if (
streq(p[1],
"untagged"))
9280 else if (
streq(p[1],
"all"))
9286 msg(msglevel,
"--vlan-accept must be 'tagged', 'untagged' or 'all'");
9290 else if (
streq(p[0],
"vlan-pvid") && p[1] && !p[2])
9304 msglvl_t msglevel_unknown = msglevel_fc;
9311 msglevel_unknown =
M_WARN;
9317 msg(msglevel_unknown,
9318 "Unrecognized option or missing or extra parameter(s) in %s:%d: %s (%s)", file,
9319 line, p[0], PACKAGE_VERSION);
9323 msg(msglevel_unknown,
"Unrecognized option or missing or extra parameter(s): --%s (%s)",
9324 p[0], PACKAGE_VERSION);
9331#if defined(__GNUC__) || defined(__clang__)
9332#pragma GCC diagnostic pop
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...
void argv_free(struct argv *a)
Frees all memory allocations allocated by the struct argv related functions.
struct argv argv_new(void)
Allocates a new struct argv and ensures it is initialised.
void buf_clear(struct buffer *buf)
bool buf_printf(struct buffer *buf, const char *format,...)
void gc_transfer(struct gc_arena *dest, struct gc_arena *src)
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
void * gc_malloc(size_t size, bool clear, struct gc_arena *a)
struct buffer alloc_buf_gc(size_t size, struct gc_arena *gc)
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)
struct buffer alloc_buf(size_t size)
int string_array_len(const char **array)
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
bool buf_parse(struct buffer *buf, const int delim, char *line, const int size)
char * string_alloc(const char *str, struct gc_arena *gc)
struct buffer string_alloc_buf(const char *str, struct gc_arena *gc)
static void gc_detach(struct gc_arena *a)
#define ALLOC_ARRAY_GC(dptr, type, n, gc)
static bool buf_valid(const struct buffer *buf)
static void gc_init(struct gc_arena *a)
#define ALLOC_OBJ_CLEAR_GC(dptr, type, gc)
#define ALLOC_OBJ_GC(dptr, type, gc)
static void strncpynt(char *dest, const char *src, size_t maxlen)
static void gc_free(struct gc_arena *a)
static bool strprefix(const char *str, const char *prefix)
Return true iff str starts with prefix.
static struct gc_arena gc_new(void)
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)
void print_client_nat_list(const struct client_nat_option_list *list, msglvl_t msglevel)
struct client_nat_option_list * new_client_nat_list(struct gc_arena *gc)
struct client_nat_option_list * clone_client_nat_option_list(const struct client_nat_option_list *src, struct gc_arena *gc)
void copy_client_nat_option_list(struct client_nat_option_list *dest, const struct client_nat_option_list *src)
#define TLS_CHANNEL_BUF_SIZE
#define TLS_CHANNEL_MTU_MIN
bool check_compression_settings_valid(struct compress_options *info, msglvl_t msglevel)
Checks if the compression settings are valid.
#define COMP_F_ALLOW_STUB_ONLY
Only accept stub compression, even with COMP_F_ADVERTISE_STUBS_ONLY we still accept other compression...
#define COMP_F_SWAP
initial command byte is swapped with last byte in buffer to preserve payload alignment
#define COMP_ALG_LZ4
LZ4 algorithm.
#define COMP_F_ALLOW_NOCOMP_ONLY
Do not allow compression framing (breaks DCO)
#define COMP_F_ALLOW_ASYM
Compression was explicitly set to allow asymetric compression.
#define COMP_ALGV2_UNCOMPRESSED
#define COMP_ALG_STUB
support compression command byte and framing without actual compression
#define COMP_ALG_LZO
LZO algorithm.
#define COMP_F_ADVERTISE_STUBS_ONLY
tell server that we only support compression stubs
#define COMP_F_MIGRATE
push stub-v2 or comp-lzo no when we see a client with comp-lzo in occ
static bool comp_non_stub_enabled(const struct compress_options *info)
int daemon(int nochdir, int noclose)
char * dirname(char *path)
char * strsep(char **stringp, const char *delim)
void init_key_type(struct key_type *kt, const char *ciphername, const char *authname, bool tls_mode, bool warn)
Initialize a key_type structure with.
int ascii2keydirection(msglvl_t msglevel, const char *str)
const char * keydirection2ascii(int kd, bool remote, bool humanreadable)
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...
void test_crypto(struct crypto_options *co, struct frame *frame)
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...
#define CO_USE_DYNAMIC_TLS_CRYPT
Bit-flag indicating that renegotiations are using tls-crypt with a TLS-EKM derived key.
#define CO_EPOCH_DATA_KEY_FORMAT
Bit-flag indicating the epoch the data format.
#define KEY_DIRECTION_BIDIRECTIONAL
#define CO_USE_CC_EXIT_NOTIFY
Bit-flag indicating that explicit exit notifies should be sent via the control channel instead of usi...
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)
static bool dco_check_option(msglvl_t msglevel, const struct options *o)
static const char * dco_version_string(struct gc_arena *gc)
bool dns_options_verify(msglvl_t msglevel, const struct dns_options *o)
Checks validity of DNS options.
void dns_options_postprocess_pull(struct dns_options *o)
Merges pulled DNS servers with static ones into an ordered list.
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...
bool dns_domain_list_append(struct dns_domain **entry, char **domains, struct gc_arena *gc)
Appends safe DNS domain parameters to a linked list.
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.
bool dns_server_priority_parse(long *priority, const char *str, bool pulled)
Parses a string DNS server priority and validates it.
struct dns_options clone_dns_options(const struct dns_options *o, struct gc_arena *gc)
Makes a deep copy of the passed DNS options.
void show_dns_options(const struct dns_options *o)
Prints configured DNS options.
void dns_options_preprocess_pull(struct dns_options *o)
Saves and resets the server options, so that pulled ones don't mix in.
static bool dns_updown_user_set(const struct dns_options *o)
Returns whether dns-updown is user defined.
static bool dns_updown_forced(const struct dns_options *o)
Returns whether dns-updown is forced to run.
static bool validate_domain(const char *domain)
void setenv_int(struct env_set *es, const char *name, int value)
void setenv_str_i(struct env_set *es, const char *name, const char *value, const int i)
void setenv_str(struct env_set *es, const char *name, const char *value)
const char * env_set_get(const struct env_set *es, const char *name)
void setenv_str_safe(struct env_set *es, const char *name, const char *value)
bool env_set_del(struct env_set *es, const char *str)
void setenv_long_long(struct env_set *es, const char *name, long long value)
Interface functions to the internal and external multiplexers.
void helper_setdefault_topology(struct options *o)
Set –topology default depending on –mode.
void helper_tcp_nodelay(struct options *o)
void helper_client_server(struct options *o)
void helper_keepalive(struct options *o)
static int max_int(int x, int y)
static int constrain_int(int x, int min, int max)
static int tls_verify(struct openvpn_plugin_args_func_in const *args)
void management_auth_token(struct management *man, const char *token)
void management_echo(struct management *man, const char *string, const bool pull)
#define MF_FORGET_DISCONNECT
#define MF_EXTERNAL_KEY_PKCS1PAD
#define MF_EXTERNAL_KEY_PSSPAD
#define MF_EXTERNAL_KEY_NOPADDING
#define MF_QUERY_PASSWORDS
#define MF_EXTERNAL_KEY_DIGEST
#define MF_CONNECT_AS_CLIENT
struct buffer prepend_dir(const char *dir, const char *path, struct gc_arena *gc)
Prepend a directory to a path.
const char * safe_print(const char *str, struct gc_arena *gc)
int translate_mtu_discover_type_name(const char *name)
size_t calc_options_string_link_mtu(const struct options *o, const struct frame *frame)
Calculate the link-mtu to advertise to our peer.
#define TAP_MTU_EXTRA_DEFAULT
static bool learn_address_script(const struct multi_context *m, const struct multi_instance *mi, const char *op, const struct mroute_addr *addr)
static int net_ctx_init(struct context *c, openvpn_net_ctx_t *ctx)
void errors_to_stderr(void)
void open_syslog(const char *pgmname, bool stdio_to_null)
void redirect_stdout_stderr(const char *file, bool append)
void openvpn_exit(const int status)
static bool machine_readable_output
void set_suppress_timestamps(bool suppressed)
void set_machine_readable_output(bool parsable)
FILE * msg_fp(const msglvl_t flags)
bool set_debug_level(const int level, const unsigned int flags)
static bool suppress_timestamps
#define OPENVPN_EXIT_STATUS_USAGE
#define OPENVPN_EXIT_STATUS_GOOD
bool options_cmp_equal(char *actual, const char *expected)
#define RESET_OPTION_ROUTES(option_ptr, field)
static void rol6_check_alloc(struct options *options)
#define CHKACC_PRIVATE
Warn if this (private) file is group/others accessible.
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...
static bool check_file_access_chroot(const char *chroot, const int type, const char *file, const int mode, const char *opt)
static void options_postprocess_verify_ce(const struct options *options, const struct connection_entry *ce)
static void options_postprocess_mutate_ce(struct options *o, struct connection_entry *ce)
static void usage_version(void)
static in_addr_t get_ip_addr(const char *ip_string, msglvl_t msglevel, bool *error)
static struct pull_filter * alloc_pull_filter(struct options *o)
#define USAGE_VALID_SERVER_PROTOS
#define CHKACC_DIRPATH
Check for directory presence where a file should reside.
static void pre_connect_save(struct options *o)
#define CHKACC_ACPTSTDIN
If filename is stdin, it's allowed and "exists".
static void setenv_connection_entry(struct env_set *es, const struct connection_entry *e, const int i)
static int global_auth_retry
bool options_postprocess_pull(struct options *o, struct env_set *es)
void uninit_options(struct options *o)
static void dhcp_option_dns6_parse(const char *parm, struct in6_addr *dns6_list, int *len, msglvl_t msglevel)
static void connection_entry_load_re(struct connection_entry *ce, const struct remote_entry *re)
int parse_topology(const char *str, const msglvl_t msglevel)
void show_windows_version(const unsigned int flags)
#define VERIFY_PERMISSION(mask)
static const char * options_warning_extract_parm1(const char *option_string, struct gc_arena *gc_ret)
bool key_is_external(const struct options *options)
static void check_ca_required(const struct options *options)
static struct http_proxy_options * parse_http_proxy_override(const char *server, const char *port, const char *flags, struct gc_arena *gc)
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)
#define CHKACC_FILEXSTWR
If file exists, is it writable?
static void tuntap_options_postprocess_dns(struct options *o)
Postprocess DNS related settings.
static char * get_ipv6_addr_no_netbits(const char *addr, struct gc_arena *gc)
Returns newly allocated string containing address part without "/nn".
static void option_iroute_ipv6(struct options *o, const char *prefix_str, msglvl_t msglevel)
static bool check_route_option(struct options *options, char *p[], const msglvl_t msglevel, bool pull_mode)
void show_dco_version(const unsigned int flags)
void rol_check_alloc(struct options *options)
static struct local_list * alloc_local_list_if_undef(struct connection_entry *ce, struct gc_arena *gc)
#define SHOW_UNSIGNED(var)
void show_settings(const struct options *o)
static void set_user_script(struct options *options, const char **script, const char *new_script, const char *type, bool in_chroot)
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.
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 ...
static bool no_more_than_n_args(const msglvl_t msglevel, char *p[], const int max, const unsigned int flags)
static void show_dhcp_option_list(const char *name, const char *const *array, int len)
static void show_connection_entries(const struct options *o)
static void options_postprocess_mutate_le(struct connection_entry *ce, struct local_entry *le, int mode)
bool options_cmp_equal_safe(char *actual, const char *expected, size_t actual_n)
bool string_defined_equal(const char *s1, const char *s2)
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...
void options_postprocess(struct options *options, struct env_set *es)
static void show_dhcp_option_addrs(const char *name, const in_addr_t *array, int len)
const char * auth_retry_print(void)
static void show_http_proxy_options(const struct http_proxy_options *o)
static void options_postprocess_filechecks(struct options *options)
static struct remote_entry * alloc_remote_entry(struct options *options, const msglvl_t msglevel)
static void show_connection_entry(const struct connection_entry *o)
void options_warning_safe(char *actual, const char *expected, size_t actual_n)
void show_library_versions(const unsigned int flags)
void setenv_settings(struct env_set *es, const struct options *o)
#define CHKACC_ACCEPT_URI
Do not check URIs, unless they start with file:
static const char usage_message[]
static char * string_substitute(const char *src, int from, int to, struct gc_arena *gc)
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)
static struct connection_list * alloc_connection_list_if_undef(struct options *options)
static bool check_cmd_access(const char *command, const char *opt, const char *chroot)
static bool check_file_access(const int type, const char *file, const int mode, const char *opt)
static void show_p2mp_parms(const struct options *o)
static const char * pull_filter_type_name(int type)
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)
static void cnol_check_alloc(struct options *options)
static void options_postprocess_mutate(struct options *o, struct env_set *es)
void options_detach(struct options *o)
static void options_warning_safe_ml(const msglvl_t msglevel, char *actual, const char *expected, size_t actual_n)
static unsigned int atou(const char *str)
void pre_connect_restore(struct options *o, struct gc_arena *gc)
static struct pull_filter_list * alloc_pull_filter_list(struct options *o)
const char * print_topology(const int topology)
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.
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.
static bool check_dns_option(struct options *options, char *p[], const msglvl_t msglevel, bool pull_mode)
#define SHOW_STR_INLINE(var)
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)
static void options_postprocess_cipher(struct options *o)
static void options_set_backwards_compatible_options(struct options *o)
Changes default values so that OpenVPN can be compatible with the user specified version.
static void show_tuntap_options(const struct tuntap_options *o)
void init_options(struct options *o, const bool init_gc)
#define MUST_BE_FALSE(condition, parm_name)
#define MUST_BE_UNDEF(parm, parm_name)
static const char * print_vlan_accept(enum vlan_acceptable_frames mode)
#define SHOW_PARM(name, value, format)
static void options_postprocess_http_proxy_override(struct options *o)
void options_warning(char *actual, const char *expected)
static void show_pull_filter_list(const struct pull_filter_list *l)
#define CHKACC_FILE
Check for a file/directory presence.
const char * options_string_version(const char *s, struct gc_arena *gc)
static void options_postprocess_mutate_invariant(struct options *options)
static bool ipv6_addr_safe_hexplusbits(const char *ipv6_prefix_spec)
const char title_string[]
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, unsigned int *update_options_found)
Processes an option to update.
static void setenv_local_entry(struct env_set *es, const struct local_entry *e, const int i)
static void remap_redirect_gateway_flags(struct options *opt)
static msglvl_t msglevel_forward_compatible(struct options *options, const msglvl_t msglevel)
bool auth_retry_set(const msglvl_t msglevel, const char *option)
static void dhcp_option_address_parse(const char *name, const char *parm, in_addr_t *array, int *len, msglvl_t msglevel)
static struct remote_list * alloc_remote_list_if_undef(struct options *options)
static bool check_route6_option(struct options *options, char *p[], const msglvl_t msglevel, bool pull_mode)
void notnull(const char *arg, const char *description)
static struct local_entry * alloc_local_entry(struct connection_entry *ce, const msglvl_t msglevel, struct gc_arena *gc)
static void show_compression_warning(struct compress_options *info)
static void options_process_mutate_prf(struct options *o)
bool has_udp_in_local_list(const struct options *options)
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)
static void option_iroute(struct options *o, const char *network_str, const char *netmask_str, msglvl_t msglevel)
static void options_postprocess_verify(const struct options *o)
static void connection_entry_preload_key(const char **key_file, bool *key_inline, struct gc_arena *gc)
static struct connection_entry * alloc_connection_entry(struct options *options, const msglvl_t msglevel)
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...
#define MODE_POINT_TO_POINT
#define PUF_TYPE_ACCEPT
filter type to accept a matching option
#define SF_TCP_NODELAY_HELPER
#define OPT_P_INSTANCE
allowed in ccd, client-connect etc
#define OPT_P_NCP
Negotiable crypto parameters.
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_ROUTE_TABLE
#define CONNECTION_LIST_SIZE
#define OPT_P_U_REDIR_GATEWAY
#define OPT_P_EXPLICIT_NOTIFY
#define PUF_TYPE_IGNORE
filter type to ignore a matching option
static bool dco_enabled(const struct options *o)
Returns whether the current configuration has dco enabled.
#define PUF_TYPE_REJECT
filter type to reject and trigger SIGUSR1
@ GENKEY_TLS_CRYPTV2_SERVER
@ GENKEY_TLS_CRYPTV2_CLIENT
#define SF_NO_PUSH_ROUTE_GATEWAY
#define PULL_DEFINED(opt)
#define PLUGIN_OPTION_LIST(opt)
#define ROUTE_OPTION_FLAGS(o)
#define OPT_P_ROUTE_EXTRAS
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)
@ VLAN_ONLY_UNTAGGED_OR_PRIORITY
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
#define MIN_SEQ_BACKTRACK
#define DEFAULT_SEQ_BACKTRACK
#define MAX_TIME_BACKTRACK
#define DEFAULT_TIME_BACKTRACK
#define MIN_TIME_BACKTRACK
struct plugin_option_list * plugin_option_list_new(struct gc_arena *gc)
bool plugin_option_list_add(struct plugin_option_list *list, char **p, struct gc_arena *gc)
void plugin_option_list_print(const struct plugin_option_list *list, msglvl_t msglevel)
bool ifconfig_pool_verify_range(const msglvl_t msglevel, const in_addr_t start, const in_addr_t end)
#define OPENVPN_8021Q_MIN_VID
#define OPENVPN_8021Q_MAX_VID
struct http_proxy_options * init_http_proxy_options_once(struct http_proxy_options **hpo, struct gc_arena *gc)
#define MAX_CUSTOM_HTTP_HEADER
void push_reset(struct options *o)
void push_options(struct options *o, char **p, msglvl_t msglevel, struct gc_arena *gc)
void clone_push_list(struct options *o)
void push_remove_option(struct options *o, const char *p)
void print_route_options(const struct route_option_list *rol, msglvl_t msglevel)
bool is_special_addr(const char *addr_str)
struct route_option_list * clone_route_option_list(const struct route_option_list *src, struct gc_arena *a)
int netmask_to_netbits2(in_addr_t netmask)
struct route_ipv6_option_list * new_route_ipv6_option_list(struct gc_arena *a)
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)
void get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6, const struct in6_addr *dest, openvpn_net_ctx_t *ctx)
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)
void copy_route_option_list(struct route_option_list *dest, const struct route_option_list *src, struct gc_arena *a)
void copy_route_ipv6_option_list(struct route_ipv6_option_list *dest, const struct route_ipv6_option_list *src, struct gc_arena *a)
void print_default_gateway(const msglvl_t msglevel, const struct route_gateway_info *rgi, const struct route_ipv6_gateway_info *rgi6)
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.
struct route_ipv6_option_list * clone_route_ipv6_option_list(const struct route_ipv6_option_list *src, struct gc_arena *a)
struct route_option_list * new_route_option_list(struct gc_arena *a)
void show_routes(msglvl_t msglevel)
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)
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)
#define ROUTE_METHOD_SERVICE
#define ROUTE_METHOD_IPAPI
#define ROUTE_METHOD_ADAPTIVE
void script_security_set(int level)
#define SSEC_PW_ENV
allow calling of built-in programs and user-defined scripts that may receive a password as an environ...
#define SSEC_NONE
strictly no calling of external programs
static void bind_local(struct link_socket *sock, const sa_family_t ai_family)
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.
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.
#define RESOLV_RETRY_INFINITE
#define SF_USE_IP_PKTINFO
#define SF_HOST_RANDOMIZE
#define SF_PKTINFO_COPY_IIF
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_HOST_ORDER
static bool proto_is_dgram(int proto)
Return if the protocol is datagram (UDP)
void ssl_set_auth_token_user(const char *username)
void ssl_set_auth_nocache(void)
int tls_version_parse(const char *vstr, const char *extra)
void ssl_set_auth_token(const char *token)
bool ssl_get_auth_nocache(void)
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.
Control Channel SSL/Data channel negotiation module.
#define X509_USERNAME_FIELD_DEFAULT
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 EXPORT_KEY_DATA_LABEL
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
#define SSLF_CLIENT_CERT_OPTIONAL
#define SSLF_AUTH_USER_PASS_OPTIONAL
#define SSLF_CLIENT_CERT_NOT_REQUIRED
#define SSLF_CRL_VERIFY_DIR
#define SSLF_TLS_DEBUG_ENABLED
#define SSLF_TLS_VERSION_MAX_MASK
#define SSLF_TLS_VERSION_MIN_SHIFT
#define SSLF_TLS_VERSION_MIN_MASK
#define SSLF_USERNAME_AS_COMMON_NAME
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...
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.
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.
char * mutate_ncp_cipher_list(const char *list, struct gc_arena *gc)
Check whether the ciphers in the supplied list are supported.
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)
#define VERIFY_X509_SUBJECT_DN
#define VERIFY_X509_SUBJECT_RDN
#define NS_CERT_CHECK_CLIENT
Do not perform Netscape certificate type verification.
#define VERIFY_X509_SUBJECT_RDN_PREFIX
#define NS_CERT_CHECK_SERVER
Do not perform Netscape certificate type verification.
void x509_track_add(const struct x509_track **ll_head, const char *name, msglvl_t msglevel, struct gc_arena *gc)
Wrapper structure for dynamically allocated memory.
uint8_t * data
Pointer to the allocated memory.
int len
Length in bytes of the actual content within the allocated memory.
struct local_list * local_list
int connect_retry_seconds
bool tls_crypt_v2_force_cookie
int connect_retry_seconds_max
const char * tls_crypt_file
const char * tls_crypt_v2_file
bool tun_mtu_extra_defined
const char * socks_proxy_port
struct http_proxy_options * http_proxy_options
bool tls_crypt_file_inline
bool tls_auth_file_inline
int explicit_exit_notification
const char * socks_proxy_authfile
const char * socks_proxy_server
const char * tls_auth_file
bool tls_crypt_v2_file_inline
struct connection_entry ** array
struct route_list * route_list
List of routing information.
struct route_ipv6_list * route_ipv6_list
struct tuntap * tuntap
Tun/tap virtual network interface.
Contains all state information for one tunnel.
openvpn_net_ctx_t net_ctx
Networking API opaque context.
struct options options
Options loaded from command line or configuration file.
struct context_1 c1
Level 1 context.
in_addr_t dns[N_DHCP_ADDR]
struct dns_server * servers
struct dhcp_options from_dhcp
enum dns_updown_flags updown_flags
struct dns_domain * search_domains
union dns_server_addr::@0 in
struct dns_server_addr addr[8]
struct dns_domain * domains
enum dns_server_transport transport
Structure for reassembling one incoming fragmented packet.
Packet geometry parameters.
int tun_mtu
the (user) configured tun-mtu.
Garbage collection arena used to keep track of dynamically allocated memory.
const char * http_version
const char * auth_method_string
struct http_custom_header custom_headers[MAX_CUSTOM_HTTP_HEADER]
const char * auth_file_up
struct iroute_ipv6 * next
const char * cipher
const name of the cipher
const char * digest
Message digest static parameters.
struct local_entry ** array
struct tuntap_options tuntap_options
int ping_rec_timeout_action
bool tuntap_options_defined
struct route_option_list * routes
struct compress_options comp
const char * ifconfig_local
struct dns_options dns_options
const char * route_default_gateway
const char * ifconfig_ipv6_local
struct route_ipv6_option_list * routes_ipv6
struct client_nat_option_list * client_nat
const char * route_ipv6_default_gateway
int resolve_retry_seconds
const char * genkey_extra_data
struct compress_options comp
struct http_proxy_options * http_proxy_override
int push_ifconfig_ipv6_netbits
struct connection_list * connection_list
const char * management_port
bool tls_crypt_file_inline
const char * ifconfig_ipv6_remote
int max_routes_per_client
const char * ncp_ciphers_conf
The original ncp_ciphers specified by the user in the configuration.
enum vlan_acceptable_frames vlan_accept
in_addr_t push_ifconfig_constraint_network
struct options_pre_connect * pre_connect
int renegotiate_seconds_min
const char * auth_token_secret_file
unsigned int imported_protocol_flags
const char * tls_export_peer_cert_dir
const char * cryptoapi_cert
unsigned int backwards_compatible
What version we should try to be compatible with as major * 10000 + minor * 100 + patch,...
hash_algo_type verify_hash_algo
int scheduled_exit_interval
int stale_routes_ageing_time
unsigned int push_option_types_found
int management_state_buffer_size
const char * tls_auth_file
struct provider_list providers
struct in6_addr server_network_ipv6
int management_echo_buffer_size
unsigned remote_cert_ku[MAX_PARMS]
bool server_bridge_defined
const char * keying_material_exporter_label
const char * remote_cert_eku
in_addr_t ifconfig_pool_netmask
bool server_bridge_proxy_dhcp
bool allow_recursive_routing
const char * exit_event_name
const char * ifconfig_ipv6_local
bool auth_user_pass_verify_script_via_file
int ifconfig_pool_persist_refresh_freq
bool push_ifconfig_defined
bool ifconfig_pool_defined
const char * packet_id_file
const char * tls_crypt_v2_file
int management_log_history_cache
in_addr_t server_bridge_netmask
const char * ip_remote_hint
struct route_option_list * routes
in_addr_t ifconfig_pool_end
int64_t inactivity_minimum_bytes
bool ifconfig_ipv6_pool_defined
unsigned int server_flags
bool push_ifconfig_ipv6_blocked
const char * client_disconnect_script
struct remote_list * remote_list
const char * key_pass_file
bool mute_replay_warnings
const char * tls_crypt_file
const char * ifconfig_local
struct connection_entry ce
struct iroute_ipv6 * iroutes_ipv6
struct push_list push_list
struct tuntap_options tuntap_options
struct verify_hash_list * verify_hash
const char * tls_cert_profile
int64_t renegotiate_packets
unsigned int management_flags
const char * route_default_gateway
in_addr_t push_ifconfig_local_alias
struct dns_options dns_options
bool exit_event_initial_state
struct static_challenge_info sc_info
bool auth_token_call_auth
uint32_t virtual_hash_size
const char * learn_address_script
const char * auth_user_pass_file
int stale_routes_check_interval
struct plugin_option_list * plugin_list
const char * tls_crypt_v2_verify_script
const char * auth_user_pass_verify_script
const char * extra_certs_file
int ifconfig_ipv6_pool_netbits
in_addr_t push_ifconfig_constraint_netmask
const char * route_ipv6_default_gateway
bool priv_key_file_inline
int ping_rec_timeout_action
bool auth_user_pass_file_inline
bool enable_ncp_fallback
If defined fall back to ciphername if NCP fails.
const char * route_predown_script
in_addr_t push_ifconfig_local
const char ** ignore_unknown_option
int route_default_table_id
bool auth_token_secret_file_inline
bool extra_certs_file_inline
bool push_ifconfig_constraint_defined
int keying_material_exporter_length
bool force_key_material_export
const char * cipher_list_tls13
int status_file_update_freq
const char * management_client_user
bool allow_deprecated_insecure_static_crypto
struct pull_filter_list * pull_filter_list
const char * management_certificate
const char * genkey_filename
const struct x509_track * x509_track
bool shared_secret_file_inline
struct in6_addr push_ifconfig_ipv6_remote
const char * management_addr
const char * client_connect_script
const char * verify_x509_name
bool route_gateway_via_dhcp
bool push_ifconfig_ipv6_defined
const char * override_username
const char * client_crresponse_script
struct route_ipv6_option_list * routes_ipv6
bool machine_readable_output
const char * priv_key_file
bool tls_auth_file_inline
bool tls_crypt_v2_file_inline
in_addr_t server_bridge_pool_start
struct client_nat_option_list * client_nat
struct in6_addr push_ifconfig_ipv6_local
const char * ifconfig_remote_netmask
in_addr_t server_bridge_pool_end
enum tun_driver_type windows_driver
int64_t renegotiate_bytes
const char * route_script
in_addr_t ifconfig_pool_start
const char * management_user_pass
unsigned int server_netbits_ipv6
in_addr_t push_ifconfig_remote_netmask
in_addr_t server_bridge_ip
const char * shared_secret_file
const char * management_client_group
struct in6_addr ifconfig_ipv6_pool_base
const char * client_config_dir
enum genkey_type genkey_type
const char * ifconfig_pool_persist_filename
int ifconfig_ipv6_netbits
const char * names[MAX_PARMS]
struct pull_filter * tail
struct pull_filter * head
struct pull_filter * next
struct remote_entry ** array
const char * challenge_text
struct in6_addr dns6[N_DHCP_ADDR]
in_addr_t nbdd[N_DHCP_ADDR]
in_addr_t ntp[N_DHCP_ADDR]
in_addr_t wins[N_DHCP_ADDR]
uint8_t netbios_node_type
in_addr_t dns[N_DHCP_ADDR]
const char * netbios_scope
bool dhcp_masq_custom_offset
int domain_search_list_len
const char * domain_search_list[N_SEARCH_LIST_LEN]
struct verify_hash_list * next
uint8_t hash[SHA256_DIGEST_LENGTH]
unsigned short sa_family_t
static bool pkcs11_id_management
void ipconfig_register_dns(const struct env_set *es)
int dev_type_enum(const char *dev, const char *dev_type)
void show_tap_win_adapters(msglvl_t msglevel, msglvl_t warnlevel)
bool dhcp_renew_by_adapter_index(const DWORD adapter_index)
int ascii2ipset(const char *name)
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)
bool dhcp_release_by_adapter_index(const DWORD adapter_index)
const char * dev_type_string(const char *dev, const char *dev_type)
void tap_allow_nonadmin_access(const char *dev_node)
void show_adapters(msglvl_t msglevel)
static bool dhcp_renew(const struct tuntap *tt)
const char * ifconfig_options_string(const struct tuntap *tt, bool remote, bool disable, struct gc_arena *gc)
const char * ipset2ascii_all(struct gc_arena *gc)
void show_valid_win32_tun_subnets(void)
const char * print_tun_backend_driver(enum tun_driver_type driver)
Return a string representation of the tun backed driver type.
#define IPW32_SET_ADAPTIVE
#define DHCP_OPTIONS_DHCP_REQUIRED
#define N_SEARCH_LIST_LEN
#define IPW32_SET_DHCP_MASQ
@ WINDOWS_DRIVER_UNSPECIFIED
@ WINDOWS_DRIVER_TAP_WINDOWS6
#define IPW32_SET_ADAPTIVE_DELAY_WINDOW
#define DHCP_OPTIONS_DHCP_OPTIONAL
static bool is_tun_afunix(const char *devnode)
Checks whether a –dev-node parameter specifies a AF_UNIX device.
const char * win_get_tempdir(void)
void set_win_sys_path(const char *newpath, struct env_set *es)
const char * win32_version_string(struct gc_arena *gc)
Get Windows version string with architecture info.
void set_pause_exit_win32(void)