Documentation about job priorities added to man page.
[strongswan.git] / man / strongswan.conf.5.in
1 .TH STRONGSWAN.CONF 5 "2011-07-17" "@IPSEC_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 charon section
130 .TP
131 .BR charon.block_threshold " [5]"
132 Maximum number of half-open IKE_SAs for a single peer IP
133 .TP
134 .BR charon.close_ike_on_child_failure " [no]"
135 Close the IKE_SA if setup of the CHILD_SA along with IKE_AUTH failed
136 .TP
137 .BR charon.cookie_threshold " [10]"
138 Number of half-open IKE_SAs that activate the cookie mechanism
139 .TP
140 .BR charon.dns1
141 .TQ
142 .BR charon.dns2
143 DNS servers assigned to peer via configuration payload (CP)
144 .TP
145 .BR charon.dos_protection " [yes]"
146 Enable Denial of Service protection using cookies and aggressiveness checks
147 .TP
148 .BR charon.filelog
149 Section to define file loggers, see LOGGER CONFIGURATION
150 .TP
151 .BR charon.flush_auth_cfg " [no]"
152
153 .TP
154 .BR charon.half_open_timeout " [30]"
155 Timeout in seconds for connecting IKE_SAs (also see IKE_SA_INIT DROPPING).
156 .TP
157 .BR charon.hash_and_url " [no]"
158 Enable hash and URL support
159 .TP
160 .BR charon.ignore_routing_tables
161 A list of routing tables to be excluded from route lookup
162 .TP
163 .BR charon.ikesa_table_segments " [1]"
164 Number of exclusively locked segments in the hash table
165 .TP
166 .BR charon.ikesa_table_size " [1]"
167 Size of the IKE_SA hash table
168 .TP
169 .BR charon.inactivity_close_ike " [no]"
170 Whether to close IKE_SA if the only CHILD_SA closed due to inactivity
171 .TP
172 .BR charon.init_limit_half_open " [0]"
173 Limit new connections based on the current number of half open IKE_SAs (see
174 IKE_SA_INIT DROPPING).
175 .TP
176 .BR charon.init_limit_job_load " [0]"
177 Limit new connections based on the number of jobs currently queued for
178 processing (see IKE_SA_INIT DROPPING).
179 .TP
180 .BR charon.install_routes " [yes]"
181 Install routes into a separate routing table for established IPsec tunnels
182 .TP
183 .BR charon.install_virtual_ip " [yes]"
184 Install virtual IP addresses
185 .TP
186 .BR charon.keep_alive " [20s]"
187 NAT keep alive interval
188 .TP
189 .BR charon.load
190 Plugins to load in the IKEv2 daemon charon
191 .TP
192 .BR charon.max_packet " [10000]"
193 Maximum packet size accepted by charon
194 .TP
195 .BR charon.multiple_authentication " [yes]"
196 Enable multiple authentication exchanges (RFC 4739)
197 .TP
198 .BR charon.nbns1
199 .TQ
200 .BR charon.nbns2
201 WINS servers assigned to peer via configuration payload (CP)
202 .TP
203 .BR charon.process_route " [yes]"
204 Process RTM_NEWROUTE and RTM_DELROUTE events
205 .TP
206 .BR charon.receive_delay " [0]"
207 Delay for receiving packets, to simulate larger RTT
208 .TP
209 .BR charon.receive_delay_response " [yes]"
210 Delay response messages
211 .TP
212 .BR charon.receive_delay_request " [yes]"
213 Delay request messages
214 .TP
215 .BR charon.receive_delay_type " [0]"
216 Specific IKEv2 message type to delay, 0 for any
217 .TP
218 .BR charon.replay_window " [32]"
219 Size of the AH/ESP replay window, in packets.
220 .TP
221 .BR charon.retransmit_base " [1.8]"
222 Base to use for calculating exponential back off, see IKEv2 RETRANSMISSION
223 .TP
224 .BR charon.retransmit_timeout " [4.0]
225 Timeout in seconds before sending first retransmit
226 .TP
227 .BR charon.retransmit_tries " [5]"
228 Number of times to retransmit a packet before giving up
229 .TP
230 .BR charon.reuse_ikesa " [yes]
231 Initiate CHILD_SA within existing IKE_SAs
232 .TP
233 .BR charon.routing_table
234 Numerical routing table to install routes to
235 .TP
236 .BR charon.routing_table_prio
237 Priority of the routing table
238 .TP
239 .BR charon.send_delay " [0]"
240 Delay for sending packets, to simulate larger RTT
241 .TP
242 .BR charon.send_delay_response " [yes]"
243 Delay response messages
244 .TP
245 .BR charon.send_delay_request " [yes]"
246 Delay request messages
247 .TP
248 .BR charon.send_delay_type " [0]"
249 Specific IKEv2 message type to delay, 0 for any
250 .TP
251 .BR charon.send_vendor_id " [no]
252 Send strongSwan vendor ID payload
253 .TP
254 .BR charon.syslog
255 Section to define syslog loggers, see LOGGER CONFIGURATION
256 .TP
257 .BR charon.threads " [16]"
258 Number of worker threads in charon
259 .SS charon.plugins subsection
260 .TP
261 .BR charon.plugins.android.loglevel " [1]"
262 Loglevel for logging to Android specific logger
263 .TP
264 .BR charon.plugins.attr
265 Section to specify arbitrary attributes that are assigned to a peer via
266 configuration payload (CP)
267 .TP
268 .BR charon.plugins.dhcp.identity_lease " [no]"
269 Derive user-defined MAC address from hash of IKEv2 identity
270 .TP
271 .BR charon.plugins.dhcp.server " [255.255.255.255]"
272 DHCP server unicast or broadcast IP address
273 .TP
274 .BR charon.plugins.duplicheck.enable " [yes]"
275 enable loaded duplicheck plugin
276 .TP
277 .BR charon.plugins.eap-aka.request_identity " [yes]"
278
279 .TP
280 .BR charon.plugins.eap-aka-3ggp2.seq_check
281
282 .TP
283 .BR charon.plugins.eap-gtc.pam_service " [login]"
284 PAM service to be used for authentication
285
286 .TP
287 .BR charon.plugins.eap-peap.fragment_size " [1024]"
288 Maximum size of an EAP-PEAP packet
289 .TP
290 .BR charon.plugins.eap-peap.max_message_count " [32]"
291 Maximum number of processed EAP-PEAP packets
292 .TP
293 .BR charon.plugins.eap-peap.include_length " [no]"
294 Include length in non-fragmented EAP-PEAP packets
295 .TP
296 .BR charon.plugins.eap-peap.phase2_method " [mschapv2]"
297 Phase2 EAP client authentication method
298 .TP
299 .BR charon.plugins.eap-peap.phase2_piggyback " [no]"
300 Phase2 EAP Identity request piggybacked by server onto TLS Finished message
301 .TP
302 .BR charon.plugins.eap-peap.phase2_tnc " [no]"
303 Start phase2 EAP TNC protocol after successful client authentication
304 .TP
305 .BR charon.plugins.eap-peap.request_peer_auth " [no]"
306 Request peer authentication based on a client certificate
307
308 .TP
309 .BR charon.plugins.eap-radius.class_group " [no]"
310 Use the
311 .I class
312 attribute sent in the RADIUS-Accept message as group membership information that
313 is compared to the groups specified in the
314 .B rightgroups
315 option in
316 .B ipsec.conf (5).
317 .TP
318 .BR charon.plugins.eap-radius.eap_start " [no]"
319 Send EAP-Start instead of EAP-Identity to start RADIUS conversation
320 .TP
321 .BR charon.plugins.eap-radius.filter_id " [no]"
322 If the RADIUS
323 .I tunnel_type
324 attribute with value
325 .B ESP
326 is received, use the
327 .I filter_id
328 attribute sent in the RADIUS-Accept message as group membership information that
329 is compared to the groups specified in the
330 .B rightgroups
331 option in
332 .B ipsec.conf (5).
333 .TP
334 .BR charon.plugins.eap-radius.id_prefix
335 Prefix to EAP-Identity, some AAA servers use a IMSI prefix to select the
336 EAP method
337 .TP
338 .BR charon.plugins.eap-radius.nas_identifier " [strongSwan]"
339 NAS-Identifier to include in RADIUS messages
340 .TP
341 .BR charon.plugins.eap-radius.port " [1812]"
342 Port of RADIUS server (authentication)
343 .TP
344 .BR charon.plugins.eap-radius.secret
345 Shared secret between RADIUS and NAS
346 .TP
347 .BR charon.plugins.eap-radius.server
348 IP/Hostname of RADIUS server
349 .TP
350 .BR charon.plugins.eap-radius.servers
351 Section to specify multiple RADIUS servers. The
352 .BR nas_identifier ,
353 .BR secret ,
354 .B sockets
355 and
356 .B port
357 options can be specified for each server. A server's IP/Hostname can be
358 configured using the
359 .B address
360 option. For each RADIUS server a priority can be specified using the
361 .BR preference " [0]"
362 option.
363 .TP
364 .BR charon.plugins.eap-radius.sockets " [1]"
365 Number of sockets (ports) to use, increase for high load
366 .TP
367 .BR charon.plugins.eap-sim.request_identity " [yes]"
368
369 .TP
370 .BR charon.plugins.eap-simaka-sql.database
371
372 .TP
373 .BR charon.plugins.eap-simaka-sql.remove_used
374
375 .TP
376 .BR charon.plugins.eap-tls.fragment_size " [1024]"
377 Maximum size of an EAP-TLS packet
378 .TP
379 .BR charon.plugins.eap-tls.max_message_count " [32]"
380 Maximum number of processed EAP-TLS packets
381 .TP
382 .BR charon.plugins.eap-tls.include_length " [yes]"
383 Include length in non-fragmented EAP-TLS packets
384 .TP
385 .BR charon.plugins.eap-tnc.fragment_size " [50000]"
386 Maximum size of an EAP-TNC packet
387 .TP
388 .BR charon.plugins.eap-tnc.max_message_count " [10]"
389 Maximum number of processed EAP-TNC packets
390 .TP
391 .BR charon.plugins.eap-tnc.include_length " [yes]"
392 Include length in non-fragmented EAP-TNC packets
393 .TP
394 .BR charon.plugins.eap-ttls.fragment_size " [1024]"
395 Maximum size of an EAP-TTLS packet
396 .TP
397 .BR charon.plugins.eap-ttls.max_message_count " [32]"
398 Maximum number of processed EAP-TTLS packets
399 .TP
400 .BR charon.plugins.eap-ttls.include_length " [yes]"
401 Include length in non-fragmented EAP-TTLS packets
402 .TP
403 .BR charon.plugins.eap-ttls.phase2_method " [md5]"
404 Phase2 EAP client authentication method
405 .TP
406 .BR charon.plugins.eap-ttls.phase2_piggyback " [no]"
407 Phase2 EAP Identity request piggybacked by server onto TLS Finished message
408 .TP
409 .BR charon.plugins.eap-ttls.phase2_tnc " [no]"
410 Start phase2 EAP TNC protocol after successful client authentication
411 .TP
412 .BR charon.plugins.eap-ttls.request_peer_auth " [no]"
413 Request peer authentication based on a client certificate
414 .TP
415 .BR charon.plugins.ha.fifo_interface " [yes]"
416
417 .TP
418 .BR charon.plugins.ha.heartbeat_delay " [1000]"
419
420 .TP
421 .BR charon.plugins.ha.heartbeat_timeout " [2100]"
422
423 .TP
424 .BR charon.plugins.ha.local
425
426 .TP
427 .BR charon.plugins.ha.monitor " [yes]"
428
429 .TP
430 .BR charon.plugins.ha.pools
431
432 .TP
433 .BR charon.plugins.ha.remote
434
435 .TP
436 .BR charon.plugins.ha.resync " [yes]"
437
438 .TP
439 .BR charon.plugins.ha.secret
440
441 .TP
442 .BR charon.plugins.ha.segment_count " [1]"
443
444 .TP
445 .BR charon.plugins.led.activity_led
446
447 .TP
448 .BR charon.plugins.led.blink_time " [50]"
449
450 .TP
451 .BR charon.plugins.kernel-klips.ipsec_dev_count " [4]"
452 Number of ipsecN devices
453 .TP
454 .BR charon.plugins.kernel-klips.ipsec_dev_mtu " [0]"
455 Set MTU of ipsecN device
456 .TP
457 .BR charon.plugins.load-tester
458 Section to configure the load-tester plugin, see LOAD TESTS
459 .TP
460 .BR charon.plugins.resolve.file " [/etc/resolv.conf]"
461 File where to add DNS server entries
462 .TP
463 .BR charon.plugins.sql.database
464 Database URI for charons SQL plugin
465 .TP
466 .BR charon.plugins.sql.loglevel " [-1]"
467 Loglevel for logging to SQL database
468 .TP
469 .BR charon.plugins.tnc-imc.preferred_language " [en]"
470 Preferred language for TNC recommendations
471 .TP
472 .BR charon.plugins.tnc-imc.tnc_config " [/etc/tnc_config]"
473 TNC IMC configuration directory
474 .TP
475 .BR charon.plugins.tnc-imv.tnc_config " [/etc/tnc_config]"
476 TNC IMV configuration directory
477 .TP
478 .BR charon.plugins.whitelist.enable " [yes]"
479 enable loaded whitelist plugin
480 .SS libstrongswan section
481 .TP
482 .BR libstrongswan.crypto_test.bench " [no]"
483
484 .TP
485 .BR libstrongswan.crypto_test.bench_size " [1024]"
486
487 .TP
488 .BR libstrongswan.crypto_test.bench_time " [50]"
489
490 .TP
491 .BR libstrongswan.crypto_test.on_add " [no]"
492 Test crypto algorithms during registration
493 .TP
494 .BR libstrongswan.crypto_test.on_create " [no]"
495 Test crypto algorithms on each crypto primitive instantiation
496 .TP
497 .BR libstrongswan.crypto_test.required " [no]"
498 Strictly require at least one test vector to enable an algorithm
499 .TP
500 .BR libstrongswan.crypto_test.rng_true " [no]"
501 Whether to test RNG with TRUE quality; requires a lot of entropy
502 .TP
503 .BR libstrongswan.dh_exponent_ansi_x9_42 " [yes]"
504 Use ANSI X9.42 DH exponent size or optimum size matched to cryptographical
505 strength
506 .TP
507 .BR libstrongswan.ecp_x_coordinate_only " [yes]"
508 Compliance with the errata for RFC 4753
509 .TP
510 .BR libstrongswan.integrity_test " [no]"
511 Check daemon, libstrongswan and plugin integrity at startup
512 .TP
513 .BR libstrongswan.leak_detective.detailed " [yes]"
514 Includes source file names and line numbers in leak detective output
515 .TP
516 .BR libstrongswan.processor.priority_threads
517 Subsection to configure the number of reserved threads per priority class
518 see JOB PRIORITY MANAGEMENT
519 .TP
520 .BR libstrongswan.x509.enforce_critical " [yes]"
521 Discard certificates with unsupported or unknown critical extensions
522 .SS libstrongswan.plugins subsection
523 .TP
524 .BR libstrongswan.plugins.attr-sql.database
525 Database URI for attr-sql plugin used by charon and pluto
526 .TP
527 .BR libstrongswan.plugins.attr-sql.lease_history " [yes]"
528 Enable logging of SQL IP pool leases
529 .TP
530 .BR libstrongswan.plugins.gcrypt.quick_random " [no]"
531 Use faster random numbers in gcrypt; for testing only, produces weak keys!
532 .TP
533 .BR libstrongswan.plugins.openssl.engine_id " [pkcs11]"
534 ENGINE ID to use in the OpenSSL plugin
535 .TP
536 .BR libstrongswan.plugins.pkcs11.modules
537 List of available PKCS#11 modules
538 .TP
539 .BR libstrongswan.plugins.pkcs11.use_hasher " [no]"
540 Whether the PKCS#11 modules should be used to hash data
541 .SS libimcv section
542 .TP
543 .BR libimcv.debug_level " [1]"
544 Debug level for a stand-alone libimcv library
545 .TP
546 .BR libimcv.stderr_quiet " [no]"
547 Disable output to stderr with a stand-alone libimcv library
548 .SS libimcv plugins section
549 .TP
550 .BR libimcv.plugins.imc_test.command " [none]"
551 Command to be sent to the Test IMV
552 .TP
553 .BR libimcv.plugins.imc_test.retry " [no]"
554 Do a handshake retry
555 .TP
556 .BR libimcv.plugins.imc_test.retry_command
557 Command to be sent to the Test IMV in the handshake retry
558 .TP
559 .BR libimcv.plugins.imv_test.rounds " [0]"
560 Number of IMC-IMV retry rounds
561 .TP
562 .BR libimcv.plugins.imv_scanner.closed_port_policy " [yes]"
563 By default all ports must be closed (yes) or can be open (no)
564 .TP
565 .BR libimcv.plugins.imv_scanner.tcp_ports
566 List of TCP ports that can be open or must be closed
567 .TP
568 .BR libimcv.plugins.imv_scanner.udp_ports
569 List of UDP ports that can be open or must be closed
570 .SS libtls section
571 .TP
572 .BR libtls.cipher
573 List of TLS encryption ciphers
574 .TP
575 .BR libtls.key_exchange
576 List of TLS key exchange methods
577 .TP
578 .BR libtls.mac
579 List of TLS MAC algorithms
580 .TP
581 .BR libtls.suites
582 List of TLS cipher suites
583 .SS manager section
584 .TP
585 .BR manager.database
586 Credential database URI for manager
587 .TP
588 .BR manager.debug " [no]"
589 Enable debugging in manager
590 .TP
591 .BR manager.load
592 Plugins to load in manager
593 .TP
594 .BR manager.socket
595 FastCGI socket of manager, to run it statically
596 .TP
597 .BR manager.threads " [10]"
598 Threads to use for request handling
599 .TP
600 .BR manager.timeout " [15m]"
601 Session timeout for manager
602 .SS mediation client section
603 .TP
604 .BR medcli.database
605 Mediation client database URI
606 .TP
607 .BR medcli.dpd " [5m]"
608 DPD timeout to use in mediation client plugin
609 .TP
610 .BR medcli.rekey " [20m]"
611 Rekeying time on mediation connections in mediation client plugin
612 .SS mediation server section
613 .TP
614 .BR medsrv.database
615 Mediation server database URI
616 .TP
617 .BR medsrv.debug " [no]"
618 Debugging in mediation server web application
619 .TP
620 .BR medsrv.dpd " [5m]"
621 DPD timeout to use in mediation server plugin
622 .TP
623 .BR medsrv.load
624 Plugins to load in mediation server plugin
625 .TP
626 .BR medsrv.password_length " [6]"
627 Minimum password length required for mediation server user accounts
628 .TP
629 .BR medsrv.rekey " [20m]"
630 Rekeying time on mediation connections in mediation server plugin
631 .TP
632 .BR medsrv.socket
633 Run Mediation server web application statically on socket
634 .TP
635 .BR medsrv.threads " [5]"
636 Number of thread for mediation service web application
637 .TP
638 .BR medsrv.timeout " [15m]"
639 Session timeout for mediation service
640 .SS openac section
641 .TP
642 .BR openac.load
643 Plugins to load in ipsec openac tool
644 .SS pki section
645 .TP
646 .BR pki.load
647 Plugins to load in ipsec pki tool
648 .SS pluto section
649 .TP
650 .BR pluto.dns1
651 .TQ
652 .BR pluto.dns2
653 DNS servers assigned to peer via Mode Config
654 .TP
655 .BR pluto.load
656 Plugins to load in IKEv1 pluto daemon
657 .TP
658 .BR pluto.nbns1
659 .TQ
660 .BR pluto.nbns2
661 WINS servers assigned to peer via Mode Config
662 .TP
663 .BR pluto.threads " [4]"
664 Number of worker threads in pluto
665 .SS pluto.plugins section
666 .TP
667 .BR pluto.plugins.attr
668 Section to specify arbitrary attributes that are assigned to a peer via
669 Mode Config
670 .TP
671 .BR charon.plugins.kernel-klips.ipsec_dev_count " [4]"
672 Number of ipsecN devices
673 .TP
674 .BR charon.plugins.kernel-klips.ipsec_dev_mtu " [0]"
675 Set MTU of ipsecN device
676 .SS pool section
677 .TP
678 .BR pool.load
679 Plugins to load in ipsec pool tool
680 .SS scepclient section
681 .TP
682 .BR scepclient.load
683 Plugins to load in ipsec scepclient tool
684 .SS starter section
685 .TP
686 .BR starter.load_warning " [yes]"
687 Disable charon/pluto plugin load option warning
688
689 .SH LOGGER CONFIGURATION
690 The options described below provide a much more flexible way to configure
691 loggers for the IKEv2 daemon charon than using the
692 .B charondebug
693 option in
694 .BR ipsec.conf (5).
695 .PP
696 .B Please note
697 that if any loggers are specified in strongswan.conf,
698 .B charondebug
699 does not have any effect.
700 .PP
701 There are currently two types of loggers defined:
702 .TP
703 .B File loggers
704 Log directly to a file and are defined by specifying the full path to the
705 file as subsection in the
706 .B charon.filelog
707 section. To log to the console the two special filenames
708 .BR stdout " and " stderr
709 can be used.
710 .TP
711 .B Syslog loggers
712 Log into a syslog facility and are defined by specifying the facility to log to
713 as the name of a subsection in the
714 .B charon.syslog
715 section. The following facilities are currently supported:
716 .BR daemon " and " auth .
717 .PP
718 Multiple loggers can be defined for each type with different log verbosity for
719 the different subsystems of the daemon.
720 .SS Options
721 .TP
722 .BR charon.filelog.<filename>.default " [1]"
723 .TQ
724 .BR charon.syslog.<facility>.default
725 Specifies the default loglevel to be used for subsystems for which no specific
726 loglevel is defined.
727 .TP
728 .BR charon.filelog.<filename>.<subsystem> " [<default>]"
729 .TQ
730 .BR charon.syslog.<facility>.<subsystem>
731 Specifies the loglevel for the given subsystem.
732 .TP
733 .BR charon.filelog.<filename>.append " [yes]"
734 If this option is enabled log entries are appended to the existing file.
735 .TP
736 .BR charon.filelog.<filename>.flush_line " [no]"
737 Enabling this option disables block buffering and enables line buffering.
738 .TP
739 .BR charon.filelog.<filename>.ike_name " [no]"
740 .TQ
741 .BR charon.syslog.<facility>.ike_name
742 Prefix each log entry with the connection name and a unique numerical
743 identifier for each IKE_SA.
744 .TP
745 .BR charon.filelog.<filename>.time_format
746 Prefix each log entry with a timestamp. The option accepts a format string as
747 passed to
748 .BR strftime (3).
749
750 .SS Subsystems
751 .TP
752 .B dmn
753 Main daemon setup/cleanup/signal handling
754 .TP
755 .B mgr
756 IKE_SA manager, handling synchronization for IKE_SA access
757 .TP
758 .B ike
759 IKE_SA
760 .TP
761 .B chd
762 CHILD_SA
763 .TP
764 .B job
765 Jobs queueing/processing and thread pool management
766 .TP
767 .B cfg
768 Configuration management and plugins
769 .TP
770 .B knl
771 IPsec/Networking kernel interface
772 .TP
773 .B net
774 IKE network communication
775 .TP
776 .B enc
777 Packet encoding/decoding encryption/decryption operations
778 .TP
779 .B tls
780 libtls library messages
781 .TP
782 .B lib
783 libstrongwan library messages
784 .SS Loglevels
785 .TP
786 .B -1
787 Absolutely silent
788 .TP
789 .B 0
790 Very basic auditing logs, (e.g. SA up/SA down)
791 .TP
792 .B 1
793 Generic control flow with errors, a good default to see whats going on
794 .TP
795 .B 2
796 More detailed debugging control flow
797 .TP
798 .B 3
799 Including RAW data dumps in Hex
800 .TP
801 .B 4
802 Also include sensitive material in dumps, e.g. keys
803 .SS Example
804 .PP
805 .EX
806         charon {
807                 filelog {
808                         /var/log/charon.log {
809                                 time_format = %b %e %T
810                                 append = no
811                                 default = 1
812                         }
813                         stderr {
814                                 ike = 2
815                                 knl = 3
816                                 ike_name = yes
817                         }
818                 }
819                 syslog {
820                         # enable logging to LOG_DAEMON, use defaults
821                         daemon {
822                         }
823                         # minimalistic IKE auditing logging to LOG_AUTHPRIV
824                         auth {
825                                 default = -1
826                                 ike = 0
827                         }
828                 }
829         }
830 .EE
831
832 .SH JOB PRIORITY MANAGEMENT
833 Some operations in the IKEv2 daemon charon are currently implemented
834 synchronously and blocking. Two examples for such operations are communication
835 with a RADIUS server via EAP-RADIUS, or fetching CRL/OCSP information during
836 certificate chain verification. Under high load conditions, the thread pool may
837 run out of available threads, and some more important jobs, such as liveness
838 checking, may not get executed in time.
839 .PP
840 To prevent thread starvation in such situations job priorities were introduced.
841 The job processor will reserve some threads for higher priority jobs, these
842 threads are not available for lower priority, locking jobs.
843 .SS Implementation
844 Currently 4 priorities have been defined, and they are used in charon as
845 follows:
846 .TP
847 .B CRITICAL
848 Priority for long-running dispatcher jobs.
849 .TP
850 .B HIGH
851 INFORMATIONAL exchanges, as used by liveness checking (DPD).
852 .TP
853 .B MEDIUM
854 Everything not HIGH/LOW, including IKE_SA_INIT processing.
855 .TP
856 .B LOW
857 IKE_AUTH message processing. RADIUS and CRL fetching block here
858 .PP
859 Although IKE_SA_INIT processing is computationally expensive, it is explicitly
860 assigned to the MEDIUM class. This allows charon to do the DH exchange while
861 other threads are blocked in IKE_AUTH. To prevent the daemon from accepting more
862 IKE_SA_INIT requests than it can handle, use IKE_SA_INIT DROPPING.
863 .PP
864 The thread pool processes jobs strictly by priority, meaning it will consume all
865 higher priority jobs before looking for ones with lower priority. Further, it
866 reserves threads for certain priorities. A priority class having reserved
867 .I n
868 threads will always have
869 .I n
870 threads available for this class (either currently processing a job, or waiting
871 for one).
872 .SS Configuration
873 To ensure that there are always enough threads available for higher priority
874 tasks, threads must be reserved for each priority class.
875 .TP
876 .BR libstrongswan.processor.priority_threads.critical " [0]"
877 Threads reserved for CRITICAL priority class jobs
878 .TP
879 .BR libstrongswan.processor.priority_threads.high " [0]"
880 Threads reserved for HIGH priority class jobs
881 .TP
882 .BR libstrongswan.processor.priority_threads.medium " [0]"
883 Threads reserved for MEDIUM priority class jobs
884 .TP
885 .BR libstrongswan.processor.priority_threads.low " [0]"
886 Threads reserved for LOW priority class jobs
887 .PP
888 Let's consider the following configuration:
889 .PP
890 .EX
891         libstrongswan {
892                 processor {
893                         priority_threads {
894                                 high = 1
895                                 medium = 4
896                         }
897                 }
898         }
899 .EE
900 .PP
901 With this configuration, one thread is reserved for HIGH priority tasks. As
902 currently only liveness checking and stroke message processing is done with
903 high priority, one or two threads should be sufficient.
904 .PP
905 The MEDIUM class mostly processes non-blocking jobs. Unless your setup is
906 experiencing many blocks in locks while accessing shared resources, threads for
907 one or two times the number of CPU cores is fine.
908 .PP
909 It is usually not required to reserve threads for CRITICAL jobs. Jobs in this
910 class rarely return and do not release their thread to the pool.
911 .PP
912 The remaining threads are available for LOW priority jobs. Reserving threads
913 does not make sense (until we have an even lower priority).
914 .SS Monitoring
915 To see what the threads are actually doing, invoke
916 .IR "ipsec statusall" .
917 Under high load, something like this will show up:
918 .PP
919 .EX
920         worker threads: 2 or 32 idle, 5/1/2/22 working,
921                 job queue: 0/0/1/149, scheduled: 198
922 .EE
923 .PP
924 From 32 worker threads,
925 .IP 2
926 are currently idle.
927 .IP 5
928 are running CRITICAL priority jobs (dispatching from sockets, etc.).
929 .IP 1
930 is currently handling a HIGH priority job. This is actually the thread currently
931 providing this information via stroke.
932 .IP 2
933 are handling MEDIUM priority jobs, likely IKE_SA_INIT or CREATE_CHILD_SA
934 messages.
935 .IP 22
936 are handling LOW priority jobs, probably waiting for an EAP-RADIUS response
937 while processing IKE_AUTH messages.
938 .PP
939 The job queue load shows how many jobs are queued for each priority, ready for
940 execution. The single MEDIUM priority job will get executed immediately, as
941 we have two spare threads reserved for MEDIUM class jobs.
942
943 .SH IKE_SA_INIT DROPPING
944 If a responder receives more connection requests per seconds than it can handle,
945 it does not make sense to accept more IKE_SA_INIT messages. And if they are
946 queued but can't get processed in time, an answer might be sent after the
947 client has already given up and restarted its connection setup. This
948 additionally increases the load on the responder.
949 .PP
950 To limit the responder load resulting from new connection attempts, the daemon
951 can drop IKE_SA_INIT messages just after reception. There are two mechanisms to
952 decide if this should happen, configured with the following options:
953 .TP
954 .BR charon.init_limit_half_open " [0]"
955 Limit based on the number of half open IKE_SAs. Half open IKE_SAs are SAs in
956 connecting state, but not yet established.
957 .TP
958 .BR charon.init_limit_job_load " [0]"
959 Limit based on the number of jobs currently queued for processing (sum over all
960 job priorities).
961 .PP
962 The second limit includes load from other jobs, such as rekeying. Choosing a
963 good value is difficult and depends on the hardware and expected load.
964 .PP
965 The first limit is simpler to calculate, but includes the load from new
966 connections only. If your responder is capable of negotiating 100 tunnels/s, you
967 might set this limit to 1000. The daemon will then drop new connection attempts
968 if generating a response would require more than 10 seconds. If you are
969 allowing for a maximum response time of more than 30 seconds, consider adjusting
970 the timeout for connecting IKE_SAs
971 .RB ( charon.half_open_timeout ).
972 A responder, by default, deletes an IKE_SA if the initiator does not establish
973 it within 30 seconds. Under high load, a higher value might be required.
974
975 .SH LOAD TESTS
976 To do stability testing and performance optimizations, the IKEv2 daemon charon
977 provides the load-tester plugin. This plugin allows to setup thousands of
978 tunnels concurrently against the daemon itself or a remote host.
979 .PP
980 .B WARNING:
981 Never enable the load-testing plugin on productive systems. It provides
982 preconfigured credentials and allows an attacker to authenticate as any user.
983 .SS Options
984 .TP
985 .BR charon.plugins.load-tester.child_rekey " [600]"
986 Seconds to start CHILD_SA rekeying after setup
987 .TP
988 .BR charon.plugins.load-tester.delay " [0]"
989 Delay between initiatons for each thread
990 .TP
991 .BR charon.plugins.load-tester.delete_after_established " [no]"
992 Delete an IKE_SA as soon as it has been established
993 .TP
994 .BR charon.plugins.load-tester.dpd_delay " [0]"
995 DPD delay to use in load test
996 .TP
997 .BR charon.plugins.load-tester.dynamic_port " [0]"
998 Base port to be used for requests (each client uses a different port)
999 .TP
1000 .BR charon.plugins.load-tester.eap_password " [default-pwd]"
1001 EAP secret to use in load test
1002 .TP
1003 .BR charon.plugins.load-tester.enable " [no]"
1004 Enable the load testing plugin
1005 .TP
1006 .BR charon.plugins.load-tester.fake_kernel " [no]"
1007 Fake the kernel interface to allow load-testing against self
1008 .TP
1009 .BR charon.plugins.load-tester.ike_rekey " [0]"
1010 Seconds to start IKE_SA rekeying after setup
1011 .TP
1012 .BR charon.plugins.load-tester.init_limit " [0]"
1013 Global limit of concurrently established SAs during load test
1014 .TP
1015 .BR charon.plugins.load-tester.initiators " [0]"
1016 Number of concurrent initiator threads to use in load test
1017 .TP
1018 .BR charon.plugins.load-tester.initiator_auth " [pubkey]"
1019 Authentication method(s) the intiator uses
1020 .TP
1021 .BR charon.plugins.load-tester.initiator_id
1022 Initiator ID used in load test
1023 .TP
1024 .BR charon.plugins.load-tester.iterations " [1]"
1025 Number of IKE_SAs to initate by each initiator in load test
1026 .TP
1027 .BR charon.plugins.load-tester.pool
1028 Provide INTERNAL_IPV4_ADDRs from a named pool
1029 .TP
1030 .BR charon.plugins.load-tester.preshared_key " [default-psk]"
1031 Preshared key to use in load test
1032 .TP
1033 .BR charon.plugins.load-tester.proposal " [aes128-sha1-modp768]"
1034 IKE proposal to use in load test
1035 .TP
1036 .BR charon.plugins.load-tester.remote " [127.0.0.1]"
1037 Address to initiation connections to
1038 .TP
1039 .BR charon.plugins.load-tester.responder_auth " [pubkey]"
1040 Authentication method(s) the responder uses
1041 .TP
1042 .BR charon.plugins.load-tester.responder_id
1043 Responder ID used in load test
1044 .TP
1045 .BR charon.plugins.load-tester.request_virtual_ip " [no]"
1046 Request an INTERNAL_IPV4_ADDR from the server
1047 .TP
1048 .BR charon.plugins.load-tester.shutdown_when_complete " [no]"
1049 Shutdown the daemon after all IKE_SAs have been established
1050 .SS Configuration details
1051 For public key authentication, the responder uses the
1052 .B \(dqCN=srv, OU=load-test, O=strongSwan\(dq
1053 identity. For the initiator, each connection attempt uses a different identity
1054 in the form
1055 .BR "\(dqCN=c1-r1, OU=load-test, O=strongSwan\(dq" ,
1056 where the first number inidicates the client number, the second the
1057 authentication round (if multiple authentication is used).
1058 .PP
1059 For PSK authentication, FQDN identities are used. The server uses
1060 .BR srv.strongswan.org ,
1061 the client uses an identity in the form
1062 .BR c1-r1.strongswan.org .
1063 .PP
1064 For EAP authentication, the client uses a NAI in the form
1065 .BR 100000000010001@strongswan.org .
1066 .PP
1067 To configure multiple authentication, concatenate multiple methods using, e.g.
1068 .EX
1069         initiator_auth = pubkey|psk|eap-md5|eap-aka
1070 .EE
1071 .PP
1072 The responder uses a hardcoded certificate based on a 1024-bit RSA key.
1073 This certificate additionally serves as CA certificate. A peer uses the same
1074 private key, but generates client certificates on demand signed by the CA
1075 certificate. Install the Responder/CA certificate on the remote host to
1076 authenticate all clients.
1077 .PP
1078 To speed up testing, the load tester plugin implements a special Diffie-Hellman
1079 implementation called modpnull. By setting
1080 .EX
1081         proposal = aes128-sha1-modpnull
1082 .EE
1083 this wicked fast DH implementation is used. It does not provide any security
1084 at all, but allows to run tests without DH calculation overhead.
1085 .SS Examples
1086 .PP
1087 In the simplest case, the daemon initiates IKE_SAs against itself using the
1088 loopback interface. This will actually establish double the number of IKE_SAs,
1089 as the daemon is initiator and responder for each IKE_SA at the same time.
1090 Installation of IPsec SAs would fails, as each SA gets installed twice. To
1091 simulate the correct behavior, a fake kernel interface can be enabled which does
1092 not install the IPsec SAs at the kernel level.
1093 .PP
1094 A simple loopback configuration might look like this:
1095 .PP
1096 .EX
1097         charon {
1098                 # create new IKE_SAs for each CHILD_SA to simulate
1099                 # different clients
1100                 reuse_ikesa = no
1101                 # turn off denial of service protection
1102                 dos_protection = no
1103
1104                 plugins {
1105                         load-tester {
1106                                 # enable the plugin
1107                                 enable = yes
1108                                 # use 4 threads to initiate connections
1109                                 # simultaneously
1110                                 initiators = 4
1111                                 # each thread initiates 1000 connections
1112                                 iterations = 1000
1113                                 # delay each initiation in each thread by 20ms
1114                                 delay = 20
1115                                 # enable the fake kernel interface to
1116                                 # avoid SA conflicts
1117                                 fake_kernel = yes
1118                         }
1119                 }
1120         }
1121 .EE
1122 .PP
1123 This will initiate 4000 IKE_SAs within 20 seconds. You may increase the delay
1124 value if your box can not handle that much load, or decrease it to put more
1125 load on it. If the daemon starts retransmitting messages your box probably can
1126 not handle all connection attempts.
1127 .PP
1128 The plugin also allows to test against a remote host. This might help to test
1129 against a real world configuration. A connection setup to do stress testing of
1130 a gateway might look like this:
1131 .PP
1132 .EX
1133         charon {
1134                 reuse_ikesa = no
1135                 threads = 32
1136
1137                 plugins {
1138                         load-tester {
1139                                 enable = yes
1140                                 # 10000 connections, ten in parallel
1141                                 initiators = 10
1142                                 iterations = 1000
1143                                 # use a delay of 100ms, overall time is:
1144                                 # iterations * delay = 100s
1145                                 delay = 100
1146                                 # address of the gateway
1147                                 remote = 1.2.3.4
1148                                 # IKE-proposal to use
1149                                 proposal = aes128-sha1-modp1024
1150                                 # use faster PSK authentication instead
1151                                 # of 1024bit RSA
1152                                 initiator_auth = psk
1153                                 responder_auth = psk
1154                                 # request a virtual IP using configuration
1155                                 # payloads
1156                                 request_virtual_ip = yes
1157                                 # enable CHILD_SA every 60s
1158                                 child_rekey = 60
1159                         }
1160                 }
1161         }
1162 .EE
1163
1164 .SH IKEv2 RETRANSMISSION
1165 Retransmission timeouts in the IKEv2 daemon charon can be configured globally
1166 using the three keys listed below:
1167 .PP
1168 .RS
1169 .nf
1170 .BR charon.retransmit_base " [1.8]"
1171 .BR charon.retransmit_timeout " [4.0]"
1172 .BR charon.retransmit_tries " [5]"
1173 .fi
1174 .RE
1175 .PP
1176 The following algorithm is used to calculate the timeout:
1177 .PP
1178 .EX
1179         relative timeout = retransmit_timeout * retransmit_base ^ (n-1)
1180 .EE
1181 .PP
1182 Where
1183 .I n
1184 is the current retransmission count.
1185 .PP
1186 Using the default values, packets are retransmitted in:
1187
1188 .TS
1189 l r r
1190 ---
1191 lB r r.
1192 Retransmission  Relative Timeout        Absolute Timeout
1193 1       4s      4s
1194 2       7s      11s
1195 3       13s     24s
1196 4       23s     47s
1197 5       42s     89s
1198 giving up       76s     165s
1199 .TE
1200
1201 .SH FILES
1202 /etc/strongswan.conf
1203
1204 .SH SEE ALSO
1205 ipsec.conf(5), ipsec.secrets(5), ipsec(8)
1206 .SH HISTORY
1207 Written for the
1208 .UR http://www.strongswan.org
1209 strongSwan project
1210 .UE
1211 by Tobias Brunner, Andreas Steffen and Martin Willi.