Merge branch 'ah'
[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 .TP
761 .BR charon.plugins.xauth-pam.trim_email " [yes]"
762 If an email address is given as an XAuth username, trim it to just the
763 username part.
764 .SS libstrongswan section
765 .TP
766 .BR libstrongswan.cert_cache " [yes]"
767 Whether relations in validated certificate chains should be cached in memory
768 .TP
769 .BR libstrongswan.crypto_test.bench " [no]"
770
771 .TP
772 .BR libstrongswan.crypto_test.bench_size " [1024]"
773
774 .TP
775 .BR libstrongswan.crypto_test.bench_time " [50]"
776
777 .TP
778 .BR libstrongswan.crypto_test.on_add " [no]"
779 Test crypto algorithms during registration
780 .TP
781 .BR libstrongswan.crypto_test.on_create " [no]"
782 Test crypto algorithms on each crypto primitive instantiation
783 .TP
784 .BR libstrongswan.crypto_test.required " [no]"
785 Strictly require at least one test vector to enable an algorithm
786 .TP
787 .BR libstrongswan.crypto_test.rng_true " [no]"
788 Whether to test RNG with TRUE quality; requires a lot of entropy
789 .TP
790 .BR libstrongswan.dh_exponent_ansi_x9_42 " [yes]"
791 Use ANSI X9.42 DH exponent size or optimum size matched to cryptographical
792 strength
793 .TP
794 .BR libstrongswan.ecp_x_coordinate_only " [yes]"
795 Compliance with the errata for RFC 4753
796 .TP
797 .BR libstrongswan.host_resolver.max_threads " [3]"
798 Maximum number of concurrent resolver threads (they are terminated if unused)
799 .TP
800 .BR libstrongswan.host_resolver.min_threads " [0]"
801 Minimum number of resolver threads to keep around
802 .TP
803 .BR libstrongswan.integrity_test " [no]"
804 Check daemon, libstrongswan and plugin integrity at startup
805 .TP
806 .BR libstrongswan.leak_detective.detailed " [yes]"
807 Includes source file names and line numbers in leak detective output
808 .TP
809 .BR libstrongswan.leak_detective.usage_threshold " [10240]"
810 Threshold in bytes for leaks to be reported (0 to report all)
811 .TP
812 .BR libstrongswan.leak_detective.usage_threshold_count " [0]"
813 Threshold in number of allocations for leaks to be reported (0 to report all)
814 .TP
815 .BR libstrongswan.processor.priority_threads
816 Subsection to configure the number of reserved threads per priority class
817 see JOB PRIORITY MANAGEMENT
818 .TP
819 .BR libstrongswan.x509.enforce_critical " [yes]"
820 Discard certificates with unsupported or unknown critical extensions
821 .SS libstrongswan.plugins subsection
822 .TP
823 .BR libstrongswan.plugins.attr-sql.database
824 Database URI for attr-sql plugin used by charon
825 .TP
826 .BR libstrongswan.plugins.attr-sql.lease_history " [yes]"
827 Enable logging of SQL IP pool leases
828 .TP
829 .BR libstrongswan.plugins.gcrypt.quick_random " [no]"
830 Use faster random numbers in gcrypt; for testing only, produces weak keys!
831 .TP
832 .BR libstrongswan.plugins.openssl.engine_id " [pkcs11]"
833 ENGINE ID to use in the OpenSSL plugin
834 .TP
835 .BR libstrongswan.plugins.openssl.fips_mode " [0]"
836 Set OpenSSL FIPS mode: disabled(0), enabled(1), Suite B enabled(2)
837 .TP
838 .BR libstrongswan.plugins.pkcs11.modules
839 List of available PKCS#11 modules
840 .TP
841 .BR libstrongswan.plugins.pkcs11.load_certs " [yes]"
842 Whether to load certificates from tokens
843 .TP
844 .BR libstrongswan.plugins.pkcs11.reload_certs " [no]"
845 Reload certificates from all tokens if charon receives a SIGHUP
846 .TP
847 .BR libstrongswan.plugins.pkcs11.use_dh " [no]"
848 Whether the PKCS#11 modules should be used for DH and ECDH (see use_ecc option)
849 .TP
850 .BR libstrongswan.plugins.pkcs11.use_ecc " [no]"
851 Whether the PKCS#11 modules should be used for ECDH and ECDSA public key
852 operations. ECDSA private keys can be used regardless of this option
853 .TP
854 .BR libstrongswan.plugins.pkcs11.use_hasher " [no]"
855 Whether the PKCS#11 modules should be used to hash data
856 .TP
857 .BR libstrongswan.plugins.pkcs11.use_pubkey " [no]"
858 Whether the PKCS#11 modules should be used for public key operations, even for
859 keys not stored on tokens
860 .TP
861 .BR libstrongswan.plugins.pkcs11.use_rng " [no]"
862 Whether the PKCS#11 modules should be used as RNG
863 .TP
864 .BR libstrongswan.plugins.random.random " [@random_device@]"
865 File to read random bytes from, instead of @random_device@
866 .TP
867 .BR libstrongswan.plugins.random.urandom " [@urandom_device@]"
868 File to read pseudo random bytes from, instead of @urandom_device@
869 .TP
870 .BR libstrongswan.plugins.unbound.resolv_conf " [/etc/resolv.conf]"
871 File to read DNS resolver configuration from
872 .TP
873 .BR libstrongswan.plugins.unbound.trust_anchors " [/etc/ipsec.d/dnssec.keys]"
874 File to read DNSSEC trust anchors from (usually root zone KSK)
875 .SS libtls section
876 .TP
877 .BR libtls.cipher
878 List of TLS encryption ciphers
879 .TP
880 .BR libtls.key_exchange
881 List of TLS key exchange methods
882 .TP
883 .BR libtls.mac
884 List of TLS MAC algorithms
885 .TP
886 .BR libtls.suites
887 List of TLS cipher suites
888 .SS libtnccs section
889 .TP
890 .BR libtnccs.tnc_config " [/etc/tnc_config]"
891 TNC IMC/IMV configuration directory
892 .PP
893 .SS libtnccs plugins section
894 .TP
895 .BR libtnccs.plugins.tnccs-11.max_message_size " [45000]"
896 Maximum size of a PA-TNC message (XML & Base64 encoding)
897 .TP
898 .BR libtnccs.plugins.tnccs-20.max_batch_size " [65522]"
899 Maximum size of a PB-TNC batch (upper limit via PT-EAP = 65529)
900 .TP
901 .BR libtnccs.plugins.tnccs-20.max_message_size " [65490]"
902 Maximum size of a PA-TNC message (upper limit via PT-EAP = 65497)
903 .TP
904 .BR libtnccs.plugins.tnc-imc.dlclose " [yes]"
905 Unload IMC after use
906 .TP
907 .BR libtnccs.plugins.tnc-imc.preferred_language " [en]"
908 Preferred language for TNC recommendations
909 .TP
910 .BR libtnccs.plugins.tnc-imv.dlclose " [yes]"
911 Unload IMV after use
912 .SS libimcv section
913 .TP
914 .BR libimcv.assessment_result " [yes]"
915 Whether IMVs send a standard IETF Assessment Result attribute
916 .TP
917 .BR libimcv.database
918 Global IMV policy database URI
919 .TP
920 .BR libimcv.debug_level " [1]"
921 Debug level for a stand-alone libimcv library
922 .TP
923 .BR libimcv.load " [random nonce gmp pubkey x509]"
924 Plugins to load in IMC/IMVs
925 .TP
926 .BR libimcv.os_info.name
927 Manually set the name of the client OS (e.g. Ubuntu)
928 .TP
929 .BR libimcv.os_info.version
930 Manually set the version of the client OS (e.g. 12.04 i686)
931 .TP
932 .BR libimcv.policy_script " [ipsec _imv_policy]"
933 Script called for each TNC connection to generate IMV policies
934 .TP
935 .BR libimcv.stderr_quiet " [no]"
936 isable output to stderr with a stand-alone libimcv library
937 .PP
938 .SS libimcv plugins section
939 .TP
940 .BR libimcv.plugins.imc-attestation.aik_blob
941 AIK encrypted private key blob file
942 .TP
943 .BR libimcv.plugins.imc-attestation.aik_cert
944 AIK certificate file
945 .TP
946 .BR libimcv.plugins.imc-attestation.aik_key
947 AIK public key file
948 .TP
949 .BR libimcv.plugins.imv-attestation.nonce_len " [20]"
950 DH nonce length
951 .TP
952 .BR libimcv.plugins.imv-attestation.use_quote2 " [yes]"
953 Use Quote2 AIK signature instead of Quote signature
954 .TP
955 .BR libimcv.plugins.imv-attestation.cadir
956 Path to directory with AIK cacerts
957 .TP
958 .BR libimcv.plugins.imv-attestation.dh_group " [ecp256]"
959 Preferred Diffie-Hellman group
960 .TP
961 .BR libimcv.plugins.imv-attestation.hash_algorithm " [sha256]"
962 Preferred measurement hash algorithm
963 .TP
964 .BR libimcv.plugins.imv-attestation.min_nonce_len " [0]"
965 DH minimum nonce length
966 .TP
967 .BR libimcv.plugins.imv-attestation.remediation_uri
968 URI pointing to attestation remediation instructions
969 .TP
970 .BR libimcv.plugins.imc-os.push_info " [yes]"
971 Send operating system info without being prompted
972 .TP
973 .BR libimcv.plugins.imv-os.remediation_uri
974 URI pointing to operating system remediation instructions
975 .TP
976 .BR libimcv.plugins.imc-scanner.push_info " [yes]"
977 Send open listening ports without being prompted
978 .TP
979 .BR libimcv.plugins.imv-scanner.remediation_uri
980 URI pointing to scanner remediation instructions
981 .TP
982 .BR libimcv.plugins.imc-swid.swid_directory " [@prefix@/share]"
983 Directory where SWID tags are located
984 .TP
985 .BR libimcv.plugins.imc-test.additional_ids " [0]"
986 Number of additional IMC IDs
987 .TP
988 .BR libimcv.plugins.imc-test.command " [none]"
989 Command to be sent to the Test IMV
990 .TP
991 .BR libimcv.plugins.imc-test.dummy_size " [0]"
992 Size of dummy attribute to be sent to the Test IMV (0 = disabled)
993 .TP
994 .BR libimcv.plugins.imv-test.remediation_uri
995 URI pointing to test remediation instructions
996 .TP
997 .BR libimcv.plugins.imc-test.retry " [no]"
998 Do a handshake retry
999 .TP
1000 .BR libimcv.plugins.imc-test.retry_command
1001 Command to be sent to the Test IMV in the handshake retry
1002 .TP
1003 .BR libimcv.plugins.imv-test.rounds " [0]"
1004 Number of IMC-IMV retry rounds
1005 .SS manager section
1006 .TP
1007 .BR manager.database
1008 Credential database URI for manager
1009 .TP
1010 .BR manager.debug " [no]"
1011 Enable debugging in manager
1012 .TP
1013 .BR manager.load
1014 Plugins to load in manager
1015 .TP
1016 .BR manager.socket
1017 FastCGI socket of manager, to run it statically
1018 .TP
1019 .BR manager.threads " [10]"
1020 Threads to use for request handling
1021 .TP
1022 .BR manager.timeout " [15m]"
1023 Session timeout for manager
1024 .SS mediation client section
1025 .TP
1026 .BR medcli.database
1027 Mediation client database URI
1028 .TP
1029 .BR medcli.dpd " [5m]"
1030 DPD timeout to use in mediation client plugin
1031 .TP
1032 .BR medcli.rekey " [20m]"
1033 Rekeying time on mediation connections in mediation client plugin
1034 .SS mediation server section
1035 .TP
1036 .BR medsrv.database
1037 Mediation server database URI
1038 .TP
1039 .BR medsrv.debug " [no]"
1040 Debugging in mediation server web application
1041 .TP
1042 .BR medsrv.dpd " [5m]"
1043 DPD timeout to use in mediation server plugin
1044 .TP
1045 .BR medsrv.load
1046 Plugins to load in mediation server plugin
1047 .TP
1048 .BR medsrv.password_length " [6]"
1049 Minimum password length required for mediation server user accounts
1050 .TP
1051 .BR medsrv.rekey " [20m]"
1052 Rekeying time on mediation connections in mediation server plugin
1053 .TP
1054 .BR medsrv.socket
1055 Run Mediation server web application statically on socket
1056 .TP
1057 .BR medsrv.threads " [5]"
1058 Number of thread for mediation service web application
1059 .TP
1060 .BR medsrv.timeout " [15m]"
1061 Session timeout for mediation service
1062 .SS openac section
1063 .TP
1064 .BR openac.load
1065 Plugins to load in ipsec openac tool
1066 .SS pacman section
1067 .TP
1068 .BR pacman.database
1069 Database URI for the database that stores the package information
1070 .SS pki section
1071 .TP
1072 .BR pki.load
1073 Plugins to load in ipsec pki tool
1074 .SS pool section
1075 .TP
1076 .BR pool.load
1077 Plugins to load in ipsec pool tool
1078 .SS scepclient section
1079 .TP
1080 .BR scepclient.load
1081 Plugins to load in ipsec scepclient tool
1082 .SS starter section
1083 .TP
1084 .BR starter.load
1085 Plugins to load in starter
1086 .TP
1087 .BR starter.load_warning " [yes]"
1088 Disable charon plugin load option warning
1089
1090 .SH LOGGER CONFIGURATION
1091 The options described below provide a much more flexible way to configure
1092 loggers for the IKEv2 daemon charon than using the
1093 .B charondebug
1094 option in
1095 .BR ipsec.conf (5).
1096 .PP
1097 .B Please note
1098 that if any loggers are specified in strongswan.conf,
1099 .B charondebug
1100 does not have any effect.
1101 .PP
1102 There are currently two types of loggers defined:
1103 .TP
1104 .B File loggers
1105 Log directly to a file and are defined by specifying the full path to the
1106 file as subsection in the
1107 .B charon.filelog
1108 section. To log to the console the two special filenames
1109 .BR stdout " and " stderr
1110 can be used.
1111 .TP
1112 .B Syslog loggers
1113 Log into a syslog facility and are defined by specifying the facility to log to
1114 as the name of a subsection in the
1115 .B charon.syslog
1116 section. The following facilities are currently supported:
1117 .BR daemon " and " auth .
1118 .PP
1119 Multiple loggers can be defined for each type with different log verbosity for
1120 the different subsystems of the daemon.
1121 .SS Options
1122 .TP
1123 .BR charon.filelog.<filename>.default " [1]"
1124 .TQ
1125 .BR charon.syslog.<facility>.default
1126 Specifies the default loglevel to be used for subsystems for which no specific
1127 loglevel is defined.
1128 .TP
1129 .BR charon.filelog.<filename>.<subsystem> " [<default>]"
1130 .TQ
1131 .BR charon.syslog.<facility>.<subsystem>
1132 Specifies the loglevel for the given subsystem.
1133 .TP
1134 .BR charon.filelog.<filename>.append " [yes]"
1135 If this option is enabled log entries are appended to the existing file.
1136 .TP
1137 .BR charon.filelog.<filename>.flush_line " [no]"
1138 Enabling this option disables block buffering and enables line buffering.
1139 .TP
1140 .BR charon.filelog.<filename>.ike_name " [no]"
1141 .TQ
1142 .BR charon.syslog.<facility>.ike_name
1143 Prefix each log entry with the connection name and a unique numerical
1144 identifier for each IKE_SA.
1145 .TP
1146 .BR charon.filelog.<filename>.time_format
1147 Prefix each log entry with a timestamp. The option accepts a format string as
1148 passed to
1149 .BR strftime (3).
1150 .TP
1151 .BR charon.syslog.identifier
1152 Global identifier used for an
1153 .BR openlog (3)
1154 call, prepended to each log message by syslog.  If not configured,
1155 .BR openlog (3)
1156 is not called, so the value will depend on system defaults (often the program
1157 name).
1158
1159 .SS Subsystems
1160 .TP
1161 .B dmn
1162 Main daemon setup/cleanup/signal handling
1163 .TP
1164 .B mgr
1165 IKE_SA manager, handling synchronization for IKE_SA access
1166 .TP
1167 .B ike
1168 IKE_SA
1169 .TP
1170 .B chd
1171 CHILD_SA
1172 .TP
1173 .B job
1174 Jobs queueing/processing and thread pool management
1175 .TP
1176 .B cfg
1177 Configuration management and plugins
1178 .TP
1179 .B knl
1180 IPsec/Networking kernel interface
1181 .TP
1182 .B net
1183 IKE network communication
1184 .TP
1185 .B asn
1186 Low-level encoding/decoding (ASN.1, X.509 etc.)
1187 .TP
1188 .B enc
1189 Packet encoding/decoding encryption/decryption operations
1190 .TP
1191 .B tls
1192 libtls library messages
1193 .TP
1194 .B esp
1195 libipsec library messages
1196 .TP
1197 .B lib
1198 libstrongwan library messages
1199 .TP
1200 .B tnc
1201 Trusted Network Connect
1202 .TP
1203 .B imc
1204 Integrity Measurement Collector
1205 .TP
1206 .B imv
1207 Integrity Measurement Verifier
1208 .TP
1209 .B pts
1210 Platform Trust Service
1211 .SS Loglevels
1212 .TP
1213 .B -1
1214 Absolutely silent
1215 .TP
1216 .B 0
1217 Very basic auditing logs, (e.g. SA up/SA down)
1218 .TP
1219 .B 1
1220 Generic control flow with errors, a good default to see whats going on
1221 .TP
1222 .B 2
1223 More detailed debugging control flow
1224 .TP
1225 .B 3
1226 Including RAW data dumps in Hex
1227 .TP
1228 .B 4
1229 Also include sensitive material in dumps, e.g. keys
1230 .SS Example
1231 .PP
1232 .EX
1233         charon {
1234                 filelog {
1235                         /var/log/charon.log {
1236                                 time_format = %b %e %T
1237                                 append = no
1238                                 default = 1
1239                         }
1240                         stderr {
1241                                 ike = 2
1242                                 knl = 3
1243                                 ike_name = yes
1244                         }
1245                 }
1246                 syslog {
1247                         # enable logging to LOG_DAEMON, use defaults
1248                         daemon {
1249                         }
1250                         # minimalistic IKE auditing logging to LOG_AUTHPRIV
1251                         auth {
1252                                 default = -1
1253                                 ike = 0
1254                         }
1255                 }
1256         }
1257 .EE
1258
1259 .SH JOB PRIORITY MANAGEMENT
1260 Some operations in the IKEv2 daemon charon are currently implemented
1261 synchronously and blocking. Two examples for such operations are communication
1262 with a RADIUS server via EAP-RADIUS, or fetching CRL/OCSP information during
1263 certificate chain verification. Under high load conditions, the thread pool may
1264 run out of available threads, and some more important jobs, such as liveness
1265 checking, may not get executed in time.
1266 .PP
1267 To prevent thread starvation in such situations job priorities were introduced.
1268 The job processor will reserve some threads for higher priority jobs, these
1269 threads are not available for lower priority, locking jobs.
1270 .SS Implementation
1271 Currently 4 priorities have been defined, and they are used in charon as
1272 follows:
1273 .TP
1274 .B CRITICAL
1275 Priority for long-running dispatcher jobs.
1276 .TP
1277 .B HIGH
1278 INFORMATIONAL exchanges, as used by liveness checking (DPD).
1279 .TP
1280 .B MEDIUM
1281 Everything not HIGH/LOW, including IKE_SA_INIT processing.
1282 .TP
1283 .B LOW
1284 IKE_AUTH message processing. RADIUS and CRL fetching block here
1285 .PP
1286 Although IKE_SA_INIT processing is computationally expensive, it is explicitly
1287 assigned to the MEDIUM class. This allows charon to do the DH exchange while
1288 other threads are blocked in IKE_AUTH. To prevent the daemon from accepting more
1289 IKE_SA_INIT requests than it can handle, use IKE_SA_INIT DROPPING.
1290 .PP
1291 The thread pool processes jobs strictly by priority, meaning it will consume all
1292 higher priority jobs before looking for ones with lower priority. Further, it
1293 reserves threads for certain priorities. A priority class having reserved
1294 .I n
1295 threads will always have
1296 .I n
1297 threads available for this class (either currently processing a job, or waiting
1298 for one).
1299 .SS Configuration
1300 To ensure that there are always enough threads available for higher priority
1301 tasks, threads must be reserved for each priority class.
1302 .TP
1303 .BR libstrongswan.processor.priority_threads.critical " [0]"
1304 Threads reserved for CRITICAL priority class jobs
1305 .TP
1306 .BR libstrongswan.processor.priority_threads.high " [0]"
1307 Threads reserved for HIGH priority class jobs
1308 .TP
1309 .BR libstrongswan.processor.priority_threads.medium " [0]"
1310 Threads reserved for MEDIUM priority class jobs
1311 .TP
1312 .BR libstrongswan.processor.priority_threads.low " [0]"
1313 Threads reserved for LOW priority class jobs
1314 .PP
1315 Let's consider the following configuration:
1316 .PP
1317 .EX
1318         libstrongswan {
1319                 processor {
1320                         priority_threads {
1321                                 high = 1
1322                                 medium = 4
1323                         }
1324                 }
1325         }
1326 .EE
1327 .PP
1328 With this configuration, one thread is reserved for HIGH priority tasks. As
1329 currently only liveness checking and stroke message processing is done with
1330 high priority, one or two threads should be sufficient.
1331 .PP
1332 The MEDIUM class mostly processes non-blocking jobs. Unless your setup is
1333 experiencing many blocks in locks while accessing shared resources, threads for
1334 one or two times the number of CPU cores is fine.
1335 .PP
1336 It is usually not required to reserve threads for CRITICAL jobs. Jobs in this
1337 class rarely return and do not release their thread to the pool.
1338 .PP
1339 The remaining threads are available for LOW priority jobs. Reserving threads
1340 does not make sense (until we have an even lower priority).
1341 .SS Monitoring
1342 To see what the threads are actually doing, invoke
1343 .IR "ipsec statusall" .
1344 Under high load, something like this will show up:
1345 .PP
1346 .EX
1347         worker threads: 2 or 32 idle, 5/1/2/22 working,
1348                 job queue: 0/0/1/149, scheduled: 198
1349 .EE
1350 .PP
1351 From 32 worker threads,
1352 .IP 2
1353 are currently idle.
1354 .IP 5
1355 are running CRITICAL priority jobs (dispatching from sockets, etc.).
1356 .IP 1
1357 is currently handling a HIGH priority job. This is actually the thread currently
1358 providing this information via stroke.
1359 .IP 2
1360 are handling MEDIUM priority jobs, likely IKE_SA_INIT or CREATE_CHILD_SA
1361 messages.
1362 .IP 22
1363 are handling LOW priority jobs, probably waiting for an EAP-RADIUS response
1364 while processing IKE_AUTH messages.
1365 .PP
1366 The job queue load shows how many jobs are queued for each priority, ready for
1367 execution. The single MEDIUM priority job will get executed immediately, as
1368 we have two spare threads reserved for MEDIUM class jobs.
1369
1370 .SH IKE_SA_INIT DROPPING
1371 If a responder receives more connection requests per seconds than it can handle,
1372 it does not make sense to accept more IKE_SA_INIT messages. And if they are
1373 queued but can't get processed in time, an answer might be sent after the
1374 client has already given up and restarted its connection setup. This
1375 additionally increases the load on the responder.
1376 .PP
1377 To limit the responder load resulting from new connection attempts, the daemon
1378 can drop IKE_SA_INIT messages just after reception. There are two mechanisms to
1379 decide if this should happen, configured with the following options:
1380 .TP
1381 .BR charon.init_limit_half_open " [0]"
1382 Limit based on the number of half open IKE_SAs. Half open IKE_SAs are SAs in
1383 connecting state, but not yet established.
1384 .TP
1385 .BR charon.init_limit_job_load " [0]"
1386 Limit based on the number of jobs currently queued for processing (sum over all
1387 job priorities).
1388 .PP
1389 The second limit includes load from other jobs, such as rekeying. Choosing a
1390 good value is difficult and depends on the hardware and expected load.
1391 .PP
1392 The first limit is simpler to calculate, but includes the load from new
1393 connections only. If your responder is capable of negotiating 100 tunnels/s, you
1394 might set this limit to 1000. The daemon will then drop new connection attempts
1395 if generating a response would require more than 10 seconds. If you are
1396 allowing for a maximum response time of more than 30 seconds, consider adjusting
1397 the timeout for connecting IKE_SAs
1398 .RB ( charon.half_open_timeout ).
1399 A responder, by default, deletes an IKE_SA if the initiator does not establish
1400 it within 30 seconds. Under high load, a higher value might be required.
1401
1402 .SH LOAD TESTS
1403 To do stability testing and performance optimizations, the IKEv2 daemon charon
1404 provides the load-tester plugin. This plugin allows one to setup thousands of
1405 tunnels concurrently against the daemon itself or a remote host.
1406 .PP
1407 .B WARNING:
1408 Never enable the load-testing plugin on productive systems. It provides
1409 preconfigured credentials and allows an attacker to authenticate as any user.
1410 .SS Options
1411 .TP
1412 .BR charon.plugins.load-tester.addrs
1413 Subsection that contains key/value pairs with address pools (in CIDR notation)
1414 to use for a specific network interface e.g. eth0 = 10.10.0.0/16
1415 .TP
1416 .BR charon.plugins.load-tester.addrs_keep " [no]"
1417 Whether to keep dynamic addresses even after the associated SA got terminated
1418 .TP
1419 .BR charon.plugins.load-tester.addrs_prefix " [16]"
1420 Network prefix length to use when installing dynamic addresses. If set to -1 the
1421 full address is used (i.e. 32 or 128)
1422 .TP
1423 .BR charon.plugins.load-tester.ca_dir
1424 Directory to load (intermediate) CA certificates from
1425 .TP
1426 .BR charon.plugins.load-tester.child_rekey " [600]"
1427 Seconds to start CHILD_SA rekeying after setup
1428 .TP
1429 .BR charon.plugins.load-tester.delay " [0]"
1430 Delay between initiatons for each thread
1431 .TP
1432 .BR charon.plugins.load-tester.delete_after_established " [no]"
1433 Delete an IKE_SA as soon as it has been established
1434 .TP
1435 .BR charon.plugins.load-tester.digest " [sha1]"
1436 Digest algorithm used when issuing certificates
1437 .TP
1438 .BR charon.plugins.load-tester.dpd_delay " [0]"
1439 DPD delay to use in load test
1440 .TP
1441 .BR charon.plugins.load-tester.dynamic_port " [0]"
1442 Base port to be used for requests (each client uses a different port)
1443 .TP
1444 .BR charon.plugins.load-tester.eap_password " [default-pwd]"
1445 EAP secret to use in load test
1446 .TP
1447 .BR charon.plugins.load-tester.enable " [no]"
1448 Enable the load testing plugin
1449 .TP
1450 .BR charon.plugins.load-tester.esp " [aes128-sha1]"
1451 CHILD_SA proposal to use for load tests
1452 .TP
1453 .BR charon.plugins.load-tester.fake_kernel " [no]"
1454 Fake the kernel interface to allow load-testing against self
1455 .TP
1456 .BR charon.plugins.load-tester.ike_rekey " [0]"
1457 Seconds to start IKE_SA rekeying after setup
1458 .TP
1459 .BR charon.plugins.load-tester.init_limit " [0]"
1460 Global limit of concurrently established SAs during load test
1461 .TP
1462 .BR charon.plugins.load-tester.initiator " [0.0.0.0]"
1463 Address to initiate from
1464 .TP
1465 .BR charon.plugins.load-tester.initiators " [0]"
1466 Number of concurrent initiator threads to use in load test
1467 .TP
1468 .BR charon.plugins.load-tester.initiator_auth " [pubkey]"
1469 Authentication method(s) the intiator uses
1470 .TP
1471 .BR charon.plugins.load-tester.initiator_id
1472 Initiator ID used in load test
1473 .TP
1474 .BR charon.plugins.load-tester.initiator_match
1475 Initiator ID to match against as responder
1476 .TP
1477 .BR charon.plugins.load-tester.initiator_tsi
1478 Traffic selector on initiator side, as proposed by initiator
1479 .TP
1480 .BR charon.plugins.load-tester.initiator_tsr
1481 Traffic selector on responder side, as proposed by initiator
1482 .TP
1483 .BR charon.plugins.load-tester.iterations " [1]"
1484 Number of IKE_SAs to initiate by each initiator in load test
1485 .TP
1486 .BR charon.plugins.load-tester.issuer_cert
1487 Path to the issuer certificate (if not configured a hard-coded value is used)
1488 .TP
1489 .BR charon.plugins.load-tester.issuer_key
1490 Path to private key that is used to issue certificates (if not configured a
1491 hard-coded value is used)
1492 .TP
1493 .BR charon.plugins.load-tester.pool
1494 Provide INTERNAL_IPV4_ADDRs from a named pool
1495 .TP
1496 .BR charon.plugins.load-tester.preshared_key " [default-psk]"
1497 Preshared key to use in load test
1498 .TP
1499 .BR charon.plugins.load-tester.proposal " [aes128-sha1-modp768]"
1500 IKE proposal to use in load test
1501 .TP
1502 .BR charon.plugins.load-tester.responder " [127.0.0.1]"
1503 Address to initiation connections to
1504 .TP
1505 .BR charon.plugins.load-tester.responder_auth " [pubkey]"
1506 Authentication method(s) the responder uses
1507 .TP
1508 .BR charon.plugins.load-tester.responder_id
1509 Responder ID used in load test
1510 .TP
1511 .BR charon.plugins.load-tester.responder_tsi " [initiator_tsi]"
1512 Traffic selector on initiator side, as narrowed by responder
1513 .TP
1514 .BR charon.plugins.load-tester.responder_tsr " [initiator_tsr]"
1515 Traffic selector on responder side, as narrowed by responder
1516 .TP
1517 .BR charon.plugins.load-tester.request_virtual_ip " [no]"
1518 Request an INTERNAL_IPV4_ADDR from the server
1519 .TP
1520 .BR charon.plugins.load-tester.shutdown_when_complete " [no]"
1521 Shutdown the daemon after all IKE_SAs have been established
1522 .TP
1523 .BR charon.plugins.load-tester.socket " [unix://@piddir@/charon.ldt]"
1524 Socket provided by the load-tester plugin
1525 .TP
1526 .BR charon.plugins.load-tester.version " [0]"
1527 IKE version to use (0 means use IKEv2 as initiator and accept any version as
1528 responder)
1529 .PP
1530 .SS Configuration details
1531 For public key authentication, the responder uses the
1532 .B \(dqCN=srv, OU=load-test, O=strongSwan\(dq
1533 identity. For the initiator, each connection attempt uses a different identity
1534 in the form
1535 .BR "\(dqCN=c1-r1, OU=load-test, O=strongSwan\(dq" ,
1536 where the first number inidicates the client number, the second the
1537 authentication round (if multiple authentication is used).
1538 .PP
1539 For PSK authentication, FQDN identities are used. The server uses
1540 .BR srv.strongswan.org ,
1541 the client uses an identity in the form
1542 .BR c1-r1.strongswan.org .
1543 .PP
1544 For EAP authentication, the client uses a NAI in the form
1545 .BR 100000000010001@strongswan.org .
1546 .PP
1547 To configure multiple authentication, concatenate multiple methods using, e.g.
1548 .EX
1549         initiator_auth = pubkey|psk|eap-md5|eap-aka
1550 .EE
1551 .PP
1552 The responder uses a hardcoded certificate based on a 1024-bit RSA key.
1553 This certificate additionally serves as CA certificate. A peer uses the same
1554 private key, but generates client certificates on demand signed by the CA
1555 certificate. Install the Responder/CA certificate on the remote host to
1556 authenticate all clients.
1557 .PP
1558 To speed up testing, the load tester plugin implements a special Diffie-Hellman
1559 implementation called modpnull. By setting
1560 .EX
1561         proposal = aes128-sha1-modpnull
1562 .EE
1563 this wicked fast DH implementation is used. It does not provide any security
1564 at all, but allows one to run tests without DH calculation overhead.
1565 .SS Examples
1566 .PP
1567 In the simplest case, the daemon initiates IKE_SAs against itself using the
1568 loopback interface. This will actually establish double the number of IKE_SAs,
1569 as the daemon is initiator and responder for each IKE_SA at the same time.
1570 Installation of IPsec SAs would fails, as each SA gets installed twice. To
1571 simulate the correct behavior, a fake kernel interface can be enabled which does
1572 not install the IPsec SAs at the kernel level.
1573 .PP
1574 A simple loopback configuration might look like this:
1575 .PP
1576 .EX
1577         charon {
1578                 # create new IKE_SAs for each CHILD_SA to simulate
1579                 # different clients
1580                 reuse_ikesa = no
1581                 # turn off denial of service protection
1582                 dos_protection = no
1583
1584                 plugins {
1585                         load-tester {
1586                                 # enable the plugin
1587                                 enable = yes
1588                                 # use 4 threads to initiate connections
1589                                 # simultaneously
1590                                 initiators = 4
1591                                 # each thread initiates 1000 connections
1592                                 iterations = 1000
1593                                 # delay each initiation in each thread by 20ms
1594                                 delay = 20
1595                                 # enable the fake kernel interface to
1596                                 # avoid SA conflicts
1597                                 fake_kernel = yes
1598                         }
1599                 }
1600         }
1601 .EE
1602 .PP
1603 This will initiate 4000 IKE_SAs within 20 seconds. You may increase the delay
1604 value if your box can not handle that much load, or decrease it to put more
1605 load on it. If the daemon starts retransmitting messages your box probably can
1606 not handle all connection attempts.
1607 .PP
1608 The plugin also allows one to test against a remote host. This might help to
1609 test against a real world configuration. A connection setup to do stress
1610 testing of a gateway might look like this:
1611 .PP
1612 .EX
1613         charon {
1614                 reuse_ikesa = no
1615                 threads = 32
1616
1617                 plugins {
1618                         load-tester {
1619                                 enable = yes
1620                                 # 10000 connections, ten in parallel
1621                                 initiators = 10
1622                                 iterations = 1000
1623                                 # use a delay of 100ms, overall time is:
1624                                 # iterations * delay = 100s
1625                                 delay = 100
1626                                 # address of the gateway
1627                                 remote = 1.2.3.4
1628                                 # IKE-proposal to use
1629                                 proposal = aes128-sha1-modp1024
1630                                 # use faster PSK authentication instead
1631                                 # of 1024bit RSA
1632                                 initiator_auth = psk
1633                                 responder_auth = psk
1634                                 # request a virtual IP using configuration
1635                                 # payloads
1636                                 request_virtual_ip = yes
1637                                 # enable CHILD_SA every 60s
1638                                 child_rekey = 60
1639                         }
1640                 }
1641         }
1642 .EE
1643
1644 .SH IKEv2 RETRANSMISSION
1645 Retransmission timeouts in the IKEv2 daemon charon can be configured globally
1646 using the three keys listed below:
1647 .PP
1648 .RS
1649 .nf
1650 .BR charon.retransmit_base " [1.8]"
1651 .BR charon.retransmit_timeout " [4.0]"
1652 .BR charon.retransmit_tries " [5]"
1653 .fi
1654 .RE
1655 .PP
1656 The following algorithm is used to calculate the timeout:
1657 .PP
1658 .EX
1659         relative timeout = retransmit_timeout * retransmit_base ^ (n-1)
1660 .EE
1661 .PP
1662 Where
1663 .I n
1664 is the current retransmission count.
1665 .PP
1666 Using the default values, packets are retransmitted in:
1667
1668 .TS
1669 l r r
1670 ---
1671 lB r r.
1672 Retransmission  Relative Timeout        Absolute Timeout
1673 1       4s      4s
1674 2       7s      11s
1675 3       13s     24s
1676 4       23s     47s
1677 5       42s     89s
1678 giving up       76s     165s
1679 .TE
1680
1681 .SH FILES
1682 /etc/strongswan.conf
1683
1684 .SH SEE ALSO
1685 \fBipsec.conf\fR(5), \fBipsec.secrets\fR(5), \fBipsec\fR(8), \fBcharon-cmd\fR(8)
1686
1687 .SH HISTORY
1688 Written for the
1689 .UR http://www.strongswan.org
1690 strongSwan project
1691 .UE
1692 by Tobias Brunner, Andreas Steffen and Martin Willi.