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