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