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