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