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