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