2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2017 IPFire Network Development Team #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
22 VPN_SECURITY_POLICIES_CONFIG_SETTINGS
="CIPHER COMPRESSION GROUP_TYPE INTEGRITY KEY_EXCHANGE LIFETIME PFS"
23 VPN_SECURITY_POLICIES_READONLY
="system"
25 VPN_DEFAULT_SECURITY_POLICY
="system"
27 declare -A VPN_SUPPORTED_CIPHERS
=(
29 [3DES-CBC
]="168 bit 3DES-EDE-CBC"
32 [AES256-CBC
]="256 bit AES-CBC"
33 [AES192-CBC
]="192 bit AES-CBC"
34 [AES128-CBC
]="128 bit AES-CBC"
37 [AES256-CTR
]="256 bit AES-COUNTER"
38 [AES192-CTR
]="192 bit AES-COUNTER"
39 [AES128-CTR
]="128 bit AES-COUNTER"
42 [AES256-GCM128
]="256 bit AES-GCM with 128 bit ICV"
43 [AES192-GCM128
]="192 bit AES-GCM with 128 bit ICV"
44 [AES128-GCM128
]="128 bit AES-GCM with 128 bit ICV"
45 [AES256-GCM96
]="256 bit AES-GCM with 96 bit ICV"
46 [AES192-GCM96
]="192 bit AES-GCM with 96 bit ICV"
47 [AES128-GCM96
]="128 bit AES-GCM with 96 bit ICV"
48 [AES256-GCM64
]="256 bit AES-GCM with 64 bit ICV"
49 [AES192-GCM64
]="192 bit AES-GCM with 64 bit ICV"
50 [AES128-GCM64
]="128 bit AES-GCM with 64 bit ICV"
53 [AES256-CCM128
]="256 bit AES-CCM with 128 bit ICV"
54 [AES192-CCM128
]="192 bit AES-CCM with 128 bit ICV"
55 [AES128-CCM128
]="128 bit AES-CCM with 128 bit ICV"
56 [AES256-CCM96
]="256 bit AES-CCM with 96 bit ICV"
57 [AES192-CCM96
]="192 bit AES-CCM with 96 bit ICV"
58 [AES128-CCM96
]="128 bit AES-CCM with 96 bit ICV"
59 [AES256-CCM64
]="256 bit AES-CCM with 64 bit ICV"
60 [AES192-CCM64
]="192 bit AES-CCM with 64 bit ICV"
61 [AES128-CCM64
]="128 bit AES-CCM with 64 bit ICV"
64 [CAMELLIA256-CBC
]="256 bit CAMELLIA-CBC"
65 [CAMELLIA192-CBC
]="192 bit CAMELLIA-CBC"
66 [CAMELLIA128-CBC
]="128 bit CAMELLIA-CBC"
69 [CAMELLIA256-CTR
]="256 bit CAMELLIA-COUNTER"
70 [CAMELLIA192-CTR
]="192 bit CAMELLIA-COUNTER"
71 [CAMELLIA128-CTR
]="128 bit CAMELLIA-COUNTER"
74 [CAMELLIA256-GCM128
]="256 bit CAMELLIA-GCM with 128 bit ICV"
75 [CAMELLIA192-GCM128
]="192 bit CAMELLIA-GCM with 128 bit ICV"
76 [CAMELLIA128-GCM128
]="128 bit CAMELLIA-GCM with 128 bit ICV"
77 [CAMELLIA256-GCM96
]="256 bit CAMELLIA-GCM with 96 bit ICV"
78 [CAMELLIA192-GCM96
]="192 bit CAMELLIA-GCM with 96 bit ICV"
79 [CAMELLIA128-GCM96
]="128 bit CAMELLIA-GCM with 96 bit ICV"
80 [CAMELLIA256-GCM64
]="256 bit CAMELLIA-GCM with 64 bit ICV"
81 [CAMELLIA192-GCM64
]="192 bit CAMELLIA-GCM with 64 bit ICV"
82 [CAMELLIA128-GCM64
]="128 bit CAMELLIA-GCM with 64 bit ICV"
85 [CAMELLIA256-CCM128
]="256 bit CAMELLIA-CCM with 128 bit ICV"
86 [CAMELLIA192-CCM128
]="192 bit CAMELLIA-CCM with 128 bit ICV"
87 [CAMELLIA128-CCM128
]="128 bit CAMELLIA-CCM with 128 bit ICV"
88 [CAMELLIA256-CCM96
]="256 bit CAMELLIA-CCM with 96 bit ICV"
89 [CAMELLIA192-CCM96
]="192 bit CAMELLIA-CCM with 96 bit ICV"
90 [CAMELLIA128-CCM96
]="128 bit CAMELLIA-CCM with 96 bit ICV"
91 [CAMELLIA256-CCM64
]="256 bit CAMELLIA-CCM with 64 bit ICV"
92 [CAMELLIA192-CCM64
]="192 bit CAMELLIA-CCM with 64 bit ICV"
93 [CAMELLIA128-CCM64
]="128 bit CAMELLIA-CCM with 64 bit ICV"
96 declare -A VPN_SUPPORTED_INTEGRITY
=(
101 [SHA512
]="512 bit SHA2-HMAC"
102 [SHA384
]="384 bit SHA2-HMAC"
103 [SHA256
]="256 bit SHA2-HMAC"
106 [AES-XCBC
]="AES-XCBC"
107 [AES-CMAC
]="AES-CMAC"
108 [AES256-GMAC
]="256 bit AES-GMAC"
109 [AES192-GMAC
]="192 bit AES-GMAC"
110 [AES128-GMAC
]="128 bit AES-GMAC"
113 declare -A VPN_SUPPORTED_GROUP_TYPES
=(
115 [MODP768
]="768 bit Modulo Prime Group"
116 [MODP1024
]="1024 bit Modulo Prime Group"
117 [MODP1536
]="1536 bit Modulo Prime Group"
118 [MODP2048
]="2048 bit Modulo Prime Group"
119 [MODP3072
]="3072 bit Modulo Prime Group"
120 [MODP4096
]="4096 bit Modulo Prime Group"
121 [MODP6144
]="6144 bit Modulo Prime Group"
122 [MODP8192
]="8192 bit Modulo Prime Group"
124 # NIST Elliptic Curve Groups
125 [ECP192
]="192 bit NIST Elliptic Curve Group"
126 [ECP224
]="224 bit NIST Elliptic Curve Group"
127 [ECP256
]="256 bit NIST Elliptic Curve Group"
128 [ECP384
]="384 bit NIST Elliptic Curve Group"
129 [ECP521
]="521 bit NIST Elliptic Curve Group"
131 # Brainpool Elliptic Curve Groups
132 [ECP224BP
]="224 bit Brainpool Elliptic Curve Group"
133 [ECP256BP
]="256 bit Brainpool Elliptic Curve Group"
134 [ECP384BP
]="384 bit Brainpool Elliptic Curve Group"
135 [ECP512BP
]="512 bit Brainpool Elliptic Curve Group"
138 [CURVE25519
]="256 bit Elliptic Curve 25519"
141 # This functions checks if a policy is readonly
142 # returns true when yes and false when no
143 vpn_security_policies_check_readonly
() {
144 if isoneof name
${VPN_SECURITY_POLICIES_READONLY}; then
151 # This function writes all values to a via ${name} specificated vpn security policy configuration file
152 vpn_security_policies_write_config
() {
157 if ! vpn_security_policy_exists
"${name}"; then
158 log ERROR
"No such vpn security policy: ${name}"
162 if vpn_security_policies_check_readonly
"${name}"; then
163 log ERROR
"The ${name} vpn security policy cannot be changed."
167 local path
="$(vpn_security_policies_path "${name}")"
168 if [ ! -w ${path} ]; then
169 log ERROR
"${path} is not writeable"
173 if ! settings_write
"${path}" ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}; then
174 log ERROR
"Could not write configuration settings for vpn security policy ${name}"
178 # TODO everytime we successfully write a config we should call some trigger to take the changes into effect
181 # This funtion writes the value for one key to a via ${name} specificated vpn security policy configuration file
182 vpn_security_policies_write_config_key
() {
191 if ! vpn_security_policy_exists
"${name}"; then
192 log ERROR
"No such vpn security policy: ${name}"
196 log DEBUG
"Set '${key}' to new value '${value}' in vpn security policy ${name}"
198 local ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
200 # Read the config settings
201 if ! vpn_security_policies_read_config
"${name}"; then
205 # Set the key to a new value
206 assign
"${key}" "${value}"
208 if ! vpn_security_policies_write_config
"${name}"; then
215 # Reads one or more keys out of a settings file or all if no key is provided.
216 vpn_security_policies_read_config
() {
222 if ! vpn_security_policy_exists
"${name}"; then
223 log ERROR
"No such vpn security policy: ${name}"
229 if [ $# -eq 0 ] && [ -n "${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}" ]; then
230 list_append args
${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
235 local path
="$(vpn_security_policies_path ${name})"
237 if ! settings_read
"${path}" ${args}; then
238 log ERROR
"Could not read settings for vpn security policy ${name}"
243 # Returns the path to a the configuration fora given name
244 vpn_security_policies_path
() {
249 if vpn_security_policies_check_readonly
"${name}"; then
250 echo "${NETWORK_SHARE_DIR}/vpn/security-policies/${name}"
252 echo "${NETWORK_CONFIG_DIR}/vpn/security-policies/${name}"
256 # Print the content of a vpn security policy configuration file in a nice way
257 vpn_security_policies_show
() {
262 local ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
263 if ! vpn_security_policies_read_config
${name}; then
267 cli_print_fmt1
0 "Security Policy: ${name}"
270 # This could be done in a loop but a loop is much more complicated
271 # because we print 'Group Types' but the variable is named 'GROUP_TYPES'
272 cli_print_fmt1
1 "Ciphers:"
274 for cipher
in ${CIPHER}; do
275 cli_print_fmt1
2 "${VPN_SUPPORTED_CIPHERS[${cipher}]-${cipher}}"
279 cli_print_fmt1
1 "Integrity:"
281 for integrity
in ${INTEGRITY}; do
282 cli_print_fmt1
2 "${VPN_SUPPORTED_INTEGRITY[${integrity}]-${integrity}}"
286 cli_print_fmt1
1 "Group Types:"
288 for group_type
in ${GROUP_TYPE}; do
289 cli_print_fmt1
2 "${VPN_SUPPORTED_GROUP_TYPES[${group_type}]-${group_type}}"
293 cli_print_fmt1
1 "Key Exchange:" "${KEY_EXCHANGE}"
296 if isinteger LIFETIME
&& [ ${LIFETIME} -gt 0 ]; then
297 cli_print_fmt1
1 "Key Lifetime:" "$(format_time ${LIFETIME})"
299 log ERROR
"The value for Key Lifetime is not a valid integer greater zero."
304 cli_print_fmt1
1 "Perfect Forward Secrecy:" "enabled"
306 cli_print_fmt1
1 "Perfect Forward Secrecy:" "disabled"
311 if enabled COMPRESSION
; then
312 cli_print_fmt1
1 "Compression:" "enabled"
314 cli_print_fmt1
1 "Compression:" "disabled"
319 # This function checks if a vpn security policy exists
320 # Returns True when yes and false when not
321 vpn_security_policy_exists
() {
326 local path
=$
(vpn_security_policies_path
"${name}")
328 [ -f ${path} ] && return ${EXIT_TRUE} || return ${EXIT_FALSE}
332 # This function parses the parameters for the 'cipher' command
333 vpn_security_policies_cipher
(){
337 if [ $# -eq 0 ]; then
338 log ERROR
"You must pass at least one value after cipher"
343 if ! vpn_security_policies_read_config
${name} "CIPHER"; then
347 # Remove duplicated entries to proceed the list safely
348 CIPHER
="$(list_unique ${CIPHER})"
350 while [ $# -gt 0 ]; do
354 # Check if the cipher is in the list of ciphers and
355 # check if the list has after removing this cipher at least one valid value
356 if list_match
${value} ${CIPHER}; then
357 list_remove CIPHER
${value}
359 # We do not break here because this error does not break the processing of the next maybe valid values.
360 log ERROR
"Can not remove ${value} from the list of Ciphers because ${value} is not in the list."
365 # Check if the Ciphers is in the list of supported ciphers.
366 if ! isoneof value
${!VPN_SUPPORTED_CIPHERS[@]}; then
367 # We do not break here because this error does not break the processing of the next maybe valid values.
368 log ERROR
"${value} is not a supported cipher and can thats why not added to the list of ciphers."
370 if list_match
${value} ${CIPHER}; then
371 log WARNING
"${value} is already in the list of ciphers of this policy."
373 list_append CIPHER
${value}
381 # Check if the list contain at least one valid cipher
382 if [ $
(list_length
${CIPHER}) -ge 1 ]; then
383 if ! vpn_security_policies_write_config_key
${name} "CIPHER" ${CIPHER}; then
384 log ERROR
"The changes for the vpn security policy ${name} could not be written."
387 log ERROR
"After proceding all ciphers the list is empty and thats why no changes are written."
392 # This function parses the parameters for the 'compression' command
393 vpn_security_policies_compression
(){
397 # Check if we get only one argument after compression <name>
398 if [ ! $# -eq 2 ]; then
399 log ERROR
"The number of arguments do not match. Only one argument after compression is allowed."
403 if ! isbool value
; then
404 # We suggest only two values to avoid overburding the user.
405 log ERROR
"Invalid Argument ${value}"
409 vpn_security_policies_write_config_key
"${name}" "COMPRESSION" "${value}"
412 # This function parses the parameters for the 'group-type' command
413 vpn_security_policies_group_type
(){
417 if [ $# -eq 0 ]; then
418 log ERROR
"You must pass at least one value after group-type"
423 if ! vpn_security_policies_read_config
${name} "GROUP_TYPE"; then
427 # Remove duplicated entries to proceed the list safely
428 GROUP_TYPE
="$(list_unique ${GROUP_TYPE})"
430 while [ $# -gt 0 ]; do
434 # Check if the group type is in the list of group types and
435 # check if the list has after removing this group type at leatst one valid value
436 if list_match
${value} ${GROUP_TYPE}; then
437 list_remove GROUP_TYPE
${value}
439 # We do not break here because this error does not break the processing of the next maybe valid values.
440 log ERROR
"Can not remove ${value} from the list of group types because ${value} is not in the list."
445 # Check if the group type is in the list of supported group types.
446 if ! isoneof value
${!VPN_SUPPORTED_GROUP_TYPES[@]}; then
447 # We do not break here because the processing of other maybe valid values are indepent from this error.
448 log ERROR
"${value} is not a supported group type and can thats why not added to the list of group types."
450 if list_match
${value} ${GROUP_TYPE}; then
451 log WARNING
"${value} is already in the list of group-types of this policy."
453 list_append GROUP_TYPE
${value}
461 # Check if the list contain at least one valid group-type
462 if [ $
(list_length
${GROUP_TYPE}) -ge 1 ]; then
463 if ! vpn_security_policies_write_config_key
${name} "GROUP_TYPE" ${GROUP_TYPE}; then
464 log ERROR
"The changes for the vpn security policy ${name} could not be written."
467 log ERROR
"After proceding all group types the list is empty and thats why no changes are written."
472 # This function parses the parameters for the 'integrity' command
473 vpn_security_policies_integrity
(){
477 if [ $# -eq 0 ]; then
478 log ERROR
"You must pass at least one value after integrity."
483 if ! vpn_security_policies_read_config
${name} "INTEGRITY"; then
487 # Remove duplicated entries to proceed the list safely
488 INTEGRITY
="$(list_unique ${INTEGRITY})"
490 while [ $# -gt 0 ]; do
494 # Check if the integrity hash is in the list of integrity hashes and
495 # check if the list has after removing this integrity hash at least one valid value
496 if list_match
${value} ${INTEGRITY}; then
497 list_remove INTEGRITY
${value}
499 # We do not break here because the processing of other maybe valid values are indepent from this error.
500 log ERROR
"Can not remove ${value} from the list of integrity hashes because ${value} is not in the list."
505 # Check if the Ciphers is in the list of supported integrity hashes.
506 if ! isoneof value
${!VPN_SUPPORTED_INTEGRITY[@]}; then
507 # We do not break here because the processing of other maybe valid values are indepent from this error.
508 log ERROR
"${value} is not a supported integrity hash and can thats why not added to the list of integrity hashes."
510 if list_match
${value} ${INTEGRITY}; then
511 log WARNING
"${value} is already in the list of integrety hashes of this policy."
513 list_append INTEGRITY
${value}
521 # Check if the list contain at least one valid group-type
522 if [ $
(list_length
${INTEGRITY}) -ge 1 ]; then
523 if ! vpn_security_policies_write_config_key
${name} "INTEGRITY" ${INTEGRITY}; then
524 log ERROR
"The changes for the vpn security policy ${name} could not be written."
527 log ERROR
"After proceding all integrity hashes the list is empty and thats why no changes are written."
532 # This function parses the parameters for the 'key-exchange' command
533 vpn_security_policies_key_exchange
() {
537 # Check if we get only one argument after key-exchange <name>
538 if [ ! $# -eq 2 ]; then
539 log ERROR
"The number of arguments do not match. Only argument after key-exchange is allowed."
543 if ! isoneof value
"ikev1" "ikev2" "IKEV1" "IKEV2"; then
544 log ERROR
"Invalid Argument ${value}"
548 vpn_security_policies_write_config_key
"${name}" "KEY_EXCHANGE" "${value,,}"
551 # This function parses the parameters for the 'lifetime' command.
552 vpn_security_policies_lifetime
(){
558 # Check if we get only one argument after lifetime <name>
559 if [ ! $# -ge 1 ]; then
560 log ERROR
"The number of arguments do not match you must provide at least one integer value or a valid time with the format <hours>h <minutes>m <seconds>s"
564 if ! isinteger value
; then
565 value
=$
(parse_time $@
)
566 if [ ! $?
-eq 0 ]; then
567 log ERROR
"Parsing the passed time was not sucessful please check the passed values."
572 if [ ${value} -le 0 ]; then
573 log ERROR
"The passed time value must be in the sum greater zero seconds."
577 vpn_security_policies_write_config_key
"${name}" "LIFETIME" "${value}"
580 # This function parses the parameters for the 'pfs' command
581 vpn_security_policies_pfs
(){
585 # Check if we get only one argument after pfs <name>
586 if [ ! $# -eq 2 ]; then
587 log ERROR
"The number of arguments do not match. Only argument after pfs is allowed."
591 if [ ! $# -eq 2 ] ||
! isbool value
; then
592 # We suggest only two values to avoid overburding the user.
593 log ERROR
"Invalid Argument ${value}"
597 vpn_security_policies_write_config_key
"${name}" "PFS" "${value}"
600 # This function checks if a vpn security policy name is valid
601 # Allowed are only A-Za-z0-9
602 vpn_security_policies_check_name
() {
607 [[ ${name} =~
[^
[:alnum
:]$
] ]]
610 # Function that creates based on the paramters one ore more new vpn security policies
611 vpn_security_policies_new
() {
612 if [ $# -gt 1 ]; then
613 error
"Too many arguments"
618 if ! isset name
; then
619 error
"Please provide a name"
623 # Check for duplicates
624 if vpn_security_policy_exists
"${name}"; then
625 error
"The VPN security policy with name ${name} already exists"
629 # Check if name is valid
630 if vpn_security_policies_check_name
"${name}"; then
631 error
"'${name}' contains illegal characters"
635 # Check if we have a read-only policy with the same name
636 if vpn_security_policies_check_readonly
"${name}"; then
637 error
"The VPN security policy ${name} is read-only"
641 # Check if our source policy exists
642 if ! vpn_security_policy_exists
"${VPN_DEFAULT_SECURITY_POLICY}"; then
643 error
"Default VPN Security Policy '${VPN_DEFAULT_SECURITY_POLICY}' does not exist"
647 log DEBUG
"Creating VPN Security Policy ${name}"
649 if copy
"$(vpn_security_policies_path "${VPN_DEFAULT_SECURITY_POLICY}")"
650 "$(vpn_security_policies_path ${name})"; then
651 log INFO
"VPN Security Policy ${name} successfully created"
653 log ERROR
"Could not create VPN Security Policy ${name}"
657 # Show the newly created policy
658 vpn_security_policies_show
"${name}"
661 # Function that deletes based on the passed parameters one ore more vpn security policies
662 vpn_security_policies_destroy
() {
665 if ! vpn_security_policy_exists
${name}; then
666 log ERROR
"The vpn security policy ${name} does not exist."
670 if vpn_security_policies_check_readonly
${name}; then
671 log ERROR
"The vpn security policy ${name} cannot be deleted."
675 log DEBUG
"Deleting vpn security policy ${name}"
676 settings_remove $
(vpn_security_policies_path
${name})