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