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