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**.
 224
 225 connections.<conn>.over_time = 10% of rekey_time/reauth_time
 226         Hard IKE_SA lifetime if rekey/reauth does not complete, as time.
 227
 228         Hard IKE_SA lifetime if rekey/reauth does not complete, as time.
 229         To avoid having an IKE/ISAKMP kept alive if IKE reauthentication or rekeying
 230         fails perpetually, a maximum hard lifetime may be specified. If the
 231         IKE_SA fails to rekey or reauthenticate within the specified time, the
 232         IKE_SA gets closed.
 233
 234         In contrast to CHILD_SA rekeying, **over_time** is relative in time to the
 235         **rekey_time** _and_ **reauth_time** values, as it applies to both.
 236
 237         The default is 10% of the longer of **rekey_time** and **reauth_time**.
 238
 239 connections.<conn>.rand_time = over_time
 240         Range of random time to subtract from rekey/reauth times.
 241
 242         Time range from which to choose a random value to subtract from
 243         rekey/reauth times. To avoid having both peers initiating the rekey/reauth
 244         procedure simultaneously, a random time gets subtracted from the
 245         rekey/reauth times.
 246
 247         The default is equal to the configured **over_time**.
 248
 249 connections.<conn>.pools =
 250         Comma separated list of named IP pools.
 251
 252         Comma separated list of named IP pools to allocate virtual IP addresses and
 253         other configuration attributes from. Each name references a pool by name
 254         from either the **pools** section or an external pool.
 255
 256 connections.<conn>.local<suffix> {}
 257         Section for a local authentication round.
 258
 259         Section for a local authentication round. A local authentication round
 260         defines the rules how authentication is performed for the local peer.
 261         Multiple rounds may be defined to use IKEv2 RFC 4739 Multiple Authentication
 262         or IKEv1 XAuth.
 263
 264         Each round is defined in a section having _local_ as prefix, and an optional
 265         unique suffix. To define a single authentication round, the suffix may be
 266         omitted.
 267
 268 connections.<conn>.local<suffix>.certs =
 269         Comma separated list of certificate candidates to use for authentication.
 270
 271         Comma separated list of certificate candidates to use for authentication.
 272         The certificates may use a relative path from the **swanctl** _x509_
 273         directory, or an absolute path.
 274
 275         The certificate used for authentication is selected based on the received
 276         certificate request payloads. If no appropriate CA can be located, the
 277         first certificate is used.
 278
 279 connections.<conn>.local<suffix>.auth = pubkey
 280         Authentication to perform locally (_pubkey_, _psk_, _xauth[-backend]_ or
 281         _eap[-method]_).
 282
 283         Authentication to perform locally. _pubkey_ uses public key authentication
 284         using a private key associated to a usable certificate. _psk_ uses
 285         pre-shared key authentication. The IKEv1 specific _xauth_ is used for
 286         XAuth or Hybrid authentication, while the IKEv2 specific _eap_ keyword
 287         defines EAP authentication.
 288
 289         For _xauth_, a specific backend name may be appended, separated by a dash.
 290         The appropriate _xauth_ backend is selected to perform the XAuth exchange.
 291         For traditional XAuth, the _xauth_ method is usually defined in the second
 292         authentication round following an initial _pubkey_ (or _psk_) round. Using
 293         _xauth_ in the first round performs Hybrid Mode client authentication.
 294
 295         For _eap_, a specific EAP method name may be appended, separated by a dash.
 296         An EAP module implementing the appropriate method is selected to perform
 297         the EAP conversation.
 298
 299 connections.<conn>.local<suffix>.id =
 300         IKE identity to use for authentication round.
 301
 302         IKE identity to use for authentication round. When using certificate
 303         authentication, the IKE identity must be contained in the certificate,
 304         either as subject or as subjectAltName.
 305
 306         The identity can be an IP address, a fully-qualified domain name, an email
 307         address or a Distinguished Name for which the ID type is determined
 308         automatically and the string is converted to the appropriate encoding. To
 309         enforce a specific identity type, a prefix may be used, followed by a colon
 310         (:). If the number sign (#) follows the colon, the remaining data is
 311         interpreted as hex encoding, otherwise the string is used as-is as the
 312         identification data. Note that this implies that no conversion is performed
 313         for non-string identities. For example, _ipv4:10.0.0.1_ does not create a
 314         valid ID_IPV4_ADDR IKE identity, as it does not get converted to binary
 315         0x0a000001. Instead, one could use _ipv4:#0a000001_ to get a valid identity,
 316         but just using the implicit type with automatic conversion is usually
 317         simpler. The same applies to the ASN1 encoded types. The following prefixes
 318         are known: _ipv4_, _ipv6_, _rfc822_, _email_, _userfqdn_, _fqdn_, _dns_,
 319         _asn1dn_, _asn1gn_ and _keyid_. Custom type prefixes may be specified by
 320         surrounding the numerical type value by curly brackets.
 321
 322 connections.<conn>.local<suffix>.eap_id = id
 323         Client EAP-Identity to use in EAP-Identity exchange and the EAP method.
 324
 325 connections.<conn>.local<suffix>.aaa_id = remote-id
 326         Server side EAP-Identity to expect in the EAP method.
 327
 328         Server side EAP-Identity to expect in the EAP method. Some EAP methods, such
 329         as EAP-TLS, use an identity for the server to perform mutual authentication.
 330         This identity may differ from the IKE identity, especially when EAP
 331         authentication is delegated from the IKE responder to an AAA backend.
 332
 333         For EAP-(T)TLS, this defines the identity for which the server must provide
 334         a certificate in the TLS exchange.
 335
 336 connections.<conn>.local<suffix>.xauth_id = id
 337         Client XAuth username used in the XAuth exchange.
 338
 339 connections.<conn>.remote<suffix> {}
 340         Section for a remote authentication round.
 341
 342         Section for a remote authentication round. A remote authentication round
 343         defines the constraints how the peers must authenticate to use this
 344         connection. Multiple rounds may be defined to use IKEv2 RFC 4739 Multiple
 345         Authentication or IKEv1 XAuth.
 346
 347         Each round is defined in a section having _remote_ as prefix, and an
 348         optional unique suffix. To define a single authentication round, the suffix
 349         may be omitted.
 350
 351 connections.<conn>.remote<suffix>.id = %any
 352         IKE identity to expect for authentication round.
 353
 354         IKE identity to expect for authentication round. Refer to the _local_ _id_
 355         section for details.
 356
 357 connections.<conn>.remote<suffix>.groups =
 358         Authorization group memberships to require.
 359
 360         Comma separated authorization group memberships to require. The peer must
 361         prove membership to at least one of the specified groups. Group membership
 362         can be certified by different means, for example by appropriate Attribute
 363         Certificates or by an AAA backend involved in the authentication.
 364
 365 connections.<conn>.remote<suffix>.certs =
 366         Comma separated list of certificate to accept for authentication.
 367
 368         Comma separated list of certificates to accept for authentication.
 369         The certificates may use a relative path from the **swanctl** _x509_
 370         directory, or an absolute path.
 371
 372 connections.<conn>.remote<suffix>.cacerts =
 373         Comma separated list of CA certificates to accept for authentication.
 374
 375         Comma separated list of CA certificates to accept for authentication.
 376         The certificates may use a relative path from the **swanctl** _x509ca_
 377         directory, or an absolute path.
 378
 379 connections.<conn>.remote<suffix>.revocation = relaxed
 380         Certificate revocation policy, (_strict_, _ifuri_ or _relaxed_).
 381
 382         Certificate revocation policy for CRL or OCSP revocation.
 383
 384         A _strict_ revocation policy fails if no revocation information is
 385         available, i.e. the certificate is not known to be unrevoked.
 386
 387         _ifuri_ fails only if a CRL/OCSP URI is available, but certificate
 388         revocation checking fails, i.e. there should be revocation information
 389         available, but it could not be obtained.
 390
 391         The default revocation policy _relaxed_ fails only if a certificate
 392         is revoked, i.e. it is explicitly known that it is bad.
 393
 394 connections.<conn>.remote<suffix>.auth = pubkey
 395         Authentication to expect from remote (_pubkey_, _psk_, _xauth[-backend]_ or
 396         _eap[-method]_).
 397
 398         Authentication to expect from remote. See the **local** sections **auth**
 399         keyword description about the details of supported mechanisms.
 400
 401 connections.<conn>.children.<child> {}
 402         CHILD_SA configuration sub-section.
 403
 404         CHILD_SA configuration sub-section. Each connection definition may have
 405         one or more sections in its _children_ subsection. The section name
 406         defines the name of the CHILD_SA configuration, which must be unique within
 407         the connection.
 408
 409 connections.<conn>.children.<child>.ah_proposals =
 410         AH proposals to offer for the CHILD_SA.
 411
 412         AH proposals to offer for the CHILD_SA. A proposal is a set of algorithms.
 413         For AH, this includes an integrity algorithm and an optional Diffie-Hellman
 414         group. If a DH group is specified, CHILD_SA/Quick Mode rekeying and initial
 415         negotiation uses a separate Diffie-Hellman exchange using the specified
 416         group.
 417
 418         In IKEv2, multiple algorithms of the same kind can be specified in a single
 419         proposal, from which one gets selected. In IKEv1, only one algorithm per
 420         kind is allowed per proposal, more algorithms get implicitly stripped. Use
 421         multiple proposals to offer different algorithms combinations in IKEv1.
 422
 423         Algorithm keywords get separated using dashes. Multiple proposals may be
 424         separated by commas. The special value _default_ forms a default proposal
 425         of supported algorithms considered safe, and is usually a good choice
 426         for interoperability. By default no AH proposals are included, instead ESP
 427         is proposed.
 428
 429 connections.<conn>.children.<child>.esp_proposals = default
 430         ESP proposals to offer for the CHILD_SA.
 431
 432         ESP proposals to offer for the CHILD_SA. A proposal is a set of algorithms.
 433         For ESP non-AEAD proposals, this includes an integrity algorithm, an
 434         encryption algorithm, an optional Diffie-Hellman group and an optional
 435         Extended Sequence Number Mode indicator. For AEAD proposals, a combined
 436         mode algorithm is used instead of the separate encryption/integrity
 437         algorithms.
 438
 439         If a DH group is specified, CHILD_SA/Quick Mode rekeying and initial (non
 440         IKE_AUTH piggybacked) negotiation uses a separate Diffie-Hellman exchange
 441         using the specified group. Extended Sequence Number support may be indicated
 442         with the _esn_ and _noesn_ values, both may be included to indicate support
 443         for both modes. If omitted, _noesn_ is assumed.
 444
 445         In IKEv2, multiple algorithms of the same kind can be specified in a single
 446         proposal, from which one gets selected. In IKEv1, only one algorithm per
 447         kind is allowed per proposal, more algorithms get implicitly stripped. Use
 448         multiple proposals to offer different algorithms combinations in IKEv1.
 449
 450         Algorithm keywords get separated using dashes. Multiple proposals may be
 451         separated by commas. The special value _default_ forms a default proposal
 452         of supported algorithms considered safe, and is usually a good choice
 453         for interoperability. If no algorithms are specified for AH nor ESP,
 454         the _default_ set of algorithms for ESP is included.
 455
 456 connections.<conn>.children.<child>.local_ts = dynamic
 457         Local traffic selectors to include in CHILD_SA.
 458
 459         Comma separated list of local traffic selectors to include in CHILD_SA.
 460         Each selector is a CIDR subnet definition, followed by an optional
 461         proto/port selector. The special value _dynamic_ may be used instead of a
 462         subnet definition, which gets replaced by the tunnel outer address or the
 463         virtual IP, if negotiated. This is the default.
 464
 465         A protocol/port selector is surrounded by opening and closing square
 466         brackets. Between these brackets, a numeric or **getservent**(3) protocol
 467         name may be specified. After the optional protocol restriction, an optional
 468         port restriction may be specified, separated by a slash. The port
 469         restriction may be numeric, a **getservent**(3) service name, or the special
 470         value _opaque_ for RFC 4301 OPAQUE selectors. Port ranges may be specified
 471         as well, none of the kernel backends currently support port ranges, though.
 472
 473         Unless the Unity extension is used, IKEv1 supports the first specified
 474         selector only. IKEv1 uses very similar traffic selector narrowing as it is
 475         supported in the IKEv2 protocol.
 476
 477 connections.<conn>.children.<child>.remote_ts = dynamic
 478         Remote selectors to include in CHILD_SA.
 479
 480         Comma separated list of remote selectors to include in CHILD_SA. See
 481         **local_ts** for a description of the selector syntax.
 482
 483 connections.<conn>.children.<child>.rekey_time = 1h
 484         Time to schedule CHILD_SA rekeying.
 485
 486         Time to schedule CHILD_SA rekeying. CHILD_SA rekeying refreshes key
 487         material, optionally using a Diffie-Hellman exchange if a group is
 488         specified in the proposal.
 489
 490         To avoid rekey collisions initiated by both ends simultaneously, a value
 491         in the range of **rand_time** gets subtracted to form the effective soft
 492         lifetime.
 493
 494         By default CHILD_SA rekeying is scheduled every hour, minus **rand_time**.
 495
 496 connections.<conn>.children.<child>.life_time = rekey_time + 10%
 497         Maximum lifetime before CHILD_SA gets closed, as time.
 498
 499         Maximum lifetime before CHILD_SA gets closed. Usually this hard lifetime
 500         is never reached, because the CHILD_SA gets rekeyed before.
 501         If that fails for whatever reason, this limit closes the CHILD_SA.
 502
 503         The default is 10% more than the **rekey_time**.
 504
 505 connections.<conn>.children.<child>.rand_time = life_time - rekey_time
 506         Range of random time to subtract from **rekey_time**.
 507
 508         Time range from which to choose a random value to subtract from
 509         **rekey_time**. The default is the difference between **life_time** and
 510         **rekey_time**.
 511
 512 connections.<conn>.children.<child>.rekey_bytes = 0
 513         Number of bytes processed before initiating CHILD_SA rekeying.
 514
 515         Number of bytes processed before initiating CHILD_SA rekeying. CHILD_SA
 516         rekeying refreshes key material, optionally using a Diffie-Hellman exchange
 517         if a group is specified in the proposal.
 518
 519         To avoid rekey collisions initiated by both ends simultaneously, a value
 520         in the range of **rand_bytes** gets subtracted to form the effective soft
 521         volume limit.
 522
 523         Volume based CHILD_SA rekeying is disabled by default.
 524
 525 connections.<conn>.children.<child>.life_bytes = rekey_bytes + 10%
 526         Maximum bytes processed before CHILD_SA gets closed.
 527
 528         Maximum bytes processed before CHILD_SA gets closed. Usually this hard
 529         volume limit is never reached, because the CHILD_SA gets rekeyed before.
 530         If that fails for whatever reason, this limit closes the CHILD_SA.
 531
 532         The default is 10% more than **rekey_bytes**.
 533
 534 connections.<conn>.children.<child>.rand_bytes = life_bytes - rekey_bytes
 535         Range of random bytes to subtract from **rekey_bytes**.
 536
 537         Byte range from which to choose a random value to subtract from
 538         **rekey_bytes**. The default is the difference between **life_bytes** and
 539         **rekey_bytes**.
 540
 541 connections.<conn>.children.<child>.rekey_packets = 0
 542         Number of packets processed before initiating CHILD_SA rekeying.
 543
 544         Number of packets processed before initiating CHILD_SA rekeying. CHILD_SA
 545         rekeying refreshes key material, optionally using a Diffie-Hellman exchange
 546         if a group is specified in the proposal.
 547
 548         To avoid rekey collisions initiated by both ends simultaneously, a value
 549         in the range of **rand_packets** gets subtracted to form the effective soft
 550         packet count limit.
 551
 552         Packet count based CHILD_SA rekeying is disabled by default.
 553
 554 connections.<conn>.children.<child>.life_packets = rekey_packets + 10%
 555         Maximum number of packets processed before CHILD_SA gets closed.
 556
 557         Maximum number of packets processed before CHILD_SA gets closed. Usually
 558         this hard packets limit is never reached, because the CHILD_SA gets rekeyed
 559         before. If that fails for whatever reason, this limit closes the CHILD_SA.
 560
 561         The default is 10% more than **rekey_bytes**.
 562
 563 connections.<conn>.children.<child>.rand_packets = life_packets - rekey_packets
 564         Range of random packets to subtract from **packets_bytes**.
 565
 566         Packet range from which to choose a random value to subtract from
 567         **rekey_packets**. The default is the difference between **life_packets**
 568         and **rekey_packets**.
 569
 570 connections.<conn>.children.<child>.updown =
 571         Updown script to invoke on CHILD_SA up and down events.
 572
 573 connections.<conn>.children.<child>.hostaccess = yes
 574         Hostaccess variable to pass to **updown** script.
 575
 576 connections.<conn>.children.<child>.mode = tunnel
 577         IPsec Mode to establish (_tunnel_, _transport_, _beet_, _pass_ or _drop_).
 578
 579         IPsec Mode to establish CHILD_SA with. _tunnel_ negotiates the CHILD_SA
 580         in IPsec Tunnel Mode, whereas _transport_ uses IPsec Transport Mode. _beet_
 581         is the Bound End to End Tunnel mixture mode, working with fixed inner
 582         addresses without the need to include them in each packet.
 583
 584         Both _transport_ and _beet_ modes are subject to mode negotiation; _tunnel_
 585         mode is negotiated if the preferred mode is not available.
 586
 587         _pass_ and _drop_ are used to install shunt policies, which explicitly
 588         bypass the defined traffic from IPsec processing, or drop it, respectively.
 589
 590 connections.<conn>.children.<child>.dpd_action = clear
 591         Action to perform on DPD timeout (_clear_, _trap_ or _restart_).
 592
 593         Action to perform for this CHILD_SA on DPD timeout. The default _clear_
 594         closes the CHILD_SA and does not take further action. _trap_ installs
 595         a trap policy, which will catch matching traffic and tries to re-negotiate
 596         the tunnel on-demand. _restart_ immediately tries to re-negotiate the
 597         CHILD_SA under a fresh IKE_SA.
 598
 599 connections.<conn>.children.<child>.ipcomp = no
 600         Enable IPComp compression before encryption.
 601
 602         Enable IPComp compression before encryption. If enabled, IKE tries to
 603         negotiate IPComp compression to compress ESP payload data prior to
 604         encryption.
 605
 606 connections.<conn>.children.<child>.inactivity = 0s
 607         Timeout before closing CHILD_SA after inactivity.
 608
 609         Timeout before closing CHILD_SA after inactivity. If no traffic has
 610         been processed in either direction for the configured timeout, the CHILD_SA
 611         gets closed due to inactivity. The default value of _0_ disables inactivity
 612         checks.
 613
 614 connections.<conn>.children.<child>.reqid = 0
 615         Fixed reqid to use for this CHILD_SA.
 616
 617         Fixed reqid to use for this CHILD_SA. This might be helpful in some
 618         scenarios, but works only if each CHILD_SA configuration is instantiated
 619         not more than once. The default of _0_ uses dynamic reqids, allocated
 620         incrementally.
 621
 622 connections.<conn>.children.<child>.mark_in = 0/0x00000000
 623         Netfilter mark and mask for input traffic.
 624
 625         Netfilter mark and mask for input traffic. On Linux Netfilter may require
 626         marks on each packet to match an SA having that option set. This allows
 627         Netfilter rules to select specific tunnels for incoming traffic. The
 628         special value _%unique_ sets a unique mark on each CHILD_SA instance.
 629
 630         An additional mask may be appended to the mark, separated by _/_. The
 631         default mask if omitted is 0xffffffff.
 632
 633 connections.<conn>.children.<child>.mark_out = 0/0x00000000
 634         Netfilter mark and mask for output traffic.
 635
 636         Netfilter mark and mask for output traffic. On Linux Netfilter may require
 637         marks on each packet to match a policy having that option set. This allows
 638         Netfilter rules to select specific tunnels for outgoing traffic. The
 639         special value _%unique_ sets a unique mark on each CHILD_SA instance.
 640
 641         An additional mask may be appended to the mark, separated by _/_. The
 642         default mask if omitted is 0xffffffff.
 643
 644 connections.<conn>.children.<child>.tfc_padding = 0
 645         Traffic Flow Confidentiality padding.
 646
 647         Pads ESP packets with additional data to have a consistent ESP packet size
 648         for improved Traffic Flow Confidentiality. The padding defines the minimum
 649         size of all ESP packets sent.
 650
 651         The default value of 0 disables TFC padding, the special value _mtu_ adds
 652         TFC padding to create a packet size equal to the Path Maximum Transfer Unit.
 653
 654 connections.<conn>.children.<child>.replay_window = 32
 655         IPsec replay window to configure for this CHILD_SA.
 656
 657         IPsec replay window to configure for this CHILD_SA. Larger values than the
 658         default of 32 are supported using the Netlink backend only, a value of 0
 659         disables IPsec replay protection.
 660
 661 connections.<conn>.children.<child>.start_action = none
 662         Action to perform after loading the configuration (_none_, _trap_, _start_).
 663
 664         Action to perform after loading the configuration. The default of _none_
 665         loads the connection only, which then can be manually initiated or used as
 666         a responder configuration.
 667
 668         The value _trap_ installs a trap policy, which triggers the tunnel as soon
 669         as matching traffic has been detected. The value _start_ initiates
 670         the connection actively.
 671
 672         When unloading or replacing a CHILD_SA configuration having a
 673         **start_action** different from _none_, the inverse action is performed.
 674         Configurations with _start_ get closed, while such with _trap_ get
 675         uninstalled.
 676
 677 connections.<conn>.children.<child>.close_action = none
 678         Action to perform after a CHILD_SA gets closed (_none_, _trap_, _start_).
 679
 680         Action to perform after a CHILD_SA gets closed by the peer. The default of
 681         _none_ does not take any action, _trap_ installs a trap policy for the
 682         CHILD_SA. _start_ tries to re-create the CHILD_SA.
 683
 684         **close_action** does not provide any guarantee that the CHILD_SA is kept
 685         alive. It acts on explicit close messages only, but not on negotiation
 686         failures. Use trap policies to reliably re-create failed CHILD_SAs.
 687
 688 secrets { # }
 689         Section defining secrets for IKE/EAP/XAuth authentication and private
 690         key decryption.
 691
 692         Section defining secrets for IKE/EAP/XAuth authentication and private key
 693         decryption. The **secrets** section takes sub-sections having a specific
 694         prefix which defines the secret type.
 695
 696         It is not recommended to define any private key decryption passphrases,
 697         as then there is no real security benefit in having encrypted keys. Either
 698         store the key unencrypted, or enter the keys manually when loading
 699         credentials.
 700
 701 secrets.eap<suffix> { # }
 702         EAP secret section for a specific secret.
 703
 704         EAP secret section for a specific secret. Each EAP secret is defined in
 705         a unique section having the _eap_ prefix. EAP secrets are used for XAuth
 706         authentication as well.
 707
 708 secrets.xauth<suffix> { # }
 709         XAuth secret section for a specific secret.
 710
 711         XAuth secret section for a specific secret. **xauth** is just an alias
 712         for **eap**, secrets under both section prefixes are used for both EAP and
 713         XAuth authentication.
 714
 715 secrets.eap<suffix>.secret =
 716         Value of the EAP/XAuth secret.
 717
 718         Value of the EAP/XAuth secret. It may either be an ASCII string, a hex
 719         encoded string if it has a _0x_ prefix, or a Base64 encoded string if it
 720         has a _0s_ prefix in its value.
 721
 722 secrets.eap<suffix>.id<suffix> =
 723         Identity the EAP/XAuth secret belongs to.
 724
 725         Identity the EAP/XAuth secret belongs to. Multiple unique identities may
 726         be specified, each having an _id_ prefix, if a secret is shared between
 727         multiple users.
 728
 729 secrets.ike<suffix> { # }
 730         IKE preshared secret section for a specific secret.
 731
 732         IKE preshared secret section for a specific secret. Each IKE PSK is defined
 733         in a unique section having the _ike_ prefix.
 734
 735 secrets.ike<suffix>.secret =
 736         Value of the IKE preshared secret.
 737
 738         Value of the IKE preshared secret. It may either be an ASCII string,
 739         a hex encoded string if it has a _0x_ prefix, or a Base64 encoded string if
 740         it has a _0s_ prefix in its value.
 741
 742 secrets.ike<suffix>.id<suffix> =
 743         IKE identity the IKE preshared secret belongs to.
 744
 745         IKE identity the IKE preshared secret belongs to. Multiple unique identities
 746         may be specified, each having an _id_ prefix, if a secret is shared between
 747         multiple peers.
 748
 749 secrets.rsa<suffix> { # }
 750         Private key decryption passphrase for a key in the _rsa_ folder.
 751
 752 secrets.rsa<suffix>.file =
 753         File name in the _rsa_ folder for which this passphrase should be used.
 754
 755 secrets.rsa<suffix>.secret
 756         Value of decryption passphrase for RSA key.
 757
 758 secrets.ecdsa<suffix> { # }
 759         Private key decryption passphrase for a key in the _ecdsa_ folder.
 760
 761 secrets.ecdsa<suffix>.file =
 762         File name in the _ecdsa_ folder for which this passphrase should be used.
 763
 764 secrets.ecdsa<suffix>.secret
 765         Value of decryption passphrase for ECDSA key.
 766
 767 secrets.pkcs8<suffix> { # }
 768         Private key decryption passphrase for a key in the _pkcs8_ folder.
 769
 770 secrets.pkcs8<suffix>.file =
 771         File name in the _pkcs8_ folder for which this passphrase should be used.
 772
 773 secrets.pkcs8<suffix>.secret
 774         Value of decryption passphrase for PKCS#8 key.
 775
 776 pools { # }
 777         Section defining named pools.
 778
 779         Section defining named pools. Named pools may be referenced by connections
 780         with the **pools** option to assign virtual IPs and other configuration
 781         attributes.
 782
 783 pools.<name> { # }
 784         Section defining a single pool with a unique name.
 785
 786 pools.<name>.addrs =
 787         Addresses allocated in pool.
 788
 789         Subnet or range defining addresses allocated in pool. Accepts a single CIDR
 790         subnet defining the pool to allocate addresses from, or an address range
 791         (<from>-<to>).  Pools must be unique and non-overlapping.
 792
 793 pools.<name>.<attr> =
 794         Comma separated list of additional attributes from type <attr>.
 795
 796         Comma separated list of additional attributes of type **<attr>**. The
 797         attribute type may be one of _dns_, _nbns_, _dhcp_, _netmask_, _server_,
 798         _subnet_, _split_include_ and _split_exclude_ to define addresses or CIDR
 799         subnets for the corresponding attribute types. Alternatively, **<attr>** can
 800         be a numerical identifier, for which string attribute values are accepted
 801         as well.