man/strongswan.conf.5.in

   1 .TH STRONGSWAN.CONF 5 "2011-07-17" "@IPSEC_VERSION@" "strongSwan"
   2 .SH NAME
   3 strongswan.conf \- strongSwan configuration file
   4 .SH DESCRIPTION
   5 While the
   6 .IR ipsec.conf (5)
   7 configuration file is well suited to define IPsec related configuration
   8 parameters, it is not useful for other strongSwan applications to read options
   9 from this file.
  10 The file is hard to parse and only
  11 .I ipsec starter
  12 is capable of doing so. As the number of components of the strongSwan project
  13 is continually growing, a more flexible configuration file was needed, one that
  14 is easy to extend and can be used by all components. With strongSwan 4.2.1
  15 .IR strongswan.conf (5)
  16 was introduced which meets these requirements.
  17
  18 .SH SYNTAX
  19 The format of the strongswan.conf file consists of hierarchical
  20 .B sections
  21 and a list of
  22 .B key/value pairs
  23 in each section. Each section has a name, followed by C-Style curly brackets
  24 defining the section body. Each section body contains a set of subsections
  25 and key/value pairs:
  26 .PP
  27 .EX
  28         settings := (section|keyvalue)*
  29         section  := name { settings }
  30         keyvalue := key = value\\n
  31 .EE
  32 .PP
  33 Values must be terminated by a newline.
  34 .PP
  35 Comments are possible using the \fB#\fP-character, but be careful: The parser
  36 implementation is currently limited and does not like brackets in comments.
  37 .PP
  38 Section names and keys may contain any printable character except:
  39 .PP
  40 .EX
  41         . { } # \\n \\t space
  42 .EE
  43 .PP
  44 An example file in this format might look like this:
  45 .PP
  46 .EX
  47         a = b
  48         section-one {
  49                 somevalue = asdf
  50                 subsection {
  51                         othervalue = xxx
  52                 }
  53                 # yei, a comment
  54                 yetanother = zz
  55         }
  56         section-two {
  57                 x = 12
  58         }
  59 .EE
  60 .PP
  61 Indentation is optional, you may use tabs or spaces.
  62
  63 .SH INCLUDING FILES
  64 Using the
  65 .B include
  66 statement it is possible to include other files into strongswan.conf, e.g.
  67 .PP
  68 .EX
  69         include /some/path/*.conf
  70 .EE
  71 .PP
  72 If the file name is not an absolute path, it is considered to be relative
  73 to the directory of the file containing the include statement. The file name
  74 may include shell wildcards (see
  75 .IR sh (1)).
  76 Also, such inclusions can be nested.
  77 .PP
  78 Sections loaded from included files
  79 .I extend
  80 previously loaded sections; already existing values are
  81 .IR replaced .
  82 It is important to note that settings are added relative to the section the
  83 include statement is in.
  84 .PP
  85 As an example, the following three files result in the same final
  86 config as the one given above:
  87 .PP
  88 .EX
  89         a = b
  90         section-one {
  91                 somevalue = before include
  92                 include include.conf
  93         }
  94         include other.conf
  95
  96 include.conf:
  97         # settings loaded from this file are added to section-one
  98         # the following replaces the previous value
  99         somevalue = asdf
 100         subsection {
 101                 othervalue = yyy
 102         }
 103         yetanother = zz
 104
 105 other.conf:
 106         # this extends section-one and subsection
 107         section-one {
 108                 subsection {
 109                         # this replaces the previous value
 110                         othervalue = xxx
 111                 }
 112         }
 113         section-two {
 114                 x = 12
 115         }
 116 .EE
 117
 118 .SH READING VALUES
 119 Values are accessed using a dot-separated section list and a key.
 120 With reference to the example above, accessing
 121 .B section-one.subsection.othervalue
 122 will return
 123 .BR xxx .
 124
 125 .SH DEFINED KEYS
 126 The following keys are currently defined (using dot notation). The default
 127 value (if any) is listed in brackets after the key.
 128
 129 .SS charon section
 130 .TP
 131 .BR charon.block_threshold " [5]"
 132 Maximum number of half-open IKE_SAs for a single peer IP
 133 .TP
 134 .BR charon.close_ike_on_child_failure " [no]"
 135 Close the IKE_SA if setup of the CHILD_SA along with IKE_AUTH failed
 136 .TP
 137 .BR charon.cookie_threshold " [10]"
 138 Number of half-open IKE_SAs that activate the cookie mechanism
 139 .TP
 140 .BR charon.dns1
 141 .TQ
 142 .BR charon.dns2
 143 DNS servers assigned to peer via configuration payload (CP)
 144 .TP
 145 .BR charon.dos_protection " [yes]"
 146 Enable Denial of Service protection using cookies and aggressiveness checks
 147 .TP
 148 .BR charon.filelog
 149 Section to define file loggers, see LOGGER CONFIGURATION
 150 .TP
 151 .BR charon.flush_auth_cfg " [no]"
 152
 153 .TP
 154 .BR charon.hash_and_url " [no]"
 155 Enable hash and URL support
 156 .TP
 157 .BR charon.ignore_routing_tables
 158 A list of routing tables to be excluded from route lookup
 159 .TP
 160 .BR charon.ikesa_table_segments " [1]"
 161 Number of exclusively locked segments in the hash table
 162 .TP
 163 .BR charon.ikesa_table_size " [1]"
 164 Size of the IKE_SA hash table
 165 .TP
 166 .BR charon.inactivity_close_ike " [no]"
 167 Whether to close IKE_SA if the only CHILD_SA closed due to inactivity
 168 .TP
 169 .BR charon.install_routes " [yes]"
 170 Install routes into a separate routing table for established IPsec tunnels
 171 .TP
 172 .BR charon.install_virtual_ip " [yes]"
 173 Install virtual IP addresses
 174 .TP
 175 .BR charon.keep_alive " [20s]"
 176 NAT keep alive interval
 177 .TP
 178 .BR charon.load
 179 Plugins to load in the IKEv2 daemon charon
 180 .TP
 181 .BR charon.max_packet " [10000]"
 182 Maximum packet size accepted by charon
 183 .TP
 184 .BR charon.multiple_authentication " [yes]"
 185 Enable multiple authentication exchanges (RFC 4739)
 186 .TP
 187 .BR charon.nbns1
 188 .TQ
 189 .BR charon.nbns2
 190 WINS servers assigned to peer via configuration payload (CP)
 191 .TP
 192 .BR charon.process_route " [yes]"
 193 Process RTM_NEWROUTE and RTM_DELROUTE events
 194 .TP
 195 .BR charon.receive_delay " [0]"
 196 Delay for receiving packets, to simulate larger RTT
 197 .TP
 198 .BR charon.receive_delay_response " [yes]"
 199 Delay response messages
 200 .TP
 201 .BR charon.receive_delay_request " [yes]"
 202 Delay request messages
 203 .TP
 204 .BR charon.receive_delay_type " [0]"
 205 Specific IKEv2 message type to delay, 0 for any
 206 .TP
 207 .BR charon.replay_window " [32]"
 208 Size of the AH/ESP replay window, in packets.
 209 .TP
 210 .BR charon.retransmit_base " [1.8]"
 211 Base to use for calculating exponential back off, see IKEv2 RETRANSMISSION
 212 .TP
 213 .BR charon.retransmit_timeout " [4.0]
 214 Timeout in seconds before sending first retransmit
 215 .TP
 216 .BR charon.retransmit_tries " [5]"
 217 Number of times to retransmit a packet before giving up
 218 .TP
 219 .BR charon.reuse_ikesa " [yes]
 220 Initiate CHILD_SA within existing IKE_SAs
 221 .TP
 222 .BR charon.routing_table
 223 Numerical routing table to install routes to
 224 .TP
 225 .BR charon.routing_table_prio
 226 Priority of the routing table
 227 .TP
 228 .BR charon.send_delay " [0]"
 229 Delay for sending packets, to simulate larger RTT
 230 .TP
 231 .BR charon.send_delay_response " [yes]"
 232 Delay response messages
 233 .TP
 234 .BR charon.send_delay_request " [yes]"
 235 Delay request messages
 236 .TP
 237 .BR charon.send_delay_type " [0]"
 238 Specific IKEv2 message type to delay, 0 for any
 239 .TP
 240 .BR charon.send_vendor_id " [no]
 241 Send strongSwan vendor ID payload
 242 .TP
 243 .BR charon.syslog
 244 Section to define syslog loggers, see LOGGER CONFIGURATION
 245 .TP
 246 .BR charon.threads " [16]"
 247 Number of worker threads in charon
 248 .SS charon.plugins subsection
 249 .TP
 250 .BR charon.plugins.android.loglevel " [1]"
 251 Loglevel for logging to Android specific logger
 252 .TP
 253 .BR charon.plugins.attr
 254 Section to specify arbitrary attributes that are assigned to a peer via
 255 configuration payload (CP)
 256 .TP
 257 .BR charon.plugins.dhcp.identity_lease " [no]"
 258 Derive user-defined MAC address from hash of IKEv2 identity
 259 .TP
 260 .BR charon.plugins.dhcp.server " [255.255.255.255]"
 261 DHCP server unicast or broadcast IP address
 262 .TP
 263 .BR charon.plugins.duplicheck.enable " [yes]"
 264 enable loaded duplicheck plugin
 265 .TP
 266 .BR charon.plugins.eap-aka.request_identity " [yes]"
 267
 268 .TP
 269 .BR charon.plugins.eap-aka-3ggp2.seq_check
 270
 271 .TP
 272 .BR charon.plugins.eap-gtc.pam_service " [login]"
 273 PAM service to be used for authentication
 274
 275 .TP
 276 .BR charon.plugins.eap-peap.fragment_size " [1024]"
 277 Maximum size of an EAP-PEAP packet
 278 .TP
 279 .BR charon.plugins.eap-peap.max_message_count " [32]"
 280 Maximum number of processed EAP-PEAP packets
 281 .TP
 282 .BR charon.plugins.eap-peap.include_length " [no]"
 283 Include length in non-fragmented EAP-PEAP packets
 284 .TP
 285 .BR charon.plugins.eap-peap.phase2_method " [mschapv2]"
 286 Phase2 EAP client authentication method
 287 .TP
 288 .BR charon.plugins.eap-peap.phase2_piggyback " [no]"
 289 Phase2 EAP Identity request piggybacked by server onto TLS Finished message
 290 .TP
 291 .BR charon.plugins.eap-peap.phase2_tnc " [no]"
 292 Start phase2 EAP TNC protocol after successful client authentication
 293 .TP
 294 .BR charon.plugins.eap-peap.request_peer_auth " [no]"
 295 Request peer authentication based on a client certificate
 296
 297 .TP
 298 .BR charon.plugins.eap-radius.class_group " [no]"
 299 Use the
 300 .I class
 301 attribute sent in the RADIUS-Accept message as group membership information that
 302 is compared to the groups specified in the
 303 .B rightgroups
 304 option in
 305 .B ipsec.conf (5).
 306 .TP
 307 .BR charon.plugins.eap-radius.eap_start " [no]"
 308 Send EAP-Start instead of EAP-Identity to start RADIUS conversation
 309 .TP
 310 .BR charon.plugins.eap-radius.filter_id " [no]"
 311 If the RADIUS
 312 .I tunnel_type
 313 attribute with value
 314 .B ESP
 315 is received, use the
 316 .I filter_id
 317 attribute sent in the RADIUS-Accept message as group membership information that
 318 is compared to the groups specified in the
 319 .B rightgroups
 320 option in
 321 .B ipsec.conf (5).
 322 .TP
 323 .BR charon.plugins.eap-radius.id_prefix
 324 Prefix to EAP-Identity, some AAA servers use a IMSI prefix to select the
 325 EAP method
 326 .TP
 327 .BR charon.plugins.eap-radius.nas_identifier " [strongSwan]"
 328 NAS-Identifier to include in RADIUS messages
 329 .TP
 330 .BR charon.plugins.eap-radius.port " [1812]"
 331 Port of RADIUS server (authentication)
 332 .TP
 333 .BR charon.plugins.eap-radius.secret
 334 Shared secret between RADIUS and NAS
 335 .TP
 336 .BR charon.plugins.eap-radius.server
 337 IP/Hostname of RADIUS server
 338 .TP
 339 .BR charon.plugins.eap-radius.servers
 340 Section to specify multiple RADIUS servers. The
 341 .BR nas_identifier ,
 342 .BR secret ,
 343 .B sockets
 344 and
 345 .B port
 346 options can be specified for each server. A server's IP/Hostname can be
 347 configured using the
 348 .B address
 349 option. For each RADIUS server a priority can be specified using the
 350 .BR preference " [0]"
 351 option.
 352 .TP
 353 .BR charon.plugins.eap-radius.sockets " [1]"
 354 Number of sockets (ports) to use, increase for high load
 355 .TP
 356 .BR charon.plugins.eap-sim.request_identity " [yes]"
 357
 358 .TP
 359 .BR charon.plugins.eap-simaka-sql.database
 360
 361 .TP
 362 .BR charon.plugins.eap-simaka-sql.remove_used
 363
 364 .TP
 365 .BR charon.plugins.eap-tls.fragment_size " [1024]"
 366 Maximum size of an EAP-TLS packet
 367 .TP
 368 .BR charon.plugins.eap-tls.max_message_count " [32]"
 369 Maximum number of processed EAP-TLS packets
 370 .TP
 371 .BR charon.plugins.eap-tls.include_length " [yes]"
 372 Include length in non-fragmented EAP-TLS packets
 373 .TP
 374 .BR charon.plugins.eap-tnc.fragment_size " [50000]"
 375 Maximum size of an EAP-TNC packet
 376 .TP
 377 .BR charon.plugins.eap-tnc.max_message_count " [10]"
 378 Maximum number of processed EAP-TNC packets
 379 .TP
 380 .BR charon.plugins.eap-tnc.include_length " [yes]"
 381 Include length in non-fragmented EAP-TNC packets
 382 .TP
 383 .BR charon.plugins.eap-ttls.fragment_size " [1024]"
 384 Maximum size of an EAP-TTLS packet
 385 .TP
 386 .BR charon.plugins.eap-ttls.max_message_count " [32]"
 387 Maximum number of processed EAP-TTLS packets
 388 .TP
 389 .BR charon.plugins.eap-ttls.include_length " [yes]"
 390 Include length in non-fragmented EAP-TTLS packets
 391 .TP
 392 .BR charon.plugins.eap-ttls.phase2_method " [md5]"
 393 Phase2 EAP client authentication method
 394 .TP
 395 .BR charon.plugins.eap-ttls.phase2_piggyback " [no]"
 396 Phase2 EAP Identity request piggybacked by server onto TLS Finished message
 397 .TP
 398 .BR charon.plugins.eap-ttls.phase2_tnc " [no]"
 399 Start phase2 EAP TNC protocol after successful client authentication
 400 .TP
 401 .BR charon.plugins.eap-ttls.request_peer_auth " [no]"
 402 Request peer authentication based on a client certificate
 403 .TP
 404 .BR charon.plugins.ha.fifo_interface " [yes]"
 405
 406 .TP
 407 .BR charon.plugins.ha.heartbeat_delay " [1000]"
 408
 409 .TP
 410 .BR charon.plugins.ha.heartbeat_timeout " [2100]"
 411
 412 .TP
 413 .BR charon.plugins.ha.local
 414
 415 .TP
 416 .BR charon.plugins.ha.monitor " [yes]"
 417
 418 .TP
 419 .BR charon.plugins.ha.pools
 420
 421 .TP
 422 .BR charon.plugins.ha.remote
 423
 424 .TP
 425 .BR charon.plugins.ha.resync " [yes]"
 426
 427 .TP
 428 .BR charon.plugins.ha.secret
 429
 430 .TP
 431 .BR charon.plugins.ha.segment_count " [1]"
 432
 433 .TP
 434 .BR charon.plugins.led.activity_led
 435
 436 .TP
 437 .BR charon.plugins.led.blink_time " [50]"
 438
 439 .TP
 440 .BR charon.plugins.kernel-klips.ipsec_dev_count " [4]"
 441 Number of ipsecN devices
 442 .TP
 443 .BR charon.plugins.kernel-klips.ipsec_dev_mtu " [0]"
 444 Set MTU of ipsecN device
 445 .TP
 446 .BR charon.plugins.load-tester
 447 Section to configure the load-tester plugin, see LOAD TESTS
 448 .TP
 449 .BR charon.plugins.resolve.file " [/etc/resolv.conf]"
 450 File where to add DNS server entries
 451 .TP
 452 .BR charon.plugins.sql.database
 453 Database URI for charons SQL plugin
 454 .TP
 455 .BR charon.plugins.sql.loglevel " [-1]"
 456 Loglevel for logging to SQL database
 457 .TP
 458 .BR charon.plugins.tnc-imc.preferred_language " [en]"
 459 Preferred language for TNC recommendations
 460 .TP
 461 .BR charon.plugins.tnc-imc.tnc_config " [/etc/tnc_config]"
 462 TNC IMC configuration directory
 463 .TP
 464 .BR charon.plugins.tnc-imv.tnc_config " [/etc/tnc_config]"
 465 TNC IMV configuration directory
 466 .TP
 467 .BR charon.plugins.whitelist.enable " [yes]"
 468 enable loaded whitelist plugin
 469 .SS libstrongswan section
 470 .TP
 471 .BR libstrongswan.crypto_test.bench " [no]"
 472
 473 .TP
 474 .BR libstrongswan.crypto_test.bench_size " [1024]"
 475
 476 .TP
 477 .BR libstrongswan.crypto_test.bench_time " [50]"
 478
 479 .TP
 480 .BR libstrongswan.crypto_test.on_add " [no]"
 481 Test crypto algorithms during registration
 482 .TP
 483 .BR libstrongswan.crypto_test.on_create " [no]"
 484 Test crypto algorithms on each crypto primitive instantiation
 485 .TP
 486 .BR libstrongswan.crypto_test.required " [no]"
 487 Strictly require at least one test vector to enable an algorithm
 488 .TP
 489 .BR libstrongswan.crypto_test.rng_true " [no]"
 490 Whether to test RNG with TRUE quality; requires a lot of entropy
 491 .TP
 492 .BR libstrongswan.dh_exponent_ansi_x9_42 " [yes]"
 493 Use ANSI X9.42 DH exponent size or optimum size matched to cryptographical
 494 strength
 495 .TP
 496 .BR libstrongswan.ecp_x_coordinate_only " [yes]"
 497 Compliance with the errata for RFC 4753
 498 .TP
 499 .BR libstrongswan.integrity_test " [no]"
 500 Check daemon, libstrongswan and plugin integrity at startup
 501 .TP
 502 .BR libstrongswan.leak_detective.detailed " [yes]"
 503 Includes source file names and line numbers in leak detective output
 504 .TP
 505 .BR libstrongswan.x509.enforce_critical " [yes]"
 506 Discard certificates with unsupported or unknown critical extensions
 507 .SS libstrongswan.plugins subsection
 508 .TP
 509 .BR libstrongswan.plugins.attr-sql.database
 510 Database URI for attr-sql plugin used by charon and pluto
 511 .TP
 512 .BR libstrongswan.plugins.attr-sql.lease_history " [yes]"
 513 Enable logging of SQL IP pool leases
 514 .TP
 515 .BR libstrongswan.plugins.gcrypt.quick_random " [no]"
 516 Use faster random numbers in gcrypt; for testing only, produces weak keys!
 517 .TP
 518 .BR libstrongswan.plugins.openssl.engine_id " [pkcs11]"
 519 ENGINE ID to use in the OpenSSL plugin
 520 .TP
 521 .BR libstrongswan.plugins.pkcs11.modules
 522 List of available PKCS#11 modules
 523 .TP
 524 .BR libstrongswan.plugins.pkcs11.use_hasher " [no]"
 525 Whether the PKCS#11 modules should be used to hash data
 526 .SS libimcv section
 527 .TP
 528 .BR libimcv.debug_level " [1]"
 529 Debug level for a stand-alone libimcv library
 530 .TP
 531 .BR libimcv.stderr_quiet " [no]"
 532 Disable output to stderr with a stand-alone libimcv library
 533 .SS libimcv plugins section
 534 .TP
 535 .BR libimcv.plugins.imc_test.command " [none]"
 536 Command to be sent to the Test IMV
 537 .TP
 538 .BR libimcv.plugins.imc_test.retry " [no]"
 539 Do a handshake retry
 540 .TP
 541 .BR libimcv.plugins.imc_test.retry_command
 542 Command to be sent to the Test IMV in the handshake retry
 543 .TP
 544 .BR libimcv.plugins.imv_test.rounds " [0]"
 545 Number of IMC-IMV retry rounds
 546 .TP
 547 .BR libimcv.plugins.imv_scanner.closed_port_policy " [yes]"
 548 By default all ports must be closed (yes) or can be open (no)
 549 .TP
 550 .BR libimcv.plugins.imv_scanner.tcp_ports
 551 List of TCP ports that can be open or must be closed
 552 .TP
 553 .BR libimcv.plugins.imv_scanner.udp_ports
 554 List of UDP ports that can be open or must be closed
 555 .SS libtls section
 556 .TP
 557 .BR libtls.cipher
 558 List of TLS encryption ciphers
 559 .TP
 560 .BR libtls.key_exchange
 561 List of TLS key exchange methods
 562 .TP
 563 .BR libtls.mac
 564 List of TLS MAC algorithms
 565 .TP
 566 .BR libtls.suites
 567 List of TLS cipher suites
 568 .SS manager section
 569 .TP
 570 .BR manager.database
 571 Credential database URI for manager
 572 .TP
 573 .BR manager.debug " [no]"
 574 Enable debugging in manager
 575 .TP
 576 .BR manager.load
 577 Plugins to load in manager
 578 .TP
 579 .BR manager.socket
 580 FastCGI socket of manager, to run it statically
 581 .TP
 582 .BR manager.threads " [10]"
 583 Threads to use for request handling
 584 .TP
 585 .BR manager.timeout " [15m]"
 586 Session timeout for manager
 587 .SS mediation client section
 588 .TP
 589 .BR medcli.database
 590 Mediation client database URI
 591 .TP
 592 .BR medcli.dpd " [5m]"
 593 DPD timeout to use in mediation client plugin
 594 .TP
 595 .BR medcli.rekey " [20m]"
 596 Rekeying time on mediation connections in mediation client plugin
 597 .SS mediation server section
 598 .TP
 599 .BR medsrv.database
 600 Mediation server database URI
 601 .TP
 602 .BR medsrv.debug " [no]"
 603 Debugging in mediation server web application
 604 .TP
 605 .BR medsrv.dpd " [5m]"
 606 DPD timeout to use in mediation server plugin
 607 .TP
 608 .BR medsrv.load
 609 Plugins to load in mediation server plugin
 610 .TP
 611 .BR medsrv.password_length " [6]"
 612 Minimum password length required for mediation server user accounts
 613 .TP
 614 .BR medsrv.rekey " [20m]"
 615 Rekeying time on mediation connections in mediation server plugin
 616 .TP
 617 .BR medsrv.socket
 618 Run Mediation server web application statically on socket
 619 .TP
 620 .BR medsrv.threads " [5]"
 621 Number of thread for mediation service web application
 622 .TP
 623 .BR medsrv.timeout " [15m]"
 624 Session timeout for mediation service
 625 .SS openac section
 626 .TP
 627 .BR openac.load
 628 Plugins to load in ipsec openac tool
 629 .SS pki section
 630 .TP
 631 .BR pki.load
 632 Plugins to load in ipsec pki tool
 633 .SS pluto section
 634 .TP
 635 .BR pluto.dns1
 636 .TQ
 637 .BR pluto.dns2
 638 DNS servers assigned to peer via Mode Config
 639 .TP
 640 .BR pluto.load
 641 Plugins to load in IKEv1 pluto daemon
 642 .TP
 643 .BR pluto.nbns1
 644 .TQ
 645 .BR pluto.nbns2
 646 WINS servers assigned to peer via Mode Config
 647 .TP
 648 .BR pluto.threads " [4]"
 649 Number of worker threads in pluto
 650 .SS pluto.plugins section
 651 .TP
 652 .BR pluto.plugins.attr
 653 Section to specify arbitrary attributes that are assigned to a peer via
 654 Mode Config
 655 .TP
 656 .BR charon.plugins.kernel-klips.ipsec_dev_count " [4]"
 657 Number of ipsecN devices
 658 .TP
 659 .BR charon.plugins.kernel-klips.ipsec_dev_mtu " [0]"
 660 Set MTU of ipsecN device
 661 .SS pool section
 662 .TP
 663 .BR pool.load
 664 Plugins to load in ipsec pool tool
 665 .SS scepclient section
 666 .TP
 667 .BR scepclient.load
 668 Plugins to load in ipsec scepclient tool
 669 .SS starter section
 670 .TP
 671 .BR starter.load_warning " [yes]"
 672 Disable charon/pluto plugin load option warning
 673
 674 .SH LOGGER CONFIGURATION
 675 The options described below provide a much more flexible way to configure
 676 loggers for the IKEv2 daemon charon than using the
 677 .B charondebug
 678 option in
 679 .BR ipsec.conf (5).
 680 .PP
 681 .B Please note
 682 that if any loggers are specified in strongswan.conf,
 683 .B charondebug
 684 does not have any effect.
 685 .PP
 686 There are currently two types of loggers defined:
 687 .TP
 688 .B File loggers
 689 Log directly to a file and are defined by specifying the full path to the
 690 file as subsection in the
 691 .B charon.filelog
 692 section. To log to the console the two special filenames
 693 .BR stdout " and " stderr
 694 can be used.
 695 .TP
 696 .B Syslog loggers
 697 Log into a syslog facility and are defined by specifying the facility to log to
 698 as the name of a subsection in the
 699 .B charon.syslog
 700 section. The following facilities are currently supported:
 701 .BR daemon " and " auth .
 702 .PP
 703 Multiple loggers can be defined for each type with different log verbosity for
 704 the different subsystems of the daemon.
 705 .SS Options
 706 .TP
 707 .BR charon.filelog.<filename>.default " [1]"
 708 .TQ
 709 .BR charon.syslog.<facility>.default
 710 Specifies the default loglevel to be used for subsystems for which no specific
 711 loglevel is defined.
 712 .TP
 713 .BR charon.filelog.<filename>.<subsystem> " [<default>]"
 714 .TQ
 715 .BR charon.syslog.<facility>.<subsystem>
 716 Specifies the loglevel for the given subsystem.
 717 .TP
 718 .BR charon.filelog.<filename>.append " [yes]"
 719 If this option is enabled log entries are appended to the existing file.
 720 .TP
 721 .BR charon.filelog.<filename>.flush_line " [no]"
 722 Enabling this option disables block buffering and enables line buffering.
 723 .TP
 724 .BR charon.filelog.<filename>.ike_name " [no]"
 725 .TQ
 726 .BR charon.syslog.<facility>.ike_name
 727 Prefix each log entry with the connection name and a unique numerical
 728 identifier for each IKE_SA.
 729 .TP
 730 .BR charon.filelog.<filename>.time_format
 731 Prefix each log entry with a timestamp. The option accepts a format string as
 732 passed to
 733 .BR strftime (3).
 734
 735 .SS Subsystems
 736 .TP
 737 .B dmn
 738 Main daemon setup/cleanup/signal handling
 739 .TP
 740 .B mgr
 741 IKE_SA manager, handling synchronization for IKE_SA access
 742 .TP
 743 .B ike
 744 IKE_SA
 745 .TP
 746 .B chd
 747 CHILD_SA
 748 .TP
 749 .B job
 750 Jobs queueing/processing and thread pool management
 751 .TP
 752 .B cfg
 753 Configuration management and plugins
 754 .TP
 755 .B knl
 756 IPsec/Networking kernel interface
 757 .TP
 758 .B net
 759 IKE network communication
 760 .TP
 761 .B enc
 762 Packet encoding/decoding encryption/decryption operations
 763 .TP
 764 .B tls
 765 libtls library messages
 766 .TP
 767 .B lib
 768 libstrongwan library messages
 769 .SS Loglevels
 770 .TP
 771 .B -1
 772 Absolutely silent
 773 .TP
 774 .B 0
 775 Very basic auditing logs, (e.g. SA up/SA down)
 776 .TP
 777 .B 1
 778 Generic control flow with errors, a good default to see whats going on
 779 .TP
 780 .B 2
 781 More detailed debugging control flow
 782 .TP
 783 .B 3
 784 Including RAW data dumps in Hex
 785 .TP
 786 .B 4
 787 Also include sensitive material in dumps, e.g. keys
 788 .SS Example
 789 .PP
 790 .EX
 791         charon {
 792                 filelog {
 793                         /var/log/charon.log {
 794                                 time_format = %b %e %T
 795                                 append = no
 796                                 default = 1
 797                         }
 798                         stderr {
 799                                 ike = 2
 800                                 knl = 3
 801                                 ike_name = yes
 802                         }
 803                 }
 804                 syslog {
 805                         # enable logging to LOG_DAEMON, use defaults
 806                         daemon {
 807                         }
 808                         # minimalistic IKE auditing logging to LOG_AUTHPRIV
 809                         auth {
 810                                 default = -1
 811                                 ike = 0
 812                         }
 813                 }
 814         }
 815 .EE
 816
 817 .SH LOAD TESTS
 818 To do stability testing and performance optimizations, the IKEv2 daemon charon
 819 provides the load-tester plugin. This plugin allows to setup thousands of
 820 tunnels concurrently against the daemon itself or a remote host.
 821 .PP
 822 .B WARNING:
 823 Never enable the load-testing plugin on productive systems. It provides
 824 preconfigured credentials and allows an attacker to authenticate as any user.
 825 .SS Options
 826 .TP
 827 .BR charon.plugins.load-tester.child_rekey " [600]"
 828 Seconds to start CHILD_SA rekeying after setup
 829 .TP
 830 .BR charon.plugins.load-tester.delay " [0]"
 831 Delay between initiatons for each thread
 832 .TP
 833 .BR charon.plugins.load-tester.delete_after_established " [no]"
 834 Delete an IKE_SA as soon as it has been established
 835 .TP
 836 .BR charon.plugins.load-tester.dpd_delay " [0]"
 837 DPD delay to use in load test
 838 .TP
 839 .BR charon.plugins.load-tester.dynamic_port " [0]"
 840 Base port to be used for requests (each client uses a different port)
 841 .TP
 842 .BR charon.plugins.load-tester.eap_password " [default-pwd]"
 843 EAP secret to use in load test
 844 .TP
 845 .BR charon.plugins.load-tester.enable " [no]"
 846 Enable the load testing plugin
 847 .TP
 848 .BR charon.plugins.load-tester.fake_kernel " [no]"
 849 Fake the kernel interface to allow load-testing against self
 850 .TP
 851 .BR charon.plugins.load-tester.ike_rekey " [0]"
 852 Seconds to start IKE_SA rekeying after setup
 853 .TP
 854 .BR charon.plugins.load-tester.init_limit " [0]"
 855 Global limit of concurrently established SAs during load test
 856 .TP
 857 .BR charon.plugins.load-tester.initiators " [0]"
 858 Number of concurrent initiator threads to use in load test
 859 .TP
 860 .BR charon.plugins.load-tester.initiator_auth " [pubkey]"
 861 Authentication method(s) the intiator uses
 862 .TP
 863 .BR charon.plugins.load-tester.initiator_id
 864 Initiator ID used in load test
 865 .TP
 866 .BR charon.plugins.load-tester.iterations " [1]"
 867 Number of IKE_SAs to initate by each initiator in load test
 868 .TP
 869 .BR charon.plugins.load-tester.pool
 870 Provide INTERNAL_IPV4_ADDRs from a named pool
 871 .TP
 872 .BR charon.plugins.load-tester.preshared_key " [default-psk]"
 873 Preshared key to use in load test
 874 .TP
 875 .BR charon.plugins.load-tester.proposal " [aes128-sha1-modp768]"
 876 IKE proposal to use in load test
 877 .TP
 878 .BR charon.plugins.load-tester.remote " [127.0.0.1]"
 879 Address to initiation connections to
 880 .TP
 881 .BR charon.plugins.load-tester.responder_auth " [pubkey]"
 882 Authentication method(s) the responder uses
 883 .TP
 884 .BR charon.plugins.load-tester.responder_id
 885 Responder ID used in load test
 886 .TP
 887 .BR charon.plugins.load-tester.request_virtual_ip " [no]"
 888 Request an INTERNAL_IPV4_ADDR from the server
 889 .TP
 890 .BR charon.plugins.load-tester.shutdown_when_complete " [no]"
 891 Shutdown the daemon after all IKE_SAs have been established
 892 .SS Configuration details
 893 For public key authentication, the responder uses the
 894 .B \(dqCN=srv, OU=load-test, O=strongSwan\(dq
 895 identity. For the initiator, each connection attempt uses a different identity
 896 in the form
 897 .BR "\(dqCN=c1-r1, OU=load-test, O=strongSwan\(dq" ,
 898 where the first number inidicates the client number, the second the
 899 authentication round (if multiple authentication is used).
 900 .PP
 901 For PSK authentication, FQDN identities are used. The server uses
 902 .BR srv.strongswan.org ,
 903 the client uses an identity in the form
 904 .BR c1-r1.strongswan.org .
 905 .PP
 906 For EAP authentication, the client uses a NAI in the form
 907 .BR 100000000010001@strongswan.org .
 908 .PP
 909 To configure multiple authentication, concatenate multiple methods using, e.g.
 910 .EX
 911         initiator_auth = pubkey|psk|eap-md5|eap-aka
 912 .EE
 913 .PP
 914 The responder uses a hardcoded certificate based on a 1024-bit RSA key.
 915 This certificate additionally serves as CA certificate. A peer uses the same
 916 private key, but generates client certificates on demand signed by the CA
 917 certificate. Install the Responder/CA certificate on the remote host to
 918 authenticate all clients.
 919 .PP
 920 To speed up testing, the load tester plugin implements a special Diffie-Hellman
 921 implementation called modpnull. By setting
 922 .EX
 923         proposal = aes128-sha1-modpnull
 924 .EE
 925 this wicked fast DH implementation is used. It does not provide any security
 926 at all, but allows to run tests without DH calculation overhead.
 927 .SS Examples
 928 .PP
 929 In the simplest case, the daemon initiates IKE_SAs against itself using the
 930 loopback interface. This will actually establish double the number of IKE_SAs,
 931 as the daemon is initiator and responder for each IKE_SA at the same time.
 932 Installation of IPsec SAs would fails, as each SA gets installed twice. To
 933 simulate the correct behavior, a fake kernel interface can be enabled which does
 934 not install the IPsec SAs at the kernel level.
 935 .PP
 936 A simple loopback configuration might look like this:
 937 .PP
 938 .EX
 939         charon {
 940                 # create new IKE_SAs for each CHILD_SA to simulate
 941                 # different clients
 942                 reuse_ikesa = no
 943                 # turn off denial of service protection
 944                 dos_protection = no
 945
 946                 plugins {
 947                         load-tester {
 948                                 # enable the plugin
 949                                 enable = yes
 950                                 # use 4 threads to initiate connections
 951                                 # simultaneously
 952                                 initiators = 4
 953                                 # each thread initiates 1000 connections
 954                                 iterations = 1000
 955                                 # delay each initiation in each thread by 20ms
 956                                 delay = 20
 957                                 # enable the fake kernel interface to
 958                                 # avoid SA conflicts
 959                                 fake_kernel = yes
 960                         }
 961                 }
 962         }
 963 .EE
 964 .PP
 965 This will initiate 4000 IKE_SAs within 20 seconds. You may increase the delay
 966 value if your box can not handle that much load, or decrease it to put more
 967 load on it. If the daemon starts retransmitting messages your box probably can
 968 not handle all connection attempts.
 969 .PP
 970 The plugin also allows to test against a remote host. This might help to test
 971 against a real world configuration. A connection setup to do stress testing of
 972 a gateway might look like this:
 973 .PP
 974 .EX
 975         charon {
 976                 reuse_ikesa = no
 977                 threads = 32
 978
 979                 plugins {
 980                         load-tester {
 981                                 enable = yes
 982                                 # 10000 connections, ten in parallel
 983                                 initiators = 10
 984                                 iterations = 1000
 985                                 # use a delay of 100ms, overall time is:
 986                                 # iterations * delay = 100s
 987                                 delay = 100
 988                                 # address of the gateway
 989                                 remote = 1.2.3.4
 990                                 # IKE-proposal to use
 991                                 proposal = aes128-sha1-modp1024
 992                                 # use faster PSK authentication instead
 993                                 # of 1024bit RSA
 994                                 initiator_auth = psk
 995                                 responder_auth = psk
 996                                 # request a virtual IP using configuration
 997                                 # payloads
 998                                 request_virtual_ip = yes
 999                                 # enable CHILD_SA every 60s
1000                                 child_rekey = 60
1001                         }
1002                 }
1003         }
1004 .EE
1005
1006 .SH IKEv2 RETRANSMISSION
1007 Retransmission timeouts in the IKEv2 daemon charon can be configured globally
1008 using the three keys listed below:
1009 .PP
1010 .RS
1011 .nf
1012 .BR charon.retransmit_base " [1.8]"
1013 .BR charon.retransmit_timeout " [4.0]"
1014 .BR charon.retransmit_tries " [5]"
1015 .fi
1016 .RE
1017 .PP
1018 The following algorithm is used to calculate the timeout:
1019 .PP
1020 .EX
1021         relative timeout = retransmit_timeout * retransmit_base ^ (n-1)
1022 .EE
1023 .PP
1024 Where
1025 .I n
1026 is the current retransmission count.
1027 .PP
1028 Using the default values, packets are retransmitted in:
1029
1030 .TS
1031 l r r
1032 ---
1033 lB r r.
1034 Retransmission  Relative Timeout        Absolute Timeout
1035 1       4s      4s
1036 2       7s      11s
1037 3       13s     24s
1038 4       23s     47s
1039 5       42s     89s
1040 giving up       76s     165s
1041 .TE
1042
1043 .SH FILES
1044 /etc/strongswan.conf
1045
1046 .SH SEE ALSO
1047 ipsec.conf(5), ipsec.secrets(5), ipsec(8)
1048 .SH HISTORY
1049 Written for the
1050 .UR http://www.strongswan.org
1051 strongSwan project
1052 .UE
1053 by Tobias Brunner, Andreas Steffen and Martin Willi.