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