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