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