Project

General

Profile

Download (66.6 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
/*
3
 * openvpn.inc
4
 *
5
 * part of pfSense (https://www.pfsense.org)
6
 * Copyright (c) 2006 Fernando Lemos
7
 * Copyright (c) 2006-2013 BSD Perimeter
8
 * Copyright (c) 2013-2016 Electric Sheep Fencing
9
 * Copyright (c) 2014-2021 Rubicon Communications, LLC (Netgate)
10
 * All rights reserved.
11
 *
12
 * This file was rewritten from scratch by Fernando Lemos but
13
 * *MIGHT* contain code previously written by:
14
 *
15
 * Copyright (c) 2005 Peter Allgeyer <allgeyer_AT_web.de>
16
 * Copyright (c) 2004 Peter Curran (peter@closeconsultants.com).
17
 * All rights reserved.
18
 *
19
 * Licensed under the Apache License, Version 2.0 (the "License");
20
 * you may not use this file except in compliance with the License.
21
 * You may obtain a copy of the License at
22
 *
23
 * http://www.apache.org/licenses/LICENSE-2.0
24
 *
25
 * Unless required by applicable law or agreed to in writing, software
26
 * distributed under the License is distributed on an "AS IS" BASIS,
27
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
28
 * See the License for the specific language governing permissions and
29
 * limitations under the License.
30
 */
31

    
32
require_once('config.inc');
33
require_once("certs.inc");
34
require_once('pfsense-utils.inc');
35
require_once("auth.inc");
36

    
37
global $openvpn_prots;
38
$openvpn_prots = array(
39
	"UDP4" => "UDP on IPv4 only",
40
	"UDP6" => "UDP on IPv6 only",
41
	"TCP4" => "TCP on IPv4 only",
42
	"TCP6" => "TCP on IPv6 only",
43
	"UDP" => "UDP IPv4 and IPv6 on all interfaces (multihome)",
44
	"TCP" => "TCP IPv4 and IPv6 on all interfaces (multihome)"
45
);
46

    
47
global $openvpn_dev_mode;
48
$openvpn_dev_mode = array(
49
	"tun" => "tun - Layer 3 Tunnel Mode",
50
	"tap" => "tap - Layer 2 Tap Mode"
51
);
52

    
53
global $openvpn_verbosity_level;
54
$openvpn_verbosity_level = array(
55
	0 =>	gettext("none"),
56
	1 =>	gettext("default"),
57
	2 =>	"2",
58
	3 =>	gettext("3 (recommended)"),
59
	4 =>	"4",
60
	5 => 	"5",
61
	6 => 	"6",
62
	7 => 	"7",
63
	8 => 	"8",
64
	9 => 	"9",
65
	10 => 	"10",
66
	11 => 	"11"
67
);
68

    
69
/*
70
 * The User Auth mode below is disabled because
71
 * OpenVPN erroneously requires that we provide
72
 * a CA configuration parameter. In this mode,
73
 * clients don't send a certificate so there is
74
 * no need for a CA. If we require that admins
75
 * provide one in the pfSense UI due to a bogus
76
 * requirement imposed by OpenVPN, it could be
77
 * considered very confusing ( I know I was ).
78
 *
79
 * -mgrooms
80
 */
81

    
82
global $openvpn_dh_lengths;
83
$openvpn_dh_lengths = array(
84
	1024 => "1024 bit",
85
	2048 => "2048 bit",
86
	3072 => "3072 bit",
87
	4096 => "4096 bit",
88
	6144 => "6144 bit",
89
	7680 => "7680 bit",
90
	8192 => "8192 bit",
91
	15360 => "15360 bit",
92
	16384 => "16384 bit",
93
	"none" => "ECDH Only"
94
);
95
foreach ($openvpn_dh_lengths as $idx => $dhlen) {
96
	if (is_numeric($idx) && !file_exists("/etc/dh-parameters.{$idx}")) {
97
		unset($openvpn_dh_lengths[$idx]);
98
	}
99
}
100

    
101
global $openvpn_cert_depths;
102
$openvpn_cert_depths = array(
103
	1 => gettext("One (Client+Server)"),
104
	2 => gettext("Two (Client+Intermediate+Server)"),
105
	3 => gettext("Three (Client+2xIntermediate+Server)"),
106
	4 => gettext("Four (Client+3xIntermediate+Server)"),
107
	5 => gettext("Five (Client+4xIntermediate+Server)")
108
);
109

    
110
global $openvpn_server_modes;
111
$openvpn_server_modes = array(
112
	'p2p_tls' => gettext("Peer to Peer ( SSL/TLS )"),
113
	'p2p_shared_key' => gettext("Peer to Peer ( Shared Key )"),
114
	'server_tls' => gettext("Remote Access ( SSL/TLS )"),
115
	'server_user' => gettext("Remote Access ( User Auth )"),
116
	'server_tls_user' => gettext("Remote Access ( SSL/TLS + User Auth )"));
117

    
118
global $openvpn_tls_server_modes;
119
$openvpn_tls_server_modes = array('p2p_tls', 'server_tls', 'server_user', 'server_tls_user');
120

    
121
global $openvpn_client_modes;
122
$openvpn_client_modes = array(
123
	'p2p_tls' => gettext("Peer to Peer ( SSL/TLS )"),
124
	'p2p_shared_key' => gettext("Peer to Peer ( Shared Key )"));
125

    
126
global $openvpn_allow_compression;
127
$openvpn_allow_compression = array(
128
	'asym' => gettext("Decompress incoming, do not compress outgoing (Asymmetric)"),
129
	'no'   => gettext("Refuse any non-stub compression (Most secure)"),
130
	'yes'  => gettext("Compress packets (WARNING: Potentially dangerous!)"),
131
);
132

    
133
global $openvpn_compression_modes;
134
$openvpn_compression_modes = array(
135
	'' => gettext("Disable Compression [Omit Preference]"),
136
	'none' => gettext("Disable Compression, retain compression packet framing [compress]"),
137
	'stub' => gettext("Enable Compression (stub) [compress stub]"),
138
	'stub-v2' => gettext("Enable Compression (stub v2) [compress stub-v2]"),
139
	'lz4' => gettext("LZ4 Compression [compress lz4]"),
140
	'lz4-v2' => gettext("LZ4 Compression v2 [compress lz4-v2]"),
141
	'lzo' => gettext("LZO Compression [compress lzo, equivalent to comp-lzo yes for compatibility]"),
142
	'noadapt' => gettext("Omit Preference, + Disable Adaptive LZO Compression [Legacy style, comp-noadapt]"),
143
	'adaptive' => gettext("Adaptive LZO Compression [Legacy style, comp-lzo adaptive]"),
144
	'yes' => gettext("LZO Compression [Legacy style, comp-lzo yes]"),
145
	'no' => gettext("No LZO Compression [Legacy style, comp-lzo no]"),
146
);
147

    
148
global $openvpn_topologies;
149
$openvpn_topologies = array(
150
	'subnet' => gettext("Subnet -- One IP address per client in a common subnet"),
151
	'net30' => gettext("net30 -- Isolated /30 network per client")
152
);
153

    
154
global $openvpn_tls_modes;
155
$openvpn_tls_modes = array(
156
	'auth' => gettext("TLS Authentication"),
157
	'crypt' => gettext("TLS Encryption and Authentication")
158
);
159

    
160
global $openvpn_ping_method;
161
$openvpn_ping_method = array(
162
	'keepalive' => gettext("keepalive -- Use keepalive helper to define ping configuration"),
163
	'ping' => gettext("ping -- Define ping/ping-exit/ping-restart manually")
164
);
165

    
166
global $openvpn_default_keepalive_interval;
167
$openvpn_default_keepalive_interval = 10;
168

    
169
global $openvpn_default_keepalive_timeout;
170
$openvpn_default_keepalive_timeout = 60;
171

    
172
global $openvpn_ping_action;
173
$openvpn_ping_action = array(
174
	'ping_restart' => gettext("ping-restart -- Restart OpenVPN after timeout"),
175
	'ping_exit' => gettext("ping-exit -- Exit OpenVPN after timeout")
176
);
177

    
178
global $openvpn_exit_notify_server;
179
$openvpn_exit_notify_server = array(
180
	'none' => gettext("Disabled"),
181
	'1' => gettext("Reconnect to this server / Retry once"),
182
	'2' => gettext("Reconnect to next server / Retry twice"),
183
);
184

    
185
global $openvpn_exit_notify_client;
186
$openvpn_exit_notify_client = array(
187
	'none' => gettext("Disabled"),
188
);
189
for ($i=1; $i<=5; $i++) {
190
	$openvpn_exit_notify_client[$i] = sprintf(gettext("Retry %dx"), $i);
191
}
192

    
193
function openvpn_build_mode_list() {
194
	global $openvpn_server_modes;
195

    
196
	$list = array();
197

    
198
	foreach ($openvpn_server_modes as $name => $desc) {
199
		$list[$name] = $desc;
200
	}
201

    
202
	return($list);
203
}
204

    
205
global $openvpn_interfacenames;
206
function convert_openvpn_interface_to_friendly_descr($if) {
207
	global $openvpn_interfacenames;
208
	if (!is_array($openvpn_interfacenames)) {
209
		$openvpn_interfacenames = openvpn_build_if_list();
210
	}
211
	foreach($openvpn_interfacenames as $key => $value) {
212
		list($item_if, $item_ip) = explode("|", $key);
213
		if ($if == $item_if) {
214
			echo "$value";
215
		}
216
	}
217
}
218

    
219
function openvpn_build_if_list() {
220
	$list = array();
221

    
222
	$interfaces = get_configured_interface_with_descr();
223
	$viplist = get_configured_vip_list();
224
	foreach ($viplist as $vip => $address) {
225
		$interfaces[$vip.'|'.$address] = $address;
226
		if (get_vip_descr($address)) {
227
			$interfaces[$vip.'|'.$address] .= " (";
228
			$interfaces[$vip.'|'.$address] .= get_vip_descr($address);
229
			$interfaces[$vip.'|'.$address] .= ")";
230
		}
231
	}
232

    
233
	$grouplist = return_gateway_groups_array();
234
	foreach ($grouplist as $name => $group) {
235
		if ($group[0]['vip'] != "") {
236
			$vipif = $group[0]['vip'];
237
		} else {
238
			$vipif = $group[0]['int'];
239
		}
240

    
241
		$interfaces[$name] = "GW Group {$name}";
242
	}
243

    
244
	$interfaces['lo0'] = "Localhost";
245
	$interfaces['any'] = "any";
246

    
247
	foreach ($interfaces as $iface => $ifacename) {
248
	   $list[$iface] = $ifacename;
249
	}
250

    
251
	return($list);
252
}
253

    
254
function openvpn_build_crl_list() {
255
	global $a_crl;
256

    
257
	$list = array('' => 'None');
258

    
259
	foreach ($a_crl as $crl) {
260
		$caname = "";
261
		$ca = lookup_ca($crl['caref']);
262

    
263
		if ($ca) {
264
			$caname = " (CA: {$ca['descr']})";
265
		}
266

    
267
		$list[$crl['refid']] = $crl['descr'] . $caname;
268
	}
269

    
270
	return($list);
271
}
272

    
273
function openvpn_build_cert_list($include_none = false, $prioritize_server_certs = false) {
274
	global $a_cert;
275
	$openvpn_compatible_certs = cert_build_list('cert', 'OpenVPN');
276

    
277
	if ($include_none) {
278
		$list = array('' => gettext('None (Username and/or Password required)'));
279
	} else {
280
		$list = array();
281
	}
282

    
283
	$non_server_list = array();
284

    
285
	if ($prioritize_server_certs) {
286
		$list[' '] = gettext("===== Server Certificates =====");
287
		$non_server_list['  '] = gettext("===== Non-Server Certificates =====");
288
	}
289

    
290
	foreach ($a_cert as $cert) {
291
		if (!array_key_exists($cert['refid'], $openvpn_compatible_certs)) {
292
			continue;
293
		}
294
		$properties = array();
295
		$propstr = "";
296
		$ca = lookup_ca($cert['caref']);
297
		$purpose = cert_get_purpose($cert['crt'], true);
298

    
299
		if ($purpose['server'] == "Yes") {
300
			$properties[] = gettext("Server: Yes");
301
		} elseif ($prioritize_server_certs) {
302
			$properties[] = gettext("Server: NO");
303
		}
304
		if ($ca) {
305
			$properties[] = sprintf(gettext("CA: %s"), $ca['descr']);
306
		}
307
		if (cert_in_use($cert['refid'])) {
308
			$properties[] = gettext("In Use");
309
		}
310
		if (is_cert_revoked($cert)) {
311
			$properties[] = gettext("Revoked");
312
		}
313

    
314
		if (!empty($properties)) {
315
			$propstr = " (" . implode(", ", $properties) . ")";
316
		}
317

    
318
		if ($prioritize_server_certs) {
319
			if ($purpose['server'] == "Yes") {
320
				$list[$cert['refid']] = $cert['descr'] . $propstr;
321
			} else {
322
				$non_server_list[$cert['refid']] = $cert['descr'] . $propstr;
323
			}
324
		} else {
325
			$list[$cert['refid']] = $cert['descr'] . $propstr;
326
		}
327
	}
328

    
329
	return(array('server' => $list, 'non-server' => $non_server_list));
330
}
331

    
332
function openvpn_build_bridge_list() {
333
	$list = array();
334

    
335
	$serverbridge_interface['none'] = "none";
336
	$serverbridge_interface = array_merge($serverbridge_interface, get_configured_interface_with_descr());
337
	$viplist = get_configured_vip_list();
338

    
339
	foreach ($viplist as $vip => $address) {
340
		$serverbridge_interface[$vip.'|'.$address] = $address;
341
		if (get_vip_descr($address)) {
342
			$serverbridge_interface[$vip.'|'.$address] .= " (". get_vip_descr($address) .")";
343
		}
344
	}
345

    
346
	foreach ($serverbridge_interface as $iface => $ifacename) {
347
		$list[$iface] = htmlspecialchars($ifacename);
348
	}
349

    
350
	return($list);
351
}
352

    
353
function openvpn_create_key() {
354

    
355
	$fp = popen("/usr/local/sbin/openvpn --genkey secret /dev/stdout 2>/dev/null", "r");
356
	if (!$fp) {
357
		return false;
358
	}
359

    
360
	$rslt = stream_get_contents($fp);
361
	pclose($fp);
362

    
363
	return $rslt;
364
}
365

    
366
function openvpn_create_dhparams($bits) {
367

    
368
	$fp = popen("/usr/bin/openssl dhparam {$bits} 2>/dev/null", "r");
369
	if (!$fp) {
370
		return false;
371
	}
372

    
373
	$rslt = stream_get_contents($fp);
374
	pclose($fp);
375

    
376
	return $rslt;
377
}
378

    
379
function openvpn_vpnid_used($vpnid) {
380
	global $config;
381

    
382
	if (is_array($config['openvpn']['openvpn-server'])) {
383
		foreach ($config['openvpn']['openvpn-server'] as & $settings) {
384
			if ($vpnid == $settings['vpnid']) {
385
				return true;
386
			}
387
		}
388
	}
389

    
390
	if (is_array($config['openvpn']['openvpn-client'])) {
391
		foreach ($config['openvpn']['openvpn-client'] as & $settings) {
392
			if ($vpnid == $settings['vpnid']) {
393
				return true;
394
			}
395
		}
396
	}
397

    
398
	return false;
399
}
400

    
401
function openvpn_vpnid_next() {
402

    
403
	$vpnid = 1;
404
	while (openvpn_vpnid_used($vpnid)) {
405
		$vpnid++;
406
	}
407

    
408
	return $vpnid;
409
}
410

    
411
function openvpn_port_used($prot, $interface, $port, $curvpnid = 0) {
412
	global $config;
413

    
414
	$ovpn_settings = array();
415
	if (is_array($config['openvpn']['openvpn-server'])) {
416
		$ovpn_settings = $config['openvpn']['openvpn-server'];
417
	}
418
	if (is_array($config['openvpn']['openvpn-client'])) {
419
		$ovpn_settings = array_merge($ovpn_settings,
420
		    $config['openvpn']['openvpn-client']);
421
	}
422

    
423
	foreach ($ovpn_settings as $settings) {
424
		if (isset($settings['disable'])) {
425
			continue;
426
		}
427

    
428
		if ($curvpnid != 0 && $curvpnid == $settings['vpnid']) {
429
			continue;
430
		}
431

    
432
		/* (TCP|UDP)(4|6) does not conflict unless interface is any */
433
		if (($interface != "any" && $settings['interface'] != "any") &&
434
		    (strlen($prot) == 4) &&
435
		    (strlen($settings['protocol']) == 4) &&
436
		    substr($prot,0,3) == substr($settings['protocol'],0,3) &&
437
		    substr($prot,3,1) != substr($settings['protocol'],3,1)) {
438
			continue;
439
		}
440

    
441
		if ($port == $settings['local_port'] &&
442
		    substr($prot,0,3) == substr($settings['protocol'],0,3) &&
443
		    ($interface == $settings['interface'] ||
444
		    $interface == "any" || $settings['interface'] == "any")) {
445
			return $settings['vpnid'];
446
		}
447
	}
448

    
449
	return 0;
450
}
451

    
452
function openvpn_port_next($prot, $interface = "wan") {
453

    
454
	$port = 1194;
455
	while (openvpn_port_used($prot, $interface, $port)) {
456
		$port++;
457
	}
458
	while (openvpn_port_used($prot, "any", $port)) {
459
		$port++;
460
	}
461

    
462
	return $port;
463
}
464

    
465
function openvpn_get_cipherlist() {
466

    
467
	$ciphers = array();
468
	$cipher_out = shell_exec('/usr/local/sbin/openvpn --show-ciphers | /usr/bin/grep \'(.*key\' | sed \'s/, TLS client\/server mode only//\'');
469
	$cipher_lines = explode("\n", trim($cipher_out));
470
	sort($cipher_lines);
471
	foreach ($cipher_lines as $line) {
472
		$words = explode(' ', $line, 2);
473
		$ciphers[$words[0]] = "{$words[0]} {$words[1]}";
474
	}
475
	$ciphers["none"] = gettext("None (No Encryption)");
476
	return $ciphers;
477
}
478

    
479
function openvpn_get_curvelist() {
480
	global $cert_curve_compatible;
481
	$curves = array();
482
	$curves["none"] = gettext("Use Default");
483
	foreach ($cert_curve_compatible['OpenVPN'] as $curve) {
484
		$curves[$curve] = $curve;
485
	}
486
	return $curves;
487
}
488

    
489
function openvpn_validate_curve($curve) {
490
	$curves = openvpn_get_curvelist();
491
	return array_key_exists($curve, $curves);
492
}
493

    
494
/* Obtain the list of digest algorithms supported by openssl and their alternate names */
495
function openvpn_get_openssldigestmappings() {
496
	$digests = array();
497
	$digest_out = shell_exec('/usr/bin/openssl list -digest-algorithms | /usr/bin/grep "=>"');
498
	$digest_lines = explode("\n", trim($digest_out));
499
	sort($digest_lines);
500
	foreach ($digest_lines as $line) {
501
		$words = explode(' => ', $line, 2);
502
		$digests[$words[0]] = $words[1];
503
	}
504
	return $digests;
505
}
506

    
507
/* Obtain the list of digest algorithms supported by openvpn */
508
function openvpn_get_digestlist() {
509
	/* Grab the list from OpenSSL to check for duplicates or aliases */
510
	$openssl_digest_mappings = openvpn_get_openssldigestmappings();
511
	$digests = array();
512
	$digest_out = shell_exec('/usr/local/sbin/openvpn --show-digests | /usr/bin/grep "digest size" | /usr/bin/awk \'{print $1, "(" $2 "-" $3 ")";}\'');
513
	$digest_lines = explode("\n", trim($digest_out));
514
	sort($digest_lines);
515
	foreach ($digest_lines as $line) {
516
		$words = explode(' ', $line);
517
		/* Only add the entry if it is NOT also listed as being an alias/mapping by OpenSSL */
518
		if (!array_key_exists($words[0], $openssl_digest_mappings)) {
519
			$digests[$words[0]] = "{$words[0]} {$words[1]}";
520
		}
521
	}
522
	$digests["none"] = gettext("None (No Authentication)");
523
	return $digests;
524
}
525

    
526
/* Check to see if a digest name is an alias and if so, find the actual digest
527
 * algorithm instead. Useful for upgrade code that has to translate aliased
528
 * algorithms to their actual names.
529
 */
530
function openvpn_remap_digest($digest) {
531
	$openssl_digest_mappings = openvpn_get_openssldigestmappings();
532
	if (array_key_exists($digest, $openssl_digest_mappings)) {
533
		/* Some mappings point to other mappings, keep going until we find the actual digest algorithm */
534
		if (array_key_exists($openssl_digest_mappings[$digest], $openssl_digest_mappings)) {
535
			return openvpn_remap_digest($openssl_digest_mappings[$digest]);
536
		} else {
537
			return $openssl_digest_mappings[$digest];
538
		}
539
	}
540
	return $digest;
541
}
542

    
543
function openvpn_get_keydirlist() {
544
	$keydirs = array(
545
		'default'  => gettext('Use default direction'),
546
		'0' => gettext('Direction 0'),
547
		'1' => gettext('Direction 1'),
548
		'2' => gettext('Both directions'),
549
	);
550
	return $keydirs;
551
}
552

    
553
function openvpn_get_engines() {
554
	$openssl_engines = array('none' => gettext('No Hardware Crypto Acceleration'));
555
	exec("/usr/bin/openssl engine -t -c", $openssl_engine_output);
556
	$openssl_engine_output = implode("\n", $openssl_engine_output);
557
	$openssl_engine_output = preg_replace("/\\n\\s+/", "|", $openssl_engine_output);
558
	$openssl_engine_output = explode("\n", $openssl_engine_output);
559

    
560
	foreach ($openssl_engine_output as $oeo) {
561
		$keep = true;
562
		$details = explode("|", $oeo);
563
		$engine = array_shift($details);
564
		$linematch = array();
565
		preg_match("/\((.*)\)\s(.*)/", $engine, $linematch);
566
		foreach ($details as $dt) {
567
			if (strpos($dt, "unavailable") !== FALSE) {
568
				$keep = false;
569
			}
570
			if (strpos($dt, "available") !== FALSE) {
571
				continue;
572
			}
573
			if (strpos($dt, "[") !== FALSE) {
574
				$ciphers = trim($dt, "[]");
575
			}
576
		}
577
		if (!empty($ciphers)) {
578
			$ciphers = " - " . $ciphers;
579
		}
580
		if (strlen($ciphers) > 60) {
581
			$ciphers = substr($ciphers, 0, 60) . " ... ";
582
		}
583
		if ($keep) {
584
			$openssl_engines[$linematch[1]] = $linematch[2] . $ciphers;
585
		}
586
	}
587
	return $openssl_engines;
588
}
589

    
590
function openvpn_get_buffer_values() {
591
	$sendbuf_max = get_single_sysctl('net.inet.tcp.sendbuf_max');
592
	$recvbuf_max = get_single_sysctl('net.inet.tcp.recvbuf_max');
593
	/* Usually these two are equal, but if they are not, take whichever one is lower. */
594
	$buffer_max = ($sendbuf_max <= $recvbuf_max) ? $sendbuf_max : $recvbuf_max;
595
	$buffer_values = array('' => gettext('Default'));
596
	for ($bs = 32; $bs >= 1; $bs /= 2) {
597
		$buffer_values[$buffer_max/$bs] = format_bytes($buffer_max/$bs);
598
	}
599
	return $buffer_values;
600
}
601

    
602
function openvpn_validate_engine($engine) {
603
	$engines = openvpn_get_engines();
604
	return array_key_exists($engine, $engines);
605
}
606

    
607
function openvpn_validate_host($value, $name) {
608
	$value = trim($value);
609
	if (empty($value) || (!is_domain($value) && !is_ipaddr($value))) {
610
		return sprintf(gettext("The field '%s' must contain a valid IP address or domain name."), $name);
611
	}
612
	return false;
613
}
614

    
615
function openvpn_validate_port($value, $name, $first_port = 0) {
616
	$value = trim($value);
617
	if (!is_numeric($first_port)) {
618
		$first_port = 0;
619
	}
620
	if (empty($value) || !is_numeric($value) || $value < $first_port || ($value > 65535)) {
621
		return sprintf(gettext("The field '%s' must contain a valid port, ranging from %s to 65535."), $name, $first_port);
622
	}
623
	return false;
624
}
625

    
626
function openvpn_validate_cidr($value, $name, $multiple = false, $ipproto = "ipv4") {
627
	$value = trim($value);
628
	$error = false;
629
	if (empty($value)) {
630
		return false;
631
	}
632
	$networks = explode(',', $value);
633

    
634
	if (!$multiple && (count($networks) > 1)) {
635
		return sprintf(gettext("The field '%1\$s' must contain a single valid %2\$s CIDR range."), $name, $ipproto);
636
	}
637

    
638
	foreach ($networks as $network) {
639
		if ($ipproto == "ipv4") {
640
			$error = !openvpn_validate_cidr_ipv4($network);
641
		} else {
642
			$error = !openvpn_validate_cidr_ipv6($network);
643
		}
644
		if ($error) {
645
			break;
646
		}
647
	}
648

    
649
	if ($error) {
650
		return sprintf(gettext("The field '%1\$s' must contain only valid %2\$s CIDR range(s) separated by commas."), $name, $ipproto);
651
	} else {
652
		return false;
653
	}
654
}
655

    
656
function openvpn_validate_cidr_ipv4($value) {
657
	$value = trim($value);
658
	if (!empty($value)) {
659
		list($ip, $mask) = explode('/', $value);
660
		if (!is_ipaddrv4($ip) or !is_numeric($mask) or ($mask > 32) or ($mask < 0)) {
661
			return false;
662
		}
663
	}
664
	return true;
665
}
666

    
667
function openvpn_validate_cidr_ipv6($value) {
668
	$value = trim($value);
669
	if (!empty($value)) {
670
		list($ipv6, $prefix) = explode('/', $value);
671
		if (empty($prefix)) {
672
			$prefix = "128";
673
		}
674
		if (!is_ipaddrv6($ipv6) or !is_numeric($prefix) or ($prefix > 128) or ($prefix < 0)) {
675
			return false;
676
		}
677
	}
678
	return true;
679
}
680

    
681
function openvpn_add_dhcpopts(& $settings, & $conf) {
682

    
683
	if (!empty($settings['dns_domain'])) {
684
		$conf .= "push \"dhcp-option DOMAIN {$settings['dns_domain']}\"\n";
685
	}
686

    
687
	if (!empty($settings['dns_server1'])) {
688
		$dnstype = (is_ipaddrv6($settings['dns_server1'])) ? "DNS6" : "DNS";
689
		$conf .= "push \"dhcp-option {$dnstype} {$settings['dns_server1']}\"\n";
690
	}
691
	if (!empty($settings['dns_server2'])) {
692
		$dnstype = (is_ipaddrv6($settings['dns_server2'])) ? "DNS6" : "DNS";
693
		$conf .= "push \"dhcp-option {$dnstype} {$settings['dns_server2']}\"\n";
694
	}
695
	if (!empty($settings['dns_server3'])) {
696
		$dnstype = (is_ipaddrv6($settings['dns_server3'])) ? "DNS6" : "DNS";
697
		$conf .= "push \"dhcp-option {$dnstype} {$settings['dns_server3']}\"\n";
698
	}
699
	if (!empty($settings['dns_server4'])) {
700
		$dnstype = (is_ipaddrv6($settings['dns_server4'])) ? "DNS6" : "DNS";
701
		$conf .= "push \"dhcp-option {$dnstype} {$settings['dns_server4']}\"\n";
702
	}
703

    
704
	if (!empty($settings['push_blockoutsidedns'])) {
705
		$conf .= "push \"block-outside-dns\"\n";
706
	}
707
	if (!empty($settings['push_register_dns'])) {
708
		$conf .= "push \"register-dns\"\n";
709
	}
710

    
711
	if (!empty($settings['ntp_server1'])) {
712
		$conf .= "push \"dhcp-option NTP {$settings['ntp_server1']}\"\n";
713
	}
714
	if (!empty($settings['ntp_server2'])) {
715
		$conf .= "push \"dhcp-option NTP {$settings['ntp_server2']}\"\n";
716
	}
717

    
718
	if ($settings['netbios_enable']) {
719

    
720
		if (!empty($settings['dhcp_nbttype']) && ($settings['dhcp_nbttype'] != 0)) {
721
			$conf .= "push \"dhcp-option NBT {$settings['dhcp_nbttype']}\"\n";
722
		}
723
		if (!empty($settings['dhcp_nbtscope'])) {
724
			$conf .= "push \"dhcp-option NBS {$settings['dhcp_nbtscope']}\"\n";
725
		}
726

    
727
		if (!empty($settings['wins_server1'])) {
728
			$conf .= "push \"dhcp-option WINS {$settings['wins_server1']}\"\n";
729
		}
730
		if (!empty($settings['wins_server2'])) {
731
			$conf .= "push \"dhcp-option WINS {$settings['wins_server2']}\"\n";
732
		}
733

    
734
		if (!empty($settings['nbdd_server1'])) {
735
			$conf .= "push \"dhcp-option NBDD {$settings['nbdd_server1']}\"\n";
736
		}
737
	}
738

    
739
	if ($settings['gwredir']) {
740
		$conf .= "push \"redirect-gateway def1\"\n";
741
	}
742
	if ($settings['gwredir6']) {
743
		$conf .= "push \"redirect-gateway ipv6\"\n";
744
	}
745
}
746

    
747
function openvpn_add_custom(& $settings, & $conf) {
748

    
749
	if ($settings['custom_options']) {
750

    
751
		$options = explode(';', $settings['custom_options']);
752

    
753
		if (is_array($options)) {
754
			foreach ($options as $option) {
755
				$conf .= "$option\n";
756
			}
757
		} else {
758
			$conf .= "{$settings['custom_options']}\n";
759
		}
760
	}
761
}
762

    
763
function openvpn_add_keyfile(& $data, & $conf, $mode_id, $directive, $opt = "") {
764
	global $g;
765

    
766
	$fpath = "{$g['openvpn_base']}/{$mode_id}/{$directive}";
767
	openvpn_create_dirs();
768
	file_put_contents($fpath, base64_decode($data));
769
	//chown($fpath, 'nobody');
770
	//chgrp($fpath, 'nobody');
771
	@chmod($fpath, 0600);
772

    
773
	$conf .= "{$directive} {$fpath} {$opt}\n";
774
}
775

    
776
function openvpn_reconfigure($mode, $settings) {
777
	global $g, $config, $openvpn_tls_server_modes, $openvpn_dh_lengths, $openvpn_default_keepalive_interval, $openvpn_default_keepalive_timeout;
778

    
779
	if (empty($settings)) {
780
		return;
781
	}
782
	if (isset($settings['disable'])) {
783
		return;
784
	}
785
	openvpn_create_dirs();
786
	/*
787
	 * NOTE: Deleting tap devices causes spontaneous reboots. Instead,
788
	 * we use a vpnid number which is allocated for a particular client
789
	 * or server configuration. ( see openvpn_vpnid_next() )
790
	 */
791

    
792
	$vpnid = $settings['vpnid'];
793
	$mode_id = $mode.$vpnid;
794

    
795
	if (isset($settings['dev_mode'])) {
796
		$tunname = "{$settings['dev_mode']}{$vpnid}";
797
	} else {
798
		/* defaults to tun */
799
		$tunname = "tun{$vpnid}";
800
		$settings['dev_mode'] = "tun";
801
	}
802

    
803
	if ($mode == "server") {
804
		$devname = "ovpns{$vpnid}";
805
	} else {
806
		$devname = "ovpnc{$vpnid}";
807
	}
808

    
809
	/* is our device already configured */
810
	if (!does_interface_exist($devname)) {
811

    
812
		/* create the tap device if required */
813
		if (!file_exists("/dev/{$tunname}")) {
814
			exec("/sbin/ifconfig " . escapeshellarg($tunname) . " create");
815
		}
816

    
817
		/* rename the device */
818
		mwexec("/sbin/ifconfig " . escapeshellarg($tunname) . " name " . escapeshellarg($devname));
819

    
820
		/* add the device to the openvpn group and make sure it's UP*/
821
		mwexec("/sbin/ifconfig " . escapeshellarg($devname) . " group openvpn up");
822

    
823
		$ifname = convert_real_interface_to_friendly_interface_name($devname);
824
		$grouptmp = link_interface_to_group($ifname);
825
		if (!empty($grouptmp)) {
826
			array_walk($grouptmp, 'interface_group_add_member');
827
		}
828
		unset($grouptmp, $ifname);
829
	}
830

    
831
	$pfile = $g['varrun_path'] . "/openvpn_{$mode_id}.pid";
832
	$proto = strtolower($settings['protocol']);
833
	if (substr($settings['protocol'], 0, 3) == "TCP") {
834
			$proto = "{$proto}-{$mode}";
835
	}
836
	$dev_mode = $settings['dev_mode'];
837
	$fbcipher = $settings['data_ciphers_fallback'];
838
	// OpenVPN defaults to SHA1, so use it when unset to maintain compatibility.
839
	$digest = !empty($settings['digest']) ? $settings['digest'] : "SHA1";
840

    
841
	$interface = get_failover_interface($settings['interface']);
842
	// The IP address in the settings can be an IPv4 or IPv6 address associated with the interface
843
	$ipaddr = $settings['ipaddr'];
844

    
845
	// If a specific ip address (VIP) is requested, use it.
846
	// Otherwise, if a specific interface is requested, use it
847
	// If "any" interface was selected, local directive will be omitted.
848
	if (is_ipaddrv4($ipaddr)) {
849
		$iface_ip = $ipaddr;
850
	} elseif (!empty($interface) && strcmp($interface, "any")) {
851
		$iface_ip=get_interface_ip($interface);
852
	}
853
	if (is_ipaddrv6($ipaddr)) {
854
		$iface_ipv6 = $ipaddr;
855
	} elseif (!empty($interface) && strcmp($interface, "any")) {
856
		/* get correct interface name for 6RD/6to4 interfaces
857
		 * see https://redmine.pfsense.org/issues/11674 */
858
		if (is_stf_interface($settings['interface'])) {
859
			$iface_ipv6=get_interface_ipv6($settings['interface']);
860
		} else {
861
			$iface_ipv6=get_interface_ipv6($interface);
862
		}
863
	}
864

    
865
	$conf = "dev {$devname}\n";
866
	if (isset($settings['verbosity_level'])) {
867
		$conf .= "verb {$settings['verbosity_level']}\n";
868
	}
869

    
870
	$conf .= "dev-type {$settings['dev_mode']}\n";
871
	$conf .= "dev-node /dev/{$tunname}\n";
872
	$conf .= "writepid {$pfile}\n";
873
	$conf .= "#user nobody\n";
874
	$conf .= "#group nobody\n";
875
	$conf .= "script-security 3\n";
876
	$conf .= "daemon\n";
877

    
878
	if (!empty($settings['inactive_seconds'])) {
879
		$conf .= "inactive {$settings['inactive_seconds']}\n";
880
	}
881

    
882
	if (!empty($settings['ping_method']) &&
883
	    $settings['ping_method'] == 'ping') {
884
		$conf .= "ping {$settings['ping_seconds']}\n";
885

    
886
		if (!empty($settings['ping_push'])) {
887
			$conf .= "push \"ping {$settings['ping_seconds']}\"\n";
888
		}
889

    
890
		$action = str_replace("_", "-", $settings['ping_action']);
891
		$conf .= "{$action} {$settings['ping_action_seconds']}\n";
892

    
893
		if (!empty($settings['ping_action_push'])) {
894
			$conf .= "push \"{$action} " .
895
			    "{$settings['ping_action_seconds']}\"\n";
896
		}
897
	} else {
898
		$conf .= "keepalive " .
899
		    ($settings['keepalive_interval']
900
			?: $openvpn_default_keepalive_interval) . " " .
901
		    ($settings['keepalive_timeout']
902
			?: $openvpn_default_keepalive_timeout) . "\n";
903
	}
904

    
905
	$conf .= "ping-timer-rem\n";
906
	$conf .= "persist-tun\n";
907
	$conf .= "persist-key\n";
908
	$conf .= "proto {$proto}\n";
909
	$conf .= "auth {$digest}\n";
910
	if ($settings['dns_add']) {
911
		$conf .= "up /usr/local/sbin/ovpn-dnslinkup\n";
912
	} else {
913
		$conf .= "up /usr/local/sbin/ovpn-linkup\n";
914
	}
915
	$conf .= "down /usr/local/sbin/ovpn-linkdown\n";
916
	if (file_exists("/usr/local/sbin/openvpn.attributes.sh")) {
917
		switch ($settings['mode']) {
918
			case 'server_user':
919
			case 'server_tls_user':
920
				$conf .= "client-connect /usr/local/sbin/openvpn.attributes.sh\n";
921
				$conf .= "client-disconnect /usr/local/sbin/openvpn.attributes.sh\n";
922
				break;
923
		}
924
	}
925
	if ($settings['dev_mode'] === 'tun' && isset($config['unbound']['enable']) && isset($config['unbound']['regovpnclients'])) {
926
		if (($settings['mode'] == 'server_tls') || ($settings['mode'] == 'server_tls_user') ||
927
		    (($settings['mode'] == 'server_user') && ($settings['username_as_common_name'] == 'enabled'))) {
928
			$domain = !empty($settings['dns_domain']) ? $settings['dns_domain'] : $config['system']['domain'];
929
			if (is_domain($domain)) {
930
				$conf .= "learn-address \"/usr/local/sbin/openvpn.learn-address.sh $domain\"\n";
931
			}
932
		}
933
	}
934

    
935
	/*
936
	 * When binding specific address, wait cases where interface is in
937
	 * tentative state otherwise it will fail
938
	 */
939
	$wait_tentative = false;
940

    
941
	/* Determine the local IP to use - and make sure it matches with the selected protocol. */
942
	switch ($settings['protocol']) {
943
		case 'UDP':
944
		case 'TCP':
945
			$conf .= "multihome\n";
946
			break;
947
		case 'UDP4':
948
		case 'TCP4':
949
			if (is_ipaddrv4($iface_ip)) {
950
				$conf .= "local {$iface_ip}\n";
951
			}
952
			if ($settings['interface'] == "any") {
953
				$conf .= "multihome\n";
954
			}
955
			break;
956
		case 'UDP6':
957
		case 'TCP6':
958
			if (is_ipaddrv6($iface_ipv6)) {
959
				$conf .= "local {$iface_ipv6}\n";
960
				$wait_tentative = true;
961
			}
962
			if ($settings['interface'] == "any") {
963
				$conf .= "multihome\n";
964
			}
965
			break;
966
		default:
967
	}
968

    
969
	if (openvpn_validate_engine($settings['engine']) && ($settings['engine'] != "none")) {
970
		$conf .= "engine {$settings['engine']}\n";
971
	}
972

    
973
	// server specific settings
974
	if ($mode == 'server') {
975

    
976
		list($ip, $cidr) = explode('/', trim($settings['tunnel_network']));
977
		list($ipv6, $prefix) = explode('/', trim($settings['tunnel_networkv6']));
978
		$mask = gen_subnet_mask($cidr);
979

    
980
		// configure tls modes
981
		switch ($settings['mode']) {
982
			case 'p2p_tls':
983
			case 'server_tls':
984
			case 'server_user':
985
			case 'server_tls_user':
986
				$conf .= "tls-server\n";
987
				break;
988
		}
989

    
990
		// configure p2p/server modes
991
		switch ($settings['mode']) {
992
			case 'p2p_tls':
993
				// If the CIDR is less than a /30, OpenVPN will complain if you try to
994
				//  use the server directive. It works for a single client without it.
995
				//  See ticket #1417
996
				if ((!empty($ip) && !empty($mask)) ||
997
				    (!empty($ipv6) && !empty($prefix))) {
998
					$add_ccd = false;
999
					if (is_ipaddr($ip) && ($cidr < 30)) {
1000
						$add_ccd = true;
1001
						$conf .= "server {$ip} {$mask}\n";
1002
					}
1003
					if (is_ipaddr($ipv6)) {
1004
						$add_ccd = true;
1005
						$conf .= "server-ipv6 {$ipv6}/{$prefix}\n";
1006
					}
1007
					if ($add_ccd) {
1008
						$conf .= "client-config-dir {$g['openvpn_base']}/server{$vpnid}/csc\n";
1009
					}
1010
				}
1011
			case 'p2p_shared_key':
1012
				if (!empty($ip) && !empty($mask)) {
1013
					list($ip1, $ip2) = openvpn_get_interface_ip($ip, $cidr);
1014
					if ($settings['dev_mode'] == 'tun') {
1015
						$conf .= "ifconfig {$ip1} {$ip2}\n";
1016
					} else {
1017
						$conf .= "ifconfig {$ip1} {$mask}\n";
1018
					}
1019
				}
1020
				if (!empty($ipv6) && !empty($prefix)) {
1021
					list($ipv6_1, $ipv6_2) = openvpn_get_interface_ipv6($ipv6, $prefix);
1022
					if ($settings['dev_mode'] == 'tun') {
1023
						$conf .= "ifconfig-ipv6 {$ipv6_1} {$ipv6_2}\n";
1024
					} else {
1025
						$conf .= "ifconfig-ipv6 {$ipv6_1}/{$prefix} {$ipv6_2}\n";
1026
					}
1027
				}
1028
				break;
1029
			case 'server_tls':
1030
			case 'server_user':
1031
			case 'server_tls_user':
1032
				if ((!empty($ip) && !empty($mask)) ||
1033
				    (!empty($ipv6) && !empty($prefix))) {
1034
					if (is_ipaddr($ip)) {
1035
						$conf .= "server {$ip} {$mask}\n";
1036
					}
1037
					if (is_ipaddr($ipv6)) {
1038
						$conf .= "server-ipv6 {$ipv6}/{$prefix}\n";
1039
					}
1040
					$conf .= "client-config-dir {$g['openvpn_base']}/server{$vpnid}/csc\n";
1041
				} else {
1042
					if ($settings['serverbridge_dhcp']) {
1043
						if ((!empty($settings['serverbridge_interface'])) && (strcmp($settings['serverbridge_interface'], "none"))) {
1044
							$biface_ip=get_interface_ip($settings['serverbridge_interface']);
1045
							$biface_sm=gen_subnet_mask(get_interface_subnet($settings['serverbridge_interface']));
1046
							if (is_ipaddrv4($biface_ip) && is_ipaddrv4($settings['serverbridge_dhcp_start']) && is_ipaddrv4($settings['serverbridge_dhcp_end'])) {
1047
								$conf .= "server-bridge {$biface_ip} {$biface_sm} {$settings['serverbridge_dhcp_start']} {$settings['serverbridge_dhcp_end']}\n";
1048
								$conf .= "client-config-dir {$g['openvpn_base']}/server{$vpnid}/csc\n";
1049
							} else {
1050
								$conf .= "mode server\n";
1051
							}
1052
							if (!empty($settings['serverbridge_routegateway']) && is_ipaddrv4($biface_ip)) {
1053
								$conf .= "push \"route-gateway {$biface_ip}\"\n";
1054
							}
1055
							/* OpenVPN doesn't support this yet, clients do not recognize the option fully.
1056
							$biface_ip6=get_interface_ipv6($settings['serverbridge_interface']);
1057
							if (!empty($settings['serverbridge_routegateway']) && is_ipaddrv6($biface_ip6)) {
1058
								$conf .= "push \"route-ipv6-gateway {$biface_ip6}\"\n";
1059
							}
1060
							*/
1061
						} else {
1062
							$conf .= "mode server\n";
1063
						}
1064
					}
1065
				}
1066
				break;
1067
		}
1068

    
1069
		// configure user auth modes
1070
		switch ($settings['mode']) {
1071
			case 'server_user':
1072
				$conf .= "verify-client-cert none\n";
1073
			case 'server_tls_user':
1074
				/* username-as-common-name is not compatible with server-bridge */
1075
				if ((stristr($conf, "server-bridge") === false) &&
1076
				    ($settings['username_as_common_name'] != 'disabled')) {
1077
					$conf .= "username-as-common-name\n";
1078
				}
1079
				if (!empty($settings['authmode'])) {
1080
					$strictusercn = "false";
1081
					if ($settings['strictusercn']) {
1082
						$strictusercn = "true";
1083
					}
1084
					$conf .= openvpn_authscript_string($settings['authmode'], $strictusercn, $mode_id, $settings['local_port']);
1085
				}
1086
				break;
1087
		}
1088
		if (!isset($settings['cert_depth']) && (strstr($settings['mode'], 'tls'))) {
1089
			$settings['cert_depth'] = 1;
1090
		}
1091
		if (is_numeric($settings['cert_depth'])) {
1092
			if (($mode == 'client') && empty($settings['certref'])) {
1093
				$cert = "";
1094
			} else {
1095
				$cert = lookup_cert($settings['certref']);
1096
				/* XXX: Seems not used at all! */
1097
				$servercn = urlencode(cert_get_cn($cert['crt']));
1098
				$conf .= "tls-verify \"/usr/local/sbin/ovpn_auth_verify tls '{$servercn}' {$settings['cert_depth']}\"\n";
1099
			}
1100
		}
1101

    
1102
		// The local port to listen on
1103
		$conf .= "lport {$settings['local_port']}\n";
1104

    
1105
		// The management port to listen on
1106
		// Use unix socket to overcome the problem on any type of server
1107
		$conf .= "management {$g['openvpn_base']}/{$mode_id}/sock unix\n";
1108
		//$conf .= "management 127.0.0.1 {$settings['local_port']}\n";
1109

    
1110
		if ($settings['maxclients']) {
1111
			$conf .= "max-clients {$settings['maxclients']}\n";
1112
		}
1113

    
1114
		// Can we push routes, and should we?
1115
		if ($settings['local_network'] && !$settings['gwredir']) {
1116
			$conf .= openvpn_gen_routes($settings['local_network'], "ipv4", true);
1117
		}
1118
		if ($settings['local_networkv6'] && !$settings['gwredir6']) {
1119
			$conf .= openvpn_gen_routes($settings['local_networkv6'], "ipv6", true);
1120
		}
1121

    
1122
		switch ($settings['mode']) {
1123
			case 'server_tls':
1124
			case 'server_user':
1125
			case 'server_tls_user':
1126
				// Configure client dhcp options
1127
				openvpn_add_dhcpopts($settings, $conf);
1128
				if ($settings['client2client']) {
1129
					$conf .= "client-to-client\n";
1130
				}
1131
				break;
1132
		}
1133
		if ($settings['mode'] != 'p2p_shared_key' &&
1134
		    isset($settings['duplicate_cn'])) {
1135
			$conf .= "duplicate-cn\n";
1136
		}
1137
	}
1138

    
1139
	// client specific settings
1140

    
1141
	if ($mode == 'client') {
1142

    
1143
		// configure p2p mode
1144
		switch ($settings['mode']) {
1145
			case 'p2p_tls':
1146
				$conf .= "tls-client\n";
1147
			case 'shared_key':
1148
				$conf .= "client\n";
1149
				break;
1150
		}
1151

    
1152
		// If there is no bind option at all (ip and/or port), add "nobind" directive
1153
		//  Otherwise, use the local port if defined, failing that, use lport 0 to
1154
		//  ensure a random source port.
1155
		if ((empty($iface_ip)) && empty($iface_ipv6) && (!$settings['local_port'])) {
1156
			$conf .= "nobind\n";
1157
		} elseif ($settings['local_port']) {
1158
			$conf .= "lport {$settings['local_port']}\n";
1159
		} else {
1160
			$conf .= "lport 0\n";
1161
		}
1162

    
1163
		// Use unix socket to overcome the problem on any type of server
1164
		$conf .= "management {$g['openvpn_base']}/{$mode_id}/sock unix\n";
1165

    
1166
		// The remote server
1167
		$remoteproto = strtolower($settings['protocol']);
1168
		if (substr($remoteproto, 0, 3) == "tcp") {
1169
			$remoteproto .= "-{$mode}";
1170
		}
1171
		$conf .= "remote {$settings['server_addr']} {$settings['server_port']} {$remoteproto}\n";
1172

    
1173
		if (!empty($settings['use_shaper'])) {
1174
			$conf .= "shaper {$settings['use_shaper']}\n";
1175
		}
1176

    
1177
		if (!empty($settings['tunnel_network'])) {
1178
			list($ip, $cidr) = explode('/', trim($settings['tunnel_network']));
1179
			$mask = gen_subnet_mask($cidr);
1180
			list($ip1, $ip2) = openvpn_get_interface_ip($ip, $cidr);
1181
			if ($settings['dev_mode'] == 'tun') {
1182
				$conf .= "ifconfig {$ip2} {$ip1}\n";
1183
			} else {
1184
				$conf .= "ifconfig {$ip2} {$mask}\n";
1185
			}
1186
		}
1187

    
1188
		if (!empty($settings['tunnel_networkv6'])) {
1189
			list($ipv6, $prefix) = explode('/', trim($settings['tunnel_networkv6']));
1190
			list($ipv6_1, $ipv6_2) = openvpn_get_interface_ipv6($ipv6, $prefix);
1191
			if ($settings['dev_mode'] == 'tun') {
1192
				$conf .= "ifconfig-ipv6 {$ipv6_2} {$ipv6_1}\n";
1193
			} else {
1194
				$conf .= "ifconfig-ipv6 {$ipv6_1}/{$prefix} {$ipv6_2}\n";
1195
			}
1196
		}
1197

    
1198
		if (($settings['auth_user'] || $settings['auth_pass']) && $settings['mode'] == "p2p_tls") {
1199
			$up_file = "{$g['openvpn_base']}/{$mode_id}/up";
1200
			$conf .= "auth-user-pass {$up_file}\n";
1201
			if (!$settings['auth-retry-none']) {
1202
				$conf .= "auth-retry nointeract\n";
1203
			}
1204
			if ($settings['auth_user']) {
1205
				$userpass = "{$settings['auth_user']}\n";
1206
			} else {
1207
				$userpass = "";
1208
			}
1209
			if ($settings['auth_pass']) {
1210
				$userpass .= "{$settings['auth_pass']}\n";
1211
			}
1212
			// If only auth_pass is given, then it acts like a user name and we put a blank line where pass would normally go.
1213
			if (!($settings['auth_user'] && $settings['auth_pass'])) {
1214
				$userpass .= "\n";
1215
			}
1216
			file_put_contents($up_file, $userpass);
1217
		}
1218

    
1219
		if ($settings['proxy_addr']) {
1220
			$conf .= "http-proxy {$settings['proxy_addr']} {$settings['proxy_port']}";
1221
			if ($settings['proxy_authtype'] != "none") {
1222
				$conf .= " {$g['openvpn_base']}/{$mode_id}/proxy_auth {$settings['proxy_authtype']}";
1223
				$proxypas = "{$settings['proxy_user']}\n";
1224
				$proxypas .= "{$settings['proxy_passwd']}\n";
1225
				file_put_contents("{$g['openvpn_base']}/{$mode_id}/proxy_auth", $proxypas);
1226
			}
1227
			$conf .= " \n";
1228
		}
1229
	}
1230

    
1231
	// Add a remote network route if set, and only for p2p modes.
1232
	if ((substr($settings['mode'], 0, 3) == "p2p") && (openvpn_validate_cidr($settings['remote_network'], "", true, "ipv4") === FALSE)) {
1233
		$conf .= openvpn_gen_routes($settings['remote_network'], "ipv4", false);
1234
	}
1235
	// Add a remote network route if set, and only for p2p modes.
1236
	if ((substr($settings['mode'], 0, 3) == "p2p") && (openvpn_validate_cidr($settings['remote_networkv6'], "", true, "ipv6") === FALSE)) {
1237
		$conf .= openvpn_gen_routes($settings['remote_networkv6'], "ipv6", false);
1238
	}
1239

    
1240
	// Write the settings for the keys
1241
	switch ($settings['mode']) {
1242
		case 'p2p_shared_key':
1243
			openvpn_add_keyfile($settings['shared_key'], $conf, $mode_id, "secret");
1244
			break;
1245
		case 'p2p_tls':
1246
		case 'server_tls':
1247
		case 'server_tls_user':
1248
		case 'server_user':
1249
			// ca_chain_array() expects parameter to be passed by reference.
1250
			// avoid passing the whole settings array, as param names or
1251
			// types might change in future releases.
1252
			$param = array('caref' => $settings['caref']);
1253
			$cas = ca_chain_array($param);
1254
			$capath = "{$g['openvpn_base']}/{$mode_id}/ca";
1255
			/* Cleanup old CA/CRL references */
1256
			@unlink_if_exists("{$capath}.*0");
1257
			/* Find the CRL listed in the settings */
1258
			if (!empty($settings['crlref'])) {
1259
				$crl = lookup_crl($settings['crlref']);
1260
				crl_update($crl);
1261
			}
1262
			/* For each CA in the chain, setup the CApath */
1263
			foreach ($cas as $ca) {
1264
				ca_setup_capath($ca, $capath, $crl);
1265
			}
1266
			$conf .= "capath {$capath}\n";
1267
			unset($cas, $param);
1268

    
1269
			if (!empty($settings['certref'])) {
1270
				$cert = lookup_cert($settings['certref']);
1271
				openvpn_add_keyfile($cert['crt'], $conf, $mode_id, "cert");
1272
				openvpn_add_keyfile($cert['prv'], $conf, $mode_id, "key");
1273
			}
1274
			if ($mode == 'server') {
1275
				if (is_numeric($settings['dh_length'])) {
1276
					if (!in_array($settings['dh_length'], array_keys($openvpn_dh_lengths))) {
1277
						/* The user selected a DH parameter length that does not have a corresponding file. */
1278
						log_error(gettext("Failed to construct OpenVPN server configuration. The selected DH Parameter length cannot be used."));
1279
						return;
1280
					}
1281
					$dh_file = "{$g['etc_path']}/dh-parameters.{$settings['dh_length']}";
1282
				} else {
1283
					$dh_file = $settings['dh_length'];
1284
				}
1285
				$conf .= "dh {$dh_file}\n";
1286
				if (!empty($settings['ecdh_curve']) && ($settings['ecdh_curve'] != "none") && openvpn_validate_curve($settings['ecdh_curve'])) {
1287
					$conf .= "ecdh-curve {$settings['ecdh_curve']}\n";
1288
				}
1289
			}
1290
			if ($settings['tls']) {
1291
				if ($settings['tls_type'] == "crypt") {
1292
					$tls_directive = "tls-crypt";
1293
					$tlsopt = "";
1294
				} else {
1295
					$tls_directive = "tls-auth";
1296
					if ($mode == "server") {
1297
						switch($settings['tlsauth_keydir']){
1298
							case '1':
1299
								$tlsopt = 1;
1300
								break;
1301
							case '2':
1302
								$tlsopt = '';
1303
								break;
1304
							default:
1305
								$tlsopt = 0;
1306
								break;
1307
						}
1308
					} else {
1309
						switch($settings['tlsauth_keydir']){
1310
							case '0':
1311
								$tlsopt = 0;
1312
								break;
1313
							case '2':
1314
								$tlsopt = '';
1315
								break;
1316
							default:
1317
								$tlsopt = 1;
1318
								break;
1319
						}
1320
					}
1321
				}
1322
				openvpn_add_keyfile($settings['tls'], $conf, $mode_id, $tls_directive, $tlsopt);
1323
			}
1324
			break;
1325
	}
1326

    
1327
	/* Data encryption cipher support.
1328
	 * If it is not set, assume enabled since that is OpenVPN's default.
1329
	 * Note that diabling this is now deprecated and will be removed in a future version of OpenVPN */
1330
	if ($settings['ncp_enable'] == "disabled") {
1331
		$conf .= "ncp-disable\n";
1332
		$conf .= "cipher {$fbcipher}\n";
1333
	} else {
1334
		$conf .= "data-ciphers " . str_replace(',', ':', openvpn_build_data_cipher_list($settings['data_ciphers'], $fbcipher)) . "\n";
1335
		$conf .= "data-ciphers-fallback {$fbcipher}\n";
1336
	}
1337

    
1338
	if (!empty($settings['allow_compression'])) {
1339
		$conf .= "allow-compression {$settings['allow_compression']}\n";
1340
	}
1341

    
1342
	$compression = "";
1343
	switch ($settings['compression']) {
1344
		case 'none':
1345
			$settings['compression'] = '';
1346
		case 'lz4':
1347
		case 'lz4-v2':
1348
		case 'lzo':
1349
		case 'stub':
1350
		case 'stub-v2':
1351
			$compression .= "compress {$settings['compression']}";
1352
			break;
1353
		case 'noadapt':
1354
			$compression .= "comp-noadapt";
1355
			break;
1356
		case 'adaptive':
1357
		case 'yes':
1358
		case 'no':
1359
			$compression .= "comp-lzo {$settings['compression']}";
1360
			break;
1361
		default:
1362
			/* Add nothing to the configuration */
1363
			break;
1364
	}
1365

    
1366
	if (($settings['allow_compression'] != 'no') &&
1367
	    !empty($compression)) {
1368
		$conf .= "{$compression}\n";
1369
		if ($settings['compression_push']) {
1370
			$conf .= "push \"{$compression}\"\n";
1371
		}
1372
	}
1373

    
1374
	if ($settings['passtos']) {
1375
		$conf .= "passtos\n";
1376
	}
1377

    
1378
	if ($mode == 'client') {
1379
		$conf .= "resolv-retry infinite\n";
1380
	}
1381

    
1382
	if ($settings['dynamic_ip']) {
1383
		$conf .= "persist-remote-ip\n";
1384
		$conf .= "float\n";
1385
	}
1386

    
1387
	// If the server is not a TLS server or it has a tunnel network CIDR less than a /30, skip this.
1388
	if (in_array($settings['mode'], $openvpn_tls_server_modes) && (!empty($ip) && !empty($mask) && ($cidr < 30)) && $settings['dev_mode'] != "tap") {
1389
		if (empty($settings['topology'])) {
1390
			$settings['topology'] = "subnet";
1391
		}
1392
		$conf .= "topology {$settings['topology']}\n";
1393
	}
1394

    
1395
	// New client features
1396
	if ($mode == "client") {
1397
		// Dont add/remove routes checkbox
1398
		if ($settings['route_no_exec']) {
1399
			$conf .= "route-noexec\n";
1400
		}
1401
	}
1402

    
1403
	/* UDP Fast I/O. Only compatible with UDP and also not compatible with OpenVPN's "shaper" directive. */
1404
	if ($settings['udp_fast_io']
1405
	    && (strtolower(substr($settings['protocol'], 0, 3)) == "udp")
1406
	    && (empty($settings['use_shaper']))) {
1407
		$conf .= "fast-io\n";
1408
	}
1409

    
1410
	/* Exit Notify. Only compatible with UDP. */
1411
	if (!empty($settings['exit_notify']) &&
1412
	    is_numericint($settings['exit_notify']) &&
1413
	    (strtolower(substr($settings['protocol'], 0, 3)) == "udp")) {
1414
		$conf .= "explicit-exit-notify {$settings['exit_notify']}\n";
1415
	}
1416

    
1417
	/* Send and Receive Buffer Settings */
1418
	if (is_numericint($settings['sndrcvbuf'])
1419
	    && ($settings['sndrcvbuf'] > 0)
1420
	    && ($settings['sndrcvbuf'] <= get_single_sysctl('net.inet.tcp.sendbuf_max'))
1421
	    && ($settings['sndrcvbuf'] <= get_single_sysctl('net.inet.tcp.recvbuf_max'))) {
1422
		$conf .= "sndbuf {$settings['sndrcvbuf']}\n";
1423
		$conf .= "rcvbuf {$settings['sndrcvbuf']}\n";
1424
	}
1425

    
1426
	openvpn_add_custom($settings, $conf);
1427

    
1428
	/* add nopull option after custom options, see https://redmine.pfsense.org/issues/11448 */
1429
	if (($mode == "client") && $settings['route_no_pull']) {
1430
		// Dont pull routes checkbox
1431
		$conf .= "route-nopull\n";
1432
	}
1433

    
1434
	openvpn_create_dirs();
1435
	$fpath = "{$g['openvpn_base']}/{$mode_id}/config.ovpn";
1436
	file_put_contents($fpath, $conf);
1437
	unset($conf);
1438
	$fpath = "{$g['openvpn_base']}/{$mode_id}/interface";
1439
	file_put_contents($fpath, $interface);
1440
	//chown($fpath, 'nobody');
1441
	//chgrp($fpath, 'nobody');
1442
	@chmod("{$g['openvpn_base']}/{$mode_id}/config.ovpn", 0600);
1443
	@chmod("{$g['openvpn_base']}/{$mode_id}/interface", 0600);
1444
	@chmod("{$g['openvpn_base']}/{$mode_id}/key", 0600);
1445
	@chmod("{$g['openvpn_base']}/{$mode_id}/tls-auth", 0600);
1446
	@chmod("{$g['openvpn_base']}/{$mode_id}/conf", 0600);
1447

    
1448
	if ($wait_tentative) {
1449
		interface_wait_tentative($interface);
1450
	}
1451
}
1452

    
1453
function openvpn_restart($mode, $settings) {
1454
	global $g, $config;
1455

    
1456
	$vpnid = $settings['vpnid'];
1457
	$mode_id = $mode.$vpnid;
1458
	$lockhandle = lock("openvpnservice{$mode_id}", LOCK_EX);
1459
	openvpn_reconfigure($mode, $settings);
1460
	/* kill the process if running */
1461
	$pfile = $g['varrun_path']."/openvpn_{$mode_id}.pid";
1462
	if (file_exists($pfile)) {
1463

    
1464
		/* read the pid file */
1465
		$pid = rtrim(file_get_contents($pfile));
1466
		unlink($pfile);
1467
		syslog(LOG_INFO, "OpenVPN terminate old pid: {$pid}");
1468

    
1469
		/* send a term signal to the process */
1470
		posix_kill($pid, SIGTERM);
1471

    
1472
		/* wait until the process exits, or timeout and kill it */
1473
		$i = 0;
1474
		while (posix_kill($pid, 0)) {
1475
			usleep(250000);
1476
			if ($i > 10) {
1477
				log_error(sprintf(gettext('OpenVPN ID %1$s PID %2$s still running, killing.'), $mode_id, $pid));
1478
				posix_kill($pid, SIGKILL);
1479
				usleep(500000);
1480
			}
1481
			$i++;
1482
		}
1483
	}
1484

    
1485
	if (isset($settings['disable'])) {
1486
		unlock($lockhandle);
1487
		return;
1488
	}
1489

    
1490
	/* Do not start an instance if we are not CARP master on this vip! */
1491
	if (strstr($settings['interface'], "_vip")) {
1492
	       	$carpstatus = get_carp_interface_status($settings['interface']);
1493
		if (in_array($carpstatus, array('BACKUP', 'INIT')) {
1494
			unlock($lockhandle);
1495
			return;
1496
		} elseif (empty($carpstatus)) {
1497
			/* Do not start an instance if vip aliased to BACKUP CARP
1498
			 * see https://redmine.pfsense.org/issues/11793 */ 
1499
			foreach ($config['virtualip']['vip'] as $vip) {
1500
				if (($settings['interface'] == "_vip{$vip['uniqid']}") &&
1501
				    in_array(get_carp_interface_status($vip['interface']), array("BACKUP", "INIT"))) {
1502
					unlock($lockhandle);
1503
					return;
1504
				}
1505
			}
1506
		}
1507
	}
1508

    
1509
	/* Check if client is bound to a gateway group */
1510
	$a_groups = return_gateway_groups_array(true);
1511
	if (is_array($a_groups[$settings['interface']])) {
1512
		/* the interface is a gateway group. If a vip is defined and its a CARP backup then do not start */
1513
		if (($a_groups[$settings['interface']][0]['vip'] <> "") && (!in_array(get_carp_interface_status($a_groups[$settings['interface']][0]['vip']), array("MASTER", "")))) {
1514
			unlock($lockhandle);
1515
			return;
1516
		}
1517
	}
1518

    
1519
	/* start the new process */
1520
	$fpath = "{$g['openvpn_base']}/{$mode_id}/config.ovpn";
1521
	openvpn_clear_route($mode, $settings);
1522
	$res = mwexec("/usr/local/sbin/openvpn --config " . escapeshellarg($fpath));
1523
	if ($res == 0) {
1524
		$i = 0;
1525
		$pid = "--";
1526
		while ($i < 3000) {
1527
			if (isvalidpid($pfile)) {
1528
				$pid = rtrim(file_get_contents($pfile));
1529
				break;
1530
			}
1531
			usleep(1000);
1532
			$i++;
1533
		}
1534
		syslog(LOG_INFO, "OpenVPN PID written: {$pid}");
1535
	} else {
1536
		syslog(LOG_ERR, "OpenVPN failed to start");
1537
	}
1538
	if (!platform_booting()) {
1539
		send_event("filter reload");
1540
	}
1541
	unlock($lockhandle);
1542
}
1543

    
1544
function openvpn_delete($mode, $settings) {
1545
	global $g, $config;
1546

    
1547
	$vpnid = $settings['vpnid'];
1548
	$mode_id = $mode.$vpnid;
1549

    
1550
	if ($mode == "server") {
1551
		$devname = "ovpns{$vpnid}";
1552
	} else {
1553
		$devname = "ovpnc{$vpnid}";
1554
	}
1555

    
1556
	/* kill the process if running */
1557
	$pfile = "{$g['varrun_path']}/openvpn_{$mode_id}.pid";
1558
	if (file_exists($pfile)) {
1559

    
1560
		/* read the pid file */
1561
		$pid = trim(file_get_contents($pfile));
1562
		unlink($pfile);
1563

    
1564
		/* send a term signal to the process */
1565
		posix_kill($pid, SIGTERM);
1566
	}
1567

    
1568
	/* destroy the device */
1569
	pfSense_interface_destroy($devname);
1570

    
1571
	/* Invalidate cache */
1572
	get_interface_arr(true);
1573

    
1574
	/* remove the configuration files */
1575
	unlink_if_exists("{$g['openvpn_base']}/{$mode_id}/*/*");
1576
	unlink_if_exists("{$g['openvpn_base']}/{$mode_id}/*");
1577
}
1578

    
1579
function openvpn_resync_csc(& $settings) {
1580
	global $g, $config, $openvpn_tls_server_modes;
1581
	if (isset($settings['disable'])) {
1582
		openvpn_delete_csc($settings);
1583
		return;
1584
	}
1585
	openvpn_create_dirs();
1586

    
1587
	if (empty($settings['server_list'])) {
1588
		$csc_server_list = array();
1589
	} else {
1590
		$csc_server_list = explode(",", $settings['server_list']);
1591
	}
1592

    
1593
	$conf = '';
1594
	if ($settings['block']) {
1595
		$conf .= "disable\n";
1596
	}
1597

    
1598
	if ($settings['push_reset']) {
1599
		$conf .= "push-reset\n";
1600
	}
1601

    
1602
	if ($settings['remove_route']) {
1603
		$conf .= "push-remove route\n";
1604
	}
1605

    
1606
	if ($settings['local_network']) {
1607
		$conf .= openvpn_gen_routes($settings['local_network'], "ipv4", true);
1608
	}
1609
	if ($settings['local_networkv6']) {
1610
		$conf .= openvpn_gen_routes($settings['local_networkv6'], "ipv6", true);
1611
	}
1612

    
1613
	// Add a remote network iroute if set
1614
	if (openvpn_validate_cidr($settings['remote_network'], "", true, "ipv4") === FALSE) {
1615
		$conf .= openvpn_gen_routes($settings['remote_network'], "ipv4", false, true);
1616
	}
1617
	// Add a remote network iroute if set
1618
	if (openvpn_validate_cidr($settings['remote_networkv6'], "", true, "ipv6") === FALSE) {
1619
		$conf .= openvpn_gen_routes($settings['remote_networkv6'], "ipv6", false, true);
1620
	}
1621

    
1622
	openvpn_add_dhcpopts($settings, $conf);
1623

    
1624
	openvpn_add_custom($settings, $conf);
1625
	/* Loop through servers, find which ones can use this CSC */
1626
	if (is_array($config['openvpn']['openvpn-server'])) {
1627
		foreach ($config['openvpn']['openvpn-server'] as $serversettings) {
1628
			if (isset($serversettings['disable'])) {
1629
				continue;
1630
			}
1631
			if (in_array($serversettings['mode'], $openvpn_tls_server_modes)) {
1632
				if ($serversettings['vpnid'] && (empty($csc_server_list) || in_array($serversettings['vpnid'], $csc_server_list))) {
1633
					$csc_path = "{$g['openvpn_base']}/server{$serversettings['vpnid']}/csc/" . basename($settings['common_name']);
1634
					$csc_conf = $conf;
1635

    
1636
					if (!empty($serversettings['tunnel_network']) && !empty($settings['tunnel_network'])) {
1637
						list($ip, $mask) = explode('/', trim($settings['tunnel_network']));
1638
						if (($serversettings['dev_mode'] == 'tap') || ($serversettings['topology'] == "subnet")) {
1639
							$csc_conf .= "ifconfig-push {$ip} " . gen_subnet_mask($mask) . "\n";
1640
						} else {
1641
							/* Because this is being pushed, the order from the client's point of view. */
1642
							$baselong = gen_subnetv4($ip, $mask);
1643
							$serverip = ip_after($baselong, 1);
1644
							$clientip = ip_after($baselong, 2);
1645
							$csc_conf .= "ifconfig-push {$clientip} {$serverip}\n";
1646
						}
1647
					}
1648

    
1649
					if (!empty($serversettings['tunnel_networkv6']) && !empty($settings['tunnel_networkv6'])) {
1650
						list($ipv6, $prefix) = explode('/', trim($serversettings['tunnel_networkv6']));
1651
						list($ipv6_1, $ipv6_2) = openvpn_get_interface_ipv6($ipv6, $prefix);
1652
						$csc_conf .= "ifconfig-ipv6-push {$settings['tunnel_networkv6']} {$ipv6_1}\n";
1653
					}
1654

    
1655
					file_put_contents($csc_path, $csc_conf);
1656
					chown($csc_path, 'nobody');
1657
					chgrp($csc_path, 'nobody');
1658
				}
1659
			}
1660
		}
1661
	}
1662
}
1663

    
1664
function openvpn_resync_csc_all() {
1665
	global $config;
1666
	if (is_array($config['openvpn']['openvpn-csc'])) {
1667
		foreach ($config['openvpn']['openvpn-csc'] as & $settings) {
1668
			openvpn_resync_csc($settings);
1669
		}
1670
	}
1671
}
1672

    
1673
function openvpn_delete_csc(& $settings) {
1674
	global $g, $config, $openvpn_tls_server_modes;
1675
	if (empty($settings['server_list'])) {
1676
		$csc_server_list = array();
1677
	} else {
1678
		$csc_server_list = explode(",", $settings['server_list']);
1679
	}
1680

    
1681
	/* Loop through servers, find which ones used this CSC */
1682
	if (is_array($config['openvpn']['openvpn-server'])) {
1683
		foreach ($config['openvpn']['openvpn-server'] as $serversettings) {
1684
			if (isset($serversettings['disable'])) {
1685
				continue;
1686
			}
1687
			if (in_array($serversettings['mode'], $openvpn_tls_server_modes)) {
1688
				if ($serversettings['vpnid'] && (empty($csc_server_list) || in_array($serversettings['vpnid'], $csc_server_list))) {
1689
					$csc_path = "{$g['openvpn_base']}/server{$serversettings['vpnid']}/csc/" . basename($settings['common_name']);
1690
					unlink_if_exists($csc_path);
1691
				}
1692
			}
1693
		}
1694
	}
1695
}
1696

    
1697
// Resync the configuration and restart the VPN
1698
function openvpn_resync($mode, $settings) {
1699
	openvpn_restart($mode, $settings);
1700
}
1701

    
1702
// Resync and restart all VPNs
1703
function openvpn_resync_all($interface = "") {
1704
	global $g, $config;
1705

    
1706
	openvpn_create_dirs();
1707

    
1708
	if (!is_array($config['openvpn'])) {
1709
		$config['openvpn'] = array();
1710
	}
1711

    
1712
	if ($interface <> "") {
1713
		log_error(sprintf(gettext("Resyncing OpenVPN instances for interface %s."), convert_friendly_interface_to_friendly_descr($interface)));
1714
	} else {
1715
		log_error(gettext("Resyncing OpenVPN instances."));
1716
	}
1717

    
1718
	// Check if OpenVPN clients and servers require a resync.
1719
	foreach (array("server", "client") as $type) {
1720
		if (!is_array($config['openvpn']["openvpn-{$type}"])) {
1721
			continue;
1722
		}
1723
		foreach ($config['openvpn']["openvpn-{$type}"] as & $settings) {
1724
			$fpath = "{$g['openvpn_base']}/{$type}{$settings['vpnid']}/interface";
1725
			$gw_group_change = FALSE;
1726
			$ip_change = ($interface === "") ||
1727
			    ($interface === $settings['interface']);
1728

    
1729
			if (!$ip_change && file_exists($fpath)) {
1730
				$gw_group_change =
1731
				    (trim(file_get_contents($fpath), " \t\n") !=
1732
				    get_failover_interface(
1733
					$settings['interface']));
1734
			}
1735

    
1736
			if ($ip_change || $gw_group_change) {
1737
				openvpn_resync($type, $settings);
1738
			}
1739
		}
1740
	}
1741

    
1742
	openvpn_resync_csc_all();
1743

    
1744
}
1745

    
1746
// Resync and restart all VPNs using a gateway group.
1747
function openvpn_resync_gwgroup($gwgroupname = "") {
1748
	global $g, $config;
1749

    
1750
	if ($gwgroupname <> "") {
1751
		if (is_array($config['openvpn']['openvpn-server'])) {
1752
			foreach ($config['openvpn']['openvpn-server'] as & $settings) {
1753
				if ($gwgroupname == $settings['interface']) {
1754
					log_error(sprintf(gettext('Resyncing OpenVPN for gateway group %1$s server %2$s.'), $gwgroupname, $settings["description"]));
1755
					openvpn_resync('server', $settings);
1756
				}
1757
			}
1758
		}
1759

    
1760
		if (is_array($config['openvpn']['openvpn-client'])) {
1761
			foreach ($config['openvpn']['openvpn-client'] as & $settings) {
1762
				if ($gwgroupname == $settings['interface']) {
1763
					log_error(sprintf(gettext('Resyncing OpenVPN for gateway group %1$s client %2$s.'), $gwgroupname, $settings["description"]));
1764
					openvpn_resync('client', $settings);
1765
				}
1766
			}
1767
		}
1768

    
1769
		// Note: no need to resysnc Client Specific (csc) here, as changes to the OpenVPN real interface do not effect these.
1770

    
1771
	} else {
1772
		log_error(gettext("openvpn_resync_gwgroup called with null gwgroup parameter."));
1773
	}
1774
}
1775

    
1776
function openvpn_get_active_servers($type="multipoint") {
1777
	global $config, $g;
1778

    
1779
	$servers = array();
1780
	if (is_array($config['openvpn']['openvpn-server'])) {
1781
		foreach ($config['openvpn']['openvpn-server'] as & $settings) {
1782
			if (empty($settings) || isset($settings['disable'])) {
1783
				continue;
1784
			}
1785

    
1786
			$prot = $settings['protocol'];
1787
			$port = $settings['local_port'];
1788

    
1789
			$server = array();
1790
			$server['port'] = ($settings['local_port']) ? $settings['local_port'] : 1194;
1791
			$server['mode'] = $settings['mode'];
1792
			if ($settings['description']) {
1793
				$server['name'] = "{$settings['description']} {$prot}:{$port}";
1794
			} else {
1795
				$server['name'] = "Server {$prot}:{$port}";
1796
			}
1797
			$server['conns'] = array();
1798
			$server['vpnid'] = $settings['vpnid'];
1799
			$server['mgmt'] = "server{$server['vpnid']}";
1800
			$socket = "unix://{$g['openvpn_base']}/{$server['mgmt']}/sock";
1801
			list($tn, $sm) = explode('/', trim($settings['tunnel_network']));
1802

    
1803
			if ((($server['mode'] == "p2p_shared_key") || ($sm >= 30)) && ($type == "p2p")) {
1804
				$servers[] = openvpn_get_client_status($server, $socket);
1805
			} elseif (($server['mode'] != "p2p_shared_key") && ($type == "multipoint") && ($sm < 30)) {
1806
				$servers[] = openvpn_get_server_status($server, $socket);
1807
			}
1808
		}
1809
	}
1810
	return $servers;
1811
}
1812

    
1813
function openvpn_get_server_status($server, $socket) {
1814
	$errval = null;
1815
	$errstr = null;
1816
	$fp = @stream_socket_client($socket, $errval, $errstr, 1);
1817
	if ($fp) {
1818
		stream_set_timeout($fp, 1);
1819

    
1820
		/* send our status request */
1821
		fputs($fp, "status 2\n");
1822

    
1823
		/* recv all response lines */
1824
		while (!feof($fp)) {
1825

    
1826
			/* read the next line */
1827
			$line = fgets($fp, 1024);
1828

    
1829
			$info = stream_get_meta_data($fp);
1830
			if ($info['timed_out']) {
1831
				break;
1832
			}
1833

    
1834
			/* parse header list line */
1835
			if (strstr($line, "HEADER")) {
1836
				continue;
1837
			}
1838

    
1839
			/* parse end of output line */
1840
			if (strstr($line, "END") || strstr($line, "ERROR")) {
1841
				break;
1842
			}
1843

    
1844
			/* parse client list line */
1845
			if (strstr($line, "CLIENT_LIST")) {
1846
				$list = explode(",", $line);
1847
				$conn = array();
1848
				$conn['common_name'] = $list[1];
1849
				$conn['remote_host'] = $list[2];
1850
				$conn['virtual_addr'] = $list[3];
1851
				$conn['virtual_addr6'] = $list[4];
1852
				$conn['bytes_recv'] = $list[5];
1853
				$conn['bytes_sent'] = $list[6];
1854
				$conn['connect_time'] = $list[7];
1855
				$conn['connect_time_unix'] = $list[8];
1856
				$conn['user_name'] = $list[9];
1857
				$conn['client_id'] = $list[10];
1858
				$conn['peer_id'] = $list[11];
1859
				$conn['cipher'] = $list[12];
1860
				$server['conns'][] = $conn;
1861
			}
1862
			/* parse routing table lines */
1863
			if (strstr($line, "ROUTING_TABLE")) {
1864
				$list = explode(",", $line);
1865
				$conn = array();
1866
				$conn['virtual_addr'] = $list[1];
1867
				$conn['common_name'] = $list[2];
1868
				$conn['remote_host'] = $list[3];
1869
				$conn['last_time'] = $list[4];
1870
				$server['routes'][] = $conn;
1871
			}
1872
		}
1873

    
1874
		/* cleanup */
1875
		fclose($fp);
1876
	} else {
1877
		$conn = array();
1878
		$conn['common_name'] = "[error]";
1879
		$conn['remote_host'] = gettext("Unable to contact daemon");
1880
		$conn['virtual_addr'] = gettext("Service not running?");
1881
		$conn['bytes_recv'] = 0;
1882
		$conn['bytes_sent'] = 0;
1883
		$conn['connect_time'] = 0;
1884
		$server['conns'][] = $conn;
1885
	}
1886
	return $server;
1887
}
1888

    
1889
function openvpn_get_active_clients() {
1890
	global $config, $g;
1891

    
1892
	$clients = array();
1893
	if (is_array($config['openvpn']['openvpn-client'])) {
1894
		foreach ($config['openvpn']['openvpn-client'] as & $settings) {
1895

    
1896
			if (empty($settings) || isset($settings['disable'])) {
1897
				continue;
1898
			}
1899

    
1900
			$prot = $settings['protocol'];
1901
			$port = ($settings['local_port']) ? ":{$settings['local_port']}" : "";
1902

    
1903
			$client = array();
1904
			$client['port'] = $settings['local_port'];
1905
			if ($settings['description']) {
1906
				$client['name'] = "{$settings['description']} {$prot}{$port}";
1907
			} else {
1908
				$client['name'] = "Client {$prot}{$port}";
1909
			}
1910

    
1911
			$client['vpnid'] = $settings['vpnid'];
1912
			$client['mgmt'] = "client{$client['vpnid']}";
1913
			$socket = "unix://{$g['openvpn_base']}/{$client['mgmt']}/sock";
1914
			$client['status']="down";
1915

    
1916
			$clients[] = openvpn_get_client_status($client, $socket);
1917
		}
1918
	}
1919
	return $clients;
1920
}
1921

    
1922
function openvpn_get_client_status($client, $socket) {
1923
	$errval = null;
1924
	$errstr = null;
1925
	$fp = @stream_socket_client($socket, $errval, $errstr, 1);
1926
	if ($fp) {
1927
		stream_set_timeout($fp, 1);
1928
		/* send our status request */
1929
		fputs($fp, "state 1\n");
1930

    
1931
		/* recv all response lines */
1932
		while (!feof($fp)) {
1933
			/* read the next line */
1934
			$line = fgets($fp, 1024);
1935

    
1936
			$info = stream_get_meta_data($fp);
1937
			if ($info['timed_out']) {
1938
				break;
1939
			}
1940

    
1941
			/* Get the client state */
1942
			if (strstr($line, "CONNECTED")) {
1943
				$client['status'] = "up";
1944
				$list = explode(",", $line);
1945

    
1946
				$client['connect_time'] = date("D M j G:i:s Y", $list[0]);
1947
				$client['virtual_addr'] = $list[3];
1948
				$client['remote_host'] = $list[4];
1949
				$client['remote_port'] = $list[5];
1950
				$client['local_host'] = $list[6];
1951
				$client['local_port'] = $list[7];
1952
				$client['virtual_addr6'] = $list[8];
1953
			}
1954
			if (strstr($line, "CONNECTING")) {
1955
				$client['status'] = "connecting";
1956
			}
1957
			if (strstr($line, "ASSIGN_IP")) {
1958
				$client['status'] = "waiting";
1959
				$list = explode(",", $line);
1960

    
1961
				$client['connect_time'] = date("D M j G:i:s Y", $list[0]);
1962
				$client['virtual_addr'] = $list[3];
1963
			}
1964
			if (strstr($line, "RECONNECTING")) {
1965
				$client['status'] = "reconnecting";
1966
				$list = explode(",", $line);
1967

    
1968
				$client['connect_time'] = date("D M j G:i:s Y", $list[0]);
1969
				$client['status'] .= "; " . $list[2];
1970
			}
1971
			/* parse end of output line */
1972
			if (strstr($line, "END") || strstr($line, "ERROR")) {
1973
				break;
1974
			}
1975
		}
1976

    
1977
		/* If up, get read/write stats */
1978
		if (strcmp($client['status'], "up") == 0) {
1979
			fputs($fp, "status 2\n");
1980
			/* recv all response lines */
1981
			while (!feof($fp)) {
1982
				/* read the next line */
1983
				$line = fgets($fp, 1024);
1984

    
1985
				$info = stream_get_meta_data($fp);
1986
				if ($info['timed_out']) {
1987
					break;
1988
				}
1989

    
1990
				if (strstr($line, "TCP/UDP read bytes")) {
1991
					$list = explode(",", $line);
1992
					$client['bytes_recv'] = $list[1];
1993
				}
1994

    
1995
				if (strstr($line, "TCP/UDP write bytes")) {
1996
					$list = explode(",", $line);
1997
					$client['bytes_sent'] = $list[1];
1998
				}
1999

    
2000
				/* parse end of output line */
2001
				if (strstr($line, "END")) {
2002
					break;
2003
				}
2004
			}
2005
		}
2006

    
2007
		fclose($fp);
2008

    
2009
	} else {
2010
		$client['remote_host'] = gettext("Unable to contact daemon");
2011
		$client['virtual_addr'] = gettext("Service not running?");
2012
		$client['bytes_recv'] = 0;
2013
		$client['bytes_sent'] = 0;
2014
		$client['connect_time'] = 0;
2015
	}
2016
	return $client;
2017
}
2018

    
2019
function openvpn_kill_client($port, $remipp) {
2020
	global $g;
2021

    
2022
	//$tcpsrv = "tcp://127.0.0.1:{$port}";
2023
	$tcpsrv = "unix://{$g['openvpn_base']}/{$port}/sock";
2024
	$errval = null;
2025
	$errstr = null;
2026

    
2027
	/* open a tcp connection to the management port of each server */
2028
	$fp = @stream_socket_client($tcpsrv, $errval, $errstr, 1);
2029
	$killed = -1;
2030
	if ($fp) {
2031
		stream_set_timeout($fp, 1);
2032
		fputs($fp, "kill {$remipp}\n");
2033
		while (!feof($fp)) {
2034
			$line = fgets($fp, 1024);
2035

    
2036
			$info = stream_get_meta_data($fp);
2037
			if ($info['timed_out']) {
2038
				break;
2039
			}
2040

    
2041
			/* parse header list line */
2042
			if (strpos($line, "INFO:") !== false) {
2043
				continue;
2044
			}
2045
			if (strpos($line, "SUCCESS") !== false) {
2046
				$killed = 0;
2047
			}
2048
			break;
2049
		}
2050
		fclose($fp);
2051
	}
2052
	return $killed;
2053
}
2054

    
2055
function openvpn_refresh_crls() {
2056
	global $g, $config;
2057

    
2058
	openvpn_create_dirs();
2059

    
2060
	if (is_array($config['openvpn']['openvpn-server'])) {
2061
		foreach ($config['openvpn']['openvpn-server'] as $settings) {
2062
			if (empty($settings)) {
2063
				continue;
2064
			}
2065
			if (isset($settings['disable'])) {
2066
				continue;
2067
			}
2068
			// Write the settings for the keys
2069
			switch ($settings['mode']) {
2070
				case 'p2p_tls':
2071
				case 'server_tls':
2072
				case 'server_tls_user':
2073
				case 'server_user':
2074
					$param = array('caref' => $settings['caref']);
2075
					$cas = ca_chain_array($param);
2076
					$capath = "{$g['openvpn_base']}/server{$settings['vpnid']}/ca";
2077
					if (!empty($settings['crlref'])) {
2078
						$crl = lookup_crl($settings['crlref']);
2079
						crl_update($crl);
2080
					}
2081
					foreach ($cas as $ca) {
2082
						ca_setup_capath($ca, $capath, $crl, true);
2083
					}
2084
					unset($cas, $param, $capath, $crl);
2085
					break;
2086
			}
2087
		}
2088
	}
2089
}
2090

    
2091
function openvpn_create_dirs() {
2092
	global $g, $config, $openvpn_tls_server_modes;
2093
	if (!is_dir($g['openvpn_base'])) {
2094
		safe_mkdir($g['openvpn_base'], 0750);
2095
	}
2096

    
2097
	init_config_arr(array('openvpn', 'openvpn-server'));
2098
	init_config_arr(array('openvpn', 'openvpn-client'));
2099
	foreach(array('server', 'client') as $mode) {
2100
		foreach ($config['openvpn']["openvpn-{$mode}"] as $settings) {
2101
			$target = "{$g['openvpn_base']}/{$mode}{$settings['vpnid']}";
2102
			@unlink_if_exists($csctarget);
2103
			@safe_mkdir($target);
2104
			if (in_array($settings['mode'], $openvpn_tls_server_modes)) {
2105
				if ($settings['vpnid']) {
2106
					$csctarget = "{$target}/csc/";
2107
					@unlink_if_exists($csctarget);
2108
					@safe_mkdir($csctarget);
2109
				}
2110
			}
2111
		}
2112
	}
2113
}
2114

    
2115
function openvpn_get_interface_ip($ip, $cidr) {
2116
	$subnet = gen_subnetv4($ip, $cidr);
2117
	if ($cidr == 31) {
2118
		$ip1 = $subnet;
2119
	} else {
2120
		$ip1 = ip_after($subnet);
2121
	}
2122
	$ip2 = ip_after($ip1);
2123
	return array($ip1, $ip2);
2124
}
2125

    
2126
function openvpn_get_interface_ipv6($ipv6, $prefix) {
2127
	$basev6 = gen_subnetv6($ipv6, $prefix);
2128
	// Is there a better way to do this math?
2129
	$ipv6_arr = explode(':', $basev6);
2130
	$last = hexdec(array_pop($ipv6_arr));
2131
	if ($prefix == 127) {
2132
		$last--;
2133
	}
2134
	$ipv6_1 = text_to_compressed_ip6(implode(':', $ipv6_arr) . ':' . dechex($last + 1));
2135
	$ipv6_2 = text_to_compressed_ip6(implode(':', $ipv6_arr) . ':' . dechex($last + 2));
2136
	return array($ipv6_1, $ipv6_2);
2137
}
2138

    
2139
function openvpn_clear_route($mode, $settings) {
2140
	if (empty($settings['tunnel_network'])) {
2141
		return;
2142
	}
2143
	list($ip, $cidr) = explode('/', trim($settings['tunnel_network']));
2144
	$mask = gen_subnet_mask($cidr);
2145
	$clear_route = false;
2146

    
2147
	switch ($settings['mode']) {
2148
		case 'shared_key':
2149
			$clear_route = true;
2150
			break;
2151
		case 'p2p_tls':
2152
		case 'p2p_shared_key':
2153
			if ($cidr >= 30) {
2154
				$clear_route = true;
2155
			}
2156
			break;
2157
	}
2158

    
2159
	if ($clear_route && !empty($ip) && !empty($mask)) {
2160
		list($ip1, $ip2) = openvpn_get_interface_ip($ip, $cidr);
2161
		$ip_to_clear = ($mode == "server") ? $ip1 : $ip2;
2162
		/* XXX: Family for route? */
2163
		mwexec("/sbin/route -q delete {$ip_to_clear}");
2164
	}
2165
}
2166

    
2167
function openvpn_gen_routes($value, $ipproto = "ipv4", $push = false, $iroute = false) {
2168
	$routes = "";
2169
	if (empty($value)) {
2170
		return "";
2171
	}
2172
	$networks = explode(',', $value);
2173

    
2174
	foreach ($networks as $network) {
2175
		if ($ipproto == "ipv4") {
2176
			$route = openvpn_gen_route_ipv4($network, $iroute);
2177
		} else {
2178
			$route = openvpn_gen_route_ipv6($network, $iroute);
2179
		}
2180

    
2181
		if ($push) {
2182
			$routes .= "push \"{$route}\"\n";
2183
		} else {
2184
			$routes .= "{$route}\n";
2185
		}
2186
	}
2187
	return $routes;
2188
}
2189

    
2190
function openvpn_gen_route_ipv4($network, $iroute = false) {
2191
	$i = ($iroute) ? "i" : "";
2192
	list($ip, $mask) = explode('/', trim($network));
2193
	$mask = gen_subnet_mask($mask);
2194
	return "{$i}route $ip $mask";
2195
}
2196

    
2197
function openvpn_gen_route_ipv6($network, $iroute = false) {
2198
	$i = ($iroute) ? "i" : "";
2199
	list($ipv6, $prefix) = explode('/', trim($network));
2200
	if (empty($prefix) && !is_numeric($prefix)) {
2201
		$prefix = "128";
2202
	}
2203
	return "{$i}route-ipv6 ${ipv6}/${prefix}";
2204
}
2205

    
2206
function openvpn_get_settings($mode, $vpnid) {
2207
	global $config;
2208

    
2209
	if (is_array($config['openvpn']['openvpn-server'])) {
2210
		foreach ($config['openvpn']['openvpn-server'] as $settings) {
2211
			if (isset($settings['disable'])) {
2212
				continue;
2213
			}
2214

    
2215
			if ($vpnid != 0 && $vpnid == $settings['vpnid']) {
2216
				return $settings;
2217
			}
2218
		}
2219
	}
2220

    
2221
	if (is_array($config['openvpn']['openvpn-client'])) {
2222
		foreach ($config['openvpn']['openvpn-client'] as $settings) {
2223
			if (isset($settings['disable'])) {
2224
				continue;
2225
			}
2226

    
2227
			if ($vpnid != 0 && $vpnid == $settings['vpnid']) {
2228
				return $settings;
2229
			}
2230
		}
2231
	}
2232

    
2233
	return array();
2234
}
2235

    
2236
function openvpn_restart_by_vpnid($mode, $vpnid) {
2237
	$settings = openvpn_get_settings($mode, $vpnid);
2238
	openvpn_restart($mode, $settings);
2239
}
2240

    
2241
/****f* certs/openvpn_is_tunnel_network_in_use
2242
 * NAME
2243
 *   openvpn_is_tunnel_network_in_use
2244
 *     Check if the supplied network is in use as an OpenVPN server or client
2245
 *     tunnel network
2246
 * INPUTS
2247
 *   $net : The IPv4 or IPv6 network to check
2248
 * RESULT
2249
 *   boolean value: true if the network is in use, false otherwise.
2250
 ******/
2251

    
2252
function openvpn_is_tunnel_network_in_use($net) {
2253
	global $config;
2254
	init_config_arr(array('openvpn', 'openvpn-server'));
2255
	init_config_arr(array('openvpn', 'openvpn-client'));
2256
	/* Determine whether to check IPv4 or IPv6 tunnel networks */
2257
	$tocheck = 'tunnel_network';
2258
	if (is_v6($net)) {
2259
		$tocheck .= "v6";
2260
	}
2261
	/* Check all OpenVPN clients and servers for this tunnel network */
2262
	foreach(array('server', 'client') as $mode) {
2263
		foreach ($config['openvpn']["openvpn-{$mode}"] as $ovpn) {
2264
			if (!empty($ovpn[$tocheck]) &&
2265
			    ($ovpn[$tocheck] == $net)) {
2266
				return true;
2267
			}
2268
		}
2269
	}
2270
	return false;
2271
}
2272

    
2273
function openvpn_build_data_cipher_list($data_ciphers = 'AES-256-GCM,AES-128-GCM,CHACHA20-POLY1305', $fallback_cipher = 'AES-256-GBC', $ncp_enabled = true) {
2274
	/* If the data_ciphers list is empty, populate it with the fallback cipher. */
2275
	if (empty($data_ciphers) || !$ncp_enabled) {
2276
		$data_ciphers = $fallback_cipher;
2277
	}
2278
	/* Add the fallback cipher to the data ciphers list if it isn't already present */
2279
	if (!in_array($fallback_cipher, explode(',', $data_ciphers))) {
2280
		$data_ciphers .= ',' . $fallback_cipher;
2281
	}
2282
	return $data_ciphers;
2283
}
2284

    
2285
function openvpn_authscript_string($authmode, $strictusercn, $mode_id, $local_port) {
2286
	return "plugin /usr/local/lib/openvpn/plugins/openvpn-plugin-auth-script.so /usr/local/sbin/ovpn_auth_verify_async user " . base64_encode($authmode) . " {$strictusercn} {$mode_id} {$local_port}\n";
2287
}
2288

    
2289
?>
(33-33/61)