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