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