man/strongswan.conf.5.in

   1 .TH STRONGSWAN.CONF 5 "2012-05-01" "@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 attest section
 130 .TP
 131 .BR attest.database
 132 Path to database with file measurement information
 133 .TP
 134 .BR attest.load
 135 Plugins to load in ipsec attest tool
 136 .SS charon section
 137 .TP
 138 .BR charon.block_threshold " [5]"
 139 Maximum number of half-open IKE_SAs for a single peer IP
 140 .TP
 141 .BR charon.cisco_unity " [no]
 142 Send Cisco Unity vendor ID payload (IKEv1 only)
 143 .TP
 144 .BR charon.close_ike_on_child_failure " [no]"
 145 Close the IKE_SA if setup of the CHILD_SA along with IKE_AUTH failed
 146 .TP
 147 .BR charon.cookie_threshold " [10]"
 148 Number of half-open IKE_SAs that activate the cookie mechanism
 149 .TP
 150 .BR charon.dns1
 151 .TQ
 152 .BR charon.dns2
 153 DNS servers assigned to peer via configuration payload (CP)
 154 .TP
 155 .BR charon.dos_protection " [yes]"
 156 Enable Denial of Service protection using cookies and aggressiveness checks
 157 .TP
 158 .BR charon.filelog
 159 Section to define file loggers, see LOGGER CONFIGURATION
 160 .TP
 161 .BR charon.flush_auth_cfg " [no]"
 162
 163 .TP
 164 .BR charon.half_open_timeout " [30]"
 165 Timeout in seconds for connecting IKE_SAs (also see IKE_SA_INIT DROPPING).
 166 .TP
 167 .BR charon.hash_and_url " [no]"
 168 Enable hash and URL support
 169 .TP
 170 .BR charon.i_dont_care_about_security_and_use_aggressive_mode_psk " [no]"
 171 If enabled responders are allowed to use IKEv1 Aggressive Mode with pre-shared
 172 keys, which is discouraged due to security concerns (offline attacks on the
 173 openly transmitted hash of the PSK)
 174 .TP
 175 .BR charon.ignore_routing_tables
 176 A list of routing tables to be excluded from route lookup
 177 .TP
 178 .BR charon.ikesa_table_segments " [1]"
 179 Number of exclusively locked segments in the hash table
 180 .TP
 181 .BR charon.ikesa_table_size " [1]"
 182 Size of the IKE_SA hash table
 183 .TP
 184 .BR charon.inactivity_close_ike " [no]"
 185 Whether to close IKE_SA if the only CHILD_SA closed due to inactivity
 186 .TP
 187 .BR charon.init_limit_half_open " [0]"
 188 Limit new connections based on the current number of half open IKE_SAs (see
 189 IKE_SA_INIT DROPPING).
 190 .TP
 191 .BR charon.init_limit_job_load " [0]"
 192 Limit new connections based on the number of jobs currently queued for
 193 processing (see IKE_SA_INIT DROPPING).
 194 .TP
 195 .BR charon.install_routes " [yes]"
 196 Install routes into a separate routing table for established IPsec tunnels
 197 .TP
 198 .BR charon.install_virtual_ip " [yes]"
 199 Install virtual IP addresses
 200 .TP
 201 .BR charon.keep_alive " [20s]"
 202 NAT keep alive interval
 203 .TP
 204 .BR charon.load
 205 Plugins to load in the IKEv2 daemon charon
 206 .TP
 207 .BR charon.max_packet " [10000]"
 208 Maximum packet size accepted by charon
 209 .TP
 210 .BR charon.multiple_authentication " [yes]"
 211 Enable multiple authentication exchanges (RFC 4739)
 212 .TP
 213 .BR charon.nbns1
 214 .TQ
 215 .BR charon.nbns2
 216 WINS servers assigned to peer via configuration payload (CP)
 217 .TP
 218 .BR charon.port " [500]"
 219 UDP port used locally. If set to 0 a random port will be allocated.
 220 .TP
 221 .BR charon.port_nat_t " [4500]"
 222 UDP port used locally in case of NAT-T. If set to 0 a random port will be
 223 allocated.  Has to be different from
 224 .BR charon.port ,
 225 otherwise a random port will be allocated.
 226 .TP
 227 .BR charon.process_route " [yes]"
 228 Process RTM_NEWROUTE and RTM_DELROUTE events
 229 .TP
 230 .BR charon.receive_delay " [0]"
 231 Delay for receiving packets, to simulate larger RTT
 232 .TP
 233 .BR charon.receive_delay_response " [yes]"
 234 Delay response messages
 235 .TP
 236 .BR charon.receive_delay_request " [yes]"
 237 Delay request messages
 238 .TP
 239 .BR charon.receive_delay_type " [0]"
 240 Specific IKEv2 message type to delay, 0 for any
 241 .TP
 242 .BR charon.replay_window " [32]"
 243 Size of the AH/ESP replay window, in packets.
 244 .TP
 245 .BR charon.retransmit_base " [1.8]"
 246 Base to use for calculating exponential back off, see IKEv2 RETRANSMISSION
 247 .TP
 248 .BR charon.retransmit_timeout " [4.0]
 249 Timeout in seconds before sending first retransmit
 250 .TP
 251 .BR charon.retransmit_tries " [5]"
 252 Number of times to retransmit a packet before giving up
 253 .TP
 254 .BR charon.retry_initiate_interval " [0]"
 255 Interval to use when retrying to initiate an IKE_SA (e.g. if DNS resolution
 256 failed), 0 to disable retries.
 257 .TP
 258 .BR charon.reuse_ikesa " [yes]
 259 Initiate CHILD_SA within existing IKE_SAs
 260 .TP
 261 .BR charon.routing_table
 262 Numerical routing table to install routes to
 263 .TP
 264 .BR charon.routing_table_prio
 265 Priority of the routing table
 266 .TP
 267 .BR charon.send_delay " [0]"
 268 Delay for sending packets, to simulate larger RTT
 269 .TP
 270 .BR charon.send_delay_response " [yes]"
 271 Delay response messages
 272 .TP
 273 .BR charon.send_delay_request " [yes]"
 274 Delay request messages
 275 .TP
 276 .BR charon.send_delay_type " [0]"
 277 Specific IKEv2 message type to delay, 0 for any
 278 .TP
 279 .BR charon.send_vendor_id " [no]
 280 Send strongSwan vendor ID payload
 281 .TP
 282 .BR charon.syslog
 283 Section to define syslog loggers, see LOGGER CONFIGURATION
 284 .TP
 285 .BR charon.threads " [16]"
 286 Number of worker threads in charon
 287 .SS charon.plugins subsection
 288 .TP
 289 .BR charon.plugins.android_log.loglevel " [1]"
 290 Loglevel for logging to Android specific logger
 291 .TP
 292 .BR charon.plugins.attr
 293 Section to specify arbitrary attributes that are assigned to a peer via
 294 configuration payload (CP)
 295 .TP
 296 .BR charon.plugins.certexpire.csv.cron
 297 Cron style string specifying CSV export times
 298 .TP
 299 .BR charon.plugins.certexpire.csv.local
 300 strftime(3) format string for the CSV file name to export local certificates to
 301 .TP
 302 .BR charon.plugins.certexpire.csv.remote
 303 strftime(3) format string for the CSV file name to export remote certificates to
 304 .TP
 305 .BR charon.plugins.certexpire.csv.separator " [,]"
 306 CSV field separator
 307 .TP
 308 .BR charon.plugins.certexpire.csv.empty_string
 309 String to use in empty intermediate CA fields
 310 .TP
 311 .BR charon.plugins.certexpire.csv.format " [%d:%m:%Y]"
 312 strftime(3) format string to export expiration dates as
 313 .TP
 314 .BR charon.plugins.certexpire.csv.fixed_fields " [yes]"
 315 Use a fixed intermediate CA field count
 316 .TP
 317 .BR charon.plugins.coupling.file
 318 File to store coupling list to
 319 .TP
 320 .BR charon.plugins.coupling.hash " [sha1]"
 321 Hashing algorithm to fingerprint coupled certificates
 322 .TP
 323 .BR charon.plugins.coupling.max " [1]"
 324 Maximum number of coupling entries to create
 325 .TP
 326 .BR charon.plugins.dhcp.force_server_address " [no]"
 327 Always use the configured server address. This might be helpful if the DHCP
 328 server runs on the same host as strongSwan, and the DHCP daemon does not listen
 329 on the loopback interface.  In that case the server cannot be reached via
 330 unicast (or even 255.255.255.255) as that would be routed via loopback.
 331 Setting this option to yes and configuring the local broadcast address (e.g.
 332 192.168.0.255) as server address might work.
 333 .TP
 334 .BR charon.plugins.dhcp.identity_lease " [no]"
 335 Derive user-defined MAC address from hash of IKEv2 identity
 336 .TP
 337 .BR charon.plugins.dhcp.server " [255.255.255.255]"
 338 DHCP server unicast or broadcast IP address
 339 .TP
 340 .BR charon.plugins.duplicheck.enable " [yes]"
 341 Enable duplicheck plugin (if loaded)
 342 .TP
 343 .BR charon.plugins.eap-aka.request_identity " [yes]"
 344
 345 .TP
 346 .BR charon.plugins.eap-aka-3ggp2.seq_check
 347
 348 .TP
 349 .BR charon.plugins.eap-dynamic.preferred
 350 The preferred EAP method(s) to be used.  If it is not given the first
 351 registered method will be used initially.  If a comma separated list is given
 352 the methods are tried in the given order before trying the rest of the
 353 registered methods.
 354 .TP
 355 .BR charon.plugins.eap-dynamic.prefer_user " [no]"
 356 If enabled the EAP methods proposed in an EAP-Nak message sent by the peer are
 357 preferred over the methods registered locally.
 358 .TP
 359 .BR charon.plugins.eap-gtc.backend " [pam]"
 360 XAuth backend to be used for credential verification
 361 .TP
 362 .BR charon.plugins.eap-peap.fragment_size " [1024]"
 363 Maximum size of an EAP-PEAP packet
 364 .TP
 365 .BR charon.plugins.eap-peap.max_message_count " [32]"
 366 Maximum number of processed EAP-PEAP packets (0 = no limit)
 367 .TP
 368 .BR charon.plugins.eap-peap.include_length " [no]"
 369 Include length in non-fragmented EAP-PEAP packets
 370 .TP
 371 .BR charon.plugins.eap-peap.phase2_method " [mschapv2]"
 372 Phase2 EAP client authentication method
 373 .TP
 374 .BR charon.plugins.eap-peap.phase2_piggyback " [no]"
 375 Phase2 EAP Identity request piggybacked by server onto TLS Finished message
 376 .TP
 377 .BR charon.plugins.eap-peap.phase2_tnc " [no]"
 378 Start phase2 EAP TNC protocol after successful client authentication
 379 .TP
 380 .BR charon.plugins.eap-peap.request_peer_auth " [no]"
 381 Request peer authentication based on a client certificate
 382
 383 .TP
 384 .BR charon.plugins.eap-radius.accounting " [no]"
 385 Send RADIUS accounting information to RADIUS servers.
 386 .TP
 387 .BR charon.plugins.eap-radius.class_group " [no]"
 388 Use the
 389 .I class
 390 attribute sent in the RADIUS-Accept message as group membership information that
 391 is compared to the groups specified in the
 392 .B rightgroups
 393 option in
 394 .B ipsec.conf (5).
 395 .TP
 396 .BR charon.plugins.eap-radius.dae.enable " [no]"
 397 Enables support for the Dynamic Authorization Extension (RFC 5176)
 398 .TP
 399 .BR charon.plugins.eap-radius.dae.listen " [0.0.0.0]"
 400 Address to listen for DAE messages from the RADIUS server
 401 .TP
 402 .BR charon.plugins.eap-radius.dae.port " [3799]"
 403 Port to listen for DAE requests
 404 .TP
 405 .BR charon.plugins.eap-radius.dae.secret
 406 Shared secret used to verify/sign DAE messages
 407 .TP
 408 .BR charon.plugins.eap-radius.eap_start " [no]"
 409 Send EAP-Start instead of EAP-Identity to start RADIUS conversation
 410 .TP
 411 .BR charon.plugins.eap-radius.filter_id " [no]"
 412 If the RADIUS
 413 .I tunnel_type
 414 attribute with value
 415 .B ESP
 416 is received, use the
 417 .I filter_id
 418 attribute sent in the RADIUS-Accept message as group membership information that
 419 is compared to the groups specified in the
 420 .B rightgroups
 421 option in
 422 .B ipsec.conf (5).
 423 .TP
 424 .BR charon.plugins.eap-radius.forward.ike_to_radius
 425 RADIUS attributes to be forwarded from IKEv2 to RADIUS (can be defined by
 426 name or attribute number, a colon can be used to specify vendor-specific
 427 attributes, e.g. Reply-Message, or 11, or 36906:12).
 428 .TP
 429 .BR charon.plugins.eap-radius.forward.radius_to_ike
 430 Same as charon.plugins.eap-radius.forward.ike_to_radius but from RADIUS to
 431 IKEv2, a strongSwan specific private notify (40969) is used to transmit the
 432 attributes.
 433 .TP
 434 .BR charon.plugins.eap-radius.id_prefix
 435 Prefix to EAP-Identity, some AAA servers use a IMSI prefix to select the
 436 EAP method
 437 .TP
 438 .BR charon.plugins.eap-radius.nas_identifier " [strongSwan]"
 439 NAS-Identifier to include in RADIUS messages
 440 .TP
 441 .BR charon.plugins.eap-radius.port " [1812]"
 442 Port of RADIUS server (authentication)
 443 .TP
 444 .BR charon.plugins.eap-radius.secret
 445 Shared secret between RADIUS and NAS
 446 .TP
 447 .BR charon.plugins.eap-radius.server
 448 IP/Hostname of RADIUS server
 449 .TP
 450 .BR charon.plugins.eap-radius.servers
 451 Section to specify multiple RADIUS servers. The
 452 .BR nas_identifier ,
 453 .BR secret ,
 454 .B sockets
 455 and
 456 .B port
 457 options can be specified for each server. A server's IP/Hostname can be
 458 configured using the
 459 .B address
 460 option. For each RADIUS server a priority can be specified using the
 461 .BR preference " [0]"
 462 option.
 463 .TP
 464 .BR charon.plugins.eap-radius.sockets " [1]"
 465 Number of sockets (ports) to use, increase for high load
 466 .TP
 467 .BR charon.plugins.eap-sim.request_identity " [yes]"
 468
 469 .TP
 470 .BR charon.plugins.eap-simaka-sql.database
 471
 472 .TP
 473 .BR charon.plugins.eap-simaka-sql.remove_used " [no]"
 474
 475 .TP
 476 .BR charon.plugins.eap-tls.fragment_size " [1024]"
 477 Maximum size of an EAP-TLS packet
 478 .TP
 479 .BR charon.plugins.eap-tls.max_message_count " [32]"
 480 Maximum number of processed EAP-TLS packets (0 = no limit)
 481 .TP
 482 .BR charon.plugins.eap-tls.include_length " [yes]"
 483 Include length in non-fragmented EAP-TLS packets
 484 .TP
 485 .BR charon.plugins.eap-tnc.max_message_count " [10]"
 486 Maximum number of processed EAP-TNC packets (0 = no limit)
 487 .TP
 488 .BR charon.plugins.eap-tnc.protocol " [tnccs-1.1]"
 489 IF-TNCCS protocol version to be used (tnccs-1.1, tnccs-2.0, tnccs-dynamic)
 490 .TP
 491 .BR charon.plugins.eap-ttls.fragment_size " [1024]"
 492 Maximum size of an EAP-TTLS packet
 493 .TP
 494 .BR charon.plugins.eap-ttls.max_message_count " [32]"
 495 Maximum number of processed EAP-TTLS packets (0 = no limit)
 496 .TP
 497 .BR charon.plugins.eap-ttls.include_length " [yes]"
 498 Include length in non-fragmented EAP-TTLS packets
 499 .TP
 500 .BR charon.plugins.eap-ttls.phase2_method " [md5]"
 501 Phase2 EAP client authentication method
 502 .TP
 503 .BR charon.plugins.eap-ttls.phase2_piggyback " [no]"
 504 Phase2 EAP Identity request piggybacked by server onto TLS Finished message
 505 .TP
 506 .BR charon.plugins.eap-ttls.phase2_tnc " [no]"
 507 Start phase2 EAP TNC protocol after successful client authentication
 508 .TP
 509 .BR charon.plugins.eap-ttls.request_peer_auth " [no]"
 510 Request peer authentication based on a client certificate
 511 .TP
 512 .BR charon.plugins.ha.fifo_interface " [yes]"
 513
 514 .TP
 515 .BR charon.plugins.ha.heartbeat_delay " [1000]"
 516
 517 .TP
 518 .BR charon.plugins.ha.heartbeat_timeout " [2100]"
 519
 520 .TP
 521 .BR charon.plugins.ha.local
 522
 523 .TP
 524 .BR charon.plugins.ha.monitor " [yes]"
 525
 526 .TP
 527 .BR charon.plugins.ha.pools
 528
 529 .TP
 530 .BR charon.plugins.ha.remote
 531
 532 .TP
 533 .BR charon.plugins.ha.resync " [yes]"
 534
 535 .TP
 536 .BR charon.plugins.ha.secret
 537
 538 .TP
 539 .BR charon.plugins.ha.segment_count " [1]"
 540
 541 .TP
 542 .BR charon.plugins.led.activity_led
 543
 544 .TP
 545 .BR charon.plugins.led.blink_time " [50]"
 546
 547 .TP
 548 .BR charon.plugins.kernel-klips.ipsec_dev_count " [4]"
 549 Number of ipsecN devices
 550 .TP
 551 .BR charon.plugins.kernel-klips.ipsec_dev_mtu " [0]"
 552 Set MTU of ipsecN device
 553 .TP
 554 .BR charon.plugins.load-tester
 555 Section to configure the load-tester plugin, see LOAD TESTS
 556 .TP
 557 .BR charon.plugins.radattr.dir
 558 Directory where RADIUS attributes are stored in client-ID specific files.
 559 .TP
 560 .BR charon.plugins.radattr.message_id " [-1]"
 561 Attributes are added to all IKE_AUTH messages by default (-1), or only to the
 562 IKE_AUTH message with the given IKEv2 message ID.
 563 .TP
 564 .BR charon.plugins.resolve.file " [/etc/resolv.conf]"
 565 File where to add DNS server entries
 566 .TP
 567 .BR charon.plugins.resolve.resolvconf.iface_prefix " [lo.inet.ipsec.]"
 568 Prefix used for interface names sent to resolvconf(8). The nameserver address
 569 is appended to this prefix to make it unique.  The result has to be a valid
 570 interface name according to the rules defined by resolvconf.  Also, it should
 571 have a high priority according to the order defined in interface-order(5).
 572 .TP
 573 .BR charon.plugins.socket-default.set_source " [yes]"
 574 Set source address on outbound packets, if possible.
 575 .TP
 576 .BR charon.plugins.sql.database
 577 Database URI for charons SQL plugin
 578 .TP
 579 .BR charon.plugins.sql.loglevel " [-1]"
 580 Loglevel for logging to SQL database
 581 .TP
 582 .BR charon.plugins.stroke.ignore_missing_ca_basic_constraint " [no]"
 583 Treat certificates in ipsec.d/cacerts and ipsec.conf ca sections as CA
 584 certificates even if they don't contain a CA basic constraint.
 585 .TP
 586 .BR charon.plugins.stroke.max_concurrent " [4]"
 587 Maximum number of stroke messages handled concurrently
 588 .TP
 589 .BR charon.plugins.tnccs-11.max_message_size " [45000]"
 590 Maximum size of a PA-TNC message (XML & Base64 encoding)
 591 .TP
 592 .BR charon.plugins.tnccs-20.max_batch_size " [65522]"
 593 Maximum size of a PB-TNC batch (upper limit via PT-EAP = 65529)
 594 .TP
 595 .BR charon.plugins.tnccs-20.max_message_size " [65490]"
 596 Maximum size of a PA-TNC message (upper limit via PT-EAP = 65497)
 597 .TP
 598 .BR charon.plugins.tnc-ifmap.device_name
 599 Unique name of strongSwan as a PEP and/or PDP device
 600 .TP
 601 .BR charon.plugins.tnc-ifmap.key_file
 602 Concatenated client certificate and private key
 603 .TP
 604 .BR charon.plugins.tnc-ifmap.password
 605 Authentication password of strongSwan MAP client
 606 .TP
 607 .BR charon.plugins.tnc-ifmap.server_cert
 608 Certificate of MAP server
 609 .TP
 610 .BR charon.plugins.tnc-ifmap.ssl_passphrase
 611 Passphrase protecting the private key
 612 .TP
 613 .BR charon.plugins.tnc-ifmap.username
 614 Authentication username of strongSwan MAP client
 615 .TP
 616 .BR charon.plugins.tnc-imc.preferred_language " [en]"
 617 Preferred language for TNC recommendations
 618 .TP
 619 .BR charon.plugins.tnc-pdp.method " [ttls]"
 620 EAP tunnel method to be used
 621 .TP
 622 .BR charon.plugins.tnc-pdp.port " [1812]"
 623 RADIUS server port the strongSwan PDP is listening on
 624 .TP
 625 .BR charon.plugins.tnc-pdp.secret
 626 Shared RADIUS secret between strongSwan PDP and NAS
 627 .TP
 628 .BR charon.plugins.tnc-pdp.server
 629 Name of the strongSwan PDP as contained in the AAA certificate
 630 .TP
 631 .BR charon.plugins.updown.dns_handler " [no]"
 632 Whether the updown script should handle DNS serves assigned via IKEv1 Mode
 633 Config or IKEv2 Config Payloads (if enabled they can't be handled by other
 634 plugins, like resolve)
 635 .TP
 636 .BR charon.plugins.whitelist.enable " [yes]"
 637 Enable loaded whitelist plugin
 638 .TP
 639 .BR charon.plugins.xauth-eap.backend " [radius]"
 640 EAP plugin to be used as backend for XAuth credential verification
 641 .TP
 642 .BR charon.plugins.xauth-pam.pam_service " [login]"
 643 PAM service to be used for authentication
 644 .SS libstrongswan section
 645 .TP
 646 .BR libstrongswan.cert_cache " [yes]"
 647 Whether relations in validated certificate chains should be cached in memory
 648 .TP
 649 .BR libstrongswan.crypto_test.bench " [no]"
 650
 651 .TP
 652 .BR libstrongswan.crypto_test.bench_size " [1024]"
 653
 654 .TP
 655 .BR libstrongswan.crypto_test.bench_time " [50]"
 656
 657 .TP
 658 .BR libstrongswan.crypto_test.on_add " [no]"
 659 Test crypto algorithms during registration
 660 .TP
 661 .BR libstrongswan.crypto_test.on_create " [no]"
 662 Test crypto algorithms on each crypto primitive instantiation
 663 .TP
 664 .BR libstrongswan.crypto_test.required " [no]"
 665 Strictly require at least one test vector to enable an algorithm
 666 .TP
 667 .BR libstrongswan.crypto_test.rng_true " [no]"
 668 Whether to test RNG with TRUE quality; requires a lot of entropy
 669 .TP
 670 .BR libstrongswan.dh_exponent_ansi_x9_42 " [yes]"
 671 Use ANSI X9.42 DH exponent size or optimum size matched to cryptographical
 672 strength
 673 .TP
 674 .BR libstrongswan.ecp_x_coordinate_only " [yes]"
 675 Compliance with the errata for RFC 4753
 676 .TP
 677 .BR libstrongswan.integrity_test " [no]"
 678 Check daemon, libstrongswan and plugin integrity at startup
 679 .TP
 680 .BR libstrongswan.leak_detective.detailed " [yes]"
 681 Includes source file names and line numbers in leak detective output
 682 .TP
 683 .BR libstrongswan.leak_detective.usage_threshold " [10240]"
 684 Threshold in bytes for leaks to be reported (0 to report all)
 685 .TP
 686 .BR libstrongswan.processor.priority_threads
 687 Subsection to configure the number of reserved threads per priority class
 688 see JOB PRIORITY MANAGEMENT
 689 .TP
 690 .BR libstrongswan.x509.enforce_critical " [yes]"
 691 Discard certificates with unsupported or unknown critical extensions
 692 .SS libstrongswan.plugins subsection
 693 .TP
 694 .BR libstrongswan.plugins.attr-sql.database
 695 Database URI for attr-sql plugin used by charon
 696 .TP
 697 .BR libstrongswan.plugins.attr-sql.lease_history " [yes]"
 698 Enable logging of SQL IP pool leases
 699 .TP
 700 .BR libstrongswan.plugins.gcrypt.quick_random " [no]"
 701 Use faster random numbers in gcrypt; for testing only, produces weak keys!
 702 .TP
 703 .BR libstrongswan.plugins.openssl.engine_id " [pkcs11]"
 704 ENGINE ID to use in the OpenSSL plugin
 705 .TP
 706 .BR libstrongswan.plugins.pkcs11.modules
 707 List of available PKCS#11 modules
 708 .TP
 709 .BR libstrongswan.plugins.pkcs11.use_dh " [no]"
 710 Whether the PKCS#11 modules should be used for DH and ECDH (see use_ecc option)
 711 .TP
 712 .BR libstrongswan.plugins.pkcs11.use_ecc " [no]"
 713 Whether the PKCS#11 modules should be used for ECDH and ECDSA public key
 714 operations. ECDSA private keys can be used regardless of this option
 715 .TP
 716 .BR libstrongswan.plugins.pkcs11.use_hasher " [no]"
 717 Whether the PKCS#11 modules should be used to hash data
 718 .TP
 719 .BR libstrongswan.plugins.pkcs11.use_pubkey " [no]"
 720 Whether the PKCS#11 modules should be used for public key operations, even for
 721 keys not stored on tokens
 722 .TP
 723 .BR libstrongswan.plugins.pkcs11.use_rng " [no]"
 724 Whether the PKCS#11 modules should be used as RNG
 725 .TP
 726 .BR libstrongswan.plugins.random.random " [@DEV_RANDOM@]"
 727 File to read random bytes from, instead of @DEV_RANDOM@
 728 .TP
 729 .BR libstrongswan.plugins.random.urandom " [@DEV_URANDOM@]"
 730 File to read pseudo random bytes from, instead of @DEV_URANDOM@
 731 .SS libtnccs section
 732 .TP
 733 .BR libtnccs.tnc_config " [/etc/tnc_config]"
 734 TNC IMC/IMV configuration directory
 735 .SS libimcv section
 736 .TP
 737 .BR libimcv.assessment_result " [yes]"
 738 Whether IMVs send a standard IETF Assessment Result attribute
 739 .TP
 740 .BR libimcv.debug_level " [1]"
 741 Debug level for a stand-alone libimcv library
 742 .TP
 743 .BR libimcv.stderr_quiet " [no]"
 744 Disable output to stderr with a stand-alone libimcv library
 745 .SS libimcv plugins section
 746 .TP
 747 .BR libimcv.plugins.imc-attestation.platform_info
 748 Information on operating system and hardware platform
 749 .TP
 750 .BR libimcv.plugins.imc-attestation.aik_blob
 751 AIK encrypted private key blob file
 752 .TP
 753 .BR libimcv.plugins.imc-attestation.aik_cert
 754 AIK certificate file
 755 .TP
 756 .BR libimcv.plugins.imc-attestation.aik_key
 757 AIK public key file
 758 .TP
 759 .BR libimcv.plugins.imv-attestation.nonce_len " [20]"
 760 DH nonce length
 761 .TP
 762 .BR libimcv.plugins.imv-attestation.use_quote2 " [yes]"
 763 Use Quote2 AIK signature instead of Quote signature
 764 .TP
 765 .BR libimcv.plugins.imv-attestation.cadir
 766 Path to directory with AIK cacerts
 767 .TP
 768 .BR libimcv.plugins.imv-attestation.database
 769 Path to database with file measurement information
 770 .TP
 771 .BR libimcv.plugins.imv-attestation.dh_group " [ecp256]"
 772 Preferred Diffie-Hellman group
 773 .TP
 774 .BR libimcv.plugins.imv-attestation.hash_algorithm " [sha256]"
 775 Preferred measurement hash algorithm
 776 .TP
 777 .BR libimcv.plugins.imv-attestation.min_nonce_len " [0]"
 778 DH minimum nonce length
 779 .TP
 780 .BR libimcv.plugins.imv-attestation.platform_info
 781 Information on operating system and hardware platform
 782 .TP
 783 .BR libimcv.plugins.imv-scanner.closed_port_policy " [yes]"
 784 By default all ports must be closed (yes) or can be open (no)
 785 .TP
 786 .BR libimcv.plugins.imv-scanner.tcp_ports
 787 List of TCP ports that can be open or must be closed
 788 .TP
 789 .BR libimcv.plugins.imv-scanner.udp_ports
 790 List of UDP ports that can be open or must be closed
 791 .TP
 792 .BR libimcv.plugins.imc-test.additional_ids " [0]"
 793 Number of additional IMC IDs
 794 .TP
 795 .BR libimcv.plugins.imc-test.command " [none]"
 796 Command to be sent to the Test IMV
 797 .TP
 798 .BR libimcv.plugins.imc-test.dummy_size " [0]"
 799 Size of dummy attribute to be sent to the Test IMV (0 = disabled)
 800 .TP
 801 .BR libimcv.plugins.imc-test.retry " [no]"
 802 Do a handshake retry
 803 .TP
 804 .BR libimcv.plugins.imc-test.retry_command
 805 Command to be sent to the Test IMV in the handshake retry
 806 .TP
 807 .BR libimcv.plugins.imv-test.rounds " [0]"
 808 Number of IMC-IMV retry rounds
 809 .SS libtls section
 810 .TP
 811 .BR libtls.cipher
 812 List of TLS encryption ciphers
 813 .TP
 814 .BR libtls.key_exchange
 815 List of TLS key exchange methods
 816 .TP
 817 .BR libtls.mac
 818 List of TLS MAC algorithms
 819 .TP
 820 .BR libtls.suites
 821 List of TLS cipher suites
 822 .SS manager section
 823 .TP
 824 .BR manager.database
 825 Credential database URI for manager
 826 .TP
 827 .BR manager.debug " [no]"
 828 Enable debugging in manager
 829 .TP
 830 .BR manager.load
 831 Plugins to load in manager
 832 .TP
 833 .BR manager.socket
 834 FastCGI socket of manager, to run it statically
 835 .TP
 836 .BR manager.threads " [10]"
 837 Threads to use for request handling
 838 .TP
 839 .BR manager.timeout " [15m]"
 840 Session timeout for manager
 841 .SS mediation client section
 842 .TP
 843 .BR medcli.database
 844 Mediation client database URI
 845 .TP
 846 .BR medcli.dpd " [5m]"
 847 DPD timeout to use in mediation client plugin
 848 .TP
 849 .BR medcli.rekey " [20m]"
 850 Rekeying time on mediation connections in mediation client plugin
 851 .SS mediation server section
 852 .TP
 853 .BR medsrv.database
 854 Mediation server database URI
 855 .TP
 856 .BR medsrv.debug " [no]"
 857 Debugging in mediation server web application
 858 .TP
 859 .BR medsrv.dpd " [5m]"
 860 DPD timeout to use in mediation server plugin
 861 .TP
 862 .BR medsrv.load
 863 Plugins to load in mediation server plugin
 864 .TP
 865 .BR medsrv.password_length " [6]"
 866 Minimum password length required for mediation server user accounts
 867 .TP
 868 .BR medsrv.rekey " [20m]"
 869 Rekeying time on mediation connections in mediation server plugin
 870 .TP
 871 .BR medsrv.socket
 872 Run Mediation server web application statically on socket
 873 .TP
 874 .BR medsrv.threads " [5]"
 875 Number of thread for mediation service web application
 876 .TP
 877 .BR medsrv.timeout " [15m]"
 878 Session timeout for mediation service
 879 .SS openac section
 880 .TP
 881 .BR openac.load
 882 Plugins to load in ipsec openac tool
 883 .SS pki section
 884 .TP
 885 .BR pki.load
 886 Plugins to load in ipsec pki tool
 887 .SS pool section
 888 .TP
 889 .BR pool.load
 890 Plugins to load in ipsec pool tool
 891 .SS scepclient section
 892 .TP
 893 .BR scepclient.load
 894 Plugins to load in ipsec scepclient tool
 895 .SS starter section
 896 .TP
 897 .BR starter.load
 898 Plugins to load in starter
 899 .TP
 900 .BR starter.load_warning " [yes]"
 901 Disable charon plugin load option warning
 902
 903 .SH LOGGER CONFIGURATION
 904 The options described below provide a much more flexible way to configure
 905 loggers for the IKEv2 daemon charon than using the
 906 .B charondebug
 907 option in
 908 .BR ipsec.conf (5).
 909 .PP
 910 .B Please note
 911 that if any loggers are specified in strongswan.conf,
 912 .B charondebug
 913 does not have any effect.
 914 .PP
 915 There are currently two types of loggers defined:
 916 .TP
 917 .B File loggers
 918 Log directly to a file and are defined by specifying the full path to the
 919 file as subsection in the
 920 .B charon.filelog
 921 section. To log to the console the two special filenames
 922 .BR stdout " and " stderr
 923 can be used.
 924 .TP
 925 .B Syslog loggers
 926 Log into a syslog facility and are defined by specifying the facility to log to
 927 as the name of a subsection in the
 928 .B charon.syslog
 929 section. The following facilities are currently supported:
 930 .BR daemon " and " auth .
 931 .PP
 932 Multiple loggers can be defined for each type with different log verbosity for
 933 the different subsystems of the daemon.
 934 .SS Options
 935 .TP
 936 .BR charon.filelog.<filename>.default " [1]"
 937 .TQ
 938 .BR charon.syslog.<facility>.default
 939 Specifies the default loglevel to be used for subsystems for which no specific
 940 loglevel is defined.
 941 .TP
 942 .BR charon.filelog.<filename>.<subsystem> " [<default>]"
 943 .TQ
 944 .BR charon.syslog.<facility>.<subsystem>
 945 Specifies the loglevel for the given subsystem.
 946 .TP
 947 .BR charon.filelog.<filename>.append " [yes]"
 948 If this option is enabled log entries are appended to the existing file.
 949 .TP
 950 .BR charon.filelog.<filename>.flush_line " [no]"
 951 Enabling this option disables block buffering and enables line buffering.
 952 .TP
 953 .BR charon.filelog.<filename>.ike_name " [no]"
 954 .TQ
 955 .BR charon.syslog.<facility>.ike_name
 956 Prefix each log entry with the connection name and a unique numerical
 957 identifier for each IKE_SA.
 958 .TP
 959 .BR charon.filelog.<filename>.time_format
 960 Prefix each log entry with a timestamp. The option accepts a format string as
 961 passed to
 962 .BR strftime (3).
 963 .TP
 964 .BR charon.syslog.identifier
 965 Global identifier used for an
 966 .BR openlog (3)
 967 call, prepended to each log message by syslog.  If not configured,
 968 .BR openlog (3)
 969 is not called, so the value will depend on system defaults (often the program
 970 name).
 971
 972 .SS Subsystems
 973 .TP
 974 .B dmn
 975 Main daemon setup/cleanup/signal handling
 976 .TP
 977 .B mgr
 978 IKE_SA manager, handling synchronization for IKE_SA access
 979 .TP
 980 .B ike
 981 IKE_SA
 982 .TP
 983 .B chd
 984 CHILD_SA
 985 .TP
 986 .B job
 987 Jobs queueing/processing and thread pool management
 988 .TP
 989 .B cfg
 990 Configuration management and plugins
 991 .TP
 992 .B knl
 993 IPsec/Networking kernel interface
 994 .TP
 995 .B net
 996 IKE network communication
 997 .TP
 998 .B asn
 999 Low-level encoding/decoding (ASN.1, X.509 etc.)
