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