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