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