Documented the strict flag (!) for ike and esp options in ipsec.conf.
[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.tnc-imc.tnc_config " [/etc/tnc_config]"
491 TNC IMC configuration directory
492 .TP
493 .BR charon.plugins.tnc-imv.tnc_config " [/etc/tnc_config]"
494 TNC IMV configuration directory
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_hasher " [no]"
558 Whether the PKCS#11 modules should be used to hash data
559 .SS libimcv section
560 .TP
561 .BR libimcv.debug_level " [1]"
562 Debug level for a stand-alone libimcv library
563 .TP
564 .BR libimcv.stderr_quiet " [no]"
565 Disable output to stderr with a stand-alone libimcv library
566 .SS libimcv plugins section
567 .TP
568 .BR libimcv.plugins.imc-attestation.platform_info
569 Information on operating system and hardware platform
570 .TP
571 .BR libimcv.plugins.imc-attestation.aik_cert
572 AIK certificate file
573 .TP
574 .BR libimcv.plugins.imc-attestation.aik_key
575 AIK public key file
576 .TP
577 .BR libimcv.plugins.imv-attestation.cadir
578 Path to directory with AIK cacerts
579 .TP
580 .BR libimcv.plugins.imv-attestation.database
581 Path to database with file measurement information
582 .TP
583 .BR libimcv.plugins.imv-attestation.hash_algorithm " [sha1]"
584 Preferred measurement hash algorithm
585 .TP
586 .BR libimcv.plugins.imv-attestation.platform_info
587 Information on operating system and hardware platform
588 .TP
589 .BR libimcv.plugins.imv-scanner.closed_port_policy " [yes]"
590 By default all ports must be closed (yes) or can be open (no)
591 .TP
592 .BR libimcv.plugins.imv-scanner.tcp_ports
593 List of TCP ports that can be open or must be closed
594 .TP
595 .BR libimcv.plugins.imv-scanner.udp_ports
596 List of UDP ports that can be open or must be closed
597 .TP
598 .BR libimcv.plugins.imc-test.command " [none]"
599 Command to be sent to the Test IMV
600 .TP
601 .BR libimcv.plugins.imc-test.retry " [no]"
602 Do a handshake retry
603 .TP
604 .BR libimcv.plugins.imc-test.retry_command
605 Command to be sent to the Test IMV in the handshake retry
606 .TP
607 .BR libimcv.plugins.imv-test.rounds " [0]"
608 Number of IMC-IMV retry rounds
609 .SS libtls section
610 .TP
611 .BR libtls.cipher
612 List of TLS encryption ciphers
613 .TP
614 .BR libtls.key_exchange
615 List of TLS key exchange methods
616 .TP
617 .BR libtls.mac
618 List of TLS MAC algorithms
619 .TP
620 .BR libtls.suites
621 List of TLS cipher suites
622 .SS manager section
623 .TP
624 .BR manager.database
625 Credential database URI for manager
626 .TP
627 .BR manager.debug " [no]"
628 Enable debugging in manager
629 .TP
630 .BR manager.load
631 Plugins to load in manager
632 .TP
633 .BR manager.socket
634 FastCGI socket of manager, to run it statically
635 .TP
636 .BR manager.threads " [10]"
637 Threads to use for request handling
638 .TP
639 .BR manager.timeout " [15m]"
640 Session timeout for manager
641 .SS mediation client section
642 .TP
643 .BR medcli.database
644 Mediation client database URI
645 .TP
646 .BR medcli.dpd " [5m]"
647 DPD timeout to use in mediation client plugin
648 .TP
649 .BR medcli.rekey " [20m]"
650 Rekeying time on mediation connections in mediation client plugin
651 .SS mediation server section
652 .TP
653 .BR medsrv.database
654 Mediation server database URI
655 .TP
656 .BR medsrv.debug " [no]"
657 Debugging in mediation server web application
658 .TP
659 .BR medsrv.dpd " [5m]"
660 DPD timeout to use in mediation server plugin
661 .TP
662 .BR medsrv.load
663 Plugins to load in mediation server plugin
664 .TP
665 .BR medsrv.password_length " [6]"
666 Minimum password length required for mediation server user accounts
667 .TP
668 .BR medsrv.rekey " [20m]"
669 Rekeying time on mediation connections in mediation server plugin
670 .TP
671 .BR medsrv.socket
672 Run Mediation server web application statically on socket
673 .TP
674 .BR medsrv.threads " [5]"
675 Number of thread for mediation service web application
676 .TP
677 .BR medsrv.timeout " [15m]"
678 Session timeout for mediation service
679 .SS openac section
680 .TP
681 .BR openac.load
682 Plugins to load in ipsec openac tool
683 .SS pki section
684 .TP
685 .BR pki.load
686 Plugins to load in ipsec pki tool
687 .SS pluto section
688 .TP
689 .BR pluto.dns1
690 .TQ
691 .BR pluto.dns2
692 DNS servers assigned to peer via Mode Config
693 .TP
694 .BR pluto.load
695 Plugins to load in IKEv1 pluto daemon
696 .TP
697 .BR pluto.nbns1
698 .TQ
699 .BR pluto.nbns2
700 WINS servers assigned to peer via Mode Config
701 .TP
702 .BR pluto.threads " [4]"
703 Number of worker threads in pluto
704 .SS pluto.plugins section
705 .TP
706 .BR pluto.plugins.attr
707 Section to specify arbitrary attributes that are assigned to a peer via
708 Mode Config
709 .TP
710 .BR charon.plugins.kernel-klips.ipsec_dev_count " [4]"
711 Number of ipsecN devices
712 .TP
713 .BR charon.plugins.kernel-klips.ipsec_dev_mtu " [0]"
714 Set MTU of ipsecN device
715 .SS pool section
716 .TP
717 .BR pool.load
718 Plugins to load in ipsec pool tool
719 .SS scepclient section
720 .TP
721 .BR scepclient.load
722 Plugins to load in ipsec scepclient tool
723 .SS starter section
724 .TP
725 .BR starter.load_warning " [yes]"
726 Disable charon/pluto plugin load option warning
727
728 .SH LOGGER CONFIGURATION
729 The options described below provide a much more flexible way to configure
730 loggers for the IKEv2 daemon charon than using the
731 .B charondebug
732 option in
733 .BR ipsec.conf (5).
734 .PP
735 .B Please note
736 that if any loggers are specified in strongswan.conf,
737 .B charondebug
738 does not have any effect.
739 .PP
740 There are currently two types of loggers defined:
741 .TP
742 .B File loggers
743 Log directly to a file and are defined by specifying the full path to the
744 file as subsection in the
745 .B charon.filelog
746 section. To log to the console the two special filenames
747 .BR stdout " and " stderr
748 can be used.
749 .TP
750 .B Syslog loggers
751 Log into a syslog facility and are defined by specifying the facility to log to
752 as the name of a subsection in the
753 .B charon.syslog
754 section. The following facilities are currently supported:
755 .BR daemon " and " auth .
756 .PP
757 Multiple loggers can be defined for each type with different log verbosity for
758 the different subsystems of the daemon.
759 .SS Options
760 .TP
761 .BR charon.filelog.<filename>.default " [1]"
762 .TQ
763 .BR charon.syslog.<facility>.default
764 Specifies the default loglevel to be used for subsystems for which no specific
765 loglevel is defined.
766 .TP
767 .BR charon.filelog.<filename>.<subsystem> " [<default>]"
768 .TQ
769 .BR charon.syslog.<facility>.<subsystem>
770 Specifies the loglevel for the given subsystem.
771 .TP
772 .BR charon.filelog.<filename>.append " [yes]"
773 If this option is enabled log entries are appended to the existing file.
774 .TP
775 .BR charon.filelog.<filename>.flush_line " [no]"
776 Enabling this option disables block buffering and enables line buffering.
777 .TP
778 .BR charon.filelog.<filename>.ike_name " [no]"
779 .TQ
780 .BR charon.syslog.<facility>.ike_name
781 Prefix each log entry with the connection name and a unique numerical
782 identifier for each IKE_SA.
783 .TP
784 .BR charon.filelog.<filename>.time_format
785 Prefix each log entry with a timestamp. The option accepts a format string as
786 passed to
787 .BR strftime (3).
788
789 .SS Subsystems
790 .TP
791 .B dmn
792 Main daemon setup/cleanup/signal handling
793 .TP
794 .B mgr
795 IKE_SA manager, handling synchronization for IKE_SA access
796 .TP
797 .B ike
798 IKE_SA
799 .TP
800 .B chd
801 CHILD_SA
802 .TP
803 .B job
804 Jobs queueing/processing and thread pool management
805 .TP
806 .B cfg
807 Configuration management and plugins
808 .TP
809 .B knl
810 IPsec/Networking kernel interface
811 .TP
812 .B net
813 IKE network communication
814 .TP
815 .B enc
816 Packet encoding/decoding encryption/decryption operations
817 .TP
818 .B tls
819 libtls library messages
820 .TP
821 .B lib
822 libstrongwan library messages
823 .TP
824 .B tnc
825 Trusted Network Connect
826 .TP
827 .B imc
828 Integrity Measurement Collector
829 .TP
830 .B imv
831 Integrity Measurement Verifier
832 .TP
833 .B pts
834 Platform Trust Service
835 .SS Loglevels
836 .TP
837 .B -1
838 Absolutely silent
839 .TP
840 .B 0
841 Very basic auditing logs, (e.g. SA up/SA down)
842 .TP
843 .B 1
844 Generic control flow with errors, a good default to see whats going on
845 .TP
846 .B 2
847 More detailed debugging control flow
848 .TP
849 .B 3
850 Including RAW data dumps in Hex
851 .TP
852 .B 4
853 Also include sensitive material in dumps, e.g. keys
854 .SS Example
855 .PP
856 .EX
857         charon {
858                 filelog {
859                         /var/log/charon.log {
860                                 time_format = %b %e %T
861                                 append = no
862                                 default = 1
863                         }
864                         stderr {
865                                 ike = 2
866                                 knl = 3
867                                 ike_name = yes
868                         }
869                 }
870                 syslog {
871                         # enable logging to LOG_DAEMON, use defaults
872                         daemon {
873                         }
874                         # minimalistic IKE auditing logging to LOG_AUTHPRIV
875                         auth {
876                                 default = -1
877                                 ike = 0
878                         }
879                 }
880         }
881 .EE
882
883 .SH JOB PRIORITY MANAGEMENT
884 Some operations in the IKEv2 daemon charon are currently implemented
885 synchronously and blocking. Two examples for such operations are communication
886 with a RADIUS server via EAP-RADIUS, or fetching CRL/OCSP information during
887 certificate chain verification. Under high load conditions, the thread pool may
888 run out of available threads, and some more important jobs, such as liveness
889 checking, may not get executed in time.
890 .PP
891 To prevent thread starvation in such situations job priorities were introduced.
892 The job processor will reserve some threads for higher priority jobs, these
893 threads are not available for lower priority, locking jobs.
894 .SS Implementation
895 Currently 4 priorities have been defined, and they are used in charon as
896 follows:
897 .TP
898 .B CRITICAL
899 Priority for long-running dispatcher jobs.
900 .TP
901 .B HIGH
902 INFORMATIONAL exchanges, as used by liveness checking (DPD).
903 .TP
904 .B MEDIUM
905 Everything not HIGH/LOW, including IKE_SA_INIT processing.
906 .TP
907 .B LOW
908 IKE_AUTH message processing. RADIUS and CRL fetching block here
909 .PP
910 Although IKE_SA_INIT processing is computationally expensive, it is explicitly
911 assigned to the MEDIUM class. This allows charon to do the DH exchange while
912 other threads are blocked in IKE_AUTH. To prevent the daemon from accepting more
913 IKE_SA_INIT requests than it can handle, use IKE_SA_INIT DROPPING.
914 .PP
915 The thread pool processes jobs strictly by priority, meaning it will consume all
916 higher priority jobs before looking for ones with lower priority. Further, it
917 reserves threads for certain priorities. A priority class having reserved
918 .I n
919 threads will always have
920 .I n
921 threads available for this class (either currently processing a job, or waiting
922 for one).
923 .SS Configuration
924 To ensure that there are always enough threads available for higher priority
925 tasks, threads must be reserved for each priority class.
926 .TP
927 .BR libstrongswan.processor.priority_threads.critical " [0]"
928 Threads reserved for CRITICAL priority class jobs
929 .TP
930 .BR libstrongswan.processor.priority_threads.high " [0]"
931 Threads reserved for HIGH priority class jobs
932 .TP
933 .BR libstrongswan.processor.priority_threads.medium " [0]"
934 Threads reserved for MEDIUM priority class jobs
935 .TP
936 .BR libstrongswan.processor.priority_threads.low " [0]"
937 Threads reserved for LOW priority class jobs
938 .PP
939 Let's consider the following configuration:
940 .PP
941 .EX
942         libstrongswan {
943                 processor {
944                         priority_threads {
945                                 high = 1
946                                 medium = 4
947                         }
948                 }
949         }
950 .EE
951 .PP
952 With this configuration, one thread is reserved for HIGH priority tasks. As
953 currently only liveness checking and stroke message processing is done with
954 high priority, one or two threads should be sufficient.
955 .PP
956 The MEDIUM class mostly processes non-blocking jobs. Unless your setup is
957 experiencing many blocks in locks while accessing shared resources, threads for
958 one or two times the number of CPU cores is fine.
959 .PP
960 It is usually not required to reserve threads for CRITICAL jobs. Jobs in this
961 class rarely return and do not release their thread to the pool.
962 .PP
963 The remaining threads are available for LOW priority jobs. Reserving threads
964 does not make sense (until we have an even lower priority).
965 .SS Monitoring
966 To see what the threads are actually doing, invoke
967 .IR "ipsec statusall" .
968 Under high load, something like this will show up:
969 .PP
970 .EX
971         worker threads: 2 or 32 idle, 5/1/2/22 working,
972                 job queue: 0/0/1/149, scheduled: 198
973 .EE
974 .PP
975 From 32 worker threads,
976 .IP 2
977 are currently idle.
978 .IP 5
979 are running CRITICAL priority jobs (dispatching from sockets, etc.).
980 .IP 1
981 is currently handling a HIGH priority job. This is actually the thread currently
982 providing this information via stroke.
983 .IP 2
984 are handling MEDIUM priority jobs, likely IKE_SA_INIT or CREATE_CHILD_SA
985 messages.
986 .IP 22
987 are handling LOW priority jobs, probably waiting for an EAP-RADIUS response
988 while processing IKE_AUTH messages.
989 .PP
990 The job queue load shows how many jobs are queued for each priority, ready for
991 execution. The single MEDIUM priority job will get executed immediately, as
992 we have two spare threads reserved for MEDIUM class jobs.
993
994 .SH IKE_SA_INIT DROPPING
995 If a responder receives more connection requests per seconds than it can handle,
996 it does not make sense to accept more IKE_SA_INIT messages. And if they are
997 queued but can't get processed in time, an answer might be sent after the
998 client has already given up and restarted its connection setup. This
999 additionally increases the load on the responder.
1000 .PP
1001 To limit the responder load resulting from new connection attempts, the daemon
1002 can drop IKE_SA_INIT messages just after reception. There are two mechanisms to
1003 decide if this should happen, configured with the following options:
1004 .TP
1005 .BR charon.init_limit_half_open " [0]"
1006 Limit based on the number of half open IKE_SAs. Half open IKE_SAs are SAs in
1007 connecting state, but not yet established.
1008 .TP
1009 .BR charon.init_limit_job_load " [0]"
1010 Limit based on the number of jobs currently queued for processing (sum over all
1011 job priorities).
1012 .PP
1013 The second limit includes load from other jobs, such as rekeying. Choosing a
1014 good value is difficult and depends on the hardware and expected load.
1015 .PP
1016 The first limit is simpler to calculate, but includes the load from new
1017 connections only. If your responder is capable of negotiating 100 tunnels/s, you
1018 might set this limit to 1000. The daemon will then drop new connection attempts
1019 if generating a response would require more than 10 seconds. If you are
1020 allowing for a maximum response time of more than 30 seconds, consider adjusting
1021 the timeout for connecting IKE_SAs
1022 .RB ( charon.half_open_timeout ).
1023 A responder, by default, deletes an IKE_SA if the initiator does not establish
1024 it within 30 seconds. Under high load, a higher value might be required.
1025
1026 .SH LOAD TESTS
1027 To do stability testing and performance optimizations, the IKEv2 daemon charon
1028 provides the load-tester plugin. This plugin allows to setup thousands of
1029 tunnels concurrently against the daemon itself or a remote host.
1030 .PP
1031 .B WARNING:
1032 Never enable the load-testing plugin on productive systems. It provides
1033 preconfigured credentials and allows an attacker to authenticate as any user.
1034 .SS Options
1035 .TP
1036 .BR charon.plugins.load-tester.child_rekey " [600]"
1037 Seconds to start CHILD_SA rekeying after setup
1038 .TP
1039 .BR charon.plugins.load-tester.delay " [0]"
1040 Delay between initiatons for each thread
1041 .TP
1042 .BR charon.plugins.load-tester.delete_after_established " [no]"
1043 Delete an IKE_SA as soon as it has been established
1044 .TP
1045 .BR charon.plugins.load-tester.dpd_delay " [0]"
1046 DPD delay to use in load test
1047 .TP
1048 .BR charon.plugins.load-tester.dynamic_port " [0]"
1049 Base port to be used for requests (each client uses a different port)
1050 .TP
1051 .BR charon.plugins.load-tester.eap_password " [default-pwd]"
1052 EAP secret to use in load test
1053 .TP
1054 .BR charon.plugins.load-tester.enable " [no]"
1055 Enable the load testing plugin
1056 .TP
1057 .BR charon.plugins.load-tester.fake_kernel " [no]"
1058 Fake the kernel interface to allow load-testing against self
1059 .TP
1060 .BR charon.plugins.load-tester.ike_rekey " [0]"
1061 Seconds to start IKE_SA rekeying after setup
1062 .TP
1063 .BR charon.plugins.load-tester.init_limit " [0]"
1064 Global limit of concurrently established SAs during load test
1065 .TP
1066 .BR charon.plugins.load-tester.initiators " [0]"
1067 Number of concurrent initiator threads to use in load test
1068 .TP
1069 .BR charon.plugins.load-tester.initiator_auth " [pubkey]"
1070 Authentication method(s) the intiator uses
1071 .TP
1072 .BR charon.plugins.load-tester.initiator_id
1073 Initiator ID used in load test
1074 .TP
1075 .BR charon.plugins.load-tester.iterations " [1]"
1076 Number of IKE_SAs to initate by each initiator in load test
1077 .TP
1078 .BR charon.plugins.load-tester.pool
1079 Provide INTERNAL_IPV4_ADDRs from a named pool
1080 .TP
1081 .BR charon.plugins.load-tester.preshared_key " [default-psk]"
1082 Preshared key to use in load test
1083 .TP
1084 .BR charon.plugins.load-tester.proposal " [aes128-sha1-modp768]"
1085 IKE proposal to use in load test
1086 .TP
1087 .BR charon.plugins.load-tester.remote " [127.0.0.1]"
1088 Address to initiation connections to
1089 .TP
1090 .BR charon.plugins.load-tester.responder_auth " [pubkey]"
1091 Authentication method(s) the responder uses
1092 .TP
1093 .BR charon.plugins.load-tester.responder_id
1094 Responder ID used in load test
1095 .TP
1096 .BR charon.plugins.load-tester.request_virtual_ip " [no]"
1097 Request an INTERNAL_IPV4_ADDR from the server
1098 .TP
1099 .BR charon.plugins.load-tester.shutdown_when_complete " [no]"
1100 Shutdown the daemon after all IKE_SAs have been established
1101 .SS Configuration details
1102 For public key authentication, the responder uses the
1103 .B \(dqCN=srv, OU=load-test, O=strongSwan\(dq
1104 identity. For the initiator, each connection attempt uses a different identity
1105 in the form
1106 .BR "\(dqCN=c1-r1, OU=load-test, O=strongSwan\(dq" ,
1107 where the first number inidicates the client number, the second the
1108 authentication round (if multiple authentication is used).
1109 .PP
1110 For PSK authentication, FQDN identities are used. The server uses
1111 .BR srv.strongswan.org ,
1112 the client uses an identity in the form
1113 .BR c1-r1.strongswan.org .
1114 .PP
1115 For EAP authentication, the client uses a NAI in the form
1116 .BR 100000000010001@strongswan.org .
1117 .PP
1118 To configure multiple authentication, concatenate multiple methods using, e.g.
1119 .EX
1120         initiator_auth = pubkey|psk|eap-md5|eap-aka
1121 .EE
1122 .PP
1123 The responder uses a hardcoded certificate based on a 1024-bit RSA key.
1124 This certificate additionally serves as CA certificate. A peer uses the same
1125 private key, but generates client certificates on demand signed by the CA
1126 certificate. Install the Responder/CA certificate on the remote host to
1127 authenticate all clients.
1128 .PP
1129 To speed up testing, the load tester plugin implements a special Diffie-Hellman
1130 implementation called modpnull. By setting
1131 .EX
1132         proposal = aes128-sha1-modpnull
1133 .EE
1134 this wicked fast DH implementation is used. It does not provide any security
1135 at all, but allows to run tests without DH calculation overhead.
1136 .SS Examples
1137 .PP
1138 In the simplest case, the daemon initiates IKE_SAs against itself using the
1139 loopback interface. This will actually establish double the number of IKE_SAs,
1140 as the daemon is initiator and responder for each IKE_SA at the same time.
1141 Installation of IPsec SAs would fails, as each SA gets installed twice. To
1142 simulate the correct behavior, a fake kernel interface can be enabled which does
1143 not install the IPsec SAs at the kernel level.
1144 .PP
1145 A simple loopback configuration might look like this:
1146 .PP
1147 .EX
1148         charon {
1149                 # create new IKE_SAs for each CHILD_SA to simulate
1150                 # different clients
1151                 reuse_ikesa = no
1152                 # turn off denial of service protection
1153                 dos_protection = no
1154
1155                 plugins {
1156                         load-tester {
1157                                 # enable the plugin
1158                                 enable = yes
1159                                 # use 4 threads to initiate connections
1160                                 # simultaneously
1161                                 initiators = 4
1162                                 # each thread initiates 1000 connections
1163                                 iterations = 1000
1164                                 # delay each initiation in each thread by 20ms
1165                                 delay = 20
1166                                 # enable the fake kernel interface to
1167                                 # avoid SA conflicts
1168                                 fake_kernel = yes
1169                         }
1170                 }
1171         }
1172 .EE
1173 .PP
1174 This will initiate 4000 IKE_SAs within 20 seconds. You may increase the delay
1175 value if your box can not handle that much load, or decrease it to put more
1176 load on it. If the daemon starts retransmitting messages your box probably can
1177 not handle all connection attempts.
1178 .PP
1179 The plugin also allows to test against a remote host. This might help to test
1180 against a real world configuration. A connection setup to do stress testing of
1181 a gateway might look like this:
1182 .PP
1183 .EX
1184         charon {
1185                 reuse_ikesa = no
1186                 threads = 32
1187
1188                 plugins {
1189                         load-tester {
1190                                 enable = yes
1191                                 # 10000 connections, ten in parallel
1192                                 initiators = 10
1193                                 iterations = 1000
1194                                 # use a delay of 100ms, overall time is:
1195                                 # iterations * delay = 100s
1196                                 delay = 100
1197                                 # address of the gateway
1198                                 remote = 1.2.3.4
1199                                 # IKE-proposal to use
1200                                 proposal = aes128-sha1-modp1024
1201                                 # use faster PSK authentication instead
1202                                 # of 1024bit RSA
1203                                 initiator_auth = psk
1204                                 responder_auth = psk
1205                                 # request a virtual IP using configuration
1206                                 # payloads
1207                                 request_virtual_ip = yes
1208                                 # enable CHILD_SA every 60s
1209                                 child_rekey = 60
1210                         }
1211                 }
1212         }
1213 .EE
1214
1215 .SH IKEv2 RETRANSMISSION
1216 Retransmission timeouts in the IKEv2 daemon charon can be configured globally
1217 using the three keys listed below:
1218 .PP
1219 .RS
1220 .nf
1221 .BR charon.retransmit_base " [1.8]"
1222 .BR charon.retransmit_timeout " [4.0]"
1223 .BR charon.retransmit_tries " [5]"
1224 .fi
1225 .RE
1226 .PP
1227 The following algorithm is used to calculate the timeout:
1228 .PP
1229 .EX
1230         relative timeout = retransmit_timeout * retransmit_base ^ (n-1)
1231 .EE
1232 .PP
1233 Where
1234 .I n
1235 is the current retransmission count.
1236 .PP
1237 Using the default values, packets are retransmitted in:
1238
1239 .TS
1240 l r r
1241 ---
1242 lB r r.
1243 Retransmission  Relative Timeout        Absolute Timeout
1244 1       4s      4s
1245 2       7s      11s
1246 3       13s     24s
1247 4       23s     47s
1248 5       42s     89s
1249 giving up       76s     165s
1250 .TE
1251
1252 .SH FILES
1253 /etc/strongswan.conf
1254
1255 .SH SEE ALSO
1256 ipsec.conf(5), ipsec.secrets(5), ipsec(8)
1257 .SH HISTORY
1258 Written for the
1259 .UR http://www.strongswan.org
1260 strongSwan project
1261 .UE
1262 by Tobias Brunner, Andreas Steffen and Martin Willi.