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