man/strongswan.conf.5.in

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