]>
Commit | Line | Data |
---|---|---|
6fbf66fa JY |
1 | /* |
2 | * OpenVPN -- An application to securely tunnel IP networks | |
3 | * over a single UDP port, with support for SSL/TLS-based | |
4 | * session authentication and key exchange, | |
5 | * packet encryption, packet authentication, and | |
6 | * packet compression. | |
7 | * | |
49979459 | 8 | * Copyright (C) 2002-2018 OpenVPN Inc <sales@openvpn.net> |
6fbf66fa JY |
9 | * |
10 | * This program is free software; you can redistribute it and/or modify | |
11 | * it under the terms of the GNU General Public License version 2 | |
12 | * as published by the Free Software Foundation. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU General Public License for more details. | |
18 | * | |
caa54ac3 DS |
19 | * You should have received a copy of the GNU General Public License along |
20 | * with this program; if not, write to the Free Software Foundation, Inc., | |
21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
6fbf66fa JY |
22 | */ |
23 | ||
24 | /* | |
25 | * 2004-01-28: Added Socks5 proxy support | |
26 | * (Christof Meerwald, http://cmeerw.org) | |
27 | */ | |
28 | ||
29 | #ifndef OPTIONS_H | |
30 | #define OPTIONS_H | |
31 | ||
32 | #include "basic.h" | |
33 | #include "common.h" | |
34 | #include "mtu.h" | |
35 | #include "route.h" | |
36 | #include "tun.h" | |
37 | #include "socket.h" | |
38 | #include "plugin.h" | |
39 | #include "manage.h" | |
40 | #include "proxy.h" | |
38d96bd7 | 41 | #include "comp.h" |
3eee126e | 42 | #include "pushlist.h" |
581bef87 | 43 | #include "clinat.h" |
2193d7c0 | 44 | #include "crypto_backend.h" |
2193d7c0 | 45 | |
6fbf66fa JY |
46 | |
47 | /* | |
48 | * Maximum number of parameters associated with an option, | |
49 | * including the option name itself. | |
50 | */ | |
51 | #define MAX_PARMS 16 | |
52 | ||
53 | /* | |
54 | * Max size of options line and parameter. | |
55 | */ | |
56 | #define OPTION_PARM_SIZE 256 | |
57 | #define OPTION_LINE_SIZE 256 | |
58 | ||
59 | extern const char title_string[]; | |
60 | ||
61 | #if P2MP | |
62 | ||
6fbf66fa JY |
63 | /* certain options are saved before --pull modifications are applied */ |
64 | struct options_pre_pull | |
65 | { | |
81d882d5 DS |
66 | bool tuntap_options_defined; |
67 | struct tuntap_options tuntap_options; | |
6fbf66fa | 68 | |
81d882d5 DS |
69 | bool routes_defined; |
70 | struct route_option_list *routes; | |
6fbf66fa | 71 | |
81d882d5 DS |
72 | bool routes_ipv6_defined; |
73 | struct route_ipv6_option_list *routes_ipv6; | |
91402236 | 74 | |
81d882d5 DS |
75 | bool client_nat_defined; |
76 | struct client_nat_option_list *client_nat; | |
581bef87 | 77 | |
81d882d5 | 78 | int foreign_option_index; |
6fbf66fa JY |
79 | }; |
80 | ||
253329a8 | 81 | #endif |
c7ca9133 | 82 | #if !defined(ENABLE_CRYPTO_OPENSSL) && !defined(ENABLE_CRYPTO_MBEDTLS) |
81d882d5 | 83 | #error "At least one of OpenSSL or mbed TLS needs to be defined." |
6fbf66fa JY |
84 | #endif |
85 | ||
4e9a51d7 JY |
86 | struct connection_entry |
87 | { | |
81d882d5 DS |
88 | int proto; |
89 | sa_family_t af; | |
90 | const char *local_port; | |
91 | bool local_port_defined; | |
92 | const char *remote_port; | |
93 | const char *local; | |
94 | const char *remote; | |
95 | bool remote_float; | |
96 | bool bind_defined; | |
97 | bool bind_ipv6_only; | |
98 | bool bind_local; | |
99 | int connect_retry_seconds; | |
100 | int connect_retry_seconds_max; | |
101 | int connect_timeout; | |
102 | struct http_proxy_options *http_proxy_options; | |
103 | const char *socks_proxy_server; | |
104 | const char *socks_proxy_port; | |
105 | const char *socks_proxy_authfile; | |
106 | ||
107 | int tun_mtu; /* MTU of tun device */ | |
108 | bool tun_mtu_defined; /* true if user overriding parm with command line option */ | |
109 | int tun_mtu_extra; | |
110 | bool tun_mtu_extra_defined; | |
111 | int link_mtu; /* MTU of device over which tunnel packets pass via TCP/UDP */ | |
112 | bool link_mtu_defined; /* true if user overriding parm with command line option */ | |
113 | ||
114 | /* Advanced MTU negotiation and datagram fragmentation options */ | |
115 | int mtu_discover_type; /* used if OS supports setting Path MTU discovery options on socket */ | |
116 | ||
117 | int fragment; /* internal fragmentation size */ | |
118 | int mssfix; /* Upper bound on TCP MSS */ | |
119 | bool mssfix_default; /* true if --mssfix was supplied without a parameter */ | |
120 | ||
121 | int explicit_exit_notification; /* Explicitly tell peer when we are exiting via OCC_EXIT or [RESTART] message */ | |
122 | ||
123 | #define CE_DISABLED (1<<0) | |
124 | #define CE_MAN_QUERY_PROXY (1<<1) | |
125 | #define CE_MAN_QUERY_REMOTE_UNDEF 0 | |
126 | #define CE_MAN_QUERY_REMOTE_QUERY 1 | |
127 | #define CE_MAN_QUERY_REMOTE_ACCEPT 2 | |
128 | #define CE_MAN_QUERY_REMOTE_MOD 3 | |
129 | #define CE_MAN_QUERY_REMOTE_SKIP 4 | |
130 | #define CE_MAN_QUERY_REMOTE_MASK (0x07) | |
131 | #define CE_MAN_QUERY_REMOTE_SHIFT (2) | |
132 | unsigned int flags; | |
57d6f103 AQ |
133 | |
134 | /* Shared secret used for TLS control channel authentication */ | |
135 | const char *tls_auth_file; | |
cb2e9218 | 136 | bool tls_auth_file_inline; |
57d6f103 AQ |
137 | int key_direction; |
138 | ||
139 | /* Shared secret used for TLS control channel authenticated encryption */ | |
140 | const char *tls_crypt_file; | |
cb2e9218 | 141 | bool tls_crypt_file_inline; |
9d59029a SK |
142 | |
143 | /* Client-specific secret or server key used for TLS control channel | |
144 | * authenticated encryption v2 */ | |
145 | const char *tls_crypt_v2_file; | |
cb2e9218 | 146 | bool tls_crypt_v2_file_inline; |
4e9a51d7 JY |
147 | }; |
148 | ||
149 | struct remote_entry | |
150 | { | |
81d882d5 DS |
151 | const char *remote; |
152 | const char *remote_port; | |
153 | int proto; | |
154 | sa_family_t af; | |
4e9a51d7 JY |
155 | }; |
156 | ||
4e9a51d7 JY |
157 | #define CONNECTION_LIST_SIZE 64 |
158 | ||
159 | struct connection_list | |
160 | { | |
81d882d5 DS |
161 | int len; |
162 | int current; | |
163 | struct connection_entry *array[CONNECTION_LIST_SIZE]; | |
4e9a51d7 JY |
164 | }; |
165 | ||
166 | struct remote_list | |
167 | { | |
81d882d5 DS |
168 | int len; |
169 | struct remote_entry *array[CONNECTION_LIST_SIZE]; | |
4e9a51d7 JY |
170 | }; |
171 | ||
99f28081 AQ |
172 | enum vlan_acceptable_frames |
173 | { | |
e375a5ce | 174 | VLAN_ONLY_TAGGED, |
99f28081 | 175 | VLAN_ONLY_UNTAGGED_OR_PRIORITY, |
d626fa17 | 176 | VLAN_ALL, |
99f28081 AQ |
177 | }; |
178 | ||
54561af6 JY |
179 | struct remote_host_store |
180 | { | |
81d882d5 DS |
181 | #define RH_HOST_LEN 80 |
182 | char host[RH_HOST_LEN]; | |
076fd3e4 | 183 | #define RH_PORT_LEN 20 |
81d882d5 | 184 | char port[RH_PORT_LEN]; |
54561af6 | 185 | }; |
54561af6 | 186 | |
0d80b562 AS |
187 | enum genkey_type { |
188 | GENKEY_SECRET, | |
189 | GENKEY_TLS_CRYPTV2_CLIENT, | |
190 | GENKEY_TLS_CRYPTV2_SERVER, | |
1b9a88a2 | 191 | GENKEY_AUTH_TOKEN |
0d80b562 AS |
192 | }; |
193 | ||
6fbf66fa JY |
194 | /* Command line options */ |
195 | struct options | |
196 | { | |
81d882d5 DS |
197 | struct gc_arena gc; |
198 | bool gc_owned; | |
6fbf66fa | 199 | |
81d882d5 DS |
200 | /* first config file */ |
201 | const char *config; | |
6fbf66fa | 202 | |
81d882d5 DS |
203 | /* major mode */ |
204 | #define MODE_POINT_TO_POINT 0 | |
205 | #define MODE_SERVER 1 | |
206 | int mode; | |
6fbf66fa | 207 | |
81d882d5 DS |
208 | /* enable forward compatibility for post-2.1 features */ |
209 | bool forward_compatible; | |
42d9f324 | 210 | /* list of options that should be ignored even if unknown */ |
81d882d5 | 211 | const char **ignore_unknown_option; |
373faab1 | 212 | |
81d882d5 DS |
213 | /* persist parms */ |
214 | bool persist_config; | |
215 | int persist_mode; | |
6fbf66fa | 216 | |
81d882d5 DS |
217 | const char *key_pass_file; |
218 | bool show_ciphers; | |
219 | bool show_digests; | |
220 | bool show_engines; | |
221 | bool show_tls_ciphers; | |
222 | bool show_curves; | |
223 | bool genkey; | |
0d80b562 | 224 | enum genkey_type genkey_type; |
9cf7b492 AS |
225 | const char *genkey_filename; |
226 | const char *genkey_extra_data; | |
81d882d5 DS |
227 | |
228 | /* Networking parms */ | |
229 | int connect_retry_max; | |
230 | struct connection_entry ce; | |
231 | struct connection_list *connection_list; | |
232 | ||
233 | struct remote_list *remote_list; | |
234 | /* Do not advanced the connection or remote addr list*/ | |
235 | bool no_advance; | |
236 | /* Counts the number of unsuccessful connection attempts */ | |
237 | unsigned int unsuccessful_attempts; | |
4e9a51d7 | 238 | |
a4b8f653 | 239 | #if ENABLE_MANAGEMENT |
81d882d5 DS |
240 | struct http_proxy_options *http_proxy_override; |
241 | #endif | |
242 | ||
243 | struct remote_host_store *rh_store; | |
244 | ||
245 | bool remote_random; | |
246 | const char *ipchange; | |
247 | const char *dev; | |
248 | const char *dev_type; | |
249 | const char *dev_node; | |
250 | const char *lladdr; | |
251 | int topology; /* one of the TOP_x values from proto.h */ | |
252 | const char *ifconfig_local; | |
253 | const char *ifconfig_remote_netmask; | |
254 | const char *ifconfig_ipv6_local; | |
255 | int ifconfig_ipv6_netbits; | |
256 | const char *ifconfig_ipv6_remote; | |
257 | bool ifconfig_noexec; | |
258 | bool ifconfig_nowarn; | |
3d163bc5 | 259 | #ifdef ENABLE_FEATURE_SHAPER |
81d882d5 | 260 | int shaper; |
6fbf66fa | 261 | #endif |
6fbf66fa | 262 | |
81d882d5 | 263 | int proto_force; |
51e6e5b0 | 264 | |
81d882d5 | 265 | bool mtu_test; |
6fbf66fa | 266 | |
ffea644c | 267 | #ifdef ENABLE_MEMSTATS |
81d882d5 | 268 | char *memstats_fn; |
ffea644c JY |
269 | #endif |
270 | ||
81d882d5 | 271 | bool mlock; |
6fbf66fa | 272 | |
81d882d5 DS |
273 | int keepalive_ping; /* a proxy for ping/ping-restart */ |
274 | int keepalive_timeout; | |
6fbf66fa | 275 | |
81d882d5 DS |
276 | int inactivity_timeout; /* --inactive */ |
277 | int inactivity_minimum_bytes; | |
838911cc | 278 | |
81d882d5 DS |
279 | int ping_send_timeout; /* Send a TCP/UDP ping to remote every n seconds */ |
280 | int ping_rec_timeout; /* Expect a TCP/UDP ping from remote at least once every n seconds */ | |
281 | bool ping_timer_remote; /* Run ping timer only if we have a remote address */ | |
6fbf66fa | 282 | |
81d882d5 DS |
283 | #define PING_UNDEF 0 |
284 | #define PING_EXIT 1 | |
285 | #define PING_RESTART 2 | |
286 | int ping_rec_timeout_action; /* What action to take on ping_rec_timeout (exit or restart)? */ | |
6fbf66fa | 287 | |
81d882d5 DS |
288 | bool persist_tun; /* Don't close/reopen TUN/TAP dev on SIGUSR1 or PING_RESTART */ |
289 | bool persist_local_ip; /* Don't re-resolve local address on SIGUSR1 or PING_RESTART */ | |
290 | bool persist_remote_ip; /* Don't re-resolve remote address on SIGUSR1 or PING_RESTART */ | |
291 | bool persist_key; /* Don't re-read key files on SIGUSR1 or PING_RESTART */ | |
6fbf66fa | 292 | |
6fbf66fa | 293 | #if PASSTOS_CAPABILITY |
81d882d5 | 294 | bool passtos; |
6fbf66fa JY |
295 | #endif |
296 | ||
81d882d5 DS |
297 | int resolve_retry_seconds; /* If hostname resolve fails, retry for n seconds */ |
298 | bool resolve_in_advance; | |
299 | const char *ip_remote_hint; | |
6fbf66fa | 300 | |
81d882d5 | 301 | struct tuntap_options tuntap_options; |
6fbf66fa | 302 | |
81d882d5 DS |
303 | /* Misc parms */ |
304 | const char *username; | |
305 | const char *groupname; | |
306 | const char *chroot_dir; | |
307 | const char *cd_dir; | |
cd5990e0 | 308 | #ifdef ENABLE_SELINUX |
81d882d5 | 309 | char *selinux_context; |
99385447 | 310 | #endif |
81d882d5 DS |
311 | const char *writepid; |
312 | const char *up_script; | |
313 | const char *down_script; | |
314 | bool user_script_used; | |
315 | bool down_pre; | |
316 | bool up_delay; | |
317 | bool up_restart; | |
318 | bool daemon; | |
6fbf66fa | 319 | |
81d882d5 | 320 | int remap_sigusr1; |
6fbf66fa | 321 | |
81d882d5 DS |
322 | /* inetd modes defined in socket.h */ |
323 | int inetd; | |
6fbf66fa | 324 | |
81d882d5 DS |
325 | bool log; |
326 | bool suppress_timestamps; | |
327 | bool machine_readable_output; | |
328 | int nice; | |
329 | int verbosity; | |
330 | int mute; | |
6fbf66fa JY |
331 | |
332 | #ifdef ENABLE_DEBUG | |
81d882d5 | 333 | int gremlin; |
6fbf66fa JY |
334 | #endif |
335 | ||
81d882d5 DS |
336 | const char *status_file; |
337 | int status_file_version; | |
338 | int status_file_update_freq; | |
6fbf66fa | 339 | |
81d882d5 DS |
340 | /* optimize TUN/TAP/UDP writes */ |
341 | bool fast_io; | |
6fbf66fa | 342 | |
38d96bd7 | 343 | #ifdef USE_COMP |
81d882d5 DS |
344 | struct compress_options comp; |
345 | #endif | |
346 | ||
347 | /* buffer sizes */ | |
348 | int rcvbuf; | |
349 | int sndbuf; | |
350 | ||
351 | /* mark value */ | |
352 | int mark; | |
19d3c602 | 353 | char *bind_dev; |
81d882d5 DS |
354 | |
355 | /* socket flags */ | |
356 | unsigned int sockflags; | |
357 | ||
358 | /* route management */ | |
359 | const char *route_script; | |
360 | const char *route_predown_script; | |
361 | const char *route_default_gateway; | |
d24e1b17 | 362 | const char *route_ipv6_default_gateway; |
81d882d5 DS |
363 | int route_default_metric; |
364 | bool route_noexec; | |
365 | int route_delay; | |
366 | int route_delay_window; | |
367 | bool route_delay_defined; | |
368 | struct route_option_list *routes; | |
369 | struct route_ipv6_option_list *routes_ipv6; /* IPv6 */ | |
e11d2d14 | 370 | bool block_ipv6; |
81d882d5 DS |
371 | bool route_nopull; |
372 | bool route_gateway_via_dhcp; | |
373 | bool allow_pull_fqdn; /* as a client, allow server to push a FQDN for certain parameters */ | |
374 | struct client_nat_option_list *client_nat; | |
581bef87 | 375 | |
81d882d5 DS |
376 | /* Enable options consistency check between peers */ |
377 | bool occ; | |
6fbf66fa JY |
378 | |
379 | #ifdef ENABLE_MANAGEMENT | |
81d882d5 DS |
380 | const char *management_addr; |
381 | const char *management_port; | |
382 | const char *management_user_pass; | |
383 | int management_log_history_cache; | |
384 | int management_echo_buffer_size; | |
385 | int management_state_buffer_size; | |
386 | const char *management_write_peer_info_file; | |
90efcacb | 387 | |
81d882d5 DS |
388 | const char *management_client_user; |
389 | const char *management_client_group; | |
bb564a59 | 390 | |
81d882d5 DS |
391 | /* Mask of MF_ values of manage.h */ |
392 | unsigned int management_flags; | |
393 | const char *management_certificate; | |
6fbf66fa JY |
394 | #endif |
395 | ||
396 | #ifdef ENABLE_PLUGIN | |
81d882d5 | 397 | struct plugin_option_list *plugin_list; |
6fbf66fa JY |
398 | #endif |
399 | ||
ea5e091e | 400 | |
b70d99fb | 401 | |
6fbf66fa JY |
402 | #if P2MP |
403 | ||
81d882d5 DS |
404 | /* the tmp dir is for now only used in the P2P server context */ |
405 | const char *tmp_dir; | |
406 | bool server_defined; | |
407 | in_addr_t server_network; | |
408 | in_addr_t server_netmask; | |
409 | bool server_ipv6_defined; /* IPv6 */ | |
410 | struct in6_addr server_network_ipv6; /* IPv6 */ | |
411 | unsigned int server_netbits_ipv6; /* IPv6 */ | |
412 | ||
413 | #define SF_NOPOOL (1<<0) | |
414 | #define SF_TCP_NODELAY_HELPER (1<<1) | |
415 | #define SF_NO_PUSH_ROUTE_GATEWAY (1<<2) | |
416 | unsigned int server_flags; | |
417 | ||
418 | bool server_bridge_proxy_dhcp; | |
419 | ||
420 | bool server_bridge_defined; | |
421 | in_addr_t server_bridge_ip; | |
422 | in_addr_t server_bridge_netmask; | |
423 | in_addr_t server_bridge_pool_start; | |
424 | in_addr_t server_bridge_pool_end; | |
425 | ||
426 | struct push_list push_list; | |
427 | bool ifconfig_pool_defined; | |
428 | in_addr_t ifconfig_pool_start; | |
429 | in_addr_t ifconfig_pool_end; | |
430 | in_addr_t ifconfig_pool_netmask; | |
431 | const char *ifconfig_pool_persist_filename; | |
432 | int ifconfig_pool_persist_refresh_freq; | |
433 | ||
434 | bool ifconfig_ipv6_pool_defined; /* IPv6 */ | |
435 | struct in6_addr ifconfig_ipv6_pool_base; /* IPv6 */ | |
436 | int ifconfig_ipv6_pool_netbits; /* IPv6 */ | |
437 | ||
438 | int real_hash_size; | |
439 | int virtual_hash_size; | |
440 | const char *client_connect_script; | |
441 | const char *client_disconnect_script; | |
442 | const char *learn_address_script; | |
443 | const char *client_config_dir; | |
444 | bool ccd_exclusive; | |
445 | bool disable; | |
446 | int n_bcast_buf; | |
447 | int tcp_queue_limit; | |
448 | struct iroute *iroutes; | |
449 | struct iroute_ipv6 *iroutes_ipv6; /* IPv6 */ | |
450 | bool push_ifconfig_defined; | |
451 | in_addr_t push_ifconfig_local; | |
452 | in_addr_t push_ifconfig_remote_netmask; | |
453 | in_addr_t push_ifconfig_local_alias; | |
454 | bool push_ifconfig_constraint_defined; | |
455 | in_addr_t push_ifconfig_constraint_network; | |
456 | in_addr_t push_ifconfig_constraint_netmask; | |
6ae2f19d | 457 | bool push_ifconfig_ipv4_blocked; /* IPv4 */ |
81d882d5 DS |
458 | bool push_ifconfig_ipv6_defined; /* IPv6 */ |
459 | struct in6_addr push_ifconfig_ipv6_local; /* IPv6 */ | |
460 | int push_ifconfig_ipv6_netbits; /* IPv6 */ | |
461 | struct in6_addr push_ifconfig_ipv6_remote; /* IPv6 */ | |
462 | bool push_ifconfig_ipv6_blocked; /* IPv6 */ | |
463 | bool enable_c2c; | |
464 | bool duplicate_cn; | |
465 | int cf_max; | |
466 | int cf_per; | |
467 | int max_clients; | |
468 | int max_routes_per_client; | |
469 | int stale_routes_check_interval; | |
470 | int stale_routes_ageing_time; | |
471 | ||
472 | const char *auth_user_pass_verify_script; | |
473 | bool auth_user_pass_verify_script_via_file; | |
474 | bool auth_token_generate; | |
c8723aa7 AS |
475 | bool auth_token_gen_secret_file; |
476 | bool auth_token_call_auth; | |
477 | int auth_token_lifetime; | |
1b9a88a2 | 478 | const char *auth_token_secret_file; |
cb2e9218 | 479 | bool auth_token_secret_file_inline; |
1b9a88a2 | 480 | |
6add6b2f | 481 | #if PORT_SHARE |
81d882d5 DS |
482 | char *port_share_host; |
483 | char *port_share_port; | |
484 | const char *port_share_journal_dir; | |
6fbf66fa JY |
485 | #endif |
486 | ||
81d882d5 DS |
487 | bool client; |
488 | bool pull; /* client pull of config options from server */ | |
489 | int push_continuation; | |
490 | unsigned int push_option_types_found; | |
491 | const char *auth_user_pass_file; | |
492 | struct options_pre_pull *pre_pull; | |
6fbf66fa | 493 | |
81d882d5 | 494 | int scheduled_exit_interval; |
6fbf66fa | 495 | |
66b9409b | 496 | #ifdef ENABLE_MANAGEMENT |
81d882d5 | 497 | struct static_challenge_info sc_info; |
6fbf66fa | 498 | #endif |
81d882d5 | 499 | #endif /* if P2MP */ |
6fbf66fa | 500 | |
81d882d5 DS |
501 | /* Cipher parms */ |
502 | const char *shared_secret_file; | |
cb2e9218 | 503 | bool shared_secret_file_inline; |
81d882d5 DS |
504 | int key_direction; |
505 | const char *ciphername; | |
506 | bool ncp_enabled; | |
507 | const char *ncp_ciphers; | |
508 | const char *authname; | |
509 | int keysize; | |
510 | const char *prng_hash; | |
511 | int prng_nonce_secret_len; | |
512 | const char *engine; | |
513 | bool replay; | |
514 | bool mute_replay_warnings; | |
515 | int replay_window; | |
516 | int replay_time; | |
517 | const char *packet_id_file; | |
81d882d5 | 518 | bool test_crypto; |
0f25d296 | 519 | #ifdef ENABLE_PREDICTION_RESISTANCE |
81d882d5 DS |
520 | bool use_prediction_resistance; |
521 | #endif | |
522 | ||
523 | /* TLS (control channel) parms */ | |
524 | bool tls_server; | |
525 | bool tls_client; | |
526 | const char *ca_file; | |
cb2e9218 | 527 | bool ca_file_inline; |
81d882d5 DS |
528 | const char *ca_path; |
529 | const char *dh_file; | |
cb2e9218 | 530 | bool dh_file_inline; |
81d882d5 | 531 | const char *cert_file; |
cb2e9218 | 532 | bool cert_file_inline; |
81d882d5 | 533 | const char *extra_certs_file; |
cb2e9218 | 534 | bool extra_certs_file_inline; |
81d882d5 | 535 | const char *priv_key_file; |
cb2e9218 | 536 | bool priv_key_file_inline; |
81d882d5 | 537 | const char *pkcs12_file; |
cb2e9218 | 538 | bool pkcs12_file_inline; |
81d882d5 | 539 | const char *cipher_list; |
ea4ee313 | 540 | const char *cipher_list_tls13; |
aba75874 | 541 | const char *tls_cert_profile; |
81d882d5 DS |
542 | const char *ecdh_curve; |
543 | const char *tls_verify; | |
544 | int verify_x509_type; | |
545 | const char *verify_x509_name; | |
546 | const char *tls_export_cert; | |
547 | const char *crl_file; | |
cb2e9218 | 548 | bool crl_file_inline; |
81d882d5 DS |
549 | |
550 | int ns_cert_type; /* set to 0, NS_CERT_CHECK_SERVER, or NS_CERT_CHECK_CLIENT */ | |
551 | unsigned remote_cert_ku[MAX_PARMS]; | |
552 | const char *remote_cert_eku; | |
553 | uint8_t *verify_hash; | |
2193d7c0 | 554 | hash_algo_type verify_hash_algo; |
81d882d5 | 555 | unsigned int ssl_flags; /* set to SSLF_x flags from ssl.h */ |
bed73623 JY |
556 | |
557 | #ifdef ENABLE_PKCS11 | |
81d882d5 DS |
558 | const char *pkcs11_providers[MAX_PARMS]; |
559 | unsigned pkcs11_private_mode[MAX_PARMS]; | |
560 | bool pkcs11_protected_authentication[MAX_PARMS]; | |
561 | bool pkcs11_cert_private[MAX_PARMS]; | |
562 | int pkcs11_pin_cache_period; | |
563 | const char *pkcs11_id; | |
564 | bool pkcs11_id_management; | |
bed73623 JY |
565 | #endif |
566 | ||
93c22ecc | 567 | #ifdef ENABLE_CRYPTOAPI |
81d882d5 | 568 | const char *cryptoapi_cert; |
6fbf66fa | 569 | #endif |
81d882d5 DS |
570 | /* Per-packet timeout on control channel */ |
571 | int tls_timeout; | |
6fbf66fa | 572 | |
81d882d5 DS |
573 | /* Data channel key renegotiation parameters */ |
574 | int renegotiate_bytes; | |
575 | int renegotiate_packets; | |
576 | int renegotiate_seconds; | |
dd996463 | 577 | int renegotiate_seconds_min; |
6fbf66fa | 578 | |
81d882d5 DS |
579 | /* Data channel key handshake must finalize |
580 | * within n seconds of handshake initiation. */ | |
581 | int handshake_window; | |
6fbf66fa | 582 | |
fbd18db6 | 583 | #ifdef ENABLE_X509ALTUSERNAME |
81d882d5 DS |
584 | /* Field used to be the username in X509 cert. */ |
585 | char *x509_username_field; | |
fbd18db6 | 586 | #endif |
2e8337de | 587 | |
81d882d5 DS |
588 | /* Old key allowed to live n seconds after new key goes active */ |
589 | int transition_window; | |
6fbf66fa | 590 | |
81d882d5 DS |
591 | /* Shared secret used for TLS control channel authentication */ |
592 | const char *tls_auth_file; | |
cb2e9218 | 593 | bool tls_auth_file_inline; |
6fbf66fa | 594 | |
81d882d5 DS |
595 | /* Shared secret used for TLS control channel authenticated encryption */ |
596 | const char *tls_crypt_file; | |
cb2e9218 | 597 | bool tls_crypt_file_inline; |
c6e24fa3 | 598 | |
9d59029a SK |
599 | /* Client-specific secret or server key used for TLS control channel |
600 | * authenticated encryption v2 */ | |
601 | const char *tls_crypt_v2_file; | |
cb2e9218 | 602 | bool tls_crypt_v2_file_inline; |
9d59029a | 603 | |
9d59029a SK |
604 | const char *tls_crypt_v2_metadata; |
605 | ||
ff931c5e SK |
606 | const char *tls_crypt_v2_verify_script; |
607 | ||
81d882d5 DS |
608 | /* Allow only one session */ |
609 | bool single_session; | |
6fbf66fa | 610 | |
81d882d5 | 611 | bool push_peer_info; |
aaf72974 | 612 | |
81d882d5 | 613 | bool tls_exit; |
6fbf66fa | 614 | |
81d882d5 | 615 | const struct x509_track *x509_track; |
9356bae8 | 616 | |
81d882d5 DS |
617 | /* special state parms */ |
618 | int foreign_option_index; | |
6fbf66fa | 619 | |
445b192a | 620 | #ifdef _WIN32 |
81d882d5 DS |
621 | HANDLE msg_channel; |
622 | const char *exit_event_name; | |
623 | bool exit_event_initial_state; | |
624 | bool show_net_up; | |
625 | int route_method; | |
626 | bool block_outside_dns; | |
36215dc5 | 627 | enum windows_driver_type windows_driver; |
6fbf66fa | 628 | #endif |
65eedc35 | 629 | |
81d882d5 DS |
630 | bool use_peer_id; |
631 | uint32_t peer_id; | |
685e486e | 632 | |
5defbba4 | 633 | #ifdef HAVE_EXPORT_KEYING_MATERIAL |
81d882d5 DS |
634 | /* Keying Material Exporters [RFC 5705] */ |
635 | const char *keying_material_exporter_label; | |
636 | int keying_material_exporter_length; | |
685e486e | 637 | #endif |
7f74c27e | 638 | |
99f28081 AQ |
639 | bool vlan_tagging; |
640 | enum vlan_acceptable_frames vlan_accept; | |
641 | uint16_t vlan_pvid; | |
642 | ||
81d882d5 | 643 | struct pull_filter_list *pull_filter_list; |
e8c42658 | 644 | |
81d882d5 DS |
645 | /* Useful when packets sent by openvpn itself are not subject |
646 | * to the routing tables that would move packets into the tunnel. */ | |
647 | bool allow_recursive_routing; | |
6fbf66fa JY |
648 | }; |
649 | ||
650 | #define streq(x, y) (!strcmp((x), (y))) | |
651 | ||
652 | /* | |
653 | * Option classes. | |
654 | */ | |
655 | #define OPT_P_GENERAL (1<<0) | |
656 | #define OPT_P_UP (1<<1) | |
657 | #define OPT_P_ROUTE (1<<2) | |
658 | #define OPT_P_IPWIN32 (1<<3) | |
659 | #define OPT_P_SCRIPT (1<<4) | |
660 | #define OPT_P_SETENV (1<<5) | |
661 | #define OPT_P_SHAPER (1<<6) | |
662 | #define OPT_P_TIMER (1<<7) | |
663 | #define OPT_P_PERSIST (1<<8) | |
664 | #define OPT_P_PERSIST_IP (1<<9) | |
665 | #define OPT_P_COMP (1<<10) /* TODO */ | |
666 | #define OPT_P_MESSAGES (1<<11) | |
d728ebed | 667 | #define OPT_P_NCP (1<<12) /**< Negotiable crypto parameters */ |
6fbf66fa JY |
668 | #define OPT_P_TLS_PARMS (1<<13) /* TODO */ |
669 | #define OPT_P_MTU (1<<14) /* TODO */ | |
670 | #define OPT_P_NICE (1<<15) | |
671 | #define OPT_P_PUSH (1<<16) | |
6168f53d | 672 | #define OPT_P_INSTANCE (1<<17) /**< allowed in ccd, client-connect etc*/ |
6fbf66fa JY |
673 | #define OPT_P_CONFIG (1<<18) |
674 | #define OPT_P_EXPLICIT_NOTIFY (1<<19) | |
675 | #define OPT_P_ECHO (1<<20) | |
676 | #define OPT_P_INHERIT (1<<21) | |
3c7f2f55 JY |
677 | #define OPT_P_ROUTE_EXTRAS (1<<22) |
678 | #define OPT_P_PULL_MODE (1<<23) | |
679 | #define OPT_P_PLUGIN (1<<24) | |
00d39170 JY |
680 | #define OPT_P_SOCKBUF (1<<25) |
681 | #define OPT_P_SOCKFLAGS (1<<26) | |
4e9a51d7 | 682 | #define OPT_P_CONNECTION (1<<27) |
65eedc35 | 683 | #define OPT_P_PEER_ID (1<<28) |
cb2e9218 | 684 | #define OPT_P_INLINE (1<<29) |
6fbf66fa | 685 | |
3c7f2f55 | 686 | #define OPT_P_DEFAULT (~(OPT_P_INSTANCE|OPT_P_PULL_MODE)) |
6fbf66fa JY |
687 | |
688 | #if P2MP | |
689 | #define PULL_DEFINED(opt) ((opt)->pull) | |
6fbf66fa JY |
690 | #define PUSH_DEFINED(opt) ((opt)->push_list) |
691 | #endif | |
6fbf66fa JY |
692 | |
693 | #ifndef PULL_DEFINED | |
694 | #define PULL_DEFINED(opt) (false) | |
695 | #endif | |
696 | ||
697 | #ifndef PUSH_DEFINED | |
698 | #define PUSH_DEFINED(opt) (false) | |
699 | #endif | |
700 | ||
445b192a | 701 | #ifdef _WIN32 |
6fbf66fa JY |
702 | #define ROUTE_OPTION_FLAGS(o) ((o)->route_method & ROUTE_METHOD_MASK) |
703 | #else | |
704 | #define ROUTE_OPTION_FLAGS(o) (0) | |
705 | #endif | |
706 | ||
3d163bc5 | 707 | #ifdef ENABLE_FEATURE_SHAPER |
6fbf66fa JY |
708 | #define SHAPER_DEFINED(opt) ((opt)->shaper) |
709 | #else | |
710 | #define SHAPER_DEFINED(opt) (false) | |
711 | #endif | |
712 | ||
713 | #ifdef ENABLE_PLUGIN | |
714 | #define PLUGIN_OPTION_LIST(opt) ((opt)->plugin_list) | |
715 | #else | |
716 | #define PLUGIN_OPTION_LIST(opt) (NULL) | |
717 | #endif | |
718 | ||
90efcacb JY |
719 | #ifdef MANAGEMENT_DEF_AUTH |
720 | #define MAN_CLIENT_AUTH_ENABLED(opt) ((opt)->management_flags & MF_CLIENT_AUTH) | |
721 | #else | |
722 | #define MAN_CLIENT_AUTH_ENABLED(opt) (false) | |
723 | #endif | |
724 | ||
81d882d5 DS |
725 | void parse_argv(struct options *options, |
726 | const int argc, | |
727 | char *argv[], | |
728 | const int msglevel, | |
729 | const unsigned int permission_mask, | |
730 | unsigned int *option_types_found, | |
731 | struct env_set *es); | |
6fbf66fa | 732 | |
81d882d5 | 733 | void notnull(const char *arg, const char *description); |
6fbf66fa | 734 | |
81d882d5 | 735 | void usage_small(void); |
6fbf66fa | 736 | |
5b17803e JY |
737 | void show_library_versions(const unsigned int flags); |
738 | ||
445b192a | 739 | #ifdef _WIN32 |
cdc65ea0 | 740 | void show_windows_version(const unsigned int flags); |
81d882d5 | 741 | |
cdc65ea0 LS |
742 | #endif |
743 | ||
81d882d5 DS |
744 | void init_options(struct options *o, const bool init_gc); |
745 | ||
746 | void uninit_options(struct options *o); | |
6fbf66fa | 747 | |
81d882d5 | 748 | void setenv_settings(struct env_set *es, const struct options *o); |
6fbf66fa | 749 | |
81d882d5 DS |
750 | void show_settings(const struct options *o); |
751 | ||
752 | bool string_defined_equal(const char *s1, const char *s2); | |
6fbf66fa | 753 | |
81d882d5 DS |
754 | const char *options_string_version(const char *s, struct gc_arena *gc); |
755 | ||
756 | char *options_string(const struct options *o, | |
757 | const struct frame *frame, | |
758 | struct tuntap *tt, | |
dc7fcd71 | 759 | openvpn_net_ctx_t *ctx, |
81d882d5 DS |
760 | bool remote, |
761 | struct gc_arena *gc); | |
762 | ||
763 | bool options_cmp_equal_safe(char *actual, const char *expected, size_t actual_n); | |
6fbf66fa | 764 | |
81d882d5 | 765 | void options_warning_safe(char *actual, const char *expected, size_t actual_n); |
6fbf66fa | 766 | |
81d882d5 DS |
767 | bool options_cmp_equal(char *actual, const char *expected); |
768 | ||
769 | void options_warning(char *actual, const char *expected); | |
6fbf66fa | 770 | |
6e5ad2fa SK |
771 | /** |
772 | * Given an OpenVPN options string, extract the value of an option. | |
773 | * | |
81d882d5 DS |
774 | * @param options_string Zero-terminated, comma-separated options string |
775 | * @param opt_name The name of the option to extract | |
776 | * @param gc The gc to allocate the return value | |
6e5ad2fa SK |
777 | * |
778 | * @return gc-allocated value of option with name opt_name if option was found, | |
779 | * or NULL otherwise. | |
780 | */ | |
81d882d5 DS |
781 | char *options_string_extract_option(const char *options_string, |
782 | const char *opt_name, struct gc_arena *gc); | |
783 | ||
6e5ad2fa | 784 | |
81d882d5 | 785 | void options_postprocess(struct options *options); |
6e5ad2fa | 786 | |
81d882d5 | 787 | void pre_pull_save(struct options *o); |
6fbf66fa | 788 | |
81d882d5 | 789 | void pre_pull_restore(struct options *o, struct gc_arena *gc); |
6fbf66fa | 790 | |
81d882d5 DS |
791 | bool apply_push_options(struct options *options, |
792 | struct buffer *buf, | |
793 | unsigned int permission_mask, | |
794 | unsigned int *option_types_found, | |
795 | struct env_set *es); | |
6fbf66fa | 796 | |
81d882d5 | 797 | void options_detach(struct options *o); |
6fbf66fa | 798 | |
81d882d5 DS |
799 | void options_server_import(struct options *o, |
800 | const char *filename, | |
801 | int msglevel, | |
802 | unsigned int permission_mask, | |
803 | unsigned int *option_types_found, | |
804 | struct env_set *es); | |
6fbf66fa | 805 | |
81d882d5 | 806 | void pre_pull_default(struct options *o); |
6fbf66fa | 807 | |
81d882d5 | 808 | void rol_check_alloc(struct options *options); |
6fbf66fa | 809 | |
81d882d5 DS |
810 | int parse_line(const char *line, |
811 | char *p[], | |
812 | const int n, | |
813 | const char *file, | |
814 | const int line_num, | |
815 | int msglevel, | |
816 | struct gc_arena *gc); | |
6fbf66fa | 817 | |
3c7f2f55 JY |
818 | /* |
819 | * parse/print topology coding | |
820 | */ | |
821 | ||
81d882d5 DS |
822 | int parse_topology(const char *str, const int msglevel); |
823 | ||
824 | const char *print_topology(const int topology); | |
3c7f2f55 | 825 | |
6fbf66fa JY |
826 | /* |
827 | * Manage auth-retry variable | |
828 | */ | |
829 | ||
830 | #if P2MP | |
831 | ||
832 | #define AR_NONE 0 | |
833 | #define AR_INTERACT 1 | |
834 | #define AR_NOINTERACT 2 | |
835 | ||
81d882d5 DS |
836 | int auth_retry_get(void); |
837 | ||
838 | bool auth_retry_set(const int msglevel, const char *option); | |
839 | ||
840 | const char *auth_retry_print(void); | |
6fbf66fa JY |
841 | |
842 | #endif | |
843 | ||
81d882d5 DS |
844 | void options_string_import(struct options *options, |
845 | const char *config, | |
846 | const int msglevel, | |
847 | const unsigned int permission_mask, | |
848 | unsigned int *option_types_found, | |
849 | struct env_set *es); | |
3c7f2f55 | 850 | |
81d882d5 | 851 | #endif /* ifndef OPTIONS_H */ |