-
Notifications
You must be signed in to change notification settings - Fork 11
/
openvpn-tools
2607 lines (2093 loc) · 78.3 KB
/
openvpn-tools
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
#!/bin/bash
#
# OpenVPN tools.
#
# For suggestion and bug reports, please contact
# Pierre-Yves Landuré <pierre-yves dot landure at biapy dot fr>
#
VERSION="2.3.0"
# History
# -------
#
# 2.3.0:
# - Fix null byte warning in basename.
# - Add regenerate-crl option for regenerating expired crl files.
#
# Get the basename of a path (multi-plateform version)
# Print the result on &1 if found.
#
# @param string $path A path.
#
# @return A return code..
function basename() {
[[ ${#} -eq 0 ]] && exit 1
case "$(uname)" in
'Linux' )
command basename -z -- "${@}" \
| command tr -d '\0'
;;
'Darwin' | * )
command basename -- "${@}"
;;
esac
return ${?}
} # basename()
SCRIPT_NAME="$(command basename "${0}")"
# Print this script help.
function usage {
command echo "OpenVPN tools v${VERSION}.
This tool ease OpenVPN administration from command line.
Usage :
${SCRIPT_NAME} [ --help ] [ --initialize | --init | -i ]
[ { --create='instance' | -c 'instance' }
[ --udp | -u ] [ --hostname='hostname' | -h 'hostname' ]
[ --range='xxx.xxx.xxx' ] ]
[ --destroy='instance' | -x 'instance' ]
[ --regenerate-crl='instance' ]
[ --status='instance' | -s 'instance' ]
[ --list[='instance'] | -l [ 'instance' ] ]
[ --domain='instance' | -d 'instance' ]
[ --c2c={1|0|y|n} ] [ --nat={1|0|y]n} ]
[ --gateway={1|0|y|n} ] [ --bind={1|0|y|n} ]
[ --add='client' | -a 'client' ] [ --remove='client' | -r 'client' ]
[ --export-configs='instance' ]
[ --export-hosts='instance' ]
Available options are :
* --domain | -d : Specify the instance concerned by the changes.
* --hostname | -h : Specify the server hostname (a valid FQDN or a IP).
Default to server public IP.
* --udp | -u : Specify the use of UDP for the server (default to TCP).
* --port | -p : Specify the server port (default to 1194 if available,
random otherwise);
* --range : Specify the first 3 digits of the VPN IP range, default
to random range.
* --c2c : (dis)allow the Client to Client communication.
* --nat : (dis)allow the client access to VPN server LAN.
* --gateway : (dis)allow the client Internet access via VPN network.
* --bind : (dis)enable the Bind DNS server for VPN network.
Available actions are :
* --help : Display this message.
* --initialize | -i : Initialize OpenVPN tools environment.
* --create | -c : Create a VPN instance.
* --destroy | -x : Destroy a VPN instance.
* --regenerate-crl : Regenerate a crl file for a VPN instance.
* --status | -s : Summarize a VPN instance configuration.
* --add | -a : Add a client to a VPN instance.
* --remove | -r : Remove a client from a VPN instance.
* --list | -l : List VPN instances,
or clients if instance name is provided.
* --export-configs : Create the clients configuration files for a
OpenVPN server.
* --export-hosts : Create the hosts file extract for a OpenVPN
server clients.
"
test -n "${1}" && exit ${1}
} # usage
###########################################################
# Configuration variables list.
CONFIG_VARS="INSTANCE_CONFIG_PATH
INSTANCE_FILES_PATH
INSTANCE_KEYS_PATH
INSTANCE_DETAILS_PATH
INSTANCE_CA_PATH
INSTANCE_PUBLIC_KEY_PATH
INSTANCE_PRIVATE_KEY_PATH
INSTANCE_DH_KEY_PATH
INSTANCE_TA_KEY_PATH
INSTANCE_CRL_PATH
INSTANCE_IPP_PATH
INSTANCE_STATUS_LOG_PATH
INSTANCE_GENERAL_LOG_PATH
INSTANCE_CLIENT_CONFIGS_PATH
INSTANCE_CLIENTS_FILES_PATH
INSTANCE_CLIENTS_LIST_PATH
INSTANCE_CLIENT_PRIVATE_KEY_PATH
INSTANCE_CLIENT_CSR_PATH
INSTANCE_CLIENT_PUBLIC_KEY_PATH
INSTANCE_CLIENT_SPECIFIC_CONFIG_PATH
INSTANCE_EXPORT_PATH
INSTANCE_CLIENT_EXPORT_PATH
INSTANCE_WIN64_EXPORT_PATH
INSTANCE_WIN32_EXPORT_PATH
INSTANCE_IPHONE_EXPORT_PATH
INSTANCE_TBLK_EXPORT_PATH
INSTANCE_UNIX_EXPORT_PATH
INSTANCE_UNIX_COMPAT_EXPORT_PATH
INSTANCE_IPTABLES_PATH
INSTANCE_BIND_LOCAL_PATH
INSTANCE_BIND_DB_PATH
INSTANCE_BIND_REVERSE_DB_PATH
INSTANCE_CLIENT_PRIVATE_KEY_PATH_EXPORT_TEMPLATE
INSTANCE_CLIENT_CSR_PATH_EXPORT_TEMPLATE
INSTANCE_CLIENT_PUBLIC_KEY_PATH_EXPORT_TEMPLATE
INSTANCE_CLIENT_SPECIFIC_CONFIG_PATH_EXPORT_TEMPLATE
INSTANCE_CLIENT_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_WIN64_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_WIN32_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_IPHONE_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_TBLK_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_UNIX_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_UNIX_COMPAT_EXPORT_PATH_EXPORT_TEMPLATE"
# Path to the Easy-RSA v3 scripts.
EASYRSA_PATH='/etc/openvpn/easy-rsa/easyrsa3'
# Path to OpenVPN server configuration files.
OVPN_PATH='/etc/openvpn'
# Path to OpenVPN persistant client IP pools.
OVPN_LIB_PATH='/var/lib/openvpn'
# Path to OpenVPN logs path.
OVPN_LOG_PATH='/var/log/openvpn'
OVPN_SYSCTL_PATH='/etc/sysctl.d/openvpn.conf'
# Path to the local easy RSA configuration file.
EASYRSA_CONFIG_PATH="${OVPN_PATH}/easy-rsa.cnf"
## For the instance.
# Path of VPN instance configuration files.
INSTANCE_CONFIG_PATH="${OVPN_PATH}/|INSTANCE|.conf"
# Path to VPN instance files store.
INSTANCE_FILES_PATH="${OVPN_PATH}/|INSTANCE|"
# Path to VPN instance key store.
INSTANCE_KEYS_PATH="${INSTANCE_FILES_PATH}/keys"
# Path to openvpn-tools configuration file for the instance.
INSTANCE_DETAILS_PATH="${INSTANCE_FILES_PATH}/openvpn-tools.cnf"
# Path to OpenVPN instance Certificate Authority.
INSTANCE_CA_PATH="${INSTANCE_KEYS_PATH}/ca.crt"
# Path to OpenVPN instance public key.
INSTANCE_PUBLIC_KEY_PATH="${INSTANCE_KEYS_PATH}/issued/|INSTANCE|.crt"
# Path to OpenVPN instance public key.
INSTANCE_PRIVATE_KEY_PATH="${INSTANCE_KEYS_PATH}/private/|INSTANCE|.key"
# Path to OpenVPN instance Diffie Hellman key.
INSTANCE_DH_KEY_PATH="${INSTANCE_KEYS_PATH}/dh.pem"
# Path to OpenVPN instance TA key.
INSTANCE_TA_KEY_PATH="${INSTANCE_KEYS_PATH}/ta.key"
# Path to OpenVPN instance revoked certificates list.
INSTANCE_CRL_PATH="${INSTANCE_KEYS_PATH}/crl.pem"
# Path to OpenVPN instance persistant client IP pool .
INSTANCE_IPP_PATH="${OVPN_LIB_PATH}/|INSTANCE|-ipp.txt"
# Path to OpenVPN instance status log.
INSTANCE_STATUS_LOG_PATH="${OVPN_LOG_PATH}/|INSTANCE|-status.log"
# Path to OpenVPN instance general log.
INSTANCE_GENERAL_LOG_PATH="${OVPN_LOG_PATH}/|INSTANCE|.log"
# Path to OpenVPN instance specific server configuration files.
INSTANCE_CLIENT_CONFIGS_PATH="${INSTANCE_FILES_PATH}/configs"
# Path to OpenVPN instance clients keys files
INSTANCE_CLIENTS_FILES_PATH="${INSTANCE_KEYS_PATH}"
# Path to OpenVPN instance clients list file.
INSTANCE_CLIENTS_LIST_PATH="${INSTANCE_FILES_PATH}/clients.list"
## For the clients
# Path to OpenVPN instance client private key.
INSTANCE_CLIENT_PRIVATE_KEY_PATH="${INSTANCE_CLIENTS_FILES_PATH}/private/|CLIENT_LONG_NAME|.key"
# Path to OpenVPN instance client certificate signing request.
INSTANCE_CLIENT_CSR_PATH="${INSTANCE_CLIENTS_FILES_PATH}/reqs/|CLIENT_LONG_NAME|.csr"
# Path to OpenVPN instance client public key.
INSTANCE_CLIENT_PUBLIC_KEY_PATH="${INSTANCE_CLIENTS_FILES_PATH}/issued/|CLIENT_LONG_NAME|.crt"
# Path to OpenVPN instance client specific server configuration
INSTANCE_CLIENT_SPECIFIC_CONFIG_PATH="${INSTANCE_CLIENT_CONFIGS_PATH}/|CLIENT_LONG_NAME|"
## For exporting instance clients configurations.
INSTANCE_EXPORT_PATH="${INSTANCE_FILES_PATH}/export"
# Client export directory
INSTANCE_CLIENT_EXPORT_PATH="${INSTANCE_EXPORT_PATH}/|CLIENT_LONG_NAME|"
# Windows x64
INSTANCE_WIN64_EXPORT_PATH="${INSTANCE_CLIENT_EXPORT_PATH}/|CLIENT_LONG_NAME|-win64.zip"
# Windows 32
INSTANCE_WIN32_EXPORT_PATH="${INSTANCE_CLIENT_EXPORT_PATH}/|CLIENT_LONG_NAME|-win32.zip"
# Mac OS X - Tunnelblick
INSTANCE_TBLK_EXPORT_PATH="${INSTANCE_CLIENT_EXPORT_PATH}/|CLIENT_LONG_NAME|-tblk.zip"
# iPhone
INSTANCE_IPHONE_EXPORT_PATH="${INSTANCE_CLIENT_EXPORT_PATH}/|CLIENT_LONG_NAME|-iphone.zip"
## Unix
INSTANCE_UNIX_EXPORT_PATH="${INSTANCE_CLIENT_EXPORT_PATH}/|CLIENT_LONG_NAME|-unix.tar.gz"
# Unix - compat.
INSTANCE_UNIX_COMPAT_EXPORT_PATH="${INSTANCE_CLIENT_EXPORT_PATH}/|CLIENT_LONG_NAME|-unix-compat.tar.gz"
## For IPTables.
INSTANCE_IPTABLES_PATH="/etc/network/if-up.d/ovpn-|INSTANCE-UNDOTED|"
## For bind.
INSTANCE_BIND_LOCAL_PATH="/etc/bind/|INSTANCE|.conf.local"
INSTANCE_BIND_DB_PATH="/etc/bind/db.|INSTANCE|"
INSTANCE_BIND_REVERSE_DB_PATH="/etc/bind/db.|RANGE|"
# Templates for clients exports generation.
EXPORT_TEMPLATES="INSTANCE_CLIENT_PRIVATE_KEY_PATH_EXPORT_TEMPLATE
INSTANCE_CLIENT_CSR_PATH_EXPORT_TEMPLATE
INSTANCE_CLIENT_PUBLIC_KEY_PATH_EXPORT_TEMPLATE
INSTANCE_CLIENT_SPECIFIC_CONFIG_PATH_EXPORT_TEMPLATE
INSTANCE_CLIENT_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_WIN64_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_WIN32_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_IPHONE_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_TBLK_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_UNIX_EXPORT_PATH_EXPORT_TEMPLATE
INSTANCE_UNIX_COMPAT_EXPORT_PATH_EXPORT_TEMPLATE"
INSTANCE_CLIENT_PRIVATE_KEY_PATH_EXPORT_TEMPLATE="${INSTANCE_CLIENT_PRIVATE_KEY_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_CLIENT_CSR_PATH_EXPORT_TEMPLATE="${INSTANCE_CLIENT_CSR_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_CLIENT_PUBLIC_KEY_PATH_EXPORT_TEMPLATE="${INSTANCE_CLIENT_PUBLIC_KEY_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_CLIENT_SPECIFIC_CONFIG_PATH_EXPORT_TEMPLATE="${INSTANCE_CLIENT_SPECIFIC_CONFIG_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_CLIENT_EXPORT_PATH_EXPORT_TEMPLATE="${INSTANCE_CLIENT_EXPORT_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_WIN64_EXPORT_PATH_EXPORT_TEMPLATE="${INSTANCE_WIN64_EXPORT_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_WIN32_EXPORT_PATH_EXPORT_TEMPLATE="${INSTANCE_WIN32_EXPORT_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_IPHONE_EXPORT_PATH_EXPORT_TEMPLATE="${INSTANCE_IPHONE_EXPORT_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_TBLK_EXPORT_PATH_EXPORT_TEMPLATE="${INSTANCE_TBLK_EXPORT_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_UNIX_EXPORT_PATH_EXPORT_TEMPLATE="${INSTANCE_UNIX_EXPORT_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
INSTANCE_UNIX_COMPAT_EXPORT_PATH_EXPORT_TEMPLATE="${INSTANCE_UNIX_COMPAT_EXPORT_PATH//CLIENT_LONG_NAME/CLIENT_EXPORT_NAME}"
############################################################
# Bash 3 compat
# predeclare global vars.
for CONFIG_VAR in ${CONFIG_VARS}; do
command declare "${CONFIG_VAR}"="${!CONFIG_VAR}"
done
for EXPORT_TEMPLATE in ${EXPORT_TEMPLATES}; do
command declare "${EXPORT_TEMPLATE//_TEMPLATE/}"=""
done
############################################################
# Echo text in color.
#
# Colors definitions.
# See http://mywiki.wooledge.org/BashFAQ/037
#
# @param string $color Color and weight for text. (boldgreen for example).
# @param string $text The text to echo (and echo options).
function cecho() {
if [[ ${#} -lt 2 ]]; then
echo "${@}"
return 0
fi
local color="${1}"
# remove color information from arguments.
shift 1
# Check that the output is to a terminal.
if [[ ! -t 1 ]]; then
# Not outputing to a terminal, discaring colors.
echo "${@}"
return 0
fi
# Bash 4 version with associative array.
## Color and weight definitions.
#declare -A font
#font['black']="$(tput 'setaf' 0)"
#font['red']="$(tput 'setaf' 1)"
#font['green']="$(tput 'setaf' 2)"
#font['yellow']="$(tput 'setaf' 3)"
#font['blue']="$(tput 'setaf' 4)"
#font['magenta']="$(tput 'setaf' 5)"
#font['cyan']="$(tput 'setaf' 6)"
#font['white']="$(tput 'setaf' 7)"
#font['bgBlack']="$(tput 'setab' 0)"
#font['bgRed']="$(tput 'setab' 1)"
#font['bgGreen']="$(tput 'setab' 2)"
#font['bgYellow']="$(tput 'setab' 3)"
#font['bgBlue']="$(tput 'setab' 4)"
#font['bgMagenta']="$(tput 'setab' 5)"
#font['bgCyan']="$(tput 'setab' 6)"
#font['bgWhite']="$(tput 'setab' 7)"
#font['bold']="$(tput 'bold')"
#font['stout']="$(tput 'smso')" # Standout.
#font['under']="$(tput 'smul')" # Underline.
#font['blink']="$(tput 'blink')" # Blinking
#font['italic']="$(tput 'sitm')"
## Parse the color string.
#for key in "${!font[@]}"; do
# [[ "${color}" = *"${key}"* ]] && echo -n "${font[${key}]}"
#done
declare -a fontIndex
declare -a fontValue
local index=0
fontIndex[$index]='black'; fontValue[$index]="$(tput 'setaf' 0)"; ((index++))
fontIndex[$index]='red'; fontValue[$index]="$(tput 'setaf' 1)"; ((index++))
fontIndex[$index]='green'; fontValue[$index]="$(tput 'setaf' 2)"; ((index++))
fontIndex[$index]='yellow'; fontValue[$index]="$(tput 'setaf' 3)"; ((index++))
fontIndex[$index]='blue'; fontValue[$index]="$(tput 'setaf' 4)"; ((index++))
fontIndex[$index]='magenta'; fontValue[$index]="$(tput 'setaf' 5)"; ((index++))
fontIndex[$index]='cyan'; fontValue[$index]="$(tput 'setaf' 6)"; ((index++))
fontIndex[$index]='white'; fontValue[$index]="$(tput 'setaf' 7)"; ((index++))
fontIndex[$index]='bgBlack'; fontValue[$index]="$(tput 'setab' 0)"; ((index++))
fontIndex[$index]='bgRed'; fontValue[$index]="$(tput 'setab' 1)"; ((index++))
fontIndex[$index]='bgGreen'; fontValue[$index]="$(tput 'setab' 2)"; ((index++))
fontIndex[$index]='bgYellow'; fontValue[$index]="$(tput 'setab' 3)"; ((index++))
fontIndex[$index]='bgBlue'; fontValue[$index]="$(tput 'setab' 4)"; ((index++))
fontIndex[$index]='bgMagenta'; fontValue[$index]="$(tput 'setab' 5)"; ((index++))
fontIndex[$index]='bgCyan'; fontValue[$index]="$(tput 'setab' 6)"; ((index++))
fontIndex[$index]='bgWhite'; fontValue[$index]="$(tput 'setab' 7)"; ((index++))
fontIndex[$index]='bold'; fontValue[$index]="$(tput 'bold')"; ((index++))
fontIndex[$index]='stout'; fontValue[$index]="$(tput 'smso')"; ((index++)) # Standout.
fontIndex[$index]='under'; fontValue[$index]="$(tput 'smul')"; ((index++)) # Underline.
fontIndex[$index]='blink'; fontValue[$index]="$(tput 'blink')"; ((index++)) # Blinking.
fontIndex[$index]='italic'; fontValue[$index]="$(tput 'sitm')"; ((index++))
for key in "${!fontIndex[@]}"; do
[[ "${color}" = *"${fontIndex[${key}]}"* ]] && echo -n "${fontValue[${key}]}"
done
# Output the text.
echo "${@}"
# Reset all attributes.
tput 'sgr0'
return 0
} # cecho()
# Get the absolute path for a file or directory.
# Print its path on &1 if found.
#
# @param string $path A relative path.
#
# @return ${realpath} A absolute path.
function realpath() {
[[ ${#} -ne 1 ]] && exit 1
local realpath=''
case "$(uname)" in
'Linux' )
realpath="$(readlink -f "${1}")"
;;
'Darwin' )
realpath="$(stat -f '%N' "${1}")"
;;
* )
realpath="$(realpath "${1}")"
;;
esac
echo -n "${realpath}"
return 0
} # realpath
# Get the absolute path for a file or directory and check the file existance.
# If the file does not exists, display an error message and exit the script.
# Print its path on &1 if found.
#
# @param string $path A relative path.
#
# @return Exit with error if the path is missing.
function realpath_check() {
[[ ${#} -ne 1 ]] && exit 1
local realpath="$(realpath "${1}")"
if [[ -n "${realpath}" && ! -e "${realpath}" ]]; then
realpath=''
fi
if [[ -z "${realpath}" ]]; then
cecho 'redbold' "Error: File '${1}' does not exists." >&2
exit 1
fi
echo -n "${realpath}"
return 0
} # realpath_check
# Check if a binary is present. Print its path on &1 if found.
#
# @param string $binary The binaries to check, separated by ;.
# @param string $package The package the binary come from.
#
# @return Exit with error if the binary is missing.
function check_binary() {
[[ ${#} -ne 2 ]] && exit 1
local primary="$(cut -d ';' -f 1 <<< "${1}")"
local binaries="";
local binary=''
read -d ';' -r -a binaries <<< "${1}"
# Test the binary presence.
for binary in ${binaries[@]}; do
if type "${binary}" &>'/dev/null'; then
command -v "${binary}"
return 0
fi
done
cecho 'redbold' "Error: '${primary}' is missing. Please install package '${2}'." >&2
exit 1
} # check_binary()
# Call to openvpn according to system.
#
# @param string $instance_name the instance to apply the action to.
# @param string $action The action (start, stop, restart)
#
# @return Return the error if action failed.
function openvpnService() {
[[ ${#} -ne 2 ]] && exit 1
local action="${1}"
local instance_name="${2}"
if type 'service' &>'/dev/null'; then
service openvpn "${action}" "${instance_name}"
return ${?}
elif [[ -x '/etc/init.d/openvpn' ]]; then
/etc/init.d/openvpn "${action}" "${instance_name}"
return ${?}
fi
# Failure
return 1
} # openvpnService()
# Update configuration variables value with given parameter.
#
# @param string $search The parameter name.
# @param string $replace The parameter value.
#
# @return The update configuration variables.
function update_config_vars
{
command test ${#} -ne 2 && exit 1
local SEARCH="|${1}|"
local REPLACE="${2}"
# Set the paths.
for CONFIG_VAR in ${CONFIG_VARS}; do
command declare -g "${CONFIG_VAR}"="${!CONFIG_VAR//${SEARCH}/${REPLACE}}" 2>&- \
|| eval "${CONFIG_VAR}='${!CONFIG_VAR//${SEARCH}/${REPLACE}}'"
done
} # update_config_vars()
# Initialize export configuration variables value from template.
#
# @param string $search The parameter name.
# @param string $replace The parameter value.
#
# @return The export configuration variables.
function initialize_export_config_vars
{
command test ${#} -ne 2 && exit 1
local SEARCH="|${1}|"
local REPLACE="${2}"
# Set the paths.
for EXPORT_TEMPLATE in ${EXPORT_TEMPLATES}; do
command declare -g "${EXPORT_TEMPLATE//_TEMPLATE/}"="${!EXPORT_TEMPLATE//${SEARCH}/${REPLACE}}" 2>&- \
|| eval "${EXPORT_TEMPLATE//_TEMPLATE/}='${!EXPORT_TEMPLATE//${SEARCH}/${REPLACE}}'"
done
} # update_config_vars()
# Delect current instance protocol.
#
# @return $PROTO (tcp or udp)
# @return $CURRENT_UDP (true or false).
declare CURRENT_UDP='false'
declare PROTO='tcp'
function detect_instance_protocol
{
# declare -g CURRENT_UDP='false'
# declare -g PROTO='tcp'
CURRENT_UDP='false'
PROTO='tcp'
# Detect current proto.
if [ "$(command grep '^proto[ \t]*' "${INSTANCE_CONFIG_PATH}" \
| command cut -d ' ' -f 2)" = 'udp' ]; then
CURRENT_UDP='true'
PROTO='udp'
fi
} # detect_instance_protocol
# Update OpenVPN instance to use UDP or TCP.
#
# @param string $udp True to use UDP, False for TCP.
#
# @return 1 if port changed, 0 otherwise.
function set_udp
{
command test ${#} -gt 1 && exit 1
detect_instance_protocol
if [ -n "${1}" -a "${1}" != "${CURRENT_UDP}" ]; then
PROTO="tcp"
if [ "${1}" = 'true' ]; then
PROTO="udp"
fi
# Update instance proto.
command sed -i \
-e "s|^proto[\t ].*|;&|" \
-e "s|^;\(proto[\t ]*${PROTO}\)|\1|" \
"${INSTANCE_CONFIG_PATH}"
echo " + Instance using ${PROTO} protocol."
return 1
else
echo " - Instance using ${PROTO} protocol."
fi
return 0
} # set_udp()
# Update OpenVPN instance file with a new listening port.
#
# @param integer $port New port number.
#
# @return 1 if port changed, 0 otherwise.
function set_port
{
command test ${#} -gt 1 && exit 1
if [ -n "${1}" ]; then
if [ ${1} -ne ${CURRENT_PORT} ]; then
# Update server listening port.
command sed -i \
-e "s|^port[\t ].*|port ${1}|" \
"${INSTANCE_CONFIG_PATH}"
echo " + Instance is now listening on port ${1}."
# Update server details for clients configuration.
command sed -i \
-e "s/^CURRENT_PORT=.*$/CURRENT_PORT='${1}'/" \
"${INSTANCE_DETAILS_PATH}"
CURRENT_PORT="${1}"
return 1
else
echo " - Instance listening on port ${CURRENT_PORT}."
fi
else
echo " - Instance listening on port ${CURRENT_PORT}."
fi
return 0
} # set_port()
# Update OpenVPN clients config with new server hostname..
#
# @param string $server_hostname New server hostname.
#
# @return 1 if hostname changed, 0 otherwise.
function set_server_hostname
{
command test ${#} -gt 1 && exit 1
if [ -n "${1}" -a "${1}" != "${CURRENT_SERVER_HOSTNAME}" ]; then
echo " + Instance is now listening on ${1}."
# Update server details for clients configuration.
command sed -i \
-e "s/^CURRENT_SERVER_HOSTNAME=.*$/CURRENT_SERVER_HOSTNAME='${1}'/" \
"${INSTANCE_DETAILS_PATH}"
CURRENT_SERVER_HOSTNAME="${1}"
return 1
else
echo " - Instance listening on ${CURRENT_SERVER_HOSTNAME}."
fi
return 0
} # set_server_hostname()
# Update OpenVPN config with new network range.
#
# @param string $ip_range New instance network IP range.
#
# @return 1 if IP range changed, 0 otherwise.
function set_ip_range
{
command test ${#} -gt 1 && exit 1
if [ -n "${1}" -a "${1}" != "${CURRENT_IP_RANGE}" ]; then
ORIG_NAT="${CURRENT_NAT}"
ORIG_GATEWAY="${CURRENT_GATEWAY}"
ORIG_BIND="${CURRENT_BIND}"
# Disable options depending on IP range.
set_nat "false" > '/dev/null'
set_gateway "false" > '/dev/null'
setup_iptables_nat > '/dev/null'
set_bind "false" > '/dev/null'
# Update server configuration file.
command sed -i \
-e "s|${CURRENT_IP_RANGE//\./\\.}|${1}|" \
"${INSTANCE_CONFIG_PATH}"
# Update server details for clients configuration.
command sed -i \
-e "s/^CURRENT_IP_RANGE=.*$/CURRENT_IP_RANGE='${1}'/" \
"${INSTANCE_DETAILS_PATH}"
CURRENT_IP_RANGE="${1}"
# Restore options depending on IP range.
set_nat "${ORIG_NAT}" > '/dev/null'
set_gateway "${ORIG_GATEWAY}" > '/dev/null'
setup_iptables_nat > '/dev/null'
set_bind "${ORIG_BIND}" > '/dev/null'
echo " + Instance network is now ${1}.0/24."
return 1
else
echo " - Instance network is ${CURRENT_IP_RANGE}.0/24."
fi
return 0
} # set_ip_range()
# Update OpenVPN instance file for client to client communication.
#
# @param string $c2c 'true' to enable, 'false' to disable.
function set_client2client
{
command test ${#} -gt 1 && exit 1
if [ -n "${1}" ]; then
# Update server details for clients configuration.
command sed -i \
-e "s/^CURRENT_C2C=.*$/CURRENT_C2C='${1}'/" \
"${INSTANCE_DETAILS_PATH}"
if [ "${1}" = 'true' ]; then
command sed -i \
-e 's/^;client-to-client/client-to-client/' \
"${INSTANCE_CONFIG_PATH}"
echo " + Client to client communications enabled."
else
command sed -i \
-e 's/^client-to-client/;client-to-client/' \
"${INSTANCE_CONFIG_PATH}"
echo " + Client to client communications disabled."
fi
# Update server details for clients configuration.
command sed -i \
-e "s/^CURRENT_C2C=.*$/CURRENT_C2C='${1}'/" \
"${INSTANCE_DETAILS_PATH}"
CURRENT_C2C="${1}"
else
if [ "${CURRENT_C2C}" = 'true' ]; then
echo " - Client to client communications enabled."
else
echo " - Client to client communications disabled."
fi
fi
} # set_client2client()
# Update OpenVPN instance file for NAT access to local network.
#
# @param string $nat 'true' to enable, 'false' to disable.
#
# @see setup_iptables_nat()
function set_nat
{
command test ${#} -gt 1 && exit 1
if [ -n "${1}" ]; then
# Detect local net range.
NET_DEV="eth0"
NET_RANGE="$(command ifconfig "${NET_DEV}" \
| command grep 'inet ' \
| command sed -e 's/^.*inet [^:]*:\([^ ]*\) .*$/\1/' \
| command cut -d '.' -f '1-3').0"
# Update server details for NAT access to local network.
if [ "${1}" = 'true' ]; then
if [ -z "$(command grep -e "^push[ \t]*\"route[ \t]*${NET_RANGE//\./\\.}[ \t]*255\.255\.255\.0\"" \
"${INSTANCE_CONFIG_PATH}")" ]; then
echo "push \"route ${NET_RANGE} 255.255.255.0\"; Allow access to local network." \
>> "${INSTANCE_CONFIG_PATH}"
fi
echo " + Local network access enabled."
else
command sed -i \
-e "/^push[ \t]*\"route[ \t]*${NET_RANGE//\./\\.}[ \t]*255\.255\.255\.0\"/d" \
"${INSTANCE_CONFIG_PATH}"
echo " + Local network access disabled."
fi
# Update server details for clients configuration.
command sed -i \
-e "s/^CURRENT_NAT=.*$/CURRENT_NAT='${1}'/" \
"${INSTANCE_DETAILS_PATH}"
CURRENT_NAT="${1}"
else
if [ "${CURRENT_NAT}" = 'true' ]; then
echo " - Local network access enabled."
else
echo " - Local network access disabled."
fi
fi
} # set_nat()
# Update OpenVPN instance file for usage as Internet gateway.
#
# @param string $nat 'true' to enable, 'false' to disable.
#
# @see setup_iptables_nat()
function set_gateway
{
command test ${#} -gt 1 && exit 1
if [ -n "${1}" ]; then
# Update server details for Internet gateway.
if [ "${1}" = 'true' ]; then
command sed -i \
-e 's/;[ \t]*\(push[ \t]*"redirect-gateway.*\)$/\1/g' \
"${INSTANCE_CONFIG_PATH}"
echo " + Internet gateway enabled."
else
command sed -i \
-e 's/[ \t]*\(push[ \t]*"redirect-gateway.*\)$/;\1/g' \
"${INSTANCE_CONFIG_PATH}"
echo " + Internet gateway disabled."
fi
# Update server details for clients configuration.
command sed -i \
-e "s/^CURRENT_GATEWAY=.*$/CURRENT_GATEWAY='${1}'/" \
"${INSTANCE_DETAILS_PATH}"
CURRENT_GATEWAY="${1}"
else
if [ "${CURRENT_GATEWAY}" = 'true' ]; then
echo " - Internet gateway enabled."
else
echo " - Internet gateway disabled."
fi
fi
} # set_gateway()
# Setup NAT for OpenVPN instance using iptables.
#
# @see set_nat()
# @see set_gateway()
function setup_iptables_nat
{
if [ "${CURRENT_NAT}" = 'true' \
-o "${CURRENT_GATEWAY}" = 'true' ]; then
# Enable iptables NAT.
if [ ! -e "${OVPN_SYSCTL_PATH}" ]; then
# Setup sysctl to enable NAT.
echo "# Allowing nat translation for VPN clients.
net.ipv4.conf.default.forwarding=1
net.ipv4.ip_forward=1" > "${OVPN_SYSCTL_PATH}"
# load new sysctl config.
command sysctl -p "${OVPN_SYSCTL_PATH}" > '/dev/null'
fi
# Create if-up.d script for instance.
command echo '#!/bin/sh' > "${INSTANCE_IPTABLES_PATH}"
command echo "# IpTables setup for OpenVPN instance ${DOMAIN}.
command iptables -t nat -C POSTROUTING -s '${CURRENT_IP_RANGE}.0/24' \\
-o 'eth0' -j MASQUERADE 2>'/dev/null' \\
|| command iptables -t nat -A POSTROUTING -s '${CURRENT_IP_RANGE}.0/24' \\
-o 'eth0' -j MASQUERADE" \
>> "${INSTANCE_IPTABLES_PATH}"
command chmod +x "${INSTANCE_IPTABLES_PATH}"
# Load iptables rules.
command sh "${INSTANCE_IPTABLES_PATH}"
echo " - IpTables NAT enabled (needed by instance for nat and internet gateway)."
else
# Disable iptables NAT.
command iptables -t nat -C POSTROUTING -s "${CURRENT_IP_RANGE}.0/24" \
-o 'eth0' -j MASQUERADE 2>'/dev/null' \
&& command iptables -t nat -D POSTROUTING -s "${CURRENT_IP_RANGE}.0/24" \
-o 'eth0' -j MASQUERADE
# Delete if-up.d script.
command test -e "${INSTANCE_IPTABLES_PATH}" && command rm "${INSTANCE_IPTABLES_PATH}"
echo " - IpTables NAT disabled (no nat or internet gateway enabled for instance)."
fi
} # setup_iptables_nat()
# Setup Bind for OpenVPN instance.
#
# @param string $bind 'true' to enable, 'false' to disable.
function set_bind
{
command test ${#} -gt 1 && exit 1
if [ -n "${1}" ]; then
# Update server details for Bind DNS.
if [ "${1}" = 'true' ]; then
# Install bind if needed.
install_bind
# Allow VPN instance network to use DNS server.
if [ -z "$(command grep "${CURRENT_IP_RANGE}.1/24;" '/etc/bind/named.conf.options')" ]; then
command sed -i -e "/acl local-networks/a\\
\t${CURRENT_IP_RANGE}.1/24;" \
'/etc/bind/named.conf.options'
fi
## Compute reverse ip range for VPN instance.
REVERSE_IP_RANGE="$(echo "${CURRENT_IP_RANGE}" \
| command sed -e 's/\([0-9]*\)\.\([0-9]*\)\.\([0-9]*\)/\3\.\2\.\1/')"
# Create bind config for instance if needed.
if [ -z "$(grep "${INSTANCE_BIND_LOCAL_PATH}" '/etc/bind/named.conf.local')" ]; then
# Initialize and declare VPN instance zones in Bind.
echo "
# OpenVPN configuration
zone \"${REVERSE_IP_RANGE}.in-addr.arpa\" in {
type master;
file \"${INSTANCE_BIND_REVERSE_DB_PATH}\";
};
zone \"${DOMAIN}\" in {
type master;
file \"${INSTANCE_BIND_DB_PATH}\";
};" > "${INSTANCE_BIND_LOCAL_PATH}"
echo "include \"${INSTANCE_BIND_LOCAL_PATH}\";" \
>> '/etc/bind/named.conf.local'
fi
# (Re)build bind databases for VPN instance.
setup_bind "true"
# Update OpenVPN instance configuration file for DNS server.
if [ -z "$(command grep "push \"dhcp-option DOMAIN ${DOMAIN}\"" "${INSTANCE_CONFIG_PATH}")" ]; then
command echo "push \"dhcp-option DOMAIN ${DOMAIN}\"
push \"dhcp-option DNS ${CURRENT_IP_RANGE}.1\"" \
>> "${INSTANCE_CONFIG_PATH}"
fi
echo " + Bind DNS enabled."
else
if [ -n "$(command grep "push \"dhcp-option DOMAIN ${DOMAIN}\"" "${INSTANCE_CONFIG_PATH}")" ]; then
# Disable Bind configuration for VPN instance.
command sed -i \
-e "/^include \"${INSTANCE_BIND_LOCAL_PATH//\//\\/}\"/d" \
'/etc/bind/named.conf.local'
# Delete Bind configuration files for VPN instance.
command test -e "${INSTANCE_BIND_REVERSE_DB_PATH}" && command rm "${INSTANCE_BIND_REVERSE_DB_PATH}"
command test -e "${INSTANCE_BIND_DB_PATH}" && command rm "${INSTANCE_BIND_DB_PATH}"
command test -e "${INSTANCE_BIND_LOCAL_PATH}" && command rm "${INSTANCE_BIND_LOCAL_PATH}"
# Remove instance network from acl
if [ -n "$(command grep "${CURRENT_IP_RANGE}.1/24;" '/etc/bind/named.conf.options')" ]; then
command sed -i -e "/${CURRENT_IP_RANGE}.1\/24;/d" \
'/etc/bind/named.conf.options'
fi
# Reload bind configuration.
command test -x '/etc/init.d/bind9' && /etc/init.d/bind9 reload
# Disable DNS server in OpenVPN instance configuration file.
command sed -i \
-e "/^[ \t]*push \"dhcp-option DOMAIN ${DOMAIN}\"/d" \
-e "/^[ \t]*push \"dhcp-option DNS ${CURRENT_IP_RANGE}.1\"/d" \
"${INSTANCE_CONFIG_PATH}"
fi
echo " + Bind DNS disabled."
fi
# Update server details for clients configuration.
command sed -i \
-e "s/^CURRENT_BIND=.*$/CURRENT_BIND='${1}'/" \
"${INSTANCE_DETAILS_PATH}"
CURRENT_BIND="${1}"
else
if [ "${CURRENT_BIND}" = 'true' ]; then
echo " - Bind DNS enabled."
else
echo " - Bind DNS disabled."