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