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
]="256 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 VPN_SUPPORTED_GROUP_TYPES
="MODP8192 MODP4096"
115 # This functions checks if a policy is readonly
116 # returns true when yes and false when no
117 vpn_security_policies_check_readonly
() {
118 if isoneof name
${VPN_SECURITY_POLICIES_READONLY}; then
125 # This function writes all values to a via ${name} specificated vpn security policy configuration file
126 vpn_security_policies_write_config
() {
131 if ! vpn_security_policy_exists
"${name}"; then
132 log ERROR
"No such vpn security policy: ${name}"
136 if vpn_security_policies_check_readonly
"${name}"; then
137 log ERROR
"The ${name} vpn security policy cannot be changed."
141 local path
="$(vpn_security_policies_path "${name}")"
142 if [ ! -w ${path} ]; then
143 log ERROR
"${path} is not writeable"
147 if ! settings_write
"${path}" ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}; then
148 log ERROR
"Could not write configuration settings for vpn security policy ${name}"
152 # TODO everytime we successfully write a config we should call some trigger to take the changes into effect
155 # This funtion writes the value for one key to a via ${name} specificated vpn security policy configuration file
156 vpn_security_policies_write_config_key
() {
165 if ! vpn_security_policy_exists
"${name}"; then
166 log ERROR
"No such vpn security policy: ${name}"
170 log DEBUG
"Set '${key}' to new value '${value}' in vpn security policy ${name}"
172 local ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
174 # Read the config settings
175 if ! vpn_security_policies_read_config
"${name}"; then
179 # Set the key to a new value
180 assign
"${key}" "${value}"
182 if ! vpn_security_policies_write_config
"${name}"; then
189 # Reads one or more keys out of a settings file or all if no key is provided.
190 vpn_security_policies_read_config
() {
196 if ! vpn_security_policy_exists
"${name}"; then
197 log ERROR
"No such vpn security policy: ${name}"
203 if [ $# -eq 0 ] && [ -n "${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}" ]; then
204 list_append args
${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
209 local path
="$(vpn_security_policies_path ${name})"
211 if ! settings_read
"${path}" ${args}; then
212 log ERROR
"Could not read settings for vpn security policy ${name}"
217 # Returns the path to a the configuration fora given name
218 vpn_security_policies_path
() {
223 if vpn_security_policies_check_readonly
"${name}"; then
224 echo "${NETWORK_SHARE_DIR}/vpn/security-policies/${name}"
226 echo "${NETWORK_CONFIG_DIR}/vpn/security-policies/${name}"
230 # Print the content of a vpn security policy configuration file in a nice way
231 vpn_security_policies_show
() {
236 local ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
237 if ! vpn_security_policies_read_config
${name}; then
241 cli_print_fmt1
0 "Security Policy: ${name}"
244 # This could be done in a loop but a loop is much more complicated
245 # because we print 'Group Types' but the variable is named 'GROUP_TYPES'
246 cli_print_fmt1
1 "Ciphers:"
249 for cipher
in ${CIPHER}; do
250 cli_print_fmt1
2 "${VPN_SUPPORTED_CIPHERS[${cipher}]-${cipher}}"
254 cli_print_fmt1
1 "Integrity:"
255 cli_print_fmt1
2 "${INTEGRITY}"
258 cli_print_fmt1
1 "Group Types:"
259 cli_print_fmt1
2 "${GROUP_TYPE}"
262 cli_print_fmt1
1 "Key Exchange:" "${KEY_EXCHANGE}"
265 if isinteger LIFETIME
&& [ ${LIFETIME} -gt 0 ]; then
266 cli_print_fmt1
1 "Key Lifetime:" "$(format_time ${LIFETIME})"
268 log ERROR
"The value for Key Lifetime is not a valid integer greater zero."
273 cli_print_fmt1
1 "Perfect Forward Secrecy:" "enabled"
275 cli_print_fmt1
1 "Perfect Forward Secrecy:" "disabled"
280 if enabled COMPRESSION
; then
281 cli_print_fmt1
1 "Compression:" "enabled"
283 cli_print_fmt1
1 "Compression:" "disabled"
288 # This function checks if a vpn security policy exists
289 # Returns True when yes and false when not
290 vpn_security_policy_exists
() {
295 local path
=$
(vpn_security_policies_path
"${name}")
297 [ -f ${path} ] && return ${EXIT_TRUE} || return ${EXIT_FALSE}
301 # This function parses the parameters for the 'cipher' command
302 vpn_security_policies_cipher
(){
306 if [ $# -eq 0 ]; then
307 log ERROR
"You must pass at least one value after cipher"
312 if ! vpn_security_policies_read_config
${name} "CIPHER"; then
316 # Remove duplicated entries to proceed the list safely
317 CIPHER
="$(list_unique ${CIPHER})"
319 while [ $# -gt 0 ]; do
323 # Check if the cipher is in the list of ciphers and
324 # check if the list has after removing this cipher at least one valid value
325 if list_match
${value} ${CIPHER}; then
326 list_remove CIPHER
${value}
328 # We do not break here because this error does not break the processing of the next maybe valid values.
329 log ERROR
"Can not remove ${value} from the list of Ciphers because ${value} is not in the list."
334 # Check if the Ciphers is in the list of supported ciphers.
335 if ! isoneof value
${!VPN_SUPPORTED_CIPHERS[@]}; then
336 # We do not break here because this error does not break the processing of the next maybe valid values.
337 log ERROR
"${value} is not a supported cipher and can thats why not added to the list of ciphers."
339 if list_match
${value} ${CIPHER}; then
340 log WARNING
"${value} is already in the list of ciphers of this policy."
342 list_append CIPHER
${value}
350 # Check if the list contain at least one valid cipher
351 if [ $
(list_length
${CIPHER}) -ge 1 ]; then
352 if ! vpn_security_policies_write_config_key
${name} "CIPHER" ${CIPHER}; then
353 log ERROR
"The changes for the vpn security policy ${name} could not be written."
356 log ERROR
"After proceding all ciphers the list is empty and thats why no changes are written."
361 # This function parses the parameters for the 'compression' command
362 vpn_security_policies_compression
(){
366 # Check if we get only one argument after compression <name>
367 if [ ! $# -eq 2 ]; then
368 log ERROR
"The number of arguments do not match. Only one argument after compression is allowed."
372 if ! isbool value
; then
373 # We suggest only two values to avoid overburding the user.
374 log ERROR
"Invalid Argument ${value}"
378 vpn_security_policies_write_config_key
"${name}" "COMPRESSION" "${value}"
381 # This function parses the parameters for the 'group-type' command
382 vpn_security_policies_group_type
(){
386 if [ $# -eq 0 ]; then
387 log ERROR
"You must pass at least one value after group-type"
392 if ! vpn_security_policies_read_config
${name} "GROUP_TYPE"; then
396 # Remove duplicated entries to proceed the list safely
397 GROUP_TYPE
="$(list_unique ${GROUP_TYPE})"
399 while [ $# -gt 0 ]; do
403 # Check if the group type is in the list of group types and
404 # check if the list has after removing this group type at leatst one valid value
405 if list_match
${value} ${GROUP_TYPE}; then
406 list_remove GROUP_TYPE
${value}
408 # We do not break here because this error does not break the processing of the next maybe valid values.
409 log ERROR
"Can not remove ${value} from the list of group types because ${value} is not in the list."
414 # Check if the group type is in the list of supported group types.
415 if ! isoneof value
${VPN_SUPPORTED_GROUP_TYPES}; then
416 # We do not break here because the processing of other maybe valid values are indepent from this error.
417 log ERROR
"${value} is not a supported group type and can thats why not added to the list of group types."
419 if list_match
${value} ${GROUP_TYPE}; then
420 log WARNING
"${value} is already in the list of group-types of this policy."
422 list_append GROUP_TYPE
${value}
430 # Check if the list contain at least one valid group-type
431 if [ $
(list_length
${GROUP_TYPE}) -ge 1 ]; then
432 if ! vpn_security_policies_write_config_key
${name} "GROUP_TYPE" ${GROUP_TYPE}; then
433 log ERROR
"The changes for the vpn security policy ${name} could not be written."
436 log ERROR
"After proceding all group types the list is empty and thats why no changes are written."
441 # This function parses the parameters for the 'integrity' command
442 vpn_security_policies_integrity
(){
446 if [ $# -eq 0 ]; then
447 log ERROR
"You must pass at least one value after integrity."
452 if ! vpn_security_policies_read_config
${name} "INTEGRITY"; then
456 # Remove duplicated entries to proceed the list safely
457 INTEGRITY
="$(list_unique ${INTEGRITY})"
459 while [ $# -gt 0 ]; do
463 # Check if the integrity hash is in the list of integrity hashes and
464 # check if the list has after removing this integrity hash at least one valid value
465 if list_match
${value} ${INTEGRITY}; then
466 list_remove INTEGRITY
${value}
468 # We do not break here because the processing of other maybe valid values are indepent from this error.
469 log ERROR
"Can not remove ${value} from the list of integrity hashes because ${value} is not in the list."
474 # Check if the Ciphers is in the list of supported integrity hashes.
475 if ! isoneof value
${!VPN_SUPPORTED_INTEGRITY[@]}; then
476 # We do not break here because the processing of other maybe valid values are indepent from this error.
477 log ERROR
"${value} is not a supported integrity hash and can thats why not added to the list of integrity hashes."
479 if list_match
${value} ${INTEGRITY}; then
480 log WARNING
"${value} is already in the list of integrety hashes of this policy."
482 list_append INTEGRITY
${value}
490 # Check if the list contain at least one valid group-type
491 if [ $
(list_length
${INTEGRITY}) -ge 1 ]; then
492 if ! vpn_security_policies_write_config_key
${name} "INTEGRITY" ${INTEGRITY}; then
493 log ERROR
"The changes for the vpn security policy ${name} could not be written."
496 log ERROR
"After proceding all integrity hashes the list is empty and thats why no changes are written."
501 # This function parses the parameters for the 'key-exchange' command
502 vpn_security_policies_key_exchange
() {
506 # Check if we get only one argument after key-exchange <name>
507 if [ ! $# -eq 2 ]; then
508 log ERROR
"The number of arguments do not match. Only argument after key-exchange is allowed."
512 if ! isoneof value
"ikev1" "ikev2" "IKEV1" "IKEV2"; then
513 log ERROR
"Invalid Argument ${value}"
517 vpn_security_policies_write_config_key
"${name}" "KEY_EXCHANGE" "${value,,}"
520 # This function parses the parameters for the 'lifetime' command.
521 vpn_security_policies_lifetime
(){
527 # Check if we get only one argument after lifetime <name>
528 if [ ! $# -ge 1 ]; then
529 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"
533 if ! isinteger value
; then
534 value
=$
(parse_time $@
)
535 if [ ! $?
-eq 0 ]; then
536 log ERROR
"Parsing the passed time was not sucessful please check the passed values."
541 if [ ${value} -le 0 ]; then
542 log ERROR
"The passed time value must be in the sum greater zero seconds."
546 vpn_security_policies_write_config_key
"${name}" "LIFETIME" "${value}"
549 # This function parses the parameters for the 'pfs' command
550 vpn_security_policies_pfs
(){
554 # Check if we get only one argument after pfs <name>
555 if [ ! $# -eq 2 ]; then
556 log ERROR
"The number of arguments do not match. Only argument after pfs is allowed."
560 if [ ! $# -eq 2 ] ||
! isbool value
; then
561 # We suggest only two values to avoid overburding the user.
562 log ERROR
"Invalid Argument ${value}"
566 vpn_security_policies_write_config_key
"${name}" "PFS" "${value}"
569 # This function checks if a vpn security policy name is valid
570 # Allowed are only A-Za-z0-9
571 vpn_security_policies_check_name
() {
576 [[ ${name} =~
[^
[:alnum
:]$
] ]]
579 # Function that creates based on the paramters one ore more new vpn security policies
580 vpn_security_policies_new
() {
581 if [ $# -gt 1 ]; then
582 error
"Too many arguments"
587 if ! isset name
; then
588 error
"Please provide a name"
592 # Check for duplicates
593 if vpn_security_policy_exists
"${name}"; then
594 error
"The VPN security policy with name ${name} already exists"
598 # Check if name is valid
599 if vpn_security_policies_check_name
"${name}"; then
600 error
"'${name}' contains illegal characters"
604 # Check if we have a read-only policy with the same name
605 if vpn_security_policies_check_readonly
"${name}"; then
606 error
"The VPN security policy ${name} is read-only"
610 # Check if our source policy exists
611 if ! vpn_security_policy_exists
"${VPN_DEFAULT_SECURITY_POLICY}"; then
612 error
"Default VPN Security Policy '${VPN_DEFAULT_SECURITY_POLICY}' does not exist"
616 log DEBUG
"Creating VPN Security Policy ${name}"
618 if copy
"$(vpn_security_policies_path "${VPN_DEFAULT_SECURITY_POLICY}")"
619 "$(vpn_security_policies_path ${name})"; then
620 log INFO
"VPN Security Policy ${name} successfully created"
622 log ERROR
"Could not create VPN Security Policy ${name}"
626 # Show the newly created policy
627 vpn_security_policies_show
"${name}"
630 # Function that deletes based on the passed parameters one ore more vpn security policies
631 vpn_security_policies_destroy
() {
634 if ! vpn_security_policy_exists
${name}; then
635 log ERROR
"The vpn security policy ${name} does not exist."
639 if vpn_security_policies_check_readonly
${name}; then
640 log ERROR
"The vpn security policy ${name} cannot be deleted."
644 log DEBUG
"Deleting vpn security policy ${name}"
645 settings_remove $
(vpn_security_policies_path
${name})