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