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