updated strongswan.conf
[strongswan.git] / man / strongswan.conf.5.in
1 .TH STRONGSWAN.CONF 5 "2011-07-26" "@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-ifmap.device_name
470 Unique name of strongSwan as a PEP and/or PDP device
471 .TP
472 .BR charon.plugins.tnc-ifmap.key_file
473 Concatenated client certificate and private key
474 .TP
475 .BR charon.plugins.tnc-ifmap.password
476 Authentication password of strongSwan MAP client
477 .TP
478 .BR charon.plugins.tnc-ifmap.server_cert
479 Certificate of MAP server
480 .TP
481 .BR charon.plugins.tnc-ifmap.username
482 Authentication username of strongSwan MAP client
483 .TP
484 .BR charon.plugins.tnc-imc.preferred_language " [en]"
485 Preferred language for TNC recommendations
486 .TP
487 .BR charon.plugins.tnc-imc.tnc_config " [/etc/tnc_config]"
488 TNC IMC configuration directory
489 .TP
490 .BR charon.plugins.tnc-imv.tnc_config " [/etc/tnc_config]"
491 TNC IMV configuration directory
492 .TP
493 .BR charon.plugins.whitelist.enable " [yes]"
494 enable loaded whitelist plugin
495 .SS libstrongswan section
496 .TP
497 .BR libstrongswan.crypto_test.bench " [no]"
498
499 .TP
500 .BR libstrongswan.crypto_test.bench_size " [1024]"
501
502 .TP
503 .BR libstrongswan.crypto_test.bench_time " [50]"
504
505 .TP
506 .BR libstrongswan.crypto_test.on_add " [no]"
507 Test crypto algorithms during registration
508 .TP
509 .BR libstrongswan.crypto_test.on_create " [no]"
510 Test crypto algorithms on each crypto primitive instantiation
511 .TP
512 .BR libstrongswan.crypto_test.required " [no]"
513 Strictly require at least one test vector to enable an algorithm
514 .TP
515 .BR libstrongswan.crypto_test.rng_true " [no]"
516 Whether to test RNG with TRUE quality; requires a lot of entropy
517 .TP
518 .BR libstrongswan.dh_exponent_ansi_x9_42 " [yes]"
519 Use ANSI X9.42 DH exponent size or optimum size matched to cryptographical
520 strength
521 .TP
522 .BR libstrongswan.ecp_x_coordinate_only " [yes]"
523 Compliance with the errata for RFC 4753
524 .TP
525 .BR libstrongswan.integrity_test " [no]"
526 Check daemon, libstrongswan and plugin integrity at startup
527 .TP
528 .BR libstrongswan.leak_detective.detailed " [yes]"
529 Includes source file names and line numbers in leak detective output
530 .TP
531 .BR libstrongswan.processor.priority_threads
532 Subsection to configure the number of reserved threads per priority class
533 see JOB PRIORITY MANAGEMENT
534 .TP
535 .BR libstrongswan.x509.enforce_critical " [yes]"
536 Discard certificates with unsupported or unknown critical extensions
537 .SS libstrongswan.plugins subsection
538 .TP
539 .BR libstrongswan.plugins.attr-sql.database
540 Database URI for attr-sql plugin used by charon and pluto
541 .TP
542 .BR libstrongswan.plugins.attr-sql.lease_history " [yes]"
543 Enable logging of SQL IP pool leases
544 .TP
545 .BR libstrongswan.plugins.gcrypt.quick_random " [no]"
546 Use faster random numbers in gcrypt; for testing only, produces weak keys!
547 .TP
548 .BR libstrongswan.plugins.openssl.engine_id " [pkcs11]"
549 ENGINE ID to use in the OpenSSL plugin
550 .TP
551 .BR libstrongswan.plugins.pkcs11.modules
552 List of available PKCS#11 modules
553 .TP
554 .BR libstrongswan.plugins.pkcs11.use_hasher " [no]"
555 Whether the PKCS#11 modules should be used to hash data
556 .SS libimcv section
557 .TP
558 .BR libimcv.debug_level " [1]"
559 Debug level for a stand-alone libimcv library
560 .TP
561 .BR libimcv.stderr_quiet " [no]"
562 Disable output to stderr with a stand-alone libimcv library
563 .SS libimcv plugins section
564 .TP
565 .BR libimcv.plugins.imc_test.command " [none]"
566 Command to be sent to the Test IMV
567 .TP
568 .BR libimcv.plugins.imc_test.retry " [no]"
569 Do a handshake retry
570 .TP
571 .BR libimcv.plugins.imc_test.retry_command
572 Command to be sent to the Test IMV in the handshake retry
573 .TP
574 .BR libimcv.plugins.imv_test.rounds " [0]"
575 Number of IMC-IMV retry rounds
576 .TP
577 .BR libimcv.plugins.imv_scanner.closed_port_policy " [yes]"
578 By default all ports must be closed (yes) or can be open (no)
579 .TP
580 .BR libimcv.plugins.imv_scanner.tcp_ports
581 List of TCP ports that can be open or must be closed
582 .TP
583 .BR libimcv.plugins.imv_scanner.udp_ports
584 List of UDP ports that can be open or must be closed
585 .SS libtls section
586 .TP
587 .BR libtls.cipher
588 List of TLS encryption ciphers
589 .TP
590 .BR libtls.key_exchange
591 List of TLS key exchange methods
592 .TP
593 .BR libtls.mac
594 List of TLS MAC algorithms
595 .TP
596 .BR libtls.suites
597 List of TLS cipher suites
598 .SS manager section
599 .TP
600 .BR manager.database
601 Credential database URI for manager
602 .TP
603 .BR manager.debug " [no]"
604 Enable debugging in manager
605 .TP
606 .BR manager.load
607 Plugins to load in manager
608 .TP
609 .BR manager.socket
610 FastCGI socket of manager, to run it statically
611 .TP
612 .BR manager.threads " [10]"
613 Threads to use for request handling
614 .TP
615 .BR manager.timeout " [15m]"
616 Session timeout for manager
617 .SS mediation client section
618 .TP
619 .BR medcli.database
620 Mediation client database URI
621 .TP
622 .BR medcli.dpd " [5m]"
623 DPD timeout to use in mediation client plugin
624 .TP
625 .BR medcli.rekey " [20m]"
626 Rekeying time on mediation connections in mediation client plugin
627 .SS mediation server section
628 .TP
629 .BR medsrv.database
630 Mediation server database URI
631 .TP
632 .BR medsrv.debug " [no]"
633 Debugging in mediation server web application
634 .TP
635 .BR medsrv.dpd " [5m]"
636 DPD timeout to use in mediation server plugin
637 .TP
638 .BR medsrv.load
639 Plugins to load in mediation server plugin
640 .TP
641 .BR medsrv.password_length " [6]"
642 Minimum password length required for mediation server user accounts
643 .TP
644 .BR medsrv.rekey " [20m]"
645 Rekeying time on mediation connections in mediation server plugin
646 .TP
647 .BR medsrv.socket
648 Run Mediation server web application statically on socket
649 .TP
650 .BR medsrv.threads " [5]"
651 Number of thread for mediation service web application
652 .TP
653 .BR medsrv.timeout " [15m]"
654 Session timeout for mediation service
655 .SS openac section
656 .TP
657 .BR openac.load
658 Plugins to load in ipsec openac tool
659 .SS pki section
660 .TP
661 .BR pki.load
662 Plugins to load in ipsec pki tool
663 .SS pluto section
664 .TP
665 .BR pluto.dns1
666 .TQ
667 .BR pluto.dns2
668 DNS servers assigned to peer via Mode Config
669 .TP
670 .BR pluto.load
671 Plugins to load in IKEv1 pluto daemon
672 .TP
673 .BR pluto.nbns1
674 .TQ
675 .BR pluto.nbns2
676 WINS servers assigned to peer via Mode Config
677 .TP
678 .BR pluto.threads " [4]"
679 Number of worker threads in pluto
680 .SS pluto.plugins section
681 .TP
682 .BR pluto.plugins.attr
683 Section to specify arbitrary attributes that are assigned to a peer via
684 Mode Config
685 .TP
686 .BR charon.plugins.kernel-klips.ipsec_dev_count " [4]"
687 Number of ipsecN devices
688 .TP
689 .BR charon.plugins.kernel-klips.ipsec_dev_mtu " [0]"
690 Set MTU of ipsecN device
691 .SS pool section
692 .TP
693 .BR pool.load
694 Plugins to load in ipsec pool tool
695 .SS scepclient section
696 .TP
697 .BR scepclient.load
698 Plugins to load in ipsec scepclient tool
699 .SS starter section
700 .TP
701 .BR starter.load_warning " [yes]"
702 Disable charon/pluto plugin load option warning
703
704 .SH LOGGER CONFIGURATION
705 The options described below provide a much more flexible way to configure
706 loggers for the IKEv2 daemon charon than using the
707 .B charondebug
708 option in
709 .BR ipsec.conf (5).
710 .PP
711 .B Please note
712 that if any loggers are specified in strongswan.conf,
713 .B charondebug
714 does not have any effect.
715 .PP
716 There are currently two types of loggers defined:
717 .TP
718 .B File loggers
719 Log directly to a file and are defined by specifying the full path to the
720 file as subsection in the
721 .B charon.filelog
722 section. To log to the console the two special filenames
723 .BR stdout " and " stderr
724 can be used.
725 .TP
726 .B Syslog loggers
727 Log into a syslog facility and are defined by specifying the facility to log to
728 as the name of a subsection in the
729 .B charon.syslog
730 section. The following facilities are currently supported:
731 .BR daemon " and " auth .
732 .PP
733 Multiple loggers can be defined for each type with different log verbosity for
734 the different subsystems of the daemon.
735 .SS Options
736 .TP
737 .BR charon.filelog.<filename>.default " [1]"
738 .TQ
739 .BR charon.syslog.<facility>.default
740 Specifies the default loglevel to be used for subsystems for which no specific
741 loglevel is defined.
742 .TP
743 .BR charon.filelog.<filename>.<subsystem> " [<default>]"
744 .TQ
745 .BR charon.syslog.<facility>.<subsystem>
746 Specifies the loglevel for the given subsystem.
747 .TP
748 .BR charon.filelog.<filename>.append " [yes]"
749 If this option is enabled log entries are appended to the existing file.
750 .TP
751 .BR charon.filelog.<filename>.flush_line " [no]"
752 Enabling this option disables block buffering and enables line buffering.
753 .TP
754 .BR charon.filelog.<filename>.ike_name " [no]"
755 .TQ
756 .BR charon.syslog.<facility>.ike_name
757 Prefix each log entry with the connection name and a unique numerical
758 identifier for each IKE_SA.
759 .TP
760 .BR charon.filelog.<filename>.time_format
761 Prefix each log entry with a timestamp. The option accepts a format string as
762 passed to
763 .BR strftime (3).
764
765 .SS Subsystems
766 .TP
767 .B dmn
768 Main daemon setup/cleanup/signal handling
769 .TP
770 .B mgr
771 IKE_SA manager, handling synchronization for IKE_SA access
772 .TP
773 .B ike
774 IKE_SA
775 .TP
776 .B chd
777 CHILD_SA
778 .TP
779 .B job
780 Jobs queueing/processing and thread pool management
781 .TP
782 .B cfg
783 Configuration management and plugins
784 .TP
785 .B knl
786 IPsec/Networking kernel interface
787 .TP
788 .B net
789 IKE network communication
790 .TP
791 .B enc
792 Packet encoding/decoding encryption/decryption operations
793 .TP
794 .B tls
795 libtls library messages
796 .TP
797 .B lib
798 libstrongwan library messages
799 .TP
800 .B tnc
801 Trusted Network Connect
802 .TP
803 .B imc
804 Integrity Measurement Collector
805 .TP
806 .B imv
807 Integrity Measurement Verifier
808 .SS Loglevels
809 .TP
810 .B -1
811 Absolutely silent
812 .TP
813 .B 0
814 Very basic auditing logs, (e.g. SA up/SA down)
815 .TP
816 .B 1
817 Generic control flow with errors, a good default to see whats going on
818 .TP
819 .B 2
820 More detailed debugging control flow
821 .TP
822 .B 3
823 Including RAW data dumps in Hex
824 .TP
825 .B 4
826 Also include sensitive material in dumps, e.g. keys
827 .SS Example
828 .PP
829 .EX
830         charon {
831                 filelog {
832                         /var/log/charon.log {
833                                 time_format = %b %e %T
834                                 append = no
835                                 default = 1
836                         }
837                         stderr {
838                                 ike = 2
839                                 knl = 3
840                                 ike_name = yes
841                         }
842                 }
843                 syslog {
844                         # enable logging to LOG_DAEMON, use defaults
845                         daemon {
846                         }
847                         # minimalistic IKE auditing logging to LOG_AUTHPRIV
848                         auth {
849                                 default = -1
850                                 ike = 0
851                         }
852                 }
853         }
854 .EE
855
856 .SH JOB PRIORITY MANAGEMENT
857 Some operations in the IKEv2 daemon charon are currently implemented
858 synchronously and blocking. Two examples for such operations are communication
859 with a RADIUS server via EAP-RADIUS, or fetching CRL/OCSP information during
860 certificate chain verification. Under high load conditions, the thread pool may
861 run out of available threads, and some more important jobs, such as liveness
862 checking, may not get executed in time.
863 .PP
864 To prevent thread starvation in such situations job priorities were introduced.
865 The job processor will reserve some threads for higher priority jobs, these
866 threads are not available for lower priority, locking jobs.
867 .SS Implementation
868 Currently 4 priorities have been defined, and they are used in charon as
869 follows:
870 .TP
871 .B CRITICAL
872 Priority for long-running dispatcher jobs.
873 .TP
874 .B HIGH
875 INFORMATIONAL exchanges, as used by liveness checking (DPD).
876 .TP
877 .B MEDIUM
878 Everything not HIGH/LOW, including IKE_SA_INIT processing.
879 .TP
880 .B LOW
881 IKE_AUTH message processing. RADIUS and CRL fetching block here
882 .PP
883 Although IKE_SA_INIT processing is computationally expensive, it is explicitly
884 assigned to the MEDIUM class. This allows charon to do the DH exchange while
885 other threads are blocked in IKE_AUTH. To prevent the daemon from accepting more
886 IKE_SA_INIT requests than it can handle, use IKE_SA_INIT DROPPING.
887 .PP
888 The thread pool processes jobs strictly by priority, meaning it will consume all
889 higher priority jobs before looking for ones with lower priority. Further, it
890 reserves threads for certain priorities. A priority class having reserved
891 .I n
892 threads will always have
893 .I n
894 threads available for this class (either currently processing a job, or waiting
895 for one).
896 .SS Configuration
897 To ensure that there are always enough threads available for higher priority
898 tasks, threads must be reserved for each priority class.
899 .TP
900 .BR libstrongswan.processor.priority_threads.critical " [0]"
901 Threads reserved for CRITICAL priority class jobs
902 .TP
903 .BR libstrongswan.processor.priority_threads.high " [0]"
904 Threads reserved for HIGH priority class jobs
905 .TP
906 .BR libstrongswan.processor.priority_threads.medium " [0]"
907 Threads reserved for MEDIUM priority class jobs
908 .TP
909 .BR libstrongswan.processor.priority_threads.low " [0]"
910 Threads reserved for LOW priority class jobs
911 .PP
912 Let's consider the following configuration:
913 .PP
914 .EX
915         libstrongswan {
916                 processor {
917                         priority_threads {
918                                 high = 1
919                                 medium = 4
920                         }
921                 }
922         }
923 .EE
924 .PP
925 With this configuration, one thread is reserved for HIGH priority tasks. As
926 currently only liveness checking and stroke message processing is done with
927 high priority, one or two threads should be sufficient.
928 .PP
929 The MEDIUM class mostly processes non-blocking jobs. Unless your setup is
930 experiencing many blocks in locks while accessing shared resources, threads for
931 one or two times the number of CPU cores is fine.
932 .PP
933 It is usually not required to reserve threads for CRITICAL jobs. Jobs in this
934 class rarely return and do not release their thread to the pool.
935 .PP
936 The remaining threads are available for LOW priority jobs. Reserving threads
937 does not make sense (until we have an even lower priority).
938 .SS Monitoring
939 To see what the threads are actually doing, invoke
940 .IR "ipsec statusall" .
941 Under high load, something like this will show up:
942 .PP
943 .EX
944         worker threads: 2 or 32 idle, 5/1/2/22 working,
945                 job queue: 0/0/1/149, scheduled: 198
946 .EE
947 .PP
948 From 32 worker threads,
949 .IP 2
950 are currently idle.
951 .IP 5
952 are running CRITICAL priority jobs (dispatching from sockets, etc.).
953 .IP 1
954 is currently handling a HIGH priority job. This is actually the thread currently
955 providing this information via stroke.
956 .IP 2
957 are handling MEDIUM priority jobs, likely IKE_SA_INIT or CREATE_CHILD_SA
958 messages.
959 .IP 22
960 are handling LOW priority jobs, probably waiting for an EAP-RADIUS response
961 while processing IKE_AUTH messages.
962 .PP
963 The job queue load shows how many jobs are queued for each priority, ready for
964 execution. The single MEDIUM priority job will get executed immediately, as
965 we have two spare threads reserved for MEDIUM class jobs.
966
967 .SH IKE_SA_INIT DROPPING
968 If a responder receives more connection requests per seconds than it can handle,
969 it does not make sense to accept more IKE_SA_INIT messages. And if they are
970 queued but can't get processed in time, an answer might be sent after the
971 client has already given up and restarted its connection setup. This
972 additionally increases the load on the responder.
973 .PP
974 To limit the responder load resulting from new connection attempts, the daemon
975 can drop IKE_SA_INIT messages just after reception. There are two mechanisms to
976 decide if this should happen, configured with the following options:
977 .TP
978 .BR charon.init_limit_half_open " [0]"
979 Limit based on the number of half open IKE_SAs. Half open IKE_SAs are SAs in
980 connecting state, but not yet established.
981 .TP
982 .BR charon.init_limit_job_load " [0]"
983 Limit based on the number of jobs currently queued for processing (sum over all
984 job priorities).
985 .PP
986 The second limit includes load from other jobs, such as rekeying. Choosing a
987 good value is difficult and depends on the hardware and expected load.
988 .PP
989 The first limit is simpler to calculate, but includes the load from new
990 connections only. If your responder is capable of negotiating 100 tunnels/s, you
991 might set this limit to 1000. The daemon will then drop new connection attempts
992 if generating a response would require more than 10 seconds. If you are
993 allowing for a maximum response time of more than 30 seconds, consider adjusting
994 the timeout for connecting IKE_SAs
995 .RB ( charon.half_open_timeout ).
996 A responder, by default, deletes an IKE_SA if the initiator does not establish
997 it within 30 seconds. Under high load, a higher value might be required.
998
999 .SH LOAD TESTS
1000 To do stability testing and performance optimizations, the IKEv2 daemon charon
1001 provides the load-tester plugin. This plugin allows to setup thousands of
1002 tunnels concurrently against the daemon itself or a remote host.
1003 .PP
1004 .B WARNING:
1005 Never enable the load-testing plugin on productive systems. It provides
1006 preconfigured credentials and allows an attacker to authenticate as any user.
1007 .SS Options
1008 .TP
1009 .BR charon.plugins.load-tester.child_rekey " [600]"
1010 Seconds to start CHILD_SA rekeying after setup
1011 .TP
1012 .BR charon.plugins.load-tester.delay " [0]"
1013 Delay between initiatons for each thread
1014 .TP
1015 .BR charon.plugins.load-tester.delete_after_established " [no]"
1016 Delete an IKE_SA as soon as it has been established
1017 .TP
1018 .BR charon.plugins.load-tester.dpd_delay " [0]"
1019 DPD delay to use in load test
1020 .TP
1021 .BR charon.plugins.load-tester.dynamic_port " [0]"
1022 Base port to be used for requests (each client uses a different port)
1023 .TP
1024 .BR charon.plugins.load-tester.eap_password " [default-pwd]"
1025 EAP secret to use in load test
1026 .TP
1027 .BR charon.plugins.load-tester.enable " [no]"
1028 Enable the load testing plugin
1029 .TP
1030 .BR charon.plugins.load-tester.fake_kernel " [no]"
1031 Fake the kernel interface to allow load-testing against self
1032 .TP
1033 .BR charon.plugins.load-tester.ike_rekey " [0]"
1034 Seconds to start IKE_SA rekeying after setup
1035 .TP
1036 .BR charon.plugins.load-tester.init_limit " [0]"
1037 Global limit of concurrently established SAs during load test
1038 .TP
1039 .BR charon.plugins.load-tester.initiators " [0]"
1040 Number of concurrent initiator threads to use in load test
1041 .TP
1042 .BR charon.plugins.load-tester.initiator_auth " [pubkey]"
1043 Authentication method(s) the intiator uses
1044 .TP
1045 .BR charon.plugins.load-tester.initiator_id
1046 Initiator ID used in load test
1047 .TP
1048 .BR charon.plugins.load-tester.iterations " [1]"
1049 Number of IKE_SAs to initate by each initiator in load test
1050 .TP
1051 .BR charon.plugins.load-tester.pool
1052 Provide INTERNAL_IPV4_ADDRs from a named pool
1053 .TP
1054 .BR charon.plugins.load-tester.preshared_key " [default-psk]"
1055 Preshared key to use in load test
1056 .TP
1057 .BR charon.plugins.load-tester.proposal " [aes128-sha1-modp768]"
1058 IKE proposal to use in load test
1059 .TP
1060 .BR charon.plugins.load-tester.remote " [127.0.0.1]"
1061 Address to initiation connections to
1062 .TP
1063 .BR charon.plugins.load-tester.responder_auth " [pubkey]"
1064 Authentication method(s) the responder uses
1065 .TP
1066 .BR charon.plugins.load-tester.responder_id
1067 Responder ID used in load test
1068 .TP
1069 .BR charon.plugins.load-tester.request_virtual_ip " [no]"
1070 Request an INTERNAL_IPV4_ADDR from the server
1071 .TP
1072 .BR charon.plugins.load-tester.shutdown_when_complete " [no]"
1073 Shutdown the daemon after all IKE_SAs have been established
1074 .SS Configuration details
1075 For public key authentication, the responder uses the
1076 .B \(dqCN=srv, OU=load-test, O=strongSwan\(dq
1077 identity. For the initiator, each connection attempt uses a different identity
1078 in the form
1079 .BR "\(dqCN=c1-r1, OU=load-test, O=strongSwan\(dq" ,
1080 where the first number inidicates the client number, the second the
1081 authentication round (if multiple authentication is used).
1082 .PP
1083 For PSK authentication, FQDN identities are used. The server uses
1084 .BR srv.strongswan.org ,
1085 the client uses an identity in the form
1086 .BR c1-r1.strongswan.org .
1087 .PP
1088 For EAP authentication, the client uses a NAI in the form
1089 .BR 100000000010001@strongswan.org .
1090 .PP
1091 To configure multiple authentication, concatenate multiple methods using, e.g.
1092 .EX
1093         initiator_auth = pubkey|psk|eap-md5|eap-aka
1094 .EE
1095 .PP
1096 The responder uses a hardcoded certificate based on a 1024-bit RSA key.
1097 This certificate additionally serves as CA certificate. A peer uses the same
1098 private key, but generates client certificates on demand signed by the CA
1099 certificate. Install the Responder/CA certificate on the remote host to
1100 authenticate all clients.
1101 .PP
1102 To speed up testing, the load tester plugin implements a special Diffie-Hellman
1103 implementation called modpnull. By setting
1104 .EX
1105         proposal = aes128-sha1-modpnull
1106 .EE
1107 this wicked fast DH implementation is used. It does not provide any security
1108 at all, but allows to run tests without DH calculation overhead.
1109 .SS Examples
1110 .PP
1111 In the simplest case, the daemon initiates IKE_SAs against itself using the
1112 loopback interface. This will actually establish double the number of IKE_SAs,
1113 as the daemon is initiator and responder for each IKE_SA at the same time.
1114 Installation of IPsec SAs would fails, as each SA gets installed twice. To
1115 simulate the correct behavior, a fake kernel interface can be enabled which does
1116 not install the IPsec SAs at the kernel level.
1117 .PP
1118 A simple loopback configuration might look like this:
1119 .PP
1120 .EX
1121         charon {
1122                 # create new IKE_SAs for each CHILD_SA to simulate
1123                 # different clients
1124                 reuse_ikesa = no
1125                 # turn off denial of service protection
1126                 dos_protection = no
1127
1128                 plugins {
1129                         load-tester {
1130                                 # enable the plugin
1131                                 enable = yes
1132                                 # use 4 threads to initiate connections
1133                                 # simultaneously
1134                                 initiators = 4
1135                                 # each thread initiates 1000 connections
1136                                 iterations = 1000
1137                                 # delay each initiation in each thread by 20ms
1138                                 delay = 20
1139                                 # enable the fake kernel interface to
1140                                 # avoid SA conflicts
1141                                 fake_kernel = yes
1142                         }
1143                 }
1144         }
1145 .EE
1146 .PP
1147 This will initiate 4000 IKE_SAs within 20 seconds. You may increase the delay
1148 value if your box can not handle that much load, or decrease it to put more
1149 load on it. If the daemon starts retransmitting messages your box probably can
1150 not handle all connection attempts.
1151 .PP
1152 The plugin also allows to test against a remote host. This might help to test
1153 against a real world configuration. A connection setup to do stress testing of
1154 a gateway might look like this:
1155 .PP
1156 .EX
1157         charon {
1158                 reuse_ikesa = no
1159                 threads = 32
1160
1161                 plugins {
1162                         load-tester {
1163                                 enable = yes
1164                                 # 10000 connections, ten in parallel
1165                                 initiators = 10
1166                                 iterations = 1000
1167                                 # use a delay of 100ms, overall time is:
1168                                 # iterations * delay = 100s
1169                                 delay = 100
1170                                 # address of the gateway
1171                                 remote = 1.2.3.4
1172                                 # IKE-proposal to use
1173                                 proposal = aes128-sha1-modp1024
1174                                 # use faster PSK authentication instead
1175                                 # of 1024bit RSA
1176                                 initiator_auth = psk
1177                                 responder_auth = psk
1178                                 # request a virtual IP using configuration
1179                                 # payloads
1180                                 request_virtual_ip = yes
1181                                 # enable CHILD_SA every 60s
1182                                 child_rekey = 60
1183                         }
1184                 }
1185         }
1186 .EE
1187
1188 .SH IKEv2 RETRANSMISSION
1189 Retransmission timeouts in the IKEv2 daemon charon can be configured globally
1190 using the three keys listed below:
1191 .PP
1192 .RS
1193 .nf
1194 .BR charon.retransmit_base " [1.8]"
1195 .BR charon.retransmit_timeout " [4.0]"
1196 .BR charon.retransmit_tries " [5]"
1197 .fi
1198 .RE
1199 .PP
1200 The following algorithm is used to calculate the timeout:
1201 .PP
1202 .EX
1203         relative timeout = retransmit_timeout * retransmit_base ^ (n-1)
1204 .EE
1205 .PP
1206 Where
1207 .I n
1208 is the current retransmission count.
1209 .PP
1210 Using the default values, packets are retransmitted in:
1211
1212 .TS
1213 l r r
1214 ---
1215 lB r r.
1216 Retransmission  Relative Timeout        Absolute Timeout
1217 1       4s      4s
1218 2       7s      11s
1219 3       13s     24s
1220 4       23s     47s
1221 5       42s     89s
1222 giving up       76s     165s
1223 .TE
1224
1225 .SH FILES
1226 /etc/strongswan.conf
1227
1228 .SH SEE ALSO
1229 ipsec.conf(5), ipsec.secrets(5), ipsec(8)
1230 .SH HISTORY
1231 Written for the
1232 .UR http://www.strongswan.org
1233 strongSwan project
1234 .UE
1235 by Tobias Brunner, Andreas Steffen and Martin Willi.