-
Notifications
You must be signed in to change notification settings - Fork 374
/
cliopt.hpp
1498 lines (1329 loc) · 54.7 KB
/
cliopt.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2022 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
// These classes encapsulate the basic setup of the various objects needed to
// create an OpenVPN client session. The basic idea here is to look at both
// compile time settings (i.e. crypto/SSL/random libraries), and run-time
// (such as transport layer using UDP, TCP, or HTTP-proxy), and
// build the actual objects that will be used to construct a client session.
#ifndef OPENVPN_CLIENT_CLIOPT_H
#define OPENVPN_CLIENT_CLIOPT_H
#include <string>
#include <tuple>
#include <unordered_set>
#include <map>
#include <set>
#include <openvpn/error/excode.hpp>
#include <openvpn/common/size.hpp>
#include <openvpn/common/platform.hpp>
#include <openvpn/common/options.hpp>
#include <openvpn/common/stop.hpp>
#include <openvpn/frame/frame_init.hpp>
#include <openvpn/pki/epkibase.hpp>
#include <openvpn/crypto/cryptodcsel.hpp>
#include <openvpn/random/mtrandapi.hpp>
#include <openvpn/ssl/mssparms.hpp>
#include <openvpn/tun/tunmtu.hpp>
#include <openvpn/tun/tristate_setting.hpp>
#include <openvpn/netconf/hwaddr.hpp>
#include <openvpn/transport/socket_protect.hpp>
#include <openvpn/transport/reconnect_notify.hpp>
#include <openvpn/transport/client/udpcli.hpp>
#include <openvpn/transport/client/tcpcli.hpp>
#include <openvpn/transport/client/httpcli.hpp>
#include <openvpn/transport/altproxy.hpp>
#include <openvpn/transport/dco.hpp>
#include <openvpn/client/cliproto.hpp>
#include <openvpn/client/cliopthelper.hpp>
#include <openvpn/client/optfilt.hpp>
#include <openvpn/client/clilife.hpp>
#include <openvpn/ssl/sslchoose.hpp>
#ifdef OPENVPN_GREMLIN
#include <openvpn/transport/gremlin.hpp>
#endif
#if defined(OPENVPN_PLATFORM_ANDROID)
#include <openvpn/client/cliemuexr.hpp>
#endif
#if defined(OPENVPN_EXTERNAL_TRANSPORT_FACTORY)
#include <openvpn/transport/client/extern/config.hpp>
#include <openvpn/transport/client/extern/fw.hpp>
#endif
#if defined(OPENVPN_EXTERNAL_TUN_FACTORY)
// requires that client implements ExternalTun::Factory::new_tun_factory
#include <openvpn/tun/extern/config.hpp>
#elif defined(USE_TUN_BUILDER)
#include <openvpn/tun/builder/client.hpp>
#elif defined(OPENVPN_PLATFORM_LINUX) && !defined(OPENVPN_FORCE_TUN_NULL)
#include <openvpn/tun/linux/client/tuncli.hpp>
#ifdef OPENVPN_COMMAND_AGENT
#include <openvpn/client/unix/cmdagent.hpp>
#endif
#elif defined(OPENVPN_PLATFORM_MAC) && !defined(OPENVPN_FORCE_TUN_NULL)
#include <openvpn/tun/mac/client/tuncli.hpp>
#include <openvpn/apple/maclife.hpp>
#ifdef OPENVPN_COMMAND_AGENT
#include <openvpn/client/unix/cmdagent.hpp>
#endif
#elif defined(OPENVPN_PLATFORM_WIN) && !defined(OPENVPN_FORCE_TUN_NULL)
#include <openvpn/tun/win/client/tuncli.hpp>
#ifdef OPENVPN_COMMAND_AGENT
#include <openvpn/client/win/cmdagent.hpp>
#endif
#else
#include <openvpn/tun/client/tunnull.hpp>
#endif
#ifdef PRIVATE_TUNNEL_PROXY
#include <openvpn/pt/ptproxy.hpp>
#endif
#if defined(ENABLE_KOVPN) || defined(ENABLE_OVPNDCO) || defined(ENABLE_OVPNDCOWIN)
#include <openvpn/dco/dcocli.hpp>
#endif
#ifndef OPENVPN_UNUSED_OPTIONS
#define OPENVPN_UNUSED_OPTIONS "UNKNOWN/UNSUPPORTED OPTIONS"
#endif
namespace openvpn {
struct ClientConfigParsed : public ClientAPI::ConfigCommon
{
/**
* Imports the settings from the UI set ClientAPI::Config
* into this class.
*/
void import_client_settings(const ClientAPI::Config &config)
{
/* explicitly allow slicing to only copy the settings that
* are in the common base class \c ConfigCommon */
ClientAPI::ConfigCommon::operator=(config);
if (!config.protoOverride.empty())
proto_override = Protocol::parse(config.protoOverride, Protocol::NO_SUFFIX);
if (config.protoVersionOverride == 4)
proto_version_override = IP::Addr::Version::V4;
else if (config.protoVersionOverride == 6)
proto_version_override = IP::Addr::Version::V6;
if (!config.allowUnusedAddrFamilies.empty())
allowUnusedAddrFamilies = TriStateSetting::parse(config.allowUnusedAddrFamilies);
}
IP::Addr::Version proto_version_override = IP::Addr::Version::UNSPEC;
Protocol proto_override;
TriStateSetting allowUnusedAddrFamilies;
/* from eval config */
std::string external_pki_alias;
};
class ClientOptions : public RC<thread_unsafe_refcount>
{
public:
typedef RCPtr<ClientOptions> Ptr;
typedef ClientProto::Session Client;
struct Config
{
/* Options set by the client application.
* This class only uses a subset. For simplicity
* we keep all client settings here instead of creating a new
* subset class of configuration options */
ClientConfigParsed clientconf;
int conn_timeout = 0;
SessionStats::Ptr cli_stats;
ClientEvent::Queue::Ptr cli_events;
ProtoContextCompressionOptions::Ptr proto_context_options;
HTTPProxyTransport::Options::Ptr http_proxy_options;
bool alt_proxy = false;
bool synchronous_dns_lookup = false;
int default_key_direction = -1;
bool allow_local_lan_access = false;
PeerInfo::Set::Ptr extra_peer_info;
#ifdef OPENVPN_PLATFORM_ANDROID
bool enable_route_emulation = true;
#endif
#ifdef OPENVPN_GREMLIN
Gremlin::Config::Ptr gremlin_config;
#endif
Stop *stop = nullptr;
// callbacks -- must remain in scope for lifetime of ClientOptions object
ExternalPKIBase *external_pki = nullptr;
SocketProtect *socket_protect = nullptr;
ReconnectNotify *reconnect_notify = nullptr;
RemoteList::RemoteOverride *remote_override = nullptr;
#if defined(USE_TUN_BUILDER)
TunBuilderBase *builder = nullptr;
#endif
#if defined(OPENVPN_EXTERNAL_TUN_FACTORY)
ExternalTun::Factory *extern_tun_factory = nullptr;
#endif
#if defined(OPENVPN_EXTERNAL_TRANSPORT_FACTORY)
ExternalTransport::Factory *extern_transport_factory = nullptr;
#endif
};
ClientOptions(const OptionList &opt, // only needs to remain in scope for duration of constructor call
const Config &config)
: clientconf(config.clientconf),
server_addr_float(false),
socket_protect(config.socket_protect),
reconnect_notify(config.reconnect_notify),
cli_stats(config.cli_stats),
cli_events(config.cli_events),
server_poll_timeout_(10),
tcp_queue_limit(64),
proto_context_options(config.proto_context_options),
http_proxy_options(config.http_proxy_options),
autologin(false),
autologin_sessions(false),
creds_locked(false),
asio_work_always_on_(false),
synchronous_dns_lookup(false)
#ifdef OPENVPN_EXTERNAL_TRANSPORT_FACTORY
,
extern_transport_factory(config.extern_transport_factory)
#endif
{
// parse general client options
const ParseClientConfig pcc(opt);
// creds
userlocked_username = pcc.userlockedUsername();
autologin = pcc.autologin();
autologin_sessions = (autologin && clientconf.autologinSessions);
// digest factory
DigestFactory::Ptr digest_factory(new CryptoDigestFactory<SSLLib::CryptoAPI>());
// initialize RNG/PRNG
rng.reset(new SSLLib::RandomAPI());
prng.reset(new MTRand(time(nullptr)));
// frame
// get tun-mtu and tun-mtu-max parameter from config
const unsigned int tun_mtu = parse_tun_mtu(opt, 0);
const unsigned int tun_mtu_max = std::max(parse_tun_mtu_max(opt, TUN_MTU_DEFAULT + 100), tun_mtu);
const MSSCtrlParms mc(opt);
frame = frame_init(true, tun_mtu_max, mc.mssfix_ctrl, true);
// TCP queue limit
tcp_queue_limit = opt.get_num<decltype(tcp_queue_limit)>("tcp-queue-limit", 1, tcp_queue_limit, 1, 65536);
// route-nopull
pushed_options_filter.reset(new PushedOptionsFilter(opt));
// OpenVPN Protocol context (including SSL)
cp_main = proto_config(opt, config, pcc, false);
cp_relay = proto_config(opt, config, pcc, true); // may be null
CryptoAlgs::allow_default_dc_algs<SSLLib::CryptoAPI>(cp_main->ssl_factory->libctx(),
!config.clientconf.enableNonPreferredDCAlgorithms,
config.clientconf.enableLegacyAlgorithms);
#if (defined(ENABLE_KOVPN) || defined(ENABLE_OVPNDCO) || defined(ENABLE_OVPNDCOWIN)) && !defined(OPENVPN_FORCE_TUN_NULL) && !defined(OPENVPN_EXTERNAL_TUN_FACTORY)
if (config.clientconf.dco)
#if defined(USE_TUN_BUILDER)
dco = DCOTransport::new_controller(config.builder);
#else
dco = DCOTransport::new_controller(nullptr);
#endif
#endif
layer = cp_main->layer;
#ifdef PRIVATE_TUNNEL_PROXY
if (config.alt_proxy && !dco)
alt_proxy = PTProxy::new_proxy(opt, rng);
#endif
// If HTTP proxy parameters are not supplied by API, try to get them from config
if (!http_proxy_options)
http_proxy_options = HTTPProxyTransport::Options::parse(opt);
// load remote list
if (config.remote_override)
{
remote_list.reset(new RemoteList(config.remote_override));
remote_list->set_random(prng);
}
else
remote_list.reset(new RemoteList(opt, "", RemoteList::WARN_UNSUPPORTED, nullptr, prng));
if (!remote_list->defined())
throw option_error(ERR_INVALID_CONFIG, "no remote option specified");
// If running in tun_persist mode, we need to do basic DNS caching so that
// we can avoid emitting DNS requests while the tunnel is blocked during
// reconnections.
remote_list->set_enable_cache(config.clientconf.tunPersist);
// process server/port/family overrides
remote_list->set_server_override(config.clientconf.serverOverride);
remote_list->set_port_override(config.clientconf.portOverride);
remote_list->set_proto_version_override(config.clientconf.proto_version_override);
// process protocol override, should be called after set_enable_cache
remote_list->handle_proto_override(config.clientconf.proto_override,
http_proxy_options || (alt_proxy && alt_proxy->requires_tcp()));
// process remote-random
if (opt.exists("remote-random"))
remote_list->randomize();
// get "float" option
server_addr_float = opt.exists("float");
// special remote cache handling for proxies
if (alt_proxy)
{
remote_list->set_enable_cache(false); // remote server addresses will be resolved by proxy
alt_proxy->set_enable_cache(config.clientconf.tunPersist);
}
else if (http_proxy_options)
{
remote_list->set_enable_cache(false); // remote server addresses will be resolved by proxy
http_proxy_options->proxy_server_set_enable_cache(config.clientconf.tunPersist);
}
check_for_incompatible_options(opt);
// throw an exception if dco is requested but config/options are dco-incompatible
bool dco_compatible = false;
std::tie(dco_compatible, std::ignore) = check_dco_compatibility(clientconf, opt);
if (config.clientconf.dco && !dco_compatible)
{
throw option_error(ERR_INVALID_CONFIG, "dco_compatibility: config/options are not compatible with dco");
}
#ifdef OPENVPN_PLATFORM_UWP
// workaround for OVPN3-62 Busy loop in win_event.hpp
asio_work_always_on_ = true;
#endif
synchronous_dns_lookup = config.synchronous_dns_lookup;
#ifdef OPENVPN_TLS_LINK
if (opt.exists("tls-ca"))
{
tls_ca = opt.cat("tls-ca");
}
#endif
// init transport config
const std::string session_name = load_transport_config();
// initialize tun/tap
if (dco)
{
DCO::TunConfig tunconf;
#if defined(OPENVPN_COMMAND_AGENT) && defined(OPENVPN_PLATFORM_WIN)
tunconf.setup_factory = WinCommandAgent::new_agent(opt);
#endif
tunconf.tun_prop.layer = layer;
tunconf.tun_prop.session_name = session_name;
if (tun_mtu)
tunconf.tun_prop.mtu = tun_mtu;
tunconf.tun_prop.mtu_max = tun_mtu_max;
tunconf.tun_prop.google_dns_fallback = config.clientconf.googleDnsFallback;
tunconf.tun_prop.remote_list = remote_list;
tunconf.stop = config.stop;
tunconf.allow_local_dns_resolvers = config.clientconf.allowLocalDnsResolvers;
#if defined(OPENVPN_PLATFORM_WIN)
if (config.clientconf.tunPersist)
tunconf.tun_persist.reset(new TunWin::DcoTunPersist(true, TunWrapObjRetain::NO_RETAIN_NO_REPLACE, nullptr));
#endif
tun_factory = dco->new_tun_factory(tunconf, opt);
}
else
{
#if defined(OPENVPN_EXTERNAL_TUN_FACTORY)
{
ExternalTun::Config tunconf;
tunconf.tun_prop.layer = layer;
tunconf.tun_prop.session_name = session_name;
tunconf.tun_prop.google_dns_fallback = config.clientconf.googleDnsFallback;
if (tun_mtu)
tunconf.tun_prop.mtu = tun_mtu;
tunconf.tun_prop.mtu_max = tun_mtu_max;
tunconf.frame = frame;
tunconf.stats = cli_stats;
tunconf.tun_prop.remote_list = remote_list;
tunconf.tun_persist = config.clientconf.tunPersist;
tunconf.stop = config.stop;
tun_factory.reset(config.extern_tun_factory->new_tun_factory(tunconf, opt));
if (!tun_factory)
throw option_error(ERR_INVALID_CONFIG, "OPENVPN_EXTERNAL_TUN_FACTORY: no tun factory");
}
#elif defined(USE_TUN_BUILDER)
{
TunBuilderClient::ClientConfig::Ptr tunconf = TunBuilderClient::ClientConfig::new_obj();
tunconf->builder = config.builder;
tunconf->tun_prop.session_name = session_name;
tunconf->tun_prop.google_dns_fallback = config.clientconf.googleDnsFallback;
tunconf->tun_prop.allow_local_lan_access = config.allow_local_lan_access;
if (tun_mtu)
tunconf->tun_prop.mtu = tun_mtu;
tunconf->tun_prop.mtu_max = tun_mtu_max;
tunconf->frame = frame;
tunconf->stats = cli_stats;
tunconf->tun_prop.remote_list = remote_list;
tun_factory = tunconf;
#if defined(OPENVPN_PLATFORM_IPHONE)
tunconf->retain_sd = true;
tunconf->tun_prefix = true;
if (config.clientconf.tunPersist)
tunconf->tun_prop.remote_bypass = true;
#endif
#if defined(OPENVPN_PLATFORM_ANDROID)
// Android VPN API only supports excluded IP prefixes starting with Android 13/API 33,
// so we must emulate them for earlier platforms
if (config.enable_route_emulation)
{
tunconf->eer_factory.reset(new EmulateExcludeRouteFactoryImpl(false));
}
else
{
tunconf->eer_factory.reset(nullptr);
}
#endif
#if defined(OPENVPN_PLATFORM_MAC)
tunconf->tun_prefix = true;
#endif
if (config.clientconf.tunPersist)
tunconf->tun_persist.reset(new TunBuilderClient::TunPersist(true, tunconf->retain_sd ? TunWrapObjRetain::RETAIN : TunWrapObjRetain::NO_RETAIN, config.builder));
tun_factory = tunconf;
}
#elif defined(OPENVPN_PLATFORM_LINUX) && !defined(OPENVPN_FORCE_TUN_NULL)
{
TunLinux::ClientConfig::Ptr tunconf = TunLinux::ClientConfig::new_obj();
tunconf->tun_prop.layer = layer;
tunconf->tun_prop.session_name = session_name;
if (tun_mtu)
tunconf->tun_prop.mtu = tun_mtu;
tunconf->tun_prop.mtu_max = tun_mtu_max;
tunconf->tun_prop.google_dns_fallback = config.clientconf.googleDnsFallback;
tunconf->generate_tun_builder_capture_event = config.clientconf.generateTunBuilderCaptureEvent;
tunconf->tun_prop.remote_list = remote_list;
tunconf->frame = frame;
tunconf->stats = cli_stats;
if (config.clientconf.tunPersist)
tunconf->tun_persist.reset(new TunLinux::TunPersist(true, TunWrapObjRetain::NO_RETAIN, nullptr));
tunconf->load(opt);
tun_factory = tunconf;
}
#elif defined(OPENVPN_PLATFORM_MAC) && !defined(OPENVPN_FORCE_TUN_NULL)
{
TunMac::ClientConfig::Ptr tunconf = TunMac::ClientConfig::new_obj();
tunconf->tun_prop.layer = layer;
tunconf->tun_prop.session_name = session_name;
tunconf->tun_prop.google_dns_fallback = config.clientconf.googleDnsFallback;
if (tun_mtu)
tunconf->tun_prop.mtu = tun_mtu;
tunconf->tun_prop.mtu_max = tun_mtu_max;
tunconf->frame = frame;
tunconf->stats = cli_stats;
tunconf->stop = config.stop;
if (config.clientconf.tunPersist)
{
tunconf->tun_persist.reset(new TunMac::TunPersist(true, TunWrapObjRetain::NO_RETAIN, nullptr));
#ifndef OPENVPN_COMMAND_AGENT
/* remote_list is required by remote_bypass to work */
tunconf->tun_prop.remote_bypass = true;
tunconf->tun_prop.remote_list = remote_list;
#endif
}
client_lifecycle.reset(new MacLifeCycle);
#ifdef OPENVPN_COMMAND_AGENT
tunconf->tun_setup_factory = UnixCommandAgent::new_agent(opt);
#endif
tun_factory = tunconf;
}
#elif defined(OPENVPN_PLATFORM_WIN) && !defined(OPENVPN_FORCE_TUN_NULL)
{
TunWin::ClientConfig::Ptr tunconf = TunWin::ClientConfig::new_obj();
tunconf->tun_prop.layer = layer;
tunconf->tun_prop.session_name = session_name;
tunconf->tun_prop.google_dns_fallback = config.clientconf.googleDnsFallback;
if (tun_mtu)
tunconf->tun_prop.mtu = tun_mtu;
tunconf->tun_prop.mtu_max = tun_mtu_max;
tunconf->frame = frame;
tunconf->stats = cli_stats;
tunconf->stop = config.stop;
tunconf->tun_type = config.clientconf.wintun ? TunWin::Wintun : TunWin::TapWindows6;
tunconf->allow_local_dns_resolvers = config.clientconf.allowLocalDnsResolvers;
if (config.clientconf.tunPersist)
{
tunconf->tun_persist.reset(new TunWin::TunPersist(true, TunWrapObjRetain::NO_RETAIN, nullptr));
#ifndef OPENVPN_COMMAND_AGENT
/* remote_list is required by remote_bypass to work */
tunconf->tun_prop.remote_bypass = true;
tunconf->tun_prop.remote_list = remote_list;
#endif
}
#ifdef OPENVPN_COMMAND_AGENT
tunconf->tun_setup_factory = WinCommandAgent::new_agent(opt);
#endif
tun_factory = tunconf;
}
#else
{
TunNull::ClientConfig::Ptr tunconf = TunNull::ClientConfig::new_obj();
tunconf->frame = frame;
tunconf->stats = cli_stats;
tun_factory = tunconf;
}
#endif
}
// The Core Library itself does not handle TAP/OSI_LAYER_2 currently,
// so we bail out early whenever someone tries to use TAP configurations
if (layer == Layer(Layer::OSI_LAYER_2))
throw ErrorCode(Error::TAP_NOT_SUPPORTED, true, "OSI layer 2 tunnels are not currently supported");
// server-poll-timeout
{
const Option *o = opt.get_ptr("server-poll-timeout");
if (o)
server_poll_timeout_ = parse_number_throw<unsigned int>(o->get(1, 16), "server-poll-timeout");
}
// create default creds object in case submit_creds is not called,
// and populate it with embedded creds, if available
{
ClientCreds::Ptr cc = new ClientCreds();
if (pcc.hasEmbeddedPassword())
{
cc->set_username(userlocked_username);
cc->set_password(pcc.embeddedPassword());
submit_creds(cc);
creds_locked = true;
}
else if (autologin_sessions)
{
submit_creds(cc);
creds_locked = true;
}
else
{
submit_creds(cc);
}
}
// configure push_base, a set of base options that will be combined with
// options pushed by server.
{
push_base.reset(new PushOptionsBase());
// base options where multiple options of the same type can aggregate
push_base->multi.extend(opt, "route");
push_base->multi.extend(opt, "route-ipv6");
push_base->multi.extend(opt, "redirect-gateway");
push_base->multi.extend(opt, "redirect-private");
push_base->multi.extend(opt, "dhcp-option");
// base options which need to be merged, not just aggregated
push_base->merge.extend(opt, "dns");
// base options where only a single instance of each option makes sense
push_base->singleton.extend(opt, "redirect-dns");
push_base->singleton.extend(opt, "inactive");
push_base->singleton.extend(opt, "route-metric");
// IPv6
{
const unsigned int n6 = push_base->singleton.extend(opt, "block-ipv6");
const unsigned int n4 = push_base->singleton.extend(opt, "block-ipv4");
if (!n6 && config.clientconf.allowUnusedAddrFamilies() == TriStateSetting::No)
{
push_base->singleton.emplace_back("block-ipv6");
}
if (!n4 && config.clientconf.allowUnusedAddrFamilies() == TriStateSetting::No)
{
push_base->singleton.emplace_back("block-ipv4");
}
}
}
handle_unused_options(opt);
}
// If those options are present, dco cannot be used
inline static std::unordered_set<std::string> dco_incompatible_opts = {
"http-proxy",
"compress",
"comp-lzo"};
/** Checks if there are dco-incompatible options in options list or config has
* dco-incompatible settings. Return dcoCompatible flag and dcoIncompatibilityReason
* string property (if applicable) */
static std::tuple<bool, std::string> check_dco_compatibility(const ClientAPI::ConfigCommon &config, const OptionList &opt)
{
#if defined(ENABLE_KOVPN)
// only care about dco/dco-win
return std::make_tuple(true, "");
#else
std::vector<std::string> reasons;
for (auto &optname : dco_incompatible_opts)
{
if (opt.exists(optname))
{
reasons.push_back("option " + optname + " is not compatible with dco");
}
}
if (config.enableLegacyAlgorithms)
{
reasons.emplace_back("legacy algorithms are not compatible with dco");
}
if (config.enableNonPreferredDCAlgorithms)
{
reasons.emplace_back("non-preferred data channel algorithms are not compatible with dco");
}
if (!config.proxyHost.empty())
{
reasons.emplace_back("proxyHost config setting is not compatible with dco");
}
if (reasons.empty())
{
return std::make_tuple(true, "");
}
else
{
return std::make_tuple(false, string::join(reasons, "\n"));
}
#endif
}
void check_for_incompatible_options(const OptionList &opt)
{
// secret option not supported
if (opt.exists("secret"))
throw option_error(ERR_INVALID_OPTION_CRYPTO, "sorry, static key encryption mode (non-SSL/TLS) is not supported");
// fragment option not supported
if (opt.exists("fragment"))
throw option_error(ERR_INVALID_OPTION_VAL, "sorry, 'fragment' directive is not supported, nor is connecting to a server that uses 'fragment' directive");
if (!opt.exists("client"))
throw option_error(ERR_INVALID_CONFIG, "Neither 'client' nor both 'tls-client' and 'pull' options declared. OpenVPN3 client only supports --client mode.");
// Only p2p mode accept
if (opt.exists("mode"))
{
const auto &mode = opt.get("mode");
if (mode.size() != 2 || mode.get(1, 128) != "p2p")
{
throw option_error(ERR_INVALID_CONFIG, "Only 'mode p2p' supported");
}
}
// key-method 2 is the only thing that 2.5+ and 3.x support
if (opt.exists("key-method"))
{
auto keymethod = opt.get("key-method");
if (keymethod.size() != 2 || keymethod.get(1, 128) != "2")
{
throw option_error(ERR_INVALID_OPTION_VAL, "Only 'key-method 2' is supported: " + keymethod.get(1, 128));
}
}
}
std::unordered_set<std::string> settings_ignoreWithWarning = {
"allow-compression", /* TODO: maybe check against our client option compression setting? */
"allow-recursive-routing",
"auth-retry",
"compat-mode",
"connect-retry",
"connect-retry-max",
"connect-timeout", /* TODO: this should be really implemented */
"data-ciphers", /* TODO: maybe add more special warning that checks it against our supported ciphers */
"data-ciphers-fallback",
"disable-dco", /* TODO: maybe throw an error if DCO is active? */
"disable-occ",
"engine",
"explicit-exit-notify", /* ignoring it in config does not break connection or functionality */
"group",
"ifconfig-nowarn", /* v3 does not do OCC checks */
"ip-win32",
"keepalive", /* A push only feature (ping/ping-restart) in v3. Ignore with warning since often present in configs too */
"link-mtu",
"machine-readable-output", /* would be set by a CliOptions */
"mark", /* enables SO_MARK */
"mute",
"ncp-ciphers",
"nice",
"opt-verify",
"passtos",
"persist-key",
"persist-tun",
"preresolve",
"providers", /* Done via client options */
"remap-usr1",
"reneg-bytes",
"reneg-pkts",
"replay-window",
"resolv-retry",
"route-method", /* Windows specific fine tuning option */
"route-delay",
"show-net-up",
"socket-flags",
"suppress-timestamps", /* harmless to ignore */
"tcp-nodelay",
"tls-version-max", /* We don't allow restricting max version */
"tun-mtu-extra", /* (only really used in tap in OpenVPN 2.x)*/
"udp-mtu", /* Alias for link-mtu */
"user",
};
std::unordered_set<std::string> settings_serverOnlyOptions = {
"auth-gen-token",
"auth-gen-token-secret",
"auth-user-pass-optional",
"auth-user-pass-verify",
"bcast-buffers",
"ccd-exclusive",
"client-config-dir",
"client-connect",
"client-disconnect",
"client-to-client",
"connect-freq",
"dh",
"disable",
"duplicate-cn",
"hash-size",
"ifconfig-ipv6-pool",
"ifconfig-pool",
"ifconfig-pool-persist",
"ifconfig-push",
"ifconfig-push-constraint",
"iroute",
"iroute-ipv6",
"max-clients",
"max-routes-per-client",
"push",
"push-remove",
"push-reset",
"server",
"server-bridge",
"server-ipv6",
"stale-routes-check",
"tls-crypt-v2-verify",
"username-as-common-name",
"verify-client-cert",
"vlan-accept",
"vlan-pvid",
"vlan-tagging",
};
/* Features not implemented and not safe to ignore */
std::unordered_set<std::string> settings_feature_not_implemented_fatal = {
"askpass",
"capath",
"cd",
"chroot",
"client-nat",
"cryptoapicert",
"daemon",
"daemon",
"errors-to-stderr",
"gremlin",
"lladdr",
"log",
"log",
"log-append",
"management",
"memstats",
"msg-channel", /* (Windows service in v2) */
"ping-timer-rem",
"single-session", /* This option is quite obscure but changes behaviour enough to not ignore it */
"socks-proxy",
"status",
"status-version",
"syslog",
"tls-server", /* No p2p mode in v3 */
"verify-hash",
"win-sys",
"writepid",
"x509-username-field",
};
/* Features not implemented but safe enough to ignore */
std::unordered_set<std::string> settings_feature_not_implemented_warn = {
"allow-pull-fqdn",
"bind",
"local",
"lport",
"mlock",
"mtu-disc",
"mtu-test",
"persist-local-ip",
"persist-remote-ip",
"shaper",
"tls-exit",
};
/* Push only options (some are allowed in the config in OpenVPN 2
* but really push only options) */
std::unordered_set<std::string> settings_pushonlyoptions = {
"auth-token",
"auth-token-user",
"echo",
"parameter",
"ping",
"ping-exit",
"ping-restart", /* ping related options are pull only in v3, v2 needs them in the config for pure p2p */
"key-derivation",
"peer-id",
"protocol-flags",
"ifconfig",
"ifconfig-ipv6",
"topology",
"route-gateway"};
/* Features related to scripts/plugins */
std::unordered_set<std::string> settings_script_plugin_feature = {
"down",
"down-pre",
"ifconfig-noexec",
"ipchange",
"learn-address",
"plugin",
"route-noexec",
"route-pre-down",
"route-up",
"setenv-safe",
"tls-export-cert",
"tls-verify",
"up",
"up-delay",
"x509-track"};
/* Standalone OpenVPN v2 modes */
std::unordered_set<std::string> settings_standalone_options = {
"genkey",
"mktun",
"rmtun",
"show-ciphers",
"show-curves",
"show-digests",
"show-engines",
"show-groups",
"show-tls",
"test-crypto"};
/* Deprecated/throwing error in OpenVPN 2.x already: */
std::unordered_set<std::string> settings_removedOptions = {
"mtu-dynamic", "no-replay", "no-name-remapping", "compat-names", "ncp-disable", "no-iv"};
std::unordered_set<std::string> settings_ignoreSilently = {
"ecdh-curve", /* Deprecated in v2, not needed with modern OpenSSL */
"fast-io",
"max-routes",
"mute-replay-warnings",
"nobind", /* only behaviour in v3 client anyway */
"prng",
"rcvbuf", /* present in many configs */
"replay-persist", /* Makes little sense in TLS mode */
"script-security",
"sndbuf",
"tmp-dir",
"tun-ipv6", /* ignored in v2 as well */
"txqueuelen", /* so platforms evaluate that in tun, some do not, do not warn about that */
"verb"};
class OptionErrors
{
public:
void add_failed_opt(const Option &o, const std::string &message, bool fatal_arg)
{
if (options_per_category.find(message) == options_per_category.end())
{
options_per_category[message] = {};
}
fatal |= fatal_arg;
options_per_category[message].push_back(o);
}
void print_option_errors()
{
std::ostringstream os;
for (const auto &[category, options] : options_per_category)
{
if (!options.empty())
{
OPENVPN_LOG(category);
os << category << ": ";
std::vector<std::string> opts;
for (size_t i = 0; i < options.size(); ++i)
{
auto &o = options[i];
OPENVPN_LOG(std::to_string(i) << ' ' << o.render(Option::RENDER_BRACKET | Option::RENDER_TRUNC_64));
opts.push_back(o.get(0, 64));
}
os << string::join(opts, ",") << std::endl;
}
}
if (fatal)
{
throw ErrorCode(Error::UNUSED_OPTIONS, true, os.str());
}
}
private:
std::map<std::string, std::vector<Option>> options_per_category;
bool fatal = false;
};
/**
* This groups all the options that OpenVPN 2.x supports that the
* OpenVPN v3 client does not support into a number of different groups
* and warns or errors out if with a specific message for that group.
*
* If any option that is not touched() after going through all groups
* the function will print them as unknown unsupported option(s) and
* error out
*/
void handle_unused_options(const OptionList &opt)
{
/* Meta options that AS profiles often have that we do not parse and
* can ignore without warning */
std::unordered_set<std::string> ignoreMetaOptions = {
"CLI_PREF_ALLOW_WEB_IMPORT",
"CLI_PREF_BASIC_CLIENT",
"CLI_PREF_ENABLE_CONNECT",
"CLI_PREF_ENABLE_XD_PROXY",
"WSHOST",
"WEB_CA_BUNDLE",
"IS_OPENVPN_WEB_CA",
"NO_WEB",
"ORGANIZATION"};
std::unordered_set<std::string> ignore_unknown_option_list;
if (opt.exists("ignore-unknown-option"))
{
auto igOptlist = opt.get_index("ignore-unknown-option");
for (auto igUnOptIdx : igOptlist)
{
const Option &o = opt[igUnOptIdx];
for (size_t i = 1; i < o.size(); i++)
{
const auto &optionToIgnore = o.get(i, 0);
ignore_unknown_option_list.insert(optionToIgnore);
}
o.touch();
}
}
for (const auto &o : opt)
{
if (!o.meta() && settings_ignoreSilently.find(o.get(0, 0)) != settings_ignoreSilently.end())
{
o.touch();
}
if (o.meta() && ignoreMetaOptions.find(o.get(0, 0)) != ignoreMetaOptions.end())
{
o.touch();
}
}
/* Mark all options that will not trigger any kind of message
* as touched to avoid an empty message with unused options */
if (opt.n_unused() == 0)
return;
OPENVPN_LOG_NTNL("NOTE: This configuration contains options that were not used:" << std::endl);
OptionErrors errors{};
/* Go through all options and check all options that have not been
* touched (parsed) yet */
showUnusedOptionsByList(opt, settings_removedOptions, "Removed deprecated option", true, errors);
showUnusedOptionsByList(opt, settings_serverOnlyOptions, "Server only option", true, errors);
showUnusedOptionsByList(opt, settings_standalone_options, "OpenVPN 2.x command line operation", true, errors);
showUnusedOptionsByList(opt, settings_feature_not_implemented_warn, "Feature not implemented (option ignored)", false, errors);