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