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