ef38d5d86eadb152734a7d6caaf2e3a53ff9a0e4
[strongswan.git] / src / swanctl / swanctl.opt
1 connections { # }
2         Section defining IKE connection configurations.
3
4         Section defining IKE connection configurations.
5
6         The connections section defines IKE connection configurations, each in
7         its own subsections. In the keyword description below, the connection
8         is named _<conn>_, but an arbitrary yet unique connection name can be
9         chosen for each connection subsection.
10
11 connections.<conn> { # }
12         Section for an IKE connection named <conn>.
13
14 connections.<conn>.version = 0
15         IKE major version to use for connection.
16
17         IKE major version to use for connection. _1_ uses IKEv1 aka ISAKMP, _2_
18         uses IKEv2. A connection using the default of _0_ accepts both IKEv1
19         and IKEv2 as responder, and initiates the connection actively with IKEv2.
20
21 connections.<conn>.local_addrs = %any
22         Local address(es) to use for IKE communication, comma separated.
23
24         Local address(es) to use for IKE communication, comma separated. Takes
25         single IPv4/IPv6 addresses, DNS names, CIDR subnets or IP address ranges.
26
27         As initiator, the first non-range/non-subnet is used to initiate the
28         connection from. As responder, the local destination address must match at
29         least to one of the specified addresses, subnets or ranges.
30
31 connections.<conn>.remote_addrs = %any
32         Remote address(es) to use for IKE communication, comma separated.
33
34         Remote address(es) to use for IKE communication, comma separated. Takes
35         single IPv4/IPv6 addresses, DNS names, CIDR subnets or IP address ranges.
36
37         As initiator, the first non-range/non-subnet is used to initiate the
38         connection to. As responder, the initiator source address must match at
39         least to one of the specified addresses, subnets or ranges.
40
41         To initiate a connection, at least one specific address or DNS name must
42         be specified.
43
44 connections.<conn>.local_port = 500
45         Local UPD port for IKE communication.
46
47         Local UPD port for IKE communication. By default the port of the socket
48         backend is used, which is usually _500_. If port _500_ is used, automatic
49         IKE port floating to port 4500 is used to work around NAT issues.
50
51         Using a non-default local IKE port requires support from the socket backend
52         in use (socket-dynamic).
53
54 connections.<conn>.remote_port = 500
55         Remote UDP port for IKE communication.
56
57         Remote UPD port for IKE communication. If the default of port _500_ is used,
58         automatic IKE port floating to port 4500 is used to work around NAT issues.
59
60 connections.<conn>.proposals = default
61         Comma separated proposals to accept for IKE.
62
63         A proposal is a set of algorithms. For non-AEAD algorithms, this includes
64         for IKE an encryption algorithm, an integrity algorithm, a pseudo random
65         function and a Diffie-Hellman group. For AEAD algorithms, instead of
66         encryption and integrity algorithms, a combined algorithm is used.
67
68         In IKEv2, multiple algorithms of the same kind can be specified in a single
69         proposal, from which one gets selected. In IKEv1, only one algorithm per
70         kind is allowed per proposal, more algorithms get implicitly stripped. Use
71         multiple proposals to offer different algorithms combinations in IKEv1.
72
73         Algorithm keywords get separated using dashes. Multiple proposals may be
74         separated by commas. The special value _default_ forms a default proposal
75         of supported algorithms considered safe, and is usually a good choice
76         for interoperability.
77
78 connections.<conn>.vips =
79         Virtual IPs to request in configuration payload / Mode Config.
80
81         Comma separated list of virtual IPs to request in IKEv2 configuration
82         payloads or IKEv1 Mode Config. The wildcard addresses _0.0.0.0_ and _::_
83         request an arbitrary address, specific addresses may be defined. The
84         responder may return a different address, though, or none at all.
85
86 connections.<conn>.aggressive = no
87         Use Aggressive Mode in IKEv1.
88
89         Enables Aggressive Mode instead of Main Mode with Identity Protection.
90         Aggressive Mode is considered less secure, because the ID and HASH
91         payloads are exchanged unprotected. This allows a passive attacker to
92         snoop peer identities, and even worse, start dictionary attacks on the
93         Preshared Key.
94
95 connections.<conn>.pull = yes
96         Set the Mode Config mode to use.
97
98         If the default of _yes_ is used, Mode Config works in pull mode, where
99         the initiator actively requests a virtual IP. With _no_, push mode is used,
100         where the responder pushes down a virtual IP to the initiating peer.
101
102         Push mode is currently supported for IKEv1, but not in IKEv2. It is used
103         by a few implementations only, pull mode is recommended.
104
105 connections.<conn>.encap = no
106         Enforce UDP encapsulation by faking NAT-D payloads.
107
108         To enforce UDP encapsulation of ESP packets, the IKE daemon can fake the
109         NAT detection payloads. This makes the peer believe that NAT takes
110         place on the path, forcing it to encapsulate ESP packets in UDP.
111
112         Usually this is not required, but it can help to work around connectivity
113         issues with too restrictive intermediary firewalls.
114
115 connections.<conn>.mobike = yes
116         Enables MOBIKE on IKEv2 connections.
117
118         Enables MOBIKE on IKEv2 connections. MOBIKE is enabled by default on IKEv2
119         connections, and allows mobility of clients and multi-homing on servers by
120         migrating active IPsec tunnels.
121
122         Usually keeping MOBIKE enabled is unproblematic, as it is not used if the
123         peer does not indicate support for it. However, due to the design of MOBIKE,
124         IKEv2 always floats to port 4500 starting from the second exchange. Some
125         implementations don't like this behavior, hence it can be disabled.
126
127 connections.<conn>.dpd_delay = 0s
128         Interval of liveness checks (DPD).
129
130         Interval to check the liveness of a peer actively using IKEv2 INFORMATIONAL
131         exchanges or IKEv1 R_U_THERE messages. Active DPD checking is only enforced
132         if no IKE or ESP/AH packet has been received for the configured DPD delay.
133
134 connections.<conn>.dpd_timeout = 0s
135         Timeout for DPD checks (IKEV1 only).
136
137         Charon by default uses the normal retransmission mechanism and timeouts to
138         check the liveness of a peer, as all messages are used for liveness
139         checking. For compatibility reasons, with IKEv1 a custom interval may be
140         specified; this option has no effect on connections using IKE2.
141
142 connections.<conn>.fragmentation = no
143         Use IKEv1 UDP packet fragmentation (_yes_, _no_ or _force_).
144
145         The default of _no_ disables IKEv1 fragmentation mechanism, _yes_ enables
146         it if support has been indicated by the peer. _force_ enforces
147         fragmentation if required even before the peer had a chance to indicate
148         support for it.
149
150         IKE fragmentation is currently not supported with IKEv2.
151
152 connections.<conn>.send_certreq = yes
153         Send certificate requests payloads (_yes_ or _no_).
154
155         Send certificate request payloads to offer trusted root CA certificates
156         to the peer. Certificate requests help the peer to choose an appropriate
157         certificate/private key for authentication and are enabled by default.
158
159         Disabling certificate requests can be useful if too many trusted root CA
160         certificates are installed, as each certificate request increases the size
161         of the initial IKE packets.
162
163 connections.<conn>.send_cert = ifasked
164         Send certificate payloads (_always_, _never_ or _ifasked_).
165
166         Send certificate payloads when using certificate authentication. With the
167         default of _ifasked_ the daemon sends certificate payloads only if
168         certificate requests have been received. _never_ disables sending of
169         certificate payloads altogether, _always_ causes certificate payloads to be
170         sent unconditionally whenever certificate authentication is used.
171
172 connections.<conn>.keyingtries = 1
173         Number of retransmission sequences to perform during initial connect.
174
175         Number of retransmission sequences to perform during initial connect.
176         Instead of giving up initiation after the first retransmission sequence with
177         the default value of _1_, additional sequences may be started according to
178         the configured value. A value of _0_ initiates a new sequence until the
179         connection establishes or fails with a permanent error.
180
181 connections.<conn>.unique = no
182         Connection uniqueness policy (_never_, _no_, _keep_ or _replace_).
183
184         Connection uniqueness policy to enforce. To avoid multiple connections
185         from the same user, a uniqueness policy can be enforced. The value _never_
186         does never enforce such a policy, even if a peer included INITIAL_CONTACT
187         notification messages, whereas _no_ replaces existing connections for the
188         same identity if a new one has the INITIAL_CONTACT notify. _keep_ rejects
189         new connection attempts if the same user already has an active connection,
190         _replace_ deletes any existing connection if a new one for the same user
191         gets established.
192
193         To compare connections for uniqueness, the remote IKE identity is used. If
194         EAP or XAuth authentication is involved, the EAP-Identity or XAuth username
195         is used to enforce the uniqueness policy instead.
196
197         On initiators this setting specifies whether an INITIAL_CONTACT notify is
198         sent during IKE_AUTH if no existing connection is found with the remote
199         peer (determined by the identities of the first authentication round).
200         Only if set to _keep_ or _replace_ will the client send a notify.
201
202 connections.<conn>.reauth_time = 0s
203         Time to schedule IKE reauthentication.
204
205         Time to schedule IKE reauthentication. IKE reauthentication recreates the
206         IKE/ISAKMP SA from scratch and re-evaluates the credentials. In asymmetric
207         configurations (with EAP or configuration payloads) it might not be possible
208         to actively reauthenticate as responder. The IKEv2 reauthentication lifetime
209         negotiation can instruct the client to perform reauthentication.
210
211         Reauthentication is disabled by default. Enabling it usually may lead
212         to small connection interruptions, as strongSwan uses a break-before-make
213         policy with IKEv2 to avoid any conflicts with associated tunnel resources.
214
215 connections.<conn>.rekey_time = 4h
216         Time to schedule IKE rekeying.
217
218         IKE rekeying refreshes key material using a Diffie-Hellman exchange, but
219         does not re-check associated credentials. It is supported in IKEv2 only,
220         IKEv1 performs a reauthentication procedure instead.
221
222         With the default value IKE rekeying is scheduled every 4 hours, minus the
223         configured **rand_time**. If a **reauth_time** is configured, **rekey_time**
224         defaults to zero disabling rekeying; explicitly set both to enforce
225         rekeying and reauthentication.
226
227 connections.<conn>.over_time = 10% of rekey_time/reauth_time
228         Hard IKE_SA lifetime if rekey/reauth does not complete, as time.
229
230         Hard IKE_SA lifetime if rekey/reauth does not complete, as time.
231         To avoid having an IKE/ISAKMP kept alive if IKE reauthentication or rekeying
232         fails perpetually, a maximum hard lifetime may be specified. If the
233         IKE_SA fails to rekey or reauthenticate within the specified time, the
234         IKE_SA gets closed.
235
236         In contrast to CHILD_SA rekeying, **over_time** is relative in time to the
237         **rekey_time** _and_ **reauth_time** values, as it applies to both.
238
239         The default is 10% of the longer of **rekey_time** and **reauth_time**.
240
241 connections.<conn>.rand_time = over_time
242         Range of random time to subtract from rekey/reauth times.
243
244         Time range from which to choose a random value to subtract from
245         rekey/reauth times. To avoid having both peers initiating the rekey/reauth
246         procedure simultaneously, a random time gets subtracted from the
247         rekey/reauth times.
248
249         The default is equal to the configured **over_time**.
250
251 connections.<conn>.pools =
252         Comma separated list of named IP pools.
253
254         Comma separated list of named IP pools to allocate virtual IP addresses and
255         other configuration attributes from. Each name references a pool by name
256         from either the **pools** section or an external pool.
257
258 connections.<conn>.local<suffix> {}
259         Section for a local authentication round.
260
261         Section for a local authentication round. A local authentication round
262         defines the rules how authentication is performed for the local peer.
263         Multiple rounds may be defined to use IKEv2 RFC 4739 Multiple Authentication
264         or IKEv1 XAuth.
265
266         Each round is defined in a section having _local_ as prefix, and an optional
267         unique suffix. To define a single authentication round, the suffix may be
268         omitted.
269
270 connections.<conn>.local<suffix>.certs =
271         Comma separated list of certificate candidates to use for authentication.
272
273         Comma separated list of certificate candidates to use for authentication.
274         The certificates may use a relative path from the **swanctl** _x509_
275         directory, or an absolute path.
276
277         The certificate used for authentication is selected based on the received
278         certificate request payloads. If no appropriate CA can be located, the
279         first certificate is used.
280
281 connections.<conn>.local<suffix>.auth = pubkey
282         Authentication to perform locally (_pubkey_, _psk_, _xauth[-backend]_ or
283         _eap[-method]_).
284
285         Authentication to perform locally. _pubkey_ uses public key authentication
286         using a private key associated to a usable certificate. _psk_ uses
287         pre-shared key authentication. The IKEv1 specific _xauth_ is used for
288         XAuth or Hybrid authentication, while the IKEv2 specific _eap_ keyword
289         defines EAP authentication.
290
291         For _xauth_, a specific backend name may be appended, separated by a dash.
292         The appropriate _xauth_ backend is selected to perform the XAuth exchange.
293         For traditional XAuth, the _xauth_ method is usually defined in the second
294         authentication round following an initial _pubkey_ (or _psk_) round. Using
295         _xauth_ in the first round performs Hybrid Mode client authentication.
296
297         For _eap_, a specific EAP method name may be appended, separated by a dash.
298         An EAP module implementing the appropriate method is selected to perform
299         the EAP conversation.
300
301 connections.<conn>.local<suffix>.id =
302         IKE identity to use for authentication round.
303
304         IKE identity to use for authentication round. When using certificate
305         authentication, the IKE identity must be contained in the certificate,
306         either as subject or as subjectAltName.
307
308         The identity can be an IP address, a fully-qualified domain name, an email
309         address or a Distinguished Name for which the ID type is determined
310         automatically and the string is converted to the appropriate encoding. To
311         enforce a specific identity type, a prefix may be used, followed by a colon
312         (:). If the number sign (#) follows the colon, the remaining data is
313         interpreted as hex encoding, otherwise the string is used as-is as the
314         identification data. Note that this implies that no conversion is performed
315         for non-string identities. For example, _ipv4:10.0.0.1_ does not create a
316         valid ID_IPV4_ADDR IKE identity, as it does not get converted to binary
317         0x0a000001. Instead, one could use _ipv4:#0a000001_ to get a valid identity,
318         but just using the implicit type with automatic conversion is usually
319         simpler. The same applies to the ASN1 encoded types. The following prefixes
320         are known: _ipv4_, _ipv6_, _rfc822_, _email_, _userfqdn_, _fqdn_, _dns_,
321         _asn1dn_, _asn1gn_ and _keyid_. Custom type prefixes may be specified by
322         surrounding the numerical type value by curly brackets.
323
324 connections.<conn>.local<suffix>.eap_id = id
325         Client EAP-Identity to use in EAP-Identity exchange and the EAP method.
326
327 connections.<conn>.local<suffix>.aaa_id = remote-id
328         Server side EAP-Identity to expect in the EAP method.
329
330         Server side EAP-Identity to expect in the EAP method. Some EAP methods, such
331         as EAP-TLS, use an identity for the server to perform mutual authentication.
332         This identity may differ from the IKE identity, especially when EAP
333         authentication is delegated from the IKE responder to an AAA backend.
334
335         For EAP-(T)TLS, this defines the identity for which the server must provide
336         a certificate in the TLS exchange.
337
338 connections.<conn>.local<suffix>.xauth_id = id
339         Client XAuth username used in the XAuth exchange.
340
341 connections.<conn>.remote<suffix> {}
342         Section for a remote authentication round.
343
344         Section for a remote authentication round. A remote authentication round
345         defines the constraints how the peers must authenticate to use this
346         connection. Multiple rounds may be defined to use IKEv2 RFC 4739 Multiple
347         Authentication or IKEv1 XAuth.
348
349         Each round is defined in a section having _remote_ as prefix, and an
350         optional unique suffix. To define a single authentication round, the suffix
351         may be omitted.
352
353 connections.<conn>.remote<suffix>.id = %any
354         IKE identity to expect for authentication round.
355
356         IKE identity to expect for authentication round. Refer to the _local_ _id_
357         section for details.
358
359 connections.<conn>.remote<suffix>.groups =
360         Authorization group memberships to require.
361
362         Comma separated authorization group memberships to require. The peer must
363         prove membership to at least one of the specified groups. Group membership
364         can be certified by different means, for example by appropriate Attribute
365         Certificates or by an AAA backend involved in the authentication.
366
367 connections.<conn>.remote<suffix>.certs =
368         Comma separated list of certificate to accept for authentication.
369
370         Comma separated list of certificates to accept for authentication.
371         The certificates may use a relative path from the **swanctl** _x509_
372         directory, or an absolute path.
373
374 connections.<conn>.remote<suffix>.cacerts =
375         Comma separated list of CA certificates to accept for authentication.
376
377         Comma separated list of CA certificates to accept for authentication.
378         The certificates may use a relative path from the **swanctl** _x509ca_
379         directory, or an absolute path.
380
381 connections.<conn>.remote<suffix>.revocation = relaxed
382         Certificate revocation policy, (_strict_, _ifuri_ or _relaxed_).
383
384         Certificate revocation policy for CRL or OCSP revocation.
385
386         A _strict_ revocation policy fails if no revocation information is
387         available, i.e. the certificate is not known to be unrevoked.
388
389         _ifuri_ fails only if a CRL/OCSP URI is available, but certificate
390         revocation checking fails, i.e. there should be revocation information
391         available, but it could not be obtained.
392
393         The default revocation policy _relaxed_ fails only if a certificate
394         is revoked, i.e. it is explicitly known that it is bad.
395
396 connections.<conn>.remote<suffix>.auth = pubkey
397         Authentication to expect from remote (_pubkey_, _psk_, _xauth[-backend]_ or
398         _eap[-method]_).
399
400         Authentication to expect from remote. See the **local** sections **auth**
401         keyword description about the details of supported mechanisms.
402
403 connections.<conn>.children.<child> {}
404         CHILD_SA configuration sub-section.
405
406         CHILD_SA configuration sub-section. Each connection definition may have
407         one or more sections in its _children_ subsection. The section name
408         defines the name of the CHILD_SA configuration, which must be unique within
409         the connection.
410
411 connections.<conn>.children.<child>.ah_proposals =
412         AH proposals to offer for the CHILD_SA.
413
414         AH proposals to offer for the CHILD_SA. A proposal is a set of algorithms.
415         For AH, this includes an integrity algorithm and an optional Diffie-Hellman
416         group. If a DH group is specified, CHILD_SA/Quick Mode rekeying and initial
417         negotiation uses a separate Diffie-Hellman exchange using the specified
418         group.
419
420         In IKEv2, multiple algorithms of the same kind can be specified in a single
421         proposal, from which one gets selected. In IKEv1, only one algorithm per
422         kind is allowed per proposal, more algorithms get implicitly stripped. Use
423         multiple proposals to offer different algorithms combinations in IKEv1.
424
425         Algorithm keywords get separated using dashes. Multiple proposals may be
426         separated by commas. The special value _default_ forms a default proposal
427         of supported algorithms considered safe, and is usually a good choice
428         for interoperability. By default no AH proposals are included, instead ESP
429         is proposed.
430
431 connections.<conn>.children.<child>.esp_proposals = default
432         ESP proposals to offer for the CHILD_SA.
433
434         ESP proposals to offer for the CHILD_SA. A proposal is a set of algorithms.
435         For ESP non-AEAD proposals, this includes an integrity algorithm, an
436         encryption algorithm, an optional Diffie-Hellman group and an optional
437         Extended Sequence Number Mode indicator. For AEAD proposals, a combined
438         mode algorithm is used instead of the separate encryption/integrity
439         algorithms.
440
441         If a DH group is specified, CHILD_SA/Quick Mode rekeying and initial (non
442         IKE_AUTH piggybacked) negotiation uses a separate Diffie-Hellman exchange
443         using the specified group. Extended Sequence Number support may be indicated
444         with the _esn_ and _noesn_ values, both may be included to indicate support
445         for both modes. If omitted, _noesn_ is assumed.
446
447         In IKEv2, multiple algorithms of the same kind can be specified in a single
448         proposal, from which one gets selected. In IKEv1, only one algorithm per
449         kind is allowed per proposal, more algorithms get implicitly stripped. Use
450         multiple proposals to offer different algorithms combinations in IKEv1.
451
452         Algorithm keywords get separated using dashes. Multiple proposals may be
453         separated by commas. The special value _default_ forms a default proposal
454         of supported algorithms considered safe, and is usually a good choice
455         for interoperability. If no algorithms are specified for AH nor ESP,
456         the _default_ set of algorithms for ESP is included.
457
458 connections.<conn>.children.<child>.local_ts = dynamic
459         Local traffic selectors to include in CHILD_SA.
460
461         Comma separated list of local traffic selectors to include in CHILD_SA.
462         Each selector is a CIDR subnet definition, followed by an optional
463         proto/port selector. The special value _dynamic_ may be used instead of a
464         subnet definition, which gets replaced by the tunnel outer address or the
465         virtual IP, if negotiated. This is the default.
466
467         A protocol/port selector is surrounded by opening and closing square
468         brackets. Between these brackets, a numeric or **getservent**(3) protocol
469         name may be specified. After the optional protocol restriction, an optional
470         port restriction may be specified, separated by a slash. The port
471         restriction may be numeric, a **getservent**(3) service name, or the special
472         value _opaque_ for RFC 4301 OPAQUE selectors. Port ranges may be specified
473         as well, none of the kernel backends currently support port ranges, though.
474
475         Unless the Unity extension is used, IKEv1 supports the first specified
476         selector only. IKEv1 uses very similar traffic selector narrowing as it is
477         supported in the IKEv2 protocol.
478
479 connections.<conn>.children.<child>.remote_ts = dynamic
480         Remote selectors to include in CHILD_SA.
481
482         Comma separated list of remote selectors to include in CHILD_SA. See
483         **local_ts** for a description of the selector syntax.
484
485 connections.<conn>.children.<child>.rekey_time = 1h
486         Time to schedule CHILD_SA rekeying.
487
488         Time to schedule CHILD_SA rekeying. CHILD_SA rekeying refreshes key
489         material, optionally using a Diffie-Hellman exchange if a group is
490         specified in the proposal.
491
492         To avoid rekey collisions initiated by both ends simultaneously, a value
493         in the range of **rand_time** gets subtracted to form the effective soft
494         lifetime.
495
496         By default CHILD_SA rekeying is scheduled every hour, minus **rand_time**.
497
498 connections.<conn>.children.<child>.life_time = rekey_time + 10%
499         Maximum lifetime before CHILD_SA gets closed, as time.
500
501         Maximum lifetime before CHILD_SA gets closed. Usually this hard lifetime
502         is never reached, because the CHILD_SA gets rekeyed before.
503         If that fails for whatever reason, this limit closes the CHILD_SA.
504
505         The default is 10% more than the **rekey_time**.
506
507 connections.<conn>.children.<child>.rand_time = life_time - rekey_time
508         Range of random time to subtract from **rekey_time**.
509
510         Time range from which to choose a random value to subtract from
511         **rekey_time**. The default is the difference between **life_time** and
512         **rekey_time**.
513
514 connections.<conn>.children.<child>.rekey_bytes = 0
515         Number of bytes processed before initiating CHILD_SA rekeying.
516
517         Number of bytes processed before initiating CHILD_SA rekeying. CHILD_SA
518         rekeying refreshes key material, optionally using a Diffie-Hellman exchange
519         if a group is specified in the proposal.
520
521         To avoid rekey collisions initiated by both ends simultaneously, a value
522         in the range of **rand_bytes** gets subtracted to form the effective soft
523         volume limit.
524
525         Volume based CHILD_SA rekeying is disabled by default.
526
527 connections.<conn>.children.<child>.life_bytes = rekey_bytes + 10%
528         Maximum bytes processed before CHILD_SA gets closed.
529
530         Maximum bytes processed before CHILD_SA gets closed. Usually this hard
531         volume limit is never reached, because the CHILD_SA gets rekeyed before.
532         If that fails for whatever reason, this limit closes the CHILD_SA.
533
534         The default is 10% more than **rekey_bytes**.
535
536 connections.<conn>.children.<child>.rand_bytes = life_bytes - rekey_bytes
537         Range of random bytes to subtract from **rekey_bytes**.
538
539         Byte range from which to choose a random value to subtract from
540         **rekey_bytes**. The default is the difference between **life_bytes** and
541         **rekey_bytes**.
542
543 connections.<conn>.children.<child>.rekey_packets = 0
544         Number of packets processed before initiating CHILD_SA rekeying.
545
546         Number of packets processed before initiating CHILD_SA rekeying. CHILD_SA
547         rekeying refreshes key material, optionally using a Diffie-Hellman exchange
548         if a group is specified in the proposal.
549
550         To avoid rekey collisions initiated by both ends simultaneously, a value
551         in the range of **rand_packets** gets subtracted to form the effective soft
552         packet count limit.
553
554         Packet count based CHILD_SA rekeying is disabled by default.
555
556 connections.<conn>.children.<child>.life_packets = rekey_packets + 10%
557         Maximum number of packets processed before CHILD_SA gets closed.
558
559         Maximum number of packets processed before CHILD_SA gets closed. Usually
560         this hard packets limit is never reached, because the CHILD_SA gets rekeyed
561         before. If that fails for whatever reason, this limit closes the CHILD_SA.
562
563         The default is 10% more than **rekey_bytes**.
564
565 connections.<conn>.children.<child>.rand_packets = life_packets - rekey_packets
566         Range of random packets to subtract from **packets_bytes**.
567
568         Packet range from which to choose a random value to subtract from
569         **rekey_packets**. The default is the difference between **life_packets**
570         and **rekey_packets**.
571
572 connections.<conn>.children.<child>.updown =
573         Updown script to invoke on CHILD_SA up and down events.
574
575 connections.<conn>.children.<child>.hostaccess = yes
576         Hostaccess variable to pass to **updown** script.
577
578 connections.<conn>.children.<child>.mode = tunnel
579         IPsec Mode to establish (_tunnel_, _transport_, _beet_, _pass_ or _drop_).
580
581         IPsec Mode to establish CHILD_SA with. _tunnel_ negotiates the CHILD_SA
582         in IPsec Tunnel Mode, whereas _transport_ uses IPsec Transport Mode. _beet_
583         is the Bound End to End Tunnel mixture mode, working with fixed inner
584         addresses without the need to include them in each packet.
585
586         Both _transport_ and _beet_ modes are subject to mode negotiation; _tunnel_
587         mode is negotiated if the preferred mode is not available.
588
589         _pass_ and _drop_ are used to install shunt policies, which explicitly
590         bypass the defined traffic from IPsec processing, or drop it, respectively.
591
592 connections.<conn>.children.<child>.policies = yes
593         Whether to install IPsec policies or not.
594
595         Whether to install IPsec policies or not. Disabling this can be useful in
596         some scenarios e.g. MIPv6, where policies are not managed by the IKE daemon.
597
598 connections.<conn>.children.<child>.dpd_action = clear
599         Action to perform on DPD timeout (_clear_, _trap_ or _restart_).
600
601         Action to perform for this CHILD_SA on DPD timeout. The default _clear_
602         closes the CHILD_SA and does not take further action. _trap_ installs
603         a trap policy, which will catch matching traffic and tries to re-negotiate
604         the tunnel on-demand. _restart_ immediately tries to re-negotiate the
605         CHILD_SA under a fresh IKE_SA.
606
607 connections.<conn>.children.<child>.ipcomp = no
608         Enable IPComp compression before encryption.
609
610         Enable IPComp compression before encryption. If enabled, IKE tries to
611         negotiate IPComp compression to compress ESP payload data prior to
612         encryption.
613
614 connections.<conn>.children.<child>.inactivity = 0s
615         Timeout before closing CHILD_SA after inactivity.
616
617         Timeout before closing CHILD_SA after inactivity. If no traffic has
618         been processed in either direction for the configured timeout, the CHILD_SA
619         gets closed due to inactivity. The default value of _0_ disables inactivity
620         checks.
621
622 connections.<conn>.children.<child>.reqid = 0
623         Fixed reqid to use for this CHILD_SA.
624
625         Fixed reqid to use for this CHILD_SA. This might be helpful in some
626         scenarios, but works only if each CHILD_SA configuration is instantiated
627         not more than once. The default of _0_ uses dynamic reqids, allocated
628         incrementally.
629
630 connections.<conn>.children.<child>.mark_in = 0/0x00000000
631         Netfilter mark and mask for input traffic.
632
633         Netfilter mark and mask for input traffic. On Linux Netfilter may require
634         marks on each packet to match an SA having that option set. This allows
635         Netfilter rules to select specific tunnels for incoming traffic. The
636         special value _%unique_ sets a unique mark on each CHILD_SA instance.
637
638         An additional mask may be appended to the mark, separated by _/_. The
639         default mask if omitted is 0xffffffff.
640
641 connections.<conn>.children.<child>.mark_out = 0/0x00000000
642         Netfilter mark and mask for output traffic.
643
644         Netfilter mark and mask for output traffic. On Linux Netfilter may require
645         marks on each packet to match a policy having that option set. This allows
646         Netfilter rules to select specific tunnels for outgoing traffic. The
647         special value _%unique_ sets a unique mark on each CHILD_SA instance.
648
649         An additional mask may be appended to the mark, separated by _/_. The
650         default mask if omitted is 0xffffffff.
651
652 connections.<conn>.children.<child>.tfc_padding = 0
653         Traffic Flow Confidentiality padding.
654
655         Pads ESP packets with additional data to have a consistent ESP packet size
656         for improved Traffic Flow Confidentiality. The padding defines the minimum
657         size of all ESP packets sent.
658
659         The default value of 0 disables TFC padding, the special value _mtu_ adds
660         TFC padding to create a packet size equal to the Path Maximum Transfer Unit.
661
662 connections.<conn>.children.<child>.replay_window = 32
663         IPsec replay window to configure for this CHILD_SA.
664
665         IPsec replay window to configure for this CHILD_SA. Larger values than the
666         default of 32 are supported using the Netlink backend only, a value of 0
667         disables IPsec replay protection.
668
669 connections.<conn>.children.<child>.start_action = none
670         Action to perform after loading the configuration (_none_, _trap_, _start_).
671
672         Action to perform after loading the configuration. The default of _none_
673         loads the connection only, which then can be manually initiated or used as
674         a responder configuration.
675
676         The value _trap_ installs a trap policy, which triggers the tunnel as soon
677         as matching traffic has been detected. The value _start_ initiates
678         the connection actively.
679
680         When unloading or replacing a CHILD_SA configuration having a
681         **start_action** different from _none_, the inverse action is performed.
682         Configurations with _start_ get closed, while such with _trap_ get
683         uninstalled.
684
685 connections.<conn>.children.<child>.close_action = none
686         Action to perform after a CHILD_SA gets closed (_none_, _trap_, _start_).
687
688         Action to perform after a CHILD_SA gets closed by the peer. The default of
689         _none_ does not take any action, _trap_ installs a trap policy for the
690         CHILD_SA. _start_ tries to re-create the CHILD_SA.
691
692         **close_action** does not provide any guarantee that the CHILD_SA is kept
693         alive. It acts on explicit close messages only, but not on negotiation
694         failures. Use trap policies to reliably re-create failed CHILD_SAs.
695
696 secrets { # }
697         Section defining secrets for IKE/EAP/XAuth authentication and private
698         key decryption.
699
700         Section defining secrets for IKE/EAP/XAuth authentication and private key
701         decryption. The **secrets** section takes sub-sections having a specific
702         prefix which defines the secret type.
703
704         It is not recommended to define any private key decryption passphrases,
705         as then there is no real security benefit in having encrypted keys. Either
706         store the key unencrypted, or enter the keys manually when loading
707         credentials.
708
709 secrets.eap<suffix> { # }
710         EAP secret section for a specific secret.
711
712         EAP secret section for a specific secret. Each EAP secret is defined in
713         a unique section having the _eap_ prefix. EAP secrets are used for XAuth
714         authentication as well.
715
716 secrets.xauth<suffix> { # }
717         XAuth secret section for a specific secret.
718
719         XAuth secret section for a specific secret. **xauth** is just an alias
720         for **eap**, secrets under both section prefixes are used for both EAP and
721         XAuth authentication.
722
723 secrets.eap<suffix>.secret =
724         Value of the EAP/XAuth secret.
725
726         Value of the EAP/XAuth secret. It may either be an ASCII string, a hex
727         encoded string if it has a _0x_ prefix, or a Base64 encoded string if it
728         has a _0s_ prefix in its value.
729
730 secrets.eap<suffix>.id<suffix> =
731         Identity the EAP/XAuth secret belongs to.
732
733         Identity the EAP/XAuth secret belongs to. Multiple unique identities may
734         be specified, each having an _id_ prefix, if a secret is shared between
735         multiple users.
736
737 secrets.ike<suffix> { # }
738         IKE preshared secret section for a specific secret.
739
740         IKE preshared secret section for a specific secret. Each IKE PSK is defined
741         in a unique section having the _ike_ prefix.
742
743 secrets.ike<suffix>.secret =
744         Value of the IKE preshared secret.
745
746         Value of the IKE preshared secret. It may either be an ASCII string,
747         a hex encoded string if it has a _0x_ prefix, or a Base64 encoded string if
748         it has a _0s_ prefix in its value.
749
750 secrets.ike<suffix>.id<suffix> =
751         IKE identity the IKE preshared secret belongs to.
752
753         IKE identity the IKE preshared secret belongs to. Multiple unique identities
754         may be specified, each having an _id_ prefix, if a secret is shared between
755         multiple peers.
756
757 secrets.rsa<suffix> { # }
758         Private key decryption passphrase for a key in the _rsa_ folder.
759
760 secrets.rsa<suffix>.file =
761         File name in the _rsa_ folder for which this passphrase should be used.
762
763 secrets.rsa<suffix>.secret
764         Value of decryption passphrase for RSA key.
765
766 secrets.ecdsa<suffix> { # }
767         Private key decryption passphrase for a key in the _ecdsa_ folder.
768
769 secrets.ecdsa<suffix>.file =
770         File name in the _ecdsa_ folder for which this passphrase should be used.
771
772 secrets.ecdsa<suffix>.secret
773         Value of decryption passphrase for ECDSA key.
774
775 secrets.pkcs8<suffix> { # }
776         Private key decryption passphrase for a key in the _pkcs8_ folder.
777
778 secrets.pkcs8<suffix>.file =
779         File name in the _pkcs8_ folder for which this passphrase should be used.
780
781 secrets.pkcs8<suffix>.secret
782         Value of decryption passphrase for PKCS#8 key.
783
784 secrets.pkcs12<suffix> { # }
785         PKCS#12 decryption passphrase for a container in the _pkcs12_ folder.
786
787 secrets.pkcs12<suffix>.file =
788         File name in the _pkcs12_ folder for which this passphrase should be used.
789
790 secrets.pkcs12<suffix>.secret
791         Value of decryption passphrase for PKCS#12 container.
792
793 pools { # }
794         Section defining named pools.
795
796         Section defining named pools. Named pools may be referenced by connections
797         with the **pools** option to assign virtual IPs and other configuration
798         attributes.
799
800 pools.<name> { # }
801         Section defining a single pool with a unique name.
802
803 pools.<name>.addrs =
804         Addresses allocated in pool.
805
806         Subnet or range defining addresses allocated in pool. Accepts a single CIDR
807         subnet defining the pool to allocate addresses from, or an address range
808         (<from>-<to>).  Pools must be unique and non-overlapping.
809
810 pools.<name>.<attr> =
811         Comma separated list of additional attributes from type <attr>.
812
813         Comma separated list of additional attributes of type **<attr>**. The
814         attribute type may be one of _dns_, _nbns_, _dhcp_, _netmask_, _server_,
815         _subnet_, _split_include_ and _split_exclude_ to define addresses or CIDR
816         subnets for the corresponding attribute types. Alternatively, **<attr>** can
817         be a numerical identifier, for which string attribute values are accepted
818         as well.
819
820 authorities { # }
821         Section defining attributes of certification authorities.
822
823 authorities.<name> { # }
824         Section defining a certification authority with a unique name.
825
826 authorities.<name>.cacert =
827         CA certificate belonging to the certification authority.
828
829         The certificates may use a relative path from the **swanctl** _x509ca_
830         directory, or an absolute path.
831
832 authorities.<name>.crl_uris =
833         Comma-separated list of CRL distribution points
834
835         Comma-separated list of CRL distribution points (ldap, http, or file URI)
836
837 authorities.<name>.ocsp_uris =
838         Comma-separated list of OCSP URIs
839
840         Comma-separated list of OCSP URIs
841
842 authorities.<name>.cert_uri_base =
843         Defines the base URI for the Hash and URL feature supported by IKEv2.
844
845         Defines the base URI for the Hash and URL feature supported by IKEv2.
846         Instead of exchanging complete certificates, IKEv2 allows one to send an
847         URI that resolves to the DER encoded certificate. The certificate URIs are
848         built by appending the SHA1 hash of the DER encoded certificates to this
849         base URI.
850