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