1000 .TP
1001 .B enc
1002 Packet encoding/decoding encryption/decryption operations
1003 .TP
1004 .B tls
1005 libtls library messages
1006 .TP
1007 .B esp
1008 libipsec library messages
1009 .TP
1010 .B lib
1011 libstrongwan library messages
1012 .TP
1013 .B tnc
1014 Trusted Network Connect
1015 .TP
1016 .B imc
1017 Integrity Measurement Collector
1018 .TP
1019 .B imv
1020 Integrity Measurement Verifier
1021 .TP
1022 .B pts
1023 Platform Trust Service
1024 .SS Loglevels
1025 .TP
1026 .B -1
1027 Absolutely silent
1028 .TP
1029 .B 0
1030 Very basic auditing logs, (e.g. SA up/SA down)
1031 .TP
1032 .B 1
1033 Generic control flow with errors, a good default to see whats going on
1034 .TP
1035 .B 2
1036 More detailed debugging control flow
1037 .TP
1038 .B 3
1039 Including RAW data dumps in Hex
1040 .TP
1041 .B 4
1042 Also include sensitive material in dumps, e.g. keys
1043 .SS Example
1044 .PP
1045 .EX
1046         charon {
1047                 filelog {
1048                         /var/log/charon.log {
1049                                 time_format = %b %e %T
1050                                 append = no
1051                                 default = 1
1052                         }
1053                         stderr {
1054                                 ike = 2
1055                                 knl = 3
1056                                 ike_name = yes
1057                         }
1058                 }
1059                 syslog {
1060                         # enable logging to LOG_DAEMON, use defaults
1061                         daemon {
1062                         }
1063                         # minimalistic IKE auditing logging to LOG_AUTHPRIV
1064                         auth {
1065                                 default = -1
1066                                 ike = 0
1067                         }
1068                 }
1069         }
1070 .EE
1071
1072 .SH JOB PRIORITY MANAGEMENT
1073 Some operations in the IKEv2 daemon charon are currently implemented
1074 synchronously and blocking. Two examples for such operations are communication
1075 with a RADIUS server via EAP-RADIUS, or fetching CRL/OCSP information during
1076 certificate chain verification. Under high load conditions, the thread pool may
1077 run out of available threads, and some more important jobs, such as liveness
1078 checking, may not get executed in time.
1079 .PP
1080 To prevent thread starvation in such situations job priorities were introduced.
1081 The job processor will reserve some threads for higher priority jobs, these
1082 threads are not available for lower priority, locking jobs.
1083 .SS Implementation
1084 Currently 4 priorities have been defined, and they are used in charon as
1085 follows:
1086 .TP
1087 .B CRITICAL
1088 Priority for long-running dispatcher jobs.
1089 .TP
1090 .B HIGH
1091 INFORMATIONAL exchanges, as used by liveness checking (DPD).
1092 .TP
1093 .B MEDIUM
1094 Everything not HIGH/LOW, including IKE_SA_INIT processing.
1095 .TP
1096 .B LOW
1097 IKE_AUTH message processing. RADIUS and CRL fetching block here
1098 .PP
1099 Although IKE_SA_INIT processing is computationally expensive, it is explicitly
1100 assigned to the MEDIUM class. This allows charon to do the DH exchange while
1101 other threads are blocked in IKE_AUTH. To prevent the daemon from accepting more
1102 IKE_SA_INIT requests than it can handle, use IKE_SA_INIT DROPPING.
1103 .PP
1104 The thread pool processes jobs strictly by priority, meaning it will consume all
1105 higher priority jobs before looking for ones with lower priority. Further, it
1106 reserves threads for certain priorities. A priority class having reserved
1107 .I n
1108 threads will always have
1109 .I n
1110 threads available for this class (either currently processing a job, or waiting
1111 for one).
1112 .SS Configuration
1113 To ensure that there are always enough threads available for higher priority
1114 tasks, threads must be reserved for each priority class.
1115 .TP
1116 .BR libstrongswan.processor.priority_threads.critical " [0]"
1117 Threads reserved for CRITICAL priority class jobs
1118 .TP
1119 .BR libstrongswan.processor.priority_threads.high " [0]"
1120 Threads reserved for HIGH priority class jobs
1121 .TP
1122 .BR libstrongswan.processor.priority_threads.medium " [0]"
1123 Threads reserved for MEDIUM priority class jobs
1124 .TP
1125 .BR libstrongswan.processor.priority_threads.low " [0]"
1126 Threads reserved for LOW priority class jobs
1127 .PP
1128 Let's consider the following configuration:
1129 .PP
1130 .EX
1131         libstrongswan {
1132                 processor {
1133                         priority_threads {
1134                                 high = 1
1135                                 medium = 4
1136                         }
1137                 }
1138         }
1139 .EE
1140 .PP
1141 With this configuration, one thread is reserved for HIGH priority tasks. As
1142 currently only liveness checking and stroke message processing is done with
1143 high priority, one or two threads should be sufficient.
1144 .PP
1145 The MEDIUM class mostly processes non-blocking jobs. Unless your setup is
1146 experiencing many blocks in locks while accessing shared resources, threads for
1147 one or two times the number of CPU cores is fine.
1148 .PP
1149 It is usually not required to reserve threads for CRITICAL jobs. Jobs in this
1150 class rarely return and do not release their thread to the pool.
1151 .PP
1152 The remaining threads are available for LOW priority jobs. Reserving threads
1153 does not make sense (until we have an even lower priority).
1154 .SS Monitoring
1155 To see what the threads are actually doing, invoke
1156 .IR "ipsec statusall" .
1157 Under high load, something like this will show up:
1158 .PP
1159 .EX
1160         worker threads: 2 or 32 idle, 5/1/2/22 working,
1161                 job queue: 0/0/1/149, scheduled: 198
1162 .EE
1163 .PP
1164 From 32 worker threads,
1165 .IP 2
1166 are currently idle.
1167 .IP 5
1168 are running CRITICAL priority jobs (dispatching from sockets, etc.).
1169 .IP 1
1170 is currently handling a HIGH priority job. This is actually the thread currently
1171 providing this information via stroke.
1172 .IP 2
1173 are handling MEDIUM priority jobs, likely IKE_SA_INIT or CREATE_CHILD_SA
1174 messages.
1175 .IP 22
1176 are handling LOW priority jobs, probably waiting for an EAP-RADIUS response
1177 while processing IKE_AUTH messages.
1178 .PP
1179 The job queue load shows how many jobs are queued for each priority, ready for
1180 execution. The single MEDIUM priority job will get executed immediately, as
1181 we have two spare threads reserved for MEDIUM class jobs.
1182
1183 .SH IKE_SA_INIT DROPPING
1184 If a responder receives more connection requests per seconds than it can handle,
1185 it does not make sense to accept more IKE_SA_INIT messages. And if they are
1186 queued but can't get processed in time, an answer might be sent after the
1187 client has already given up and restarted its connection setup. This
1188 additionally increases the load on the responder.
1189 .PP
1190 To limit the responder load resulting from new connection attempts, the daemon
1191 can drop IKE_SA_INIT messages just after reception. There are two mechanisms to
1192 decide if this should happen, configured with the following options:
1193 .TP
1194 .BR charon.init_limit_half_open " [0]"
1195 Limit based on the number of half open IKE_SAs. Half open IKE_SAs are SAs in
1196 connecting state, but not yet established.
1197 .TP
1198 .BR charon.init_limit_job_load " [0]"
1199 Limit based on the number of jobs currently queued for processing (sum over all
1200 job priorities).
1201 .PP
1202 The second limit includes load from other jobs, such as rekeying. Choosing a
1203 good value is difficult and depends on the hardware and expected load.
1204 .PP
1205 The first limit is simpler to calculate, but includes the load from new
1206 connections only. If your responder is capable of negotiating 100 tunnels/s, you
1207 might set this limit to 1000. The daemon will then drop new connection attempts
1208 if generating a response would require more than 10 seconds. If you are
1209 allowing for a maximum response time of more than 30 seconds, consider adjusting
1210 the timeout for connecting IKE_SAs
1211 .RB ( charon.half_open_timeout ).
1212 A responder, by default, deletes an IKE_SA if the initiator does not establish
1213 it within 30 seconds. Under high load, a higher value might be required.
1214
1215 .SH LOAD TESTS
1216 To do stability testing and performance optimizations, the IKEv2 daemon charon
1217 provides the load-tester plugin. This plugin allows one to setup thousands of
1218 tunnels concurrently against the daemon itself or a remote host.
1219 .PP
1220 .B WARNING:
1221 Never enable the load-testing plugin on productive systems. It provides
1222 preconfigured credentials and allows an attacker to authenticate as any user.
1223 .SS Options
1224 .TP
1225 .BR charon.plugins.load-tester.child_rekey " [600]"
1226 Seconds to start CHILD_SA rekeying after setup
1227 .TP
1228 .BR charon.plugins.load-tester.delay " [0]"
1229 Delay between initiatons for each thread
1230 .TP
1231 .BR charon.plugins.load-tester.delete_after_established " [no]"
1232 Delete an IKE_SA as soon as it has been established
1233 .TP
1234 .BR charon.plugins.load-tester.dpd_delay " [0]"
1235 DPD delay to use in load test
1236 .TP
1237 .BR charon.plugins.load-tester.dynamic_port " [0]"
1238 Base port to be used for requests (each client uses a different port)
1239 .TP
1240 .BR charon.plugins.load-tester.eap_password " [default-pwd]"
1241 EAP secret to use in load test
1242 .TP
1243 .BR charon.plugins.load-tester.enable " [no]"
1244 Enable the load testing plugin
1245 .TP
1246 .BR charon.plugins.load-tester.fake_kernel " [no]"
1247 Fake the kernel interface to allow load-testing against self
1248 .TP
1249 .BR charon.plugins.load-tester.ike_rekey " [0]"
1250 Seconds to start IKE_SA rekeying after setup
1251 .TP
1252 .BR charon.plugins.load-tester.init_limit " [0]"
1253 Global limit of concurrently established SAs during load test
1254 .TP
1255 .BR charon.plugins.load-tester.initiators " [0]"
1256 Number of concurrent initiator threads to use in load test
1257 .TP
1258 .BR charon.plugins.load-tester.initiator_auth " [pubkey]"
1259 Authentication method(s) the intiator uses
1260 .TP
1261 .BR charon.plugins.load-tester.initiator_id
1262 Initiator ID used in load test
1263 .TP
1264 .BR charon.plugins.load-tester.iterations " [1]"
1265 Number of IKE_SAs to initate by each initiator in load test
1266 .TP
1267 .BR charon.plugins.load-tester.pool
1268 Provide INTERNAL_IPV4_ADDRs from a named pool
1269 .TP
1270 .BR charon.plugins.load-tester.preshared_key " [default-psk]"
1271 Preshared key to use in load test
1272 .TP
1273 .BR charon.plugins.load-tester.proposal " [aes128-sha1-modp768]"
1274 IKE proposal to use in load test
1275 .TP
1276 .BR charon.plugins.load-tester.remote " [127.0.0.1]"
1277 Address to initiation connections to
1278 .TP
1279 .BR charon.plugins.load-tester.responder_auth " [pubkey]"
1280 Authentication method(s) the responder uses
1281 .TP
1282 .BR charon.plugins.load-tester.responder_id
1283 Responder ID used in load test
1284 .TP
1285 .BR charon.plugins.load-tester.request_virtual_ip " [no]"
1286 Request an INTERNAL_IPV4_ADDR from the server
1287 .TP
1288 .BR charon.plugins.load-tester.shutdown_when_complete " [no]"
1289 Shutdown the daemon after all IKE_SAs have been established
1290 .SS Configuration details
1291 For public key authentication, the responder uses the
1292 .B \(dqCN=srv, OU=load-test, O=strongSwan\(dq
1293 identity. For the initiator, each connection attempt uses a different identity
1294 in the form
1295 .BR "\(dqCN=c1-r1, OU=load-test, O=strongSwan\(dq" ,
1296 where the first number inidicates the client number, the second the
1297 authentication round (if multiple authentication is used).
1298 .PP
1299 For PSK authentication, FQDN identities are used. The server uses
1300 .BR srv.strongswan.org ,
1301 the client uses an identity in the form
1302 .BR c1-r1.strongswan.org .
1303 .PP
1304 For EAP authentication, the client uses a NAI in the form
1305 .BR 100000000010001@strongswan.org .
1306 .PP
1307 To configure multiple authentication, concatenate multiple methods using, e.g.
1308 .EX
1309         initiator_auth = pubkey|psk|eap-md5|eap-aka
1310 .EE
1311 .PP
1312 The responder uses a hardcoded certificate based on a 1024-bit RSA key.
1313 This certificate additionally serves as CA certificate. A peer uses the same
1314 private key, but generates client certificates on demand signed by the CA
1315 certificate. Install the Responder/CA certificate on the remote host to
1316 authenticate all clients.
1317 .PP
1318 To speed up testing, the load tester plugin implements a special Diffie-Hellman
1319 implementation called modpnull. By setting
1320 .EX
1321         proposal = aes128-sha1-modpnull
1322 .EE
1323 this wicked fast DH implementation is used. It does not provide any security
1324 at all, but allows one to run tests without DH calculation overhead.
1325 .SS Examples
1326 .PP
1327 In the simplest case, the daemon initiates IKE_SAs against itself using the
1328 loopback interface. This will actually establish double the number of IKE_SAs,
1329 as the daemon is initiator and responder for each IKE_SA at the same time.
1330 Installation of IPsec SAs would fails, as each SA gets installed twice. To
1331 simulate the correct behavior, a fake kernel interface can be enabled which does
1332 not install the IPsec SAs at the kernel level.
1333 .PP
1334 A simple loopback configuration might look like this:
1335 .PP
1336 .EX
1337         charon {
1338                 # create new IKE_SAs for each CHILD_SA to simulate
1339                 # different clients
1340                 reuse_ikesa = no
1341                 # turn off denial of service protection
1342                 dos_protection = no
1343
1344                 plugins {
1345                         load-tester {
1346                                 # enable the plugin
1347                                 enable = yes
1348                                 # use 4 threads to initiate connections
1349                                 # simultaneously
1350                                 initiators = 4
1351                                 # each thread initiates 1000 connections
1352                                 iterations = 1000
1353                                 # delay each initiation in each thread by 20ms
1354                                 delay = 20
1355                                 # enable the fake kernel interface to
1356                                 # avoid SA conflicts
1357                                 fake_kernel = yes
1358                         }
1359                 }
1360         }
1361 .EE
1362 .PP
1363 This will initiate 4000 IKE_SAs within 20 seconds. You may increase the delay
1364 value if your box can not handle that much load, or decrease it to put more
1365 load on it. If the daemon starts retransmitting messages your box probably can
1366 not handle all connection attempts.
1367 .PP
1368 The plugin also allows one to test against a remote host. This might help to
1369 test against a real world configuration. A connection setup to do stress
1370 testing of a gateway might look like this:
1371 .PP
1372 .EX
1373         charon {
1374                 reuse_ikesa = no
1375                 threads = 32
1376
1377                 plugins {
1378                         load-tester {
1379                                 enable = yes
1380                                 # 10000 connections, ten in parallel
1381                                 initiators = 10
1382                                 iterations = 1000
1383                                 # use a delay of 100ms, overall time is:
1384                                 # iterations * delay = 100s
1385                                 delay = 100
1386                                 # address of the gateway
1387                                 remote = 1.2.3.4
1388                                 # IKE-proposal to use
1389                                 proposal = aes128-sha1-modp1024
1390                                 # use faster PSK authentication instead
1391                                 # of 1024bit RSA
1392                                 initiator_auth = psk
1393                                 responder_auth = psk
1394                                 # request a virtual IP using configuration
1395                                 # payloads
1396                                 request_virtual_ip = yes
1397                                 # enable CHILD_SA every 60s
1398                                 child_rekey = 60
1399                         }
1400                 }
1401         }
1402 .EE
1403
1404 .SH IKEv2 RETRANSMISSION
1405 Retransmission timeouts in the IKEv2 daemon charon can be configured globally
1406 using the three keys listed below:
1407 .PP
1408 .RS
1409 .nf
1410 .BR charon.retransmit_base " [1.8]"
1411 .BR charon.retransmit_timeout " [4.0]"
1412 .BR charon.retransmit_tries " [5]"
1413 .fi
1414 .RE
1415 .PP
1416 The following algorithm is used to calculate the timeout:
1417 .PP
1418 .EX
1419         relative timeout = retransmit_timeout * retransmit_base ^ (n-1)
1420 .EE
1421 .PP
1422 Where
1423 .I n
1424 is the current retransmission count.
1425 .PP
1426 Using the default values, packets are retransmitted in:
1427
1428 .TS
1429 l r r
1430 ---
1431 lB r r.
1432 Retransmission  Relative Timeout        Absolute Timeout
1433 1       4s      4s
1434 2       7s      11s
1435 3       13s     24s
1436 4       23s     47s
1437 5       42s     89s
1438 giving up       76s     165s
1439 .TE
1440
1441 .SH FILES
1442 /etc/strongswan.conf
1443
1444 .SH SEE ALSO
1445 ipsec.conf(5), ipsec.secrets(5), ipsec(8)
1446 .SH HISTORY
1447 Written for the
1448 .UR http://www.strongswan.org
1449 strongSwan project
1450 .UE
1451 by Tobias Brunner, Andreas Steffen and Martin Willi.