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