src/functions/functions.vpn-security-policies

   1 #!/bin/bash
   2 ###############################################################################
   3 #                                                                             #
   4 # IPFire.org - A linux based firewall                                         #
   5 # Copyright (C) 2017  IPFire Network Development Team                         #
   6 #                                                                             #
   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.                                         #
  11 #                                                                             #
  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.                                #
  16 #                                                                             #
  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/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 VPN_SECURITY_POLICIES_CONFIG_SETTINGS="CIPHER COMPRESSION GROUP_TYPE INTEGRITY KEY_EXCHANGE LIFETIME PFS"
  23 VPN_SECURITY_POLICIES_READONLY="system performance"
  24
  25 VPN_DEFAULT_SECURITY_POLICY="system"
  26
  27 declare -A VPN_SUPPORTED_CIPHERS=(
  28         # 3DES-CBC
  29         [3DES-CBC]="168 bit 3DES-EDE-CBC"
  30
  31         # AES-CBC
  32         [AES256-CBC]="256 bit AES-CBC"
  33         [AES192-CBC]="192 bit AES-CBC"
  34         [AES128-CBC]="128 bit AES-CBC"
  35
  36         # AES-CTR
  37         [AES256-CTR]="256 bit AES-COUNTER"
  38         [AES192-CTR]="192 bit AES-COUNTER"
  39         [AES128-CTR]="128 bit AES-COUNTER"
  40
  41         # AES-GCM
  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"
  51
  52         # AES-CCM
  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"
  62
  63         # CAMELLIA-CBC
  64         [CAMELLIA256-CBC]="256 bit CAMELLIA-CBC"
  65         [CAMELLIA192-CBC]="192 bit CAMELLIA-CBC"
  66         [CAMELLIA128-CBC]="128 bit CAMELLIA-CBC"
  67
  68         # CAMELLIA-CTR
  69         [CAMELLIA256-CTR]="256 bit CAMELLIA-COUNTER"
  70         [CAMELLIA192-CTR]="192 bit CAMELLIA-COUNTER"
  71         [CAMELLIA128-CTR]="128 bit CAMELLIA-COUNTER"
  72
  73         # CAMELLIA-GCM
  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"
  83
  84         # CAMELLIA-CCM
  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"
  94 )
  95
  96 declare -A CIPHER_TO_STRONGSWAN=(
  97         # 3DES-CBC
  98         [3DES-CBC]="3des"
  99
 100         # AES-CBC
 101         [AES256-CBC]="aes256"
 102         [AES192-CBC]="aes192"
 103         [AES128-CBC]="aes128"
 104
 105         # AES-CTR
 106         [AES256-CTR]="aes256ctr"
 107         [AES192-CTR]="aes192ctr"
 108         [AES128-CTR]="aes128ctr"
 109
 110         # AES-GCM
 111         [AES256-GCM128]="aes256gcm128"
 112         [AES192-GCM128]="aes192gcm128"
 113         [AES128-GCM128]="aes128gcm128"
 114         [AES256-GCM96]="aes256gcm96"
 115         [AES192-GCM96]="aes192gcm96"
 116         [AES128-GCM96]="aes128gcm96"
 117         [AES256-GCM64]="aes256gcm64"
 118         [AES192-GCM64]="aes192gcm64"
 119         [AES128-GCM64]="aes128gcm64"
 120
 121         # AES-CCM
 122         [AES256-CCM128]="aes256ccm128"
 123         [AES192-CCM128]="aes192ccm128"
 124         [AES128-CCM128]="aes128ccm128"
 125         [AES256-CCM96]="aes256ccm96"
 126         [AES192-CCM96]="aes192ccm96"
 127         [AES128-CCM96]="aes128ccm96"
 128         [AES256-CCM64]="aes256ccm64"
 129         [AES192-CCM64]="aes192ccm64"
 130         [AES128-CCM64]="aes128ccm64"
 131
 132         # CAMELLIA-CBC
 133         [CAMELLIA256-CBC]="camellia256"
 134         [CAMELLIA192-CBC]="camellia192"
 135         [CAMELLIA128-CBC]="camellia128"
 136
 137         # CAMELLIA-CTR
 138         [CAMELLIA256-CTR]="camellia256ctr"
 139         [CAMELLIA192-CTR]="camellia192ctr"
 140         [CAMELLIA128-CTR]="camellia128ctr"
 141
 142         # CAMELLIA-GCM
 143         [CAMELLIA256-GCM128]="camellia256gcm128"
 144         [CAMELLIA192-GCM128]="camellia192gcm128"
 145         [CAMELLIA128-GCM128]="camellia128gcm128"
 146         [CAMELLIA256-GCM96]="camellia256gcm96"
 147         [CAMELLIA192-GCM96]="camellia192gcm96"
 148         [CAMELLIA128-GCM96]="camellia128gcm96"
 149         [CAMELLIA256-GCM64]="camellia256gcm64"
 150         [CAMELLIA192-GCM64]="camellia192gcm64"
 151         [CAMELLIA128-GCM64]="camellia128gcm64"
 152
 153         # CAMELLIA-CCM
 154         [CAMELLIA256-CCM128]="camellia256ccm128"
 155         [CAMELLIA192-CCM128]="camellia192ccm128"
 156         [CAMELLIA128-CCM128]="camellia128ccm128"
 157         [CAMELLIA256-CCM96]="camellia256ccm96"
 158         [CAMELLIA192-CCM96]="camellia192ccm96"
 159         [CAMELLIA128-CCM96]="camellia128ccm96"
 160         [CAMELLIA256-CCM64]="camellia256ccm64"
 161         [CAMELLIA192-CCM64]="camellia192ccm64"
 162         [CAMELLIA128-CCM64]="camellia128ccm64"
 163 )
 164
 165 declare -A VPN_SUPPORTED_INTEGRITY=(
 166         [MD5]="MD5-HMAC"
 167
 168         # SHA
 169         [SHA1]="SHA1-HMAC"
 170         [SHA512]="512 bit SHA2-HMAC"
 171         [SHA384]="384 bit SHA2-HMAC"
 172         [SHA256]="256 bit SHA2-HMAC"
 173
 174         # AES
 175         [AES-XCBC]="AES-XCBC"
 176         [AES-CMAC]="AES-CMAC"
 177         [AES256-GMAC]="256 bit AES-GMAC"
 178         [AES192-GMAC]="192 bit AES-GMAC"
 179         [AES128-GMAC]="128 bit AES-GMAC"
 180 )
 181
 182 declare -A INTEGRITY_TO_STRONGSWAN=(
 183         [MD5]="md5"
 184
 185         # SHA
 186         [SHA1]="sha1"
 187         [SHA512]="sha512"
 188         [SHA384]="sha384"
 189         [SHA256]="sha256"
 190
 191         # AES
 192         [AES-XCBC]="aesxcbc"
 193         [AES-CMAC]="aescmac"
 194         [AES256-GMAC]="aes256gmac"
 195         [AES192-GMAC]="aes192gmac"
 196         [AES128-GMAC]="aes128gmac"
 197 )
 198
 199 declare -A VPN_SUPPORTED_GROUP_TYPES=(
 200         # Regular Groups
 201         [MODP768]="768 bit Modulo Prime Group"
 202         [MODP1024]="1024 bit Modulo Prime Group"
 203         [MODP1536]="1536 bit Modulo Prime Group"
 204         [MODP2048]="2048 bit Modulo Prime Group"
 205         [MODP3072]="3072 bit Modulo Prime Group"
 206         [MODP4096]="4096 bit Modulo Prime Group"
 207         [MODP6144]="6144 bit Modulo Prime Group"
 208         [MODP8192]="8192 bit Modulo Prime Group"
 209
 210         # NIST Elliptic Curve Groups
 211         [ECP192]="192 bit NIST Elliptic Curve Group"
 212         [ECP224]="224 bit NIST Elliptic Curve Group"
 213         [ECP256]="256 bit NIST Elliptic Curve Group"
 214         [ECP384]="384 bit NIST Elliptic Curve Group"
 215         [ECP521]="521 bit NIST Elliptic Curve Group"
 216
 217         # Brainpool Elliptic Curve Groups
 218         [ECP224BP]="224 bit Brainpool Elliptic Curve Group"
 219         [ECP256BP]="256 bit Brainpool Elliptic Curve Group"
 220         [ECP384BP]="384 bit Brainpool Elliptic Curve Group"
 221         [ECP512BP]="512 bit Brainpool Elliptic Curve Group"
 222
 223         # Curve25519
 224         [CURVE25519]="256 bit Elliptic Curve 25519"
 225 )
 226
 227 declare -A GROUP_TYPE_TO_STRONGSWAN=(
 228         # Regular Groups
 229         [MODP768]="modp768"
 230         [MODP1024]="modp1024"
 231         [MODP1536]="modp1536"
 232         [MODP2048]="modp2048"
 233         [MODP3072]="modp3072"
 234         [MODP4096]="modp4096"
 235         [MODP6144]="modp6144"
 236         [MODP8192]="modp8192"
 237
 238         # NIST Elliptic Curve Groups
 239         [ECP192]="ecp192"
 240         [ECP224]="ecp224"
 241         [ECP256]="ecp256"
 242         [ECP384]="ecp384"
 243         [ECP521]="ecp521"
 244
 245         # Brainpool Elliptic Curve Groups
 246         [ECP224BP]="ecp224bp"
 247         [ECP256BP]="ecp256bp"
 248         [ECP384BP]="ecp384bp"
 249         [ECP512BP]="ecp512bp"
 250
 251         # Curve25519
 252         [CURVE25519]="curve25519"
 253 )
 254
 255 cli_vpn_security_policies() {
 256         local action
 257         local security_policy
 258
 259         if vpn_security_policy_exists ${1}; then
 260                 security_policy=${1}
 261                 key=${2}
 262                 shift 2
 263
 264                 case "${key}" in
 265                         cipher|compression|integrity|lifetime|pfs|show)
 266                                 vpn_security_policies_${key} ${security_policy} $@
 267                                 ;;
 268                         group-type)
 269                                 vpn_security_policies_group_type ${security_policy} $@
 270                                 ;;
 271                         key-exchange)
 272                                 vpn_security_policies_key_exchange ${security_policy} $@
 273                                 ;;
 274                         *)
 275                                 error "Unrecognized argument: ${key}"
 276                                 exit ${EXIT_ERROR}
 277                                 ;;
 278                 esac
 279         else
 280                 action=${1}
 281                 shift
 282
 283                 case "${action}" in
 284                         new)
 285                                 vpn_security_policies_new $@
 286                                 ;;
 287                         destroy)
 288                                 vpn_security_policies_destroy $@
 289                                 ;;
 290                         ""|*)
 291                                 if [ -n "${action}" ]; then
 292                                         error "Unrecognized argument: '${action}'"
 293                                 fi
 294                                 exit ${EXIT_ERROR}
 295                                 ;;
 296                 esac
 297         fi
 298 }
 299
 300 # This functions checks if a policy is readonly
 301 # returns true when yes and false when no
 302 vpn_security_policies_check_readonly() {
 303         if isoneof name ${VPN_SECURITY_POLICIES_READONLY}; then
 304                 return ${EXIT_TRUE}
 305         else
 306                 return ${EXIT_FALSE}
 307         fi
 308 }
 309
 310 # This function writes all values to a via ${name} specificated vpn security policy configuration file
 311 vpn_security_policies_write_config() {
 312         assert [ $# -ge 1 ]
 313
 314         local name="${1}"
 315
 316         if ! vpn_security_policy_exists "${name}"; then
 317                 log ERROR "No such vpn security policy: ${name}"
 318                 return ${EXIT_ERROR}
 319         fi
 320
 321         if vpn_security_policies_check_readonly "${name}"; then
 322                 log ERROR "The ${name} vpn security policy cannot be changed."
 323                 return ${EXIT_ERROR}
 324         fi
 325
 326         local path="$(vpn_security_policies_path "${name}")"
 327         if [ ! -w ${path} ]; then
 328                 log ERROR "${path} is not writeable"
 329                 return ${EXIT_ERROR}
 330         fi
 331
 332         if ! settings_write "${path}" ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}; then
 333                 log ERROR "Could not write configuration settings for vpn security policy ${name}"
 334                 return ${EXIT_ERROR}
 335         fi
 336
 337         # TODO everytime we successfully write a config we should call some trigger to take the changes into effect
 338 }
 339
 340 # This funtion writes the value for one key to a via ${name} specificated vpn security policy configuration file
 341 vpn_security_policies_write_config_key() {
 342         assert [ $# -ge 3 ]
 343
 344         local name=${1}
 345         local key=${2}
 346         shift 2
 347
 348         local value="$@"
 349
 350         if ! vpn_security_policy_exists "${name}"; then
 351                 log ERROR "No such vpn security policy: ${name}"
 352                 return ${EXIT_ERROR}
 353         fi
 354
 355         log DEBUG "Set '${key}' to new value '${value}' in vpn security policy ${name}"
 356
 357         local ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
 358
 359         # Read the config settings
 360         if ! vpn_security_policies_read_config "${name}"; then
 361                 return ${EXIT_ERROR}
 362         fi
 363
 364         # Set the key to a new value
 365         assign "${key}" "${value}"
 366
 367         if ! vpn_security_policies_write_config "${name}"; then
 368                 return ${EXIT_ERROR}
 369         fi
 370
 371         return ${EXIT_TRUE}
 372 }
 373
 374 # Reads one or more keys out of a settings file or all if no key is provided.
 375 vpn_security_policies_read_config() {
 376         assert [ $# -ge 1 ]
 377
 378         local name="${1}"
 379         shift 1
 380
 381         if ! vpn_security_policy_exists "${name}"; then
 382                 log ERROR "No such vpn security policy: ${name}"
 383                 return ${EXIT_ERROR}
 384         fi
 385
 386
 387         local args
 388         if [ $# -eq 0 ] && [ -n "${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}" ]; then
 389                 list_append args ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
 390         else
 391                 list_append args $@
 392         fi
 393
 394         local path="$(vpn_security_policies_path ${name})"
 395
 396         if ! settings_read "${path}" ${args}; then
 397                 log ERROR "Could not read settings for vpn security policy ${name}"
 398                 return ${EXIT_ERROR}
 399         fi
 400 }
 401
 402 # Returns the path to a the configuration fora given name
 403 vpn_security_policies_path() {
 404         assert [ $# -eq 1 ]
 405
 406         local name=${1}
 407
 408         if vpn_security_policies_check_readonly "${name}"; then
 409                 echo "${NETWORK_SHARE_DIR}/vpn/security-policies/${name}"
 410         else
 411                 echo "${NETWORK_CONFIG_DIR}/vpn/security-policies/${name}"
 412         fi
 413 }
 414
 415 # Print the content of a vpn security policy configuration file in a nice way
 416 vpn_security_policies_show() {
 417         assert [ $# -eq 1 ]
 418
 419         local name=${1}
 420
 421         local ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
 422         if ! vpn_security_policies_read_config ${name}; then
 423                 return ${EXIT_ERROR}
 424         fi
 425
 426         cli_print_fmt1 0 "Security Policy: ${name}"
 427         cli_space
 428
 429         # This could be done in a loop but a loop is much more complicated
 430         # because we print 'Group Types' but the variable is named 'GROUP_TYPES'
 431         cli_print_fmt1 1 "Ciphers:"
 432         local cipher
 433         for cipher in ${CIPHER}; do
 434                 cli_print_fmt1 2 "${VPN_SUPPORTED_CIPHERS[${cipher}]-${cipher}}"
 435         done
 436         cli_space
 437
 438         cli_print_fmt1 1 "Integrity:"
 439         local integrity
 440         for integrity in ${INTEGRITY}; do
 441                 cli_print_fmt1 2 "${VPN_SUPPORTED_INTEGRITY[${integrity}]-${integrity}}"
 442         done
 443         cli_space
 444
 445         cli_print_fmt1 1 "Group Types:"
 446         local group_type
 447         for group_type in ${GROUP_TYPE}; do
 448                 cli_print_fmt1 2 "${VPN_SUPPORTED_GROUP_TYPES[${group_type}]-${group_type}}"
 449         done
 450         cli_space
 451
 452         cli_print_fmt1 1 "Key Exchange:" "${KEY_EXCHANGE}"
 453
 454         # Key Lifetime
 455         if isinteger LIFETIME && [ ${LIFETIME} -gt 0 ]; then
 456                 cli_print_fmt1 1 "Key Lifetime:" "$(format_time ${LIFETIME})"
 457         else
 458                 log ERROR "The value for Key Lifetime is not a valid integer greater zero."
 459         fi
 460
 461         # PFS
 462         if enabled PFS; then
 463                 cli_print_fmt1 1 "Perfect Forward Secrecy:" "enabled"
 464         else
 465                 cli_print_fmt1 1 "Perfect Forward Secrecy:" "disabled"
 466         fi
 467         cli_space
 468
 469         # Compression
 470         if enabled COMPRESSION; then
 471                 cli_print_fmt1 1 "Compression:" "enabled"
 472         else
 473                 cli_print_fmt1 1 "Compression:" "disabled"
 474         fi
 475         cli_space
 476 }
 477
 478 # This function checks if a vpn security policy exists
 479 # Returns True when yes and false when not
 480 vpn_security_policy_exists() {
 481         assert [ $# -eq 1 ]
 482
 483         local name=${1}
 484
 485         local path=$(vpn_security_policies_path "${name}")
 486
 487         [ -f ${path} ] && return ${EXIT_TRUE} || return ${EXIT_FALSE}
 488 }
 489
 490
 491 # This function parses the parameters for the 'cipher' command
 492 vpn_security_policies_cipher(){
 493         local name=${1}
 494         shift
 495
 496         if [ $# -eq 0 ]; then
 497                 log ERROR "You must pass at least one value after cipher"
 498                 return ${EXIT_ERROR}
 499         fi
 500
 501         local CIPHER
 502         if ! vpn_security_policies_read_config ${name} "CIPHER"; then
 503                 return ${EXIT_ERROR}
 504         fi
 505
 506         # Remove duplicated entries to proceed the list safely
 507         CIPHER="$(list_unique ${CIPHER})"
 508
 509         local ciphers_added
 510         local ciphers_removed
 511         local ciphers_set
 512
 513         while [ $# -gt 0 ]; do
 514                 local arg="${1}"
 515
 516                 case "${arg}" in
 517                         +*)
 518                                 list_append ciphers_added "${arg:1}"
 519                                 ;;
 520                         -*)
 521                                 list_append ciphers_removed "${arg:1}"
 522                                 ;;
 523                         [A-Z0-9]*)
 524                                 list_append ciphers_set "${arg}"
 525                                 ;;
 526                         *)
 527                                 error "Invalid argument: ${arg}"
 528                                 return ${EXIT_ERROR}
 529                                 ;;
 530                 esac
 531                 shift
 532         done
 533
 534         # Check if the user is trying a mixed operation
 535         if ! list_is_empty ciphers_set && (! list_is_empty ciphers_added || ! list_is_empty ciphers_removed); then
 536                 error "You cannot reset the cipher list and add or remove ciphers at the same time"
 537                 return ${EXIT_ERROR}
 538         fi
 539
 540         # Set new cipher list
 541         if ! list_is_empty ciphers_set; then
 542                 # Check if all ciphers are valid
 543                 local cipher
 544                 for cipher in ${ciphers_set}; do
 545                         if ! vpn_security_policies_cipher_supported ${cipher}; then
 546                                 error "Unsupported cipher: ${cipher}"
 547                                 return ${EXIT_ERROR}
 548                         fi
 549                 done
 550
 551                 CIPHER="${ciphers_set}"
 552
 553         # Perform incremental updates
 554         else
 555                 local cipher
 556
 557                 # Perform all removals
 558                 for cipher in ${ciphers_removed}; do
 559                         if ! list_remove CIPHER ${cipher}; then
 560                                 warning "${cipher} was not on the list and could not be removed"
 561                         fi
 562                 done
 563
 564                 for cipher in ${ciphers_added}; do
 565                         if vpn_security_policies_cipher_supported ${cipher}; then
 566                                 if ! list_append_unique CIPHER ${cipher}; then
 567                                         warning "${cipher} is already on the cipher list"
 568                                 fi
 569                         else
 570                                 warning "${cipher} is unknown or unsupported and could not be added"
 571                         fi
 572                 done
 573         fi
 574
 575         # Check if the list contain at least one valid cipher
 576         if list_is_empty CIPHER; then
 577                 error "Cannot save an empty cipher list"
 578                 return ${EXIT_ERROR}
 579         fi
 580
 581         # Save everything
 582         if ! vpn_security_policies_write_config_key ${name} "CIPHER" ${CIPHER}; then
 583                 log ERROR "The changes for the vpn security policy ${name} could not be written."
 584         fi
 585
 586         cli_headline 1 "Current cipher list for ${name}:"
 587         for cipher in ${CIPHER}; do
 588                 cli_print_fmt1 1 "${cipher}" "${VPN_SUPPORTED_CIPHERS[${cipher}]}"
 589         done
 590 }
 591
 592 # This function parses the parameters for the 'compression' command
 593 vpn_security_policies_compression(){
 594         local name=${1}
 595         local value=${2}
 596
 597         # Check if we get only one argument after compression <name>
 598         if [ ! $# -eq 2 ]; then
 599                 log ERROR "The number of arguments do not match. Only one argument after compression is allowed."
 600                 return ${EXIT_ERROR}
 601         fi
 602
 603         if ! isbool value; then
 604                 # We suggest only two values to avoid overburding the user.
 605                 log ERROR "Invalid Argument ${value}"
 606                 return ${EXIT_ERROR}
 607         fi
 608
 609         vpn_security_policies_write_config_key "${name}" "COMPRESSION" "${value}"
 610 }
 611
 612 # This function parses the parameters for the 'group-type' command
 613 vpn_security_policies_group_type(){
 614         local name=${1}
 615         shift
 616
 617         if [ $# -eq 0 ]; then
 618                 log ERROR "You must pass at least one value after group-type"
 619                 return ${EXIT_ERROR}
 620         fi
 621
 622         local GROUP_TYPE
 623         if ! vpn_security_policies_read_config ${name} "GROUP_TYPE"; then
 624                 return ${EXIT_ERROR}
 625         fi
 626
 627         # Remove duplicated entries to proceed the list safely
 628         GROUP_TYPE="$(list_unique ${GROUP_TYPE})"
 629
 630         while [ $# -gt 0 ]; do
 631                 case "${1}" in
 632                         -*)
 633                                 value=${1#-}
 634                                 # Check if the group type is in the list of group types and
 635                                 # check if the list has after removing this group type at leatst one valid value
 636                                 if list_match ${value} ${GROUP_TYPE}; then
 637                                         list_remove GROUP_TYPE ${value}
 638                                 else
 639                                         # We do not break here because this error does not break the processing of the next maybe valid values.
 640                                         log ERROR "Can not remove ${value} from the list of group types because ${value} is not in the list."
 641                                 fi
 642                                 ;;
 643                         +*)
 644                                 value=${1#+}
 645                                 # Check if the group type is in the list of supported group types.
 646                                 if ! isoneof value ${!VPN_SUPPORTED_GROUP_TYPES[@]}; then
 647                                         # We do not break here because the processing of other maybe valid values are indepent from this error.
 648                                         log ERROR "${value} is not a supported group type and can thats why not added to the list of group types."
 649                                 else
 650                                         if list_match ${value} ${GROUP_TYPE}; then
 651                                                 log WARNING "${value} is already in the list of group-types of this policy."
 652                                         else
 653                                                 list_append GROUP_TYPE ${value}
 654                                         fi
 655                                 fi
 656                                 ;;
 657                 esac
 658                 shift
 659         done
 660
 661         # Check if the list contain at least one valid group-type
 662         if [ $(list_length ${GROUP_TYPE}) -ge 1 ]; then
 663                 if ! vpn_security_policies_write_config_key ${name} "GROUP_TYPE" ${GROUP_TYPE}; then
 664                         log ERROR "The changes for the vpn security policy ${name} could not be written."
 665                 fi
 666         else
 667                 log ERROR "After proceding all group types the list is empty and thats why no changes are written."
 668                 return ${EXIT_ERROR}
 669         fi
 670 }
 671
 672 # This function parses the parameters for the 'integrity' command
 673 vpn_security_policies_integrity(){
 674         local name=${1}
 675         shift
 676
 677         if [ $# -eq 0 ]; then
 678                 log ERROR "You must pass at least one value after integrity."
 679                 return ${EXIT_ERROR}
 680         fi
 681
 682         local INTEGRITY
 683         if ! vpn_security_policies_read_config ${name} "INTEGRITY"; then
 684                 return ${EXIT_ERROR}
 685         fi
 686
 687         # Remove duplicated entries to proceed the list safely
 688         INTEGRITY="$(list_unique ${INTEGRITY})"
 689
 690         while [ $# -gt 0 ]; do
 691                 case "${1}" in
 692                         -*)
 693                                 value=${1#-}
 694                                 # Check if the integrity hash is in the list of integrity hashes and
 695                                 # check if the list has after removing this  integrity hash at least one valid value
 696                                 if list_match ${value} ${INTEGRITY}; then
 697                                         list_remove INTEGRITY ${value}
 698                                 else
 699                                         # We do not break here because the processing of other maybe valid values are indepent from this error.
 700                                         log ERROR "Can not remove ${value} from the list of integrity hashes because ${value} is not in the list."
 701                                 fi
 702                                 ;;
 703                         +*)
 704                                 value=${1#+}
 705                                 # Check if the Ciphers is in the list of supported integrity hashes.
 706                                 if ! isoneof value ${!VPN_SUPPORTED_INTEGRITY[@]}; then
 707                                         # We do not break here because the processing of other maybe valid values are indepent from this error.
 708                                         log ERROR "${value} is not a supported integrity hash and can thats why not added to the list of integrity hashes."
 709                                 else
 710                                         if list_match ${value} ${INTEGRITY}; then
 711                                                 log WARNING "${value} is already in the list of integrety hashes of this policy."
 712                                         else
 713                                                 list_append INTEGRITY ${value}
 714                                         fi
 715                                 fi
 716                                 ;;
 717                 esac
 718                 shift
 719         done
 720
 721         # Check if the list contain at least one valid group-type
 722         if [ $(list_length ${INTEGRITY}) -ge 1 ]; then
 723                 if ! vpn_security_policies_write_config_key ${name} "INTEGRITY" ${INTEGRITY}; then
 724                         log ERROR "The changes for the vpn security policy ${name} could not be written."
 725                 fi
 726         else
 727                 log ERROR "After proceding all integrity hashes the list is empty and thats why no changes are written."
 728                 return ${EXIT_ERROR}
 729         fi
 730 }
 731
 732 # This function parses the parameters for the 'key-exchange' command
 733 vpn_security_policies_key_exchange() {
 734         local name=${1}
 735         local value=${2}
 736
 737         # Check if we get only one argument after key-exchange <name>
 738         if [ ! $# -eq 2 ]; then
 739                 log ERROR "The number of arguments do not match. Only argument after key-exchange is allowed."
 740                 return ${EXIT_ERROR}
 741         fi
 742
 743         if ! isoneof value "ikev1" "ikev2" "IKEV1" "IKEV2"; then
 744                 log ERROR "Invalid Argument ${value}"
 745                 return ${EXIT_ERROR}
 746         fi
 747
 748         vpn_security_policies_write_config_key "${name}" "KEY_EXCHANGE" "${value,,}"
 749 }
 750
 751 # This function parses the parameters for the 'lifetime' command.
 752 vpn_security_policies_lifetime(){
 753         local name=${1}
 754         shift
 755
 756         local value=$@
 757
 758         # Check if we get only one argument after lifetime <name>
 759         if [ ! $# -ge 1 ]; then
 760                 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"
 761                 return ${EXIT_ERROR}
 762         fi
 763
 764         if ! isinteger value; then
 765                 value=$(parse_time $@)
 766                 if [ ! $? -eq 0 ]; then
 767                         log ERROR "Parsing the passed time was not sucessful please check the passed values."
 768                         return ${EXIT_ERROR}
 769                 fi
 770         fi
 771
 772         if [ ${value} -le 0 ]; then
 773                 log ERROR "The passed time value must be in the sum greater zero seconds."
 774                 return ${EXIT_ERROR}
 775         fi
 776
 777         vpn_security_policies_write_config_key "${name}" "LIFETIME" "${value}"
 778 }
 779
 780 # This function parses the parameters for the 'pfs' command
 781 vpn_security_policies_pfs(){
 782         local name=${1}
 783         local value=${2}
 784
 785         # Check if we get only one argument after pfs <name>
 786         if [ ! $# -eq 2 ]; then
 787                 log ERROR "The number of arguments do not match. Only argument after pfs is allowed."
 788                 return ${EXIT_ERROR}
 789         fi
 790
 791         if [ ! $# -eq 2 ] || ! isbool value; then
 792                 # We suggest only two values to avoid overburding the user.
 793                 log ERROR "Invalid Argument ${value}"
 794                 return ${EXIT_ERROR}
 795         fi
 796
 797         vpn_security_policies_write_config_key "${name}" "PFS" "${value}"
 798 }
 799
 800 # This function checks if a vpn security policy name is valid
 801 # Allowed are only A-Za-z0-9
 802 vpn_security_policies_check_name() {
 803         assert [ $# -eq 1 ]
 804
 805         local name=${1}
 806
 807         [[ ${name} =~ [^[:alnum:]$] ]]
 808 }
 809
 810 # Function that creates based on the paramters one ore more new vpn security policies
 811 vpn_security_policies_new() {
 812         if [ $# -gt 1 ]; then
 813                 error "Too many arguments"
 814                 return ${EXIT_ERROR}
 815         fi
 816
 817         local name="${1}"
 818         if ! isset name; then
 819                 error "Please provide a name"
 820                 return ${EXIT_ERROR}
 821         fi
 822
 823         # Check for duplicates
 824         if vpn_security_policy_exists "${name}"; then
 825                 error "The VPN security policy with name ${name} already exists"
 826                 return ${EXIT_ERROR}
 827         fi
 828
 829         # Check if name is valid
 830         if  vpn_security_policies_check_name "${name}"; then
 831                 error "'${name}' contains illegal characters"
 832                 return ${EXIT_ERROR}
 833         fi
 834
 835         # Check if we have a read-only policy with the same name
 836         if vpn_security_policies_check_readonly "${name}"; then
 837                 error "The VPN security policy ${name} is read-only"
 838                 return ${EXIT_ERROR}
 839         fi
 840
 841         # Check if our source policy exists
 842         if ! vpn_security_policy_exists "${VPN_DEFAULT_SECURITY_POLICY}"; then
 843                 error "Default VPN Security Policy '${VPN_DEFAULT_SECURITY_POLICY}' does not exist"
 844                 return ${EXIT_ERROR}
 845         fi
 846
 847         log DEBUG "Creating VPN Security Policy ${name}"
 848
 849         if copy "$(vpn_security_policies_path "${VPN_DEFAULT_SECURITY_POLICY}")" \
 850                         "$(vpn_security_policies_path ${name})"; then
 851                 log INFO "VPN Security Policy ${name} successfully created"
 852         else
 853                 log ERROR "Could not create VPN Security Policy ${name}"
 854                 return ${EXIT_ERROR}
 855         fi
 856
 857         # Show the newly created policy
 858         vpn_security_policies_show "${name}"
 859 }
 860
 861 # Function that deletes based on the passed parameters one ore more vpn security policies
 862 vpn_security_policies_destroy() {
 863         local name
 864         for name in $@; do
 865                 if ! vpn_security_policy_exists ${name}; then
 866                         log ERROR "The vpn security policy ${name} does not exist."
 867                         continue
 868                 fi
 869
 870                 if vpn_security_policies_check_readonly ${name}; then
 871                         log ERROR "The vpn security policy ${name} cannot be deleted."
 872                         continue
 873                 fi
 874
 875                 log DEBUG "Deleting vpn security policy ${name}"
 876                 settings_remove $(vpn_security_policies_path ${name})
 877
 878                 # Delete cache
 879                 rm -rf "${NETWORK_CACHE_DIR}/vpn/security-policies/${name}"
 880         done
 881 }
 882
 883 vpn_security_policies_cipher_supported() {
 884         local cipher=${1}
 885
 886         list_match ${cipher} ${!VPN_SUPPORTED_CIPHERS[@]}
 887 }
 888
 889 vpn_security_policies_cipher_is_aead() {
 890         local cipher=${1}
 891
 892         # All CCM and GCM ciphers are AEAD
 893         string_match "[CG]CM" "${cipher}"
 894 }
 895
 896 vpn_security_policies_make_ike_proposal() {
 897         local name=${1}
 898
 899         if ! vpn_security_policy_exists ${name}; then
 900                 return ${EXIT_ERROR}
 901         fi
 902
 903         local config_path="$(vpn_security_policies_path ${name})"
 904         local cache_path="${NETWORK_CACHE_DIR}/vpn/security-policies/${name}/ike-proposal"
 905
 906         # Get data from cache if possible
 907         if file_exists "${cache_path}" && ! file_is_newer_than "${config_path}" "${cache_path}"; then
 908                 fread "${cache_path}"
 909                 return ${EXIT_OK}
 910         fi
 911
 912         # No or invalid cache data found
 913         local proposal=$(_vpn_security_policies_make_ike_proposal "${name}")
 914
 915         # Write proposal to cache
 916         if ! make_parent_dir "${cache_path}" || ! fwrite "${cache_path}" "${proposal}"; then
 917                 log WARNING "Could not write to cache: ${cache_path}"
 918         fi
 919
 920         print "${proposal}"
 921 }
 922
 923 _vpn_security_policies_make_ike_proposal() {
 924         local name=${1}
 925
 926         # Read the config settings
 927         local ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
 928         if ! vpn_security_policies_read_config "${name}"; then
 929                 return ${EXIT_ERROR}
 930         fi
 931
 932         local proposals
 933
 934         local cipher
 935         for cipher in ${CIPHER}; do
 936                 # Translate cipher
 937                 local _cipher=${CIPHER_TO_STRONGSWAN[${cipher}]}
 938
 939                 if ! isset _cipher; then
 940                         log WARN "Unsupported cipher: ${cipher}"
 941                         continue
 942                 fi
 943
 944                 local integrity
 945                 for integrity in ${INTEGRITY}; do
 946                         local _integrity=${INTEGRITY_TO_STRONGSWAN[${integrity}]}
 947
 948                         if ! isset _integrity; then
 949                                 log WARN "Unsupported integrity: ${integrity}"
 950                                 continue
 951                         fi
 952
 953                         local group_type
 954                         for group_type in ${GROUP_TYPE}; do
 955                                 local _group_type=${GROUP_TYPE_TO_STRONGSWAN[${group_type}]}
 956
 957                                 if ! isset _group_type; then
 958                                         log WARN "Unsupported group-type: ${group_type}"
 959                                         continue
 960                                 fi
 961
 962                                 # Put everything together
 963                                 list_append proposals "${_cipher}-${_integrity}-${_group_type}"
 964                         done
 965                 done
 966         done
 967
 968         # Returns as a comma-separated list
 969         list_join proposals ,
 970 }
 971
 972 vpn_security_policies_make_esp_proposal() {
 973         local name=${1}
 974
 975         if ! vpn_security_policy_exists ${name}; then
 976                 return ${EXIT_ERROR}
 977         fi
 978
 979         local config_path="$(vpn_security_policies_path ${name})"
 980         local cache_path="${NETWORK_CACHE_DIR}/vpn/security-policies/${name}/esp-proposal"
 981
 982         # Get data from cache if possible
 983         if file_exists "${cache_path}" && ! file_is_newer_than "${config_path}" "${cache_path}"; then
 984                 fread "${cache_path}"
 985                 return ${EXIT_OK}
 986         fi
 987
 988         # No or invalid cache data found
 989         local proposal=$(_vpn_security_policies_make_esp_proposal "${name}")
 990
 991         # Write proposal to cache
 992         if ! make_parent_dir "${cache_path}" || ! fwrite "${cache_path}" "${proposal}"; then
 993                 log WARNING "Could not write to cache: ${cache_path}"
 994         fi
 995
 996         print "${proposal}"
 997 }
 998
 999 _vpn_security_policies_make_esp_proposal() {
1000         local name=${1}
1001
1002         # Read the config settings
1003         local ${VPN_SECURITY_POLICIES_CONFIG_SETTINGS}
1004         if ! vpn_security_policies_read_config "${name}"; then
1005                 return ${EXIT_ERROR}
1006         fi
1007
1008         local proposals
1009
1010         local cipher
1011         for cipher in ${CIPHER}; do
1012                 # Translate cipher
1013                 local _cipher=${CIPHER_TO_STRONGSWAN[${cipher}]}
1014
1015                 if ! isset _cipher; then
1016                         log WARN "Unsupported cipher: ${cipher}"
1017                         continue
1018                 fi
1019
1020                 if vpn_security_policies_cipher_is_aead ${cipher}; then
1021                         local group_type
1022                         for group_type in ${GROUP_TYPE}; do
1023                                 local _group_type=${GROUP_TYPE_TO_STRONGSWAN[${group_type}]}
1024
1025                                 if ! isset _group_type; then
1026                                         log WARN "Unsupported group-type: ${group_type}"
1027                                         continue
1028                                 fi
1029
1030                                 # Put everything together
1031                                 list_append proposals "${_cipher}-${_group_type}"
1032                         done
1033                 else
1034                         local integrity
1035                         for integrity in ${INTEGRITY}; do
1036                                 local _integrity=${INTEGRITY_TO_STRONGSWAN[${integrity}]}
1037
1038                                 if ! isset _integrity; then
1039                                         log WARN "Unsupported integrity: ${integrity}"
1040                                         continue
1041                                 fi
1042
1043                                 local group_type
1044                                 for group_type in ${GROUP_TYPE}; do
1045                                         local _group_type=${GROUP_TYPE_TO_STRONGSWAN[${group_type}]}
1046
1047                                         if ! isset _group_type; then
1048                                                 log WARN "Unsupported group-type: ${group_type}"
1049                                                 continue
1050                                         fi
1051
1052                                         # Put everything together
1053                                         list_append proposals "${_cipher}-${_integrity}-${_group_type}"
1054                                 done
1055                         done
1056                 fi
1057         done
1058
1059         # Returns as a comma-separated list
1060         list_join proposals ,
1061 }
1062
1063 # List all security policies
1064 vpn_security_policies_list_all() {
1065         local security_policy
1066         for security_policy in ${NETWORK_SHARE_DIR}/vpn/security-policies/*; do
1067                 [ -f ${security_policy} ] || continue
1068                 basename ${security_policy}
1069         done
1070
1071         for security_policy in ${NETWORK_CONFIG_DIR}/vpn/security-policies/*; do
1072                 [ -f ${security_policy} ] || continue
1073                 basename ${security_policy}
1074         done
1075 }