52983ee63d2f56b56e7c7ab49ac2314e87bf9211
[strongswan.git] / conf / options / charon.opt
1 charon {}
2         Options for the charon IKE daemon.
3
4         Options for the charon IKE daemon.
5
6         **Note**: Many of the options in this section also apply to **charon-cmd**
7         and other **charon** derivatives.  Just use their respective name (e.g.
8         **charon-cmd** instead of **charon**). For many options defaults can be
9         defined in the **libstrongswan** section.
10
11 charon.accept_private_algs = no
12         Deliberately violate the IKE standard's requirement and allow the use of
13         private algorithm identifiers, even if the peer implementation is unknown.
14
15 charon.accept_unencrypted_mainmode_messages = no
16         Accept unencrypted ID and HASH payloads in IKEv1 Main Mode.
17
18         Accept unencrypted ID and HASH payloads in IKEv1 Main Mode.
19
20         Some implementations send the third Main Mode message unencrypted, probably
21         to find the PSKs for the specified ID for authentication. This is very
22         similar to Aggressive Mode, and has the same security implications: A
23         passive attacker can sniff the negotiated Identity, and start brute forcing
24         the PSK using the HASH payload.
25
26         It is recommended to keep this option to no, unless you know exactly
27         what the implications are and require compatibility to such devices (for
28         example, some SonicWall boxes).
29
30 charon.block_threshold = 5
31         Maximum number of half-open IKE_SAs for a single peer IP.
32
33 charon.cert_cache = yes
34         Whether relations in validated certificate chains should be cached in
35         memory.
36
37 charon.cache_crls = no
38         Whether Certificate Revocation Lists (CRLs) fetched via HTTP or LDAP should
39         be saved under a unique file name derived from the public key of the
40         Certification Authority (CA) to **/etc/ipsec.d/crls** (stroke) or
41         **/etc/swanctl/x509crl** (vici), respectively.
42
43 charon.check_current_path = no
44         Whether to use DPD to check if the current path still works after any
45         changes to interfaces/addresses.
46
47         By default, after detecting any changes to interfaces and/or addresses no
48         action is taken if the current path to the remote peer still looks usable.
49         Enabling this option will use DPD to check if the path actually still works,
50         or, for instance, the peer removed the state after a longer phase without
51         connectivity.  It will also trigger a MOBIKE update if NAT mappings were
52         removed during the downtime.
53
54 charon.cisco_unity = no
55         Send Cisco Unity vendor ID payload (IKEv1 only).
56
57 charon.close_ike_on_child_failure = no
58         Close the IKE_SA if setup of the CHILD_SA along with IKE_AUTH failed.
59
60 charon.cookie_threshold = 10
61         Number of half-open IKE_SAs that activate the cookie mechanism.
62
63 charon.crypto_test.bench = no
64         Benchmark crypto algorithms and order them by efficiency.
65
66 charon.crypto_test.bench_size = 1024
67         Buffer size used for crypto benchmark.
68
69 charon.crypto_test.bench_time = 50
70         Time in ms during which crypto algorithm performance is measured.
71
72 charon.crypto_test.on_add = no
73         Test crypto algorithms during registration (requires test vectors provided
74         by the _test-vectors_ plugin).
75
76 charon.crypto_test.on_create = no
77         Test crypto algorithms on each crypto primitive instantiation.
78
79 charon.crypto_test.required = no
80         Strictly require at least one test vector to enable an algorithm.
81
82 charon.crypto_test.rng_true = no
83         Whether to test RNG with TRUE quality; requires a lot of entropy.
84
85 charon.delete_rekeyed = no
86         Delete CHILD_SAs right after they got successfully rekeyed (IKEv1 only).
87
88         Delete CHILD_SAs right after they got successfully rekeyed (IKEv1 only).
89         Reduces the number of stale CHILD_SAs in scenarios with a lot of rekeyings.
90         However, this might cause problems with implementations that continue to
91         use rekeyed SAs until they expire.
92
93 charon.delete_rekeyed_delay = 5
94         Delay in seconds until inbound IPsec SAs are deleted after rekeyings (IKEv2
95         only).
96
97         Delay in seconds until inbound IPsec SAs are deleted after rekeyings (IKEv2
98         only). To process delayed packets the inbound part of a CHILD_SA is kept
99         installed up to the configured number of seconds after it got replaced
100         during a rekeying. If set to 0 the CHILD_SA will be kept installed until it
101         expires (if no lifetime is set it will be destroyed immediately).
102
103 charon.dh_exponent_ansi_x9_42 = yes
104         Use ANSI X9.42 DH exponent size or optimum size matched to cryptographic
105         strength.
106
107 charon.dlopen_use_rtld_now = no
108         Use RTLD_NOW with dlopen when loading plugins and IMV/IMCs to reveal missing
109         symbols immediately.
110
111 charon.dns1
112         DNS server assigned to peer via configuration payload (CP).
113
114 charon.dns2
115         DNS server assigned to peer via configuration payload (CP).
116
117 charon.dos_protection = yes
118         Enable Denial of Service protection using cookies and aggressiveness checks.
119
120 charon.ecp_x_coordinate_only = yes
121         Compliance with the errata for RFC 4753.
122
123 charon.flush_auth_cfg = no
124         Free objects during authentication (might conflict with plugins).
125
126         If enabled objects used during authentication (certificates, identities
127         etc.) are released to free memory once an IKE_SA is established. Enabling
128         this might conflict with plugins that later need access to e.g. the used
129         certificates.
130
131 charon.follow_redirects = yes
132         Whether to follow IKEv2 redirects (RFC 5685).
133
134 charon.force_eap_only_authentication = no
135         Violate RFC 5998 and use EAP-only authentication even if the peer did not
136         send an EAP_ONLY_AUTHENTICATION notify during IKE_AUTH.
137
138 charon.fragment_size = 1280
139         Maximum size (complete IP datagram size in bytes) of a sent IKE fragment
140         when using proprietary IKEv1 or standardized IKEv2 fragmentation, defaults
141         to 1280 (use 0 for address family specific default values, which uses a
142         lower value for IPv4).  If specified this limit is used for both IPv4 and
143         IPv6.
144
145 charon.group
146         Name of the group the daemon changes to after startup.
147
148 charon.half_open_timeout = 30
149         Timeout in seconds for connecting IKE_SAs (also see IKE_SA_INIT DROPPING).
150
151 charon.hash_and_url = no
152         Enable hash and URL support.
153
154 charon.host_resolver.max_threads = 3
155         Maximum number of concurrent resolver threads (they are terminated if
156         unused).
157
158 charon.host_resolver.min_threads = 0
159         Minimum number of resolver threads to keep around.
160
161 charon.i_dont_care_about_security_and_use_aggressive_mode_psk = no
162         Allow IKEv1 Aggressive Mode with pre-shared keys as responder.
163
164         If enabled responders are allowed to use IKEv1 Aggressive Mode with
165         pre-shared keys, which is discouraged due to security concerns (offline
166         attacks on the openly transmitted hash of the PSK).
167
168 charon.ignore_routing_tables
169         A space-separated list of routing tables to be excluded from route lookups.
170
171 charon.ignore_acquire_ts = no
172         Whether to ignore the traffic selectors from the kernel's acquire events for
173         IKEv2 connections (they are not used for IKEv1).
174
175         If this is disabled the traffic selectors from the kernel's acquire events,
176         which are derived from the triggering packet, are prepended to the traffic
177         selectors from the configuration for IKEv2 connection. By enabling this,
178         such specific traffic selectors will be ignored and only the ones in the
179         config will     be sent. This always happens for IKEv1 connections as the
180         protocol only supports one set of traffic selectors per CHILD_SA.
181
182 charon.ikesa_limit = 0
183         Maximum number of IKE_SAs that can be established at the same time before
184         new connection attempts are blocked.
185
186 charon.ikesa_table_segments = 1
187         Number of exclusively locked segments in the hash table.
188
189 charon.ikesa_table_size = 1
190         Size of the IKE_SA hash table.
191
192 charon.inactivity_close_ike = no
193         Whether to close IKE_SA if the only CHILD_SA closed due to inactivity.
194
195 charon.init_limit_half_open = 0
196         Limit new connections based on the current number of half open IKE_SAs, see
197         IKE_SA_INIT DROPPING in **strongswan.conf**(5).
198
199 charon.init_limit_job_load = 0
200         Limit new connections based on the number of queued jobs.
201
202         Limit new connections based on the number of jobs currently queued for
203         processing (see IKE_SA_INIT DROPPING).
204
205 charon.initiator_only = no
206         Causes charon daemon to ignore IKE initiation requests.
207
208 charon.install_routes = yes
209         Install routes into a separate routing table for established IPsec tunnels.
210
211 charon.install_virtual_ip = yes
212         Install virtual IP addresses.
213
214 charon.install_virtual_ip_on
215         The name of the interface on which virtual IP addresses should be installed.
216
217         The name of the interface on which virtual IP addresses should be installed.
218         If not specified the addresses will be installed on the outbound interface.
219
220 charon.integrity_test = no
221         Check daemon, libstrongswan and plugin integrity at startup.
222
223 charon.interfaces_ignore
224         A comma-separated list of network interfaces that should be ignored, if
225         **interfaces_use** is specified this option has no effect.
226
227 charon.interfaces_use
228         A comma-separated list of network interfaces that should be used by charon.
229         All other interfaces are ignored.
230
231 charon.keep_alive = 20s
232         NAT keep alive interval.
233
234 charon.keep_alive_dpd_margin = 0s
235         Number of seconds the keep alive interval may be exceeded before a DPD is
236         sent instead of a NAT keep alive (0 to disable).  This is only useful if a
237         clock is used that includes time spent suspended (e.g. CLOCK_BOOTTIME).
238
239 charon.leak_detective.detailed = yes
240         Includes source file names and line numbers in leak detective output.
241
242 charon.leak_detective.usage_threshold = 10240
243         Threshold in bytes for leaks to be reported (0 to report all).
244
245 charon.leak_detective.usage_threshold_count = 0
246         Threshold in number of allocations for leaks to be reported (0 to report
247         all).
248
249 charon.load
250         Plugins to load in the IKE daemon charon.
251
252 charon.load_modular = no
253         Determine plugins to load via each plugin's load option.
254
255         If enabled, the list of plugins to load is determined via the value of the
256         _charon.plugins.<name>.load_ options.  In addition to a simple boolean flag
257         that option may take an integer value indicating the priority of a plugin,
258         which would influence the order of a plugin in the plugin list (the default
259         is 1). If two plugins have the same priority their order in the default
260         plugin list is preserved. Enabled plugins not found in that list are ordered
261         alphabetically before other plugins with the same priority.
262
263 charon.max_ikev1_exchanges = 3
264         Maximum number of IKEv1 phase 2 exchanges per IKE_SA to keep state about and
265         track concurrently.
266
267 charon.max_packet = 10000
268         Maximum packet size accepted by charon.
269
270 charon.make_before_break = no
271         Initiate IKEv2 reauthentication with a make-before-break scheme.
272
273         Initiate IKEv2 reauthentication with a make-before-break instead of a
274         break-before-make scheme. Make-before-break uses overlapping IKE and
275         CHILD_SA during reauthentication by first recreating all new SAs before
276         deleting the old ones. This behavior can be beneficial to avoid connectivity
277         gaps during reauthentication, but requires support for overlapping SAs by
278         the peer. strongSwan can handle such overlapping SAs since version 5.3.0.
279
280 charon.multiple_authentication = yes
281         Enable multiple authentication exchanges (RFC 4739).
282
283 charon.nbns1
284         WINS servers assigned to peer via configuration payload (CP).
285
286 charon.nbns2
287         WINS servers assigned to peer via configuration payload (CP).
288
289 charon.port = 500
290         UDP port used locally. If set to 0 a random port will be allocated.
291
292 charon.port_nat_t = 4500
293         UDP port used locally in case of NAT-T. If set to 0 a random port will be
294         allocated.  Has to be different from **charon.port**, otherwise a random
295         port will be allocated.
296
297 charon.prefer_best_path = no
298         Whether to prefer updating SAs to the path with the best route.
299
300         By default, charon keeps SAs on the routing path with addresses it
301         previously used if that path is still usable. By setting this option to
302         yes, it tries more aggressively to update SAs with MOBIKE on routing
303         priority changes using the cheapest path. This adds more noise, but allows
304         to dynamically adapt SAs to routing priority changes. This option has no
305         effect if MOBIKE is not supported or disabled.
306
307 charon.prefer_configured_proposals = yes
308         Prefer locally configured proposals for IKE/IPsec over supplied ones as
309         responder (disabling this can avoid keying retries due to INVALID_KE_PAYLOAD
310         notifies).
311
312 charon.prefer_temporary_addrs = no
313         Controls whether permanent or temporary IPv6 addresses are used as source,
314         or announced as additional addresses if MOBIKE is used.
315
316         By default, permanent IPv6 source addresses are preferred over temporary
317         ones (RFC 4941), to make connections more stable. Enable this option to
318         reverse this.
319
320         It also affects which IPv6 addresses are announced as additional addresses
321         if MOBIKE is used.  If the option is disabled, only permanent addresses are
322         sent, and only temporary ones if it is enabled.
323
324 charon.process_route = yes
325         Process RTM_NEWROUTE and RTM_DELROUTE events.
326
327 charon.processor.priority_threads {}
328         Section to configure the number of reserved threads per priority class
329         see JOB PRIORITY MANAGEMENT in **strongswan.conf**(5).
330
331 charon.rdn_matching = strict
332         How RDNs in subject DNs of certificates are matched against configured
333         identities (_strict_, _reordered_, or _relaxed_).
334
335         How RDNs in subject DNs of certificates are matched against configured
336         identities. Possible values are _strict_ (the default), _reordered_, and
337         _relaxed_. With _strict_ the number, type and order of all RDNs has to
338         match, wildcards (*) for the values of RDNs are allowed (that's the case
339         for all three variants). Using _reordered_ also matches DNs if the RDNs
340         appear in a different order, the number and type still has to match.
341         Finally, _relaxed_ also allows matches of DNs that contain more RDNs than
342         the configured identity (missing RDNs are treated like a wildcard match).
343
344         Note that _reordered_ and _relaxed_ impose a considerable overhead on memory
345         usage and runtime, in particular, for mismatches, compared to _strict_.
346
347 charon.receive_delay = 0
348         Delay in ms for receiving packets, to simulate larger RTT.
349
350 charon.receive_delay_response = yes
351         Delay response messages.
352
353 charon.receive_delay_request = yes
354         Delay request messages.
355
356 charon.receive_delay_type = 0
357         Specific IKEv2 message type to delay, 0 for any.
358
359 charon.replay_window = 32
360         Size of the AH/ESP replay window, in packets.
361
362 charon.retransmit_base = 1.8
363         Base to use for calculating exponential back off, see IKEv2 RETRANSMISSION
364         in **strongswan.conf**(5).
365
366 charon.retransmit_timeout = 4.0
367         Timeout in seconds before sending first retransmit.
368
369 charon.retransmit_tries = 5
370         Number of times to retransmit a packet before giving up.
371
372 charon.retransmit_jitter = 0
373         Maximum jitter in percent to apply randomly to calculated retransmission
374         timeout (0 to disable).
375
376 charon.retransmit_limit = 0
377         Upper limit in seconds for calculated retransmission timeout (0 to disable).
378
379 charon.retry_initiate_interval = 0
380         Interval in seconds to use when retrying to initiate an IKE_SA (e.g. if DNS
381         resolution failed), 0 to disable retries.
382
383 charon.reuse_ikesa = yes
384         Initiate CHILD_SA within existing IKE_SAs (always enabled for IKEv1).
385
386 charon.routing_table
387         Numerical routing table to install routes to.
388
389 charon.routing_table_prio
390         Priority of the routing table.
391
392 charon.rsa_pss = no
393         Whether to use RSA with PSS padding instead of PKCS#1 padding by default.
394
395 charon.send_delay = 0
396         Delay in ms for sending packets, to simulate larger RTT.
397
398 charon.send_delay_response = yes
399         Delay response messages.
400
401 charon.send_delay_request = yes
402         Delay request messages.
403
404 charon.send_delay_type = 0
405         Specific IKEv2 message type to delay, 0 for any.
406
407 charon.send_vendor_id = no
408         Send strongSwan vendor ID payload
409
410 charon.signature_authentication = yes
411         Whether to enable Signature Authentication as per RFC 7427.
412
413 charon.signature_authentication_constraints = yes
414         Whether to enable constraints against IKEv2 signature schemes.
415
416         If enabled, signature schemes configured in _rightauth_, in addition to
417         getting used as constraints against signature schemes employed in the
418         certificate chain, are also used as constraints against the signature scheme
419         used by peers during IKEv2.
420
421 charon.spi_label = 0x0000000000000000
422         Value mixed into the local IKE SPIs after applying _spi_mask_.
423
424 charon.spi_mask = 0x0000000000000000
425         Mask applied to local IKE SPIs before mixing in _spi_label_ (bits set will
426         be replaced with _spi_label_).
427
428 charon.spi_min = 0xc0000000
429         The lower limit for SPIs requested from the kernel for IPsec SAs.
430
431         The lower limit for SPIs requested from the kernel for IPsec SAs. Should not
432         be set lower than 0x00000100 (256), as SPIs between 1 and 255 are reserved
433         by IANA.
434
435 charon.spi_max = 0xcfffffff
436         The upper limit for SPIs requested from the kernel for IPsec SAs.
437
438 charon.start-scripts {}
439         Section containing a list of scripts (name = path) that are executed when
440         the daemon is started.
441
442 charon.stop-scripts {}
443         Section containing a list of scripts (name = path) that are executed when
444         the daemon is terminated.
445
446 charon.threads = 16
447         Number of worker threads in charon.
448
449         Number of worker threads in charon. Several of these are reserved for long
450         running tasks in internal modules and plugins. Therefore, make sure you
451         don't set this value too low. The number of idle worker threads listed in
452         _ipsec statusall_ might be used as indicator on the number of reserved
453         threads.
454
455 charon.tls.cipher
456         List of TLS encryption ciphers.
457
458 charon.tls.key_exchange
459         List of TLS key exchange methods.
460
461 charon.tls.mac
462         List of TLS MAC algorithms.
463
464 charon.tls.suites
465         List of TLS cipher suites.
466
467 charon.user
468         Name of the user the daemon changes to after startup.
469
470 charon.x509.enforce_critical = yes
471         Discard certificates with unsupported or unknown critical extensions.