pyrox.dev
1# See: https://wiki.strongswan.org/projects/strongswan/wiki/Swanctlconf
2#
3# When strongSwan is upgraded please update the parameters in this file. You can
4# see which parameters should be deleted, changed or added by diffing
5# swanctl.opt:
6#
7# git clone https://github.com/strongswan/strongswan.git
8# cd strongswan
9# git diff 5.5.3..5.6.0 src/swanctl/swanctl.opt
10
11lib: with (import ./param-constructors.nix lib);
12
13let
14 certParams = {
15 file = mkOptionalStrParam ''
16 Absolute path to the certificate to load. Passed as-is to the daemon, so
17 it must be readable by it.
18 </para><para>
19 Configure either this or <option>handle</option>, but not both, in one section.
20 '';
21
22 handle = mkOptionalHexParam ''
23 Hex-encoded CKA_ID or handle of the certificate on a token or TPM,
24 respectively.
25 </para><para>
26 Configure either this or <option>file</option>, but not both, in one section.
27 '';
28
29 slot = mkOptionalIntParam ''
30 Optional slot number of the token that stores the certificate.
31 '';
32
33 module = mkOptionalStrParam ''
34 Optional PKCS#11 module name.
35 '';
36 };
37in {
38 authorities = mkAttrsOfParams ({
39
40 cacert = mkOptionalStrParam ''
41 The certificates may use a relative path from the swanctl
42 <literal>x509ca</literal> directory or an absolute path.
43 </para><para>
44 Configure one of <option>cacert</option>,
45 <option>file</option>, or
46 <option>handle</option> per section.
47 '';
48
49 cert_uri_base = mkOptionalStrParam ''
50 Defines the base URI for the Hash and URL feature supported by
51 IKEv2. Instead of exchanging complete certificates, IKEv2 allows one to
52 send an URI that resolves to the DER encoded certificate. The certificate
53 URIs are built by appending the SHA1 hash of the DER encoded certificates
54 to this base URI.
55 '';
56
57 crl_uris = mkCommaSepListParam [] ''
58 List of CRL distribution points (ldap, http, or file URI).
59 '';
60
61 ocsp_uris = mkCommaSepListParam [] ''
62 List of OCSP URIs.
63 '';
64
65 } // certParams) ''
66 Section defining complementary attributes of certification authorities, each
67 in its own subsection with an arbitrary yet unique name
68 '';
69
70 connections = mkAttrsOfParams {
71
72 version = mkIntParam 0 ''
73 IKE major version to use for connection.
74 <itemizedlist>
75 <listitem><para>1 uses IKEv1 aka ISAKMP,</para></listitem>
76 <listitem><para>2 uses IKEv2.</para></listitem>
77 <listitem><para>A connection using the default of 0 accepts both IKEv1 and IKEv2 as
78 responder, and initiates the connection actively with IKEv2.</para></listitem>
79 </itemizedlist>
80 '';
81
82 local_addrs = mkCommaSepListParam [] ''
83 Local address(es) to use for IKE communication. Takes
84 single IPv4/IPv6 addresses, DNS names, CIDR subnets or IP address ranges.
85 </para><para>
86 As initiator, the first non-range/non-subnet is used to initiate the
87 connection from. As responder, the local destination address must match at
88 least to one of the specified addresses, subnets or ranges.
89 </para><para>
90 If FQDNs are assigned they are resolved every time a configuration lookup
91 is done. If DNS resolution times out, the lookup is delayed for that time.
92 '';
93
94 remote_addrs = mkCommaSepListParam [] ''
95 Remote address(es) to use for IKE communication. Takes
96 single IPv4/IPv6 addresses, DNS names, CIDR subnets or IP address ranges.
97 </para><para>
98 As initiator, the first non-range/non-subnet is used to initiate the
99 connection to. As responder, the initiator source address must match at
100 least to one of the specified addresses, subnets or ranges.
101 </para><para>
102 If FQDNs are assigned they are resolved every time a configuration lookup
103 is done. If DNS resolution times out, the lookup is delayed for that time.
104 To initiate a connection, at least one specific address or DNS name must
105 be specified.
106 '';
107
108 local_port = mkIntParam 500 ''
109 Local UDP port for IKE communication. By default the port of the socket
110 backend is used, which is usually <literal>500</literal>. If port
111 <literal>500</literal> is used, automatic IKE port floating to port
112 <literal>4500</literal> is used to work around NAT issues.
113 </para><para>
114 Using a non-default local IKE port requires support from the socket
115 backend in use (socket-dynamic).
116 '';
117
118 remote_port = mkIntParam 500 ''
119 Remote UDP port for IKE communication. If the default of port
120 <literal>500</literal> is used, automatic IKE port floating to port
121 <literal>4500</literal> is used to work around NAT issues.
122 '';
123
124 proposals = mkCommaSepListParam ["default"] ''
125 A proposal is a set of algorithms. For non-AEAD algorithms, this includes
126 for IKE an encryption algorithm, an integrity algorithm, a pseudo random
127 function and a Diffie-Hellman group. For AEAD algorithms, instead of
128 encryption and integrity algorithms, a combined algorithm is used.
129 </para><para>
130 In IKEv2, multiple algorithms of the same kind can be specified in a
131 single proposal, from which one gets selected. In IKEv1, only one
132 algorithm per kind is allowed per proposal, more algorithms get implicitly
133 stripped. Use multiple proposals to offer different algorithms
134 combinations in IKEv1.
135 </para><para>
136 Algorithm keywords get separated using dashes. Multiple proposals may be
137 specified in a list. The special value <literal>default</literal> forms a
138 default proposal of supported algorithms considered safe, and is usually a
139 good choice for interoperability.
140 '';
141
142 vips = mkCommaSepListParam [] ''
143 List of virtual IPs to request in IKEv2 configuration payloads or IKEv1
144 Mode Config. The wildcard addresses <literal>0.0.0.0</literal> and
145 <literal>::</literal> request an arbitrary address, specific addresses may
146 be defined. The responder may return a different address, though, or none
147 at all.
148 '';
149
150 aggressive = mkYesNoParam no ''
151 Enables Aggressive Mode instead of Main Mode with Identity
152 Protection. Aggressive Mode is considered less secure, because the ID and
153 HASH payloads are exchanged unprotected. This allows a passive attacker to
154 snoop peer identities, and even worse, start dictionary attacks on the
155 Preshared Key.
156 '';
157
158 pull = mkYesNoParam yes ''
159 If the default of yes is used, Mode Config works in pull mode, where the
160 initiator actively requests a virtual IP. With no, push mode is used,
161 where the responder pushes down a virtual IP to the initiating peer.
162 </para><para>
163 Push mode is currently supported for IKEv1, but not in IKEv2. It is used
164 by a few implementations only, pull mode is recommended.
165 '';
166
167 dscp = mkStrParam "000000" ''
168 Differentiated Services Field Codepoint to set on outgoing IKE packets for
169 this connection. The value is a six digit binary encoded string specifying
170 the Codepoint to set, as defined in RFC 2474.
171 '';
172
173 encap = mkYesNoParam no ''
174 To enforce UDP encapsulation of ESP packets, the IKE daemon can fake the
175 NAT detection payloads. This makes the peer believe that NAT takes place
176 on the path, forcing it to encapsulate ESP packets in UDP.
177 </para><para>
178 Usually this is not required, but it can help to work around connectivity
179 issues with too restrictive intermediary firewalls.
180 '';
181
182 mobike = mkYesNoParam yes ''
183 Enables MOBIKE on IKEv2 connections. MOBIKE is enabled by default on IKEv2
184 connections, and allows mobility of clients and multi-homing on servers by
185 migrating active IPsec tunnels.
186 </para><para>
187 Usually keeping MOBIKE enabled is unproblematic, as it is not used if the
188 peer does not indicate support for it. However, due to the design of
189 MOBIKE, IKEv2 always floats to port 4500 starting from the second
190 exchange. Some implementations don't like this behavior, hence it can be
191 disabled.
192 '';
193
194 dpd_delay = mkDurationParam "0s" ''
195 Interval to check the liveness of a peer actively using IKEv2
196 INFORMATIONAL exchanges or IKEv1 R_U_THERE messages. Active DPD checking
197 is only enforced if no IKE or ESP/AH packet has been received for the
198 configured DPD delay.
199 '';
200
201 dpd_timeout = mkDurationParam "0s" ''
202 Charon by default uses the normal retransmission mechanism and timeouts to
203 check the liveness of a peer, as all messages are used for liveness
204 checking. For compatibility reasons, with IKEv1 a custom interval may be
205 specified; this option has no effect on connections using IKEv2.
206 '';
207
208 fragmentation = mkEnumParam ["yes" "accept" "force" "no"] "yes" ''
209 Use IKE fragmentation (proprietary IKEv1 extension or RFC 7383 IKEv2
210 fragmentation). Acceptable values are <literal>yes</literal> (the default
211 since 5.5.1), <literal>accept</literal> (since versions:5.5.3),
212 <literal>force</literal> and <literal>no</literal>.
213 <itemizedlist>
214 <listitem><para>If set to <literal>yes</literal>, and the peer
215 supports it, oversized IKE messages will be sent in fragments.</para></listitem>
216 <listitem><para>If set to
217 <literal>accept</literal>, support for fragmentation is announced to the peer but the daemon
218 does not send its own messages in fragments.</para></listitem>
219 <listitem><para>If set to <literal>force</literal> (only
220 supported for IKEv1) the initial IKE message will already be fragmented if
221 required.</para></listitem>
222 <listitem><para>Finally, setting the option to <literal>no</literal> will disable announcing
223 support for this feature.</para></listitem>
224 </itemizedlist>
225 </para><para>
226 Note that fragmented IKE messages sent by a peer are always processed
227 irrespective of the value of this option (even when set to no).
228 '';
229
230 send_certreq = mkYesNoParam yes ''
231 Send certificate request payloads to offer trusted root CA certificates to
232 the peer. Certificate requests help the peer to choose an appropriate
233 certificate/private key for authentication and are enabled by default.
234 Disabling certificate requests can be useful if too many trusted root CA
235 certificates are installed, as each certificate request increases the size
236 of the initial IKE packets.
237 '';
238
239 send_cert = mkEnumParam ["always" "never" "ifasked" ] "ifasked" ''
240 Send certificate payloads when using certificate authentication.
241 <itemizedlist>
242 <listitem><para>With the default of <literal>ifasked</literal> the daemon sends
243 certificate payloads only if certificate requests have been received.</para></listitem>
244 <listitem><para><literal>never</literal> disables sending of certificate payloads
245 altogether,</para></listitem>
246 <listitem><para><literal>always</literal> causes certificate payloads to be sent
247 unconditionally whenever certificate authentication is used.</para></listitem>
248 </itemizedlist>
249 '';
250
251 keyingtries = mkIntParam 1 ''
252 Number of retransmission sequences to perform during initial
253 connect. Instead of giving up initiation after the first retransmission
254 sequence with the default value of <literal>1</literal>, additional
255 sequences may be started according to the configured value. A value of
256 <literal>0</literal> initiates a new sequence until the connection
257 establishes or fails with a permanent error.
258 '';
259
260 unique = mkEnumParam ["no" "never" "keep" "replace"] "no" ''
261 Connection uniqueness policy to enforce. To avoid multiple connections
262 from the same user, a uniqueness policy can be enforced.
263 </para><para>
264 <itemizedlist>
265 <listitem><para>
266 The value <literal>never</literal> does never enforce such a policy, even
267 if a peer included INITIAL_CONTACT notification messages,
268 </para></listitem>
269 <listitem><para>
270 whereas <literal>no</literal> replaces existing connections for the same
271 identity if a new one has the INITIAL_CONTACT notify.
272 </para></listitem>
273 <listitem><para>
274 <literal>keep</literal> rejects new connection attempts if the same user
275 already has an active connection,
276 </para></listitem>
277 <listitem><para>
278 <literal>replace</literal> deletes any existing connection if a new one
279 for the same user gets established.
280 </para></listitem>
281 </itemizedlist>
282 To compare connections for uniqueness, the remote IKE identity is used. If
283 EAP or XAuth authentication is involved, the EAP-Identity or XAuth
284 username is used to enforce the uniqueness policy instead.
285 </para><para>
286 On initiators this setting specifies whether an INITIAL_CONTACT notify is
287 sent during IKE_AUTH if no existing connection is found with the remote
288 peer (determined by the identities of the first authentication
289 round). Unless set to <literal>never</literal> the client will send a notify.
290 '';
291
292 reauth_time = mkDurationParam "0s" ''
293 Time to schedule IKE reauthentication. IKE reauthentication recreates the
294 IKE/ISAKMP SA from scratch and re-evaluates the credentials. In asymmetric
295 configurations (with EAP or configuration payloads) it might not be
296 possible to actively reauthenticate as responder. The IKEv2
297 reauthentication lifetime negotiation can instruct the client to perform
298 reauthentication.
299 </para><para>
300 Reauthentication is disabled by default. Enabling it usually may lead to
301 small connection interruptions, as strongSwan uses a break-before-make
302 policy with IKEv2 to avoid any conflicts with associated tunnel resources.
303 '';
304
305 rekey_time = mkDurationParam "4h" ''
306 IKE rekeying refreshes key material using a Diffie-Hellman exchange, but
307 does not re-check associated credentials. It is supported in IKEv2 only,
308 IKEv1 performs a reauthentication procedure instead.
309 </para><para>
310 With the default value IKE rekeying is scheduled every 4 hours, minus the
311 configured rand_time. If a reauth_time is configured, rekey_time defaults
312 to zero, disabling rekeying; explicitly set both to enforce rekeying and
313 reauthentication.
314 '';
315
316 over_time = mkOptionalDurationParam ''
317 Hard IKE_SA lifetime if rekey/reauth does not complete, as time. To avoid
318 having an IKE/ISAKMP kept alive if IKE reauthentication or rekeying fails
319 perpetually, a maximum hard lifetime may be specified. If the IKE_SA fails
320 to rekey or reauthenticate within the specified time, the IKE_SA gets
321 closed.
322 </para><para>
323 In contrast to CHILD_SA rekeying, over_time is relative in time to the
324 rekey_time and reauth_time values, as it applies to both.
325 </para><para>
326 The default is 10% of the longer of <option>rekey_time</option> and
327 <option>reauth_time</option>.
328 '';
329
330 rand_time = mkOptionalDurationParam ''
331 Time range from which to choose a random value to subtract from
332 rekey/reauth times. To avoid having both peers initiating the rekey/reauth
333 procedure simultaneously, a random time gets subtracted from the
334 rekey/reauth times.
335 </para><para>
336 The default is equal to the configured <option>over_time</option>.
337 '';
338
339 pools = mkCommaSepListParam [] ''
340 List of named IP pools to allocate virtual IP addresses
341 and other configuration attributes from. Each name references a pool by
342 name from either the pools section or an external pool.
343 '';
344
345 mediation = mkYesNoParam no ''
346 Whether this connection is a mediation connection, that is, whether this
347 connection is used to mediate other connections using the IKEv2 Mediation
348 Extension. Mediation connections create no CHILD_SA.
349 '';
350
351 mediated_by = mkOptionalStrParam ''
352 The name of the connection to mediate this connection through. If given,
353 the connection will be mediated through the named mediation
354 connection. The mediation connection must have mediation enabled.
355 '';
356
357 mediation_peer = mkOptionalStrParam ''
358 Identity under which the peer is registered at the mediation server, that
359 is, the IKE identity the other end of this connection uses as its local
360 identity on its connection to the mediation server. This is the identity
361 we request the mediation server to mediate us with. Only relevant on
362 connections that set mediated_by. If it is not given, the remote IKE
363 identity of the first authentication round of this connection will be
364 used.
365 '';
366
367 local = mkPrefixedAttrsOfParams {
368
369 round = mkIntParam 0 ''
370 Optional numeric identifier by which authentication rounds are
371 sorted. If not specified rounds are ordered by their position in the
372 config file/vici message.
373 '';
374
375 certs = mkCommaSepListParam [] ''
376 List of certificate candidates to use for
377 authentication. The certificates may use a relative path from the
378 swanctl <literal>x509</literal> directory or an absolute path.
379 </para><para>
380 The certificate used for authentication is selected based on the
381 received certificate request payloads. If no appropriate CA can be
382 located, the first certificate is used.
383 '';
384
385 cert = mkPostfixedAttrsOfParams certParams ''
386 Section for a certificate candidate to use for
387 authentication. Certificates in certs are transmitted as binary blobs,
388 these sections offer more flexibility.
389 '';
390
391 pubkeys = mkCommaSepListParam [] ''
392 List of raw public key candidates to use for
393 authentication. The public keys may use a relative path from the swanctl
394 <literal>pubkey</literal> directory or an absolute path.
395 </para><para>
396 Even though multiple local public keys could be defined in principle,
397 only the first public key in the list is used for authentication.
398 '';
399
400 auth = mkStrParam "pubkey" ''
401 Authentication to perform locally.
402 <itemizedlist>
403 <listitem><para>
404 The default <literal>pubkey</literal> uses public key authentication
405 using a private key associated to a usable certificate.
406 </para></listitem>
407 <listitem><para>
408 <literal>psk</literal> uses pre-shared key authentication.
409 </para></listitem>
410 <listitem><para>
411 The IKEv1 specific <literal>xauth</literal> is used for XAuth or Hybrid
412 authentication,
413 </para></listitem>
414 <listitem><para>
415 while the IKEv2 specific <literal>eap</literal> keyword defines EAP
416 authentication.
417 </para></listitem>
418 <listitem><para>
419 For <literal>xauth</literal>, a specific backend name may be appended,
420 separated by a dash. The appropriate <literal>xauth</literal> backend is
421 selected to perform the XAuth exchange. For traditional XAuth, the
422 <literal>xauth</literal> method is usually defined in the second
423 authentication round following an initial <literal>pubkey</literal> (or
424 <literal>psk</literal>) round. Using <literal>xauth</literal> in the
425 first round performs Hybrid Mode client authentication.
426 </para></listitem>
427 <listitem><para>
428 For <literal>eap</literal>, a specific EAP method name may be appended, separated by a
429 dash. An EAP module implementing the appropriate method is selected to
430 perform the EAP conversation.
431 </para></listitem>
432 <listitem><para>
433 Since 5.4.0, if both peers support RFC 7427 ("Signature Authentication
434 in IKEv2") specific hash algorithms to be used during IKEv2
435 authentication may be configured. To do so use <literal>ike:</literal>
436 followed by a trust chain signature scheme constraint (see description
437 of the <option>remote</option> section's <option>auth</option>
438 keyword). For example, with <literal>ike:pubkey-sha384-sha256</literal>
439 a public key signature scheme with either SHA-384 or SHA-256 would get
440 used for authentication, in that order and depending on the hash
441 algorithms supported by the peer. If no specific hash algorithms are
442 configured, the default is to prefer an algorithm that matches or
443 exceeds the strength of the signature key. If no constraints with
444 <literal>ike:</literal> prefix are configured any signature scheme
445 constraint (without <literal>ike:</literal> prefix) will also apply to
446 IKEv2 authentication, unless this is disabled in
447 <literal>strongswan.conf</literal>. To use RSASSA-PSS signatures use
448 <literal>rsa/pss</literal> instead of <literal>pubkey</literal> or
449 <literal>rsa</literal> as in e.g.
450 <literal>ike:rsa/pss-sha256</literal>. If <literal>pubkey</literal> or
451 <literal>rsa</literal> constraints are configured RSASSA-PSS signatures
452 will only be used if enabled in <literal>strongswan.conf</literal>(5).
453 </para></listitem>
454 </itemizedlist>
455 '';
456
457 id = mkOptionalStrParam ''
458 IKE identity to use for authentication round. When using certificate
459 authentication, the IKE identity must be contained in the certificate,
460 either as subject or as subjectAltName.
461 '';
462
463 eap_id = mkOptionalStrParam ''
464 Client EAP-Identity to use in EAP-Identity exchange and the EAP method.
465 '';
466
467 aaa_id = mkOptionalStrParam ''
468 Server side EAP-Identity to expect in the EAP method. Some EAP methods,
469 such as EAP-TLS, use an identity for the server to perform mutual
470 authentication. This identity may differ from the IKE identity,
471 especially when EAP authentication is delegated from the IKE responder
472 to an AAA backend.
473 </para><para>
474 For EAP-(T)TLS, this defines the identity for which the server must
475 provide a certificate in the TLS exchange.
476 '';
477
478 xauth_id = mkOptionalStrParam ''
479 Client XAuth username used in the XAuth exchange.
480 '';
481
482 } ''
483 Section for a local authentication round. A local authentication round
484 defines the rules how authentication is performed for the local
485 peer. Multiple rounds may be defined to use IKEv2 RFC 4739 Multiple
486 Authentication or IKEv1 XAuth.
487 </para><para>
488 Each round is defined in a section having <literal>local</literal> as
489 prefix, and an optional unique suffix. To define a single authentication
490 round, the suffix may be omitted.
491 '';
492
493 remote = mkPrefixedAttrsOfParams {
494
495 round = mkIntParam 0 ''
496 Optional numeric identifier by which authentication rounds are
497 sorted. If not specified rounds are ordered by their position in the
498 config file/vici message.
499 '';
500
501 id = mkStrParam "%any" ''
502 IKE identity to expect for authentication round. When using certificate
503 authentication, the IKE identity must be contained in the certificate,
504 either as subject or as subjectAltName.
505 '';
506
507 eap_id = mkOptionalStrParam ''
508 Identity to use as peer identity during EAP authentication. If set to
509 <literal>%any</literal> the EAP-Identity method will be used to ask the
510 client for an EAP identity.
511 '';
512
513 groups = mkCommaSepListParam [] ''
514 Authorization group memberships to require. The peer
515 must prove membership to at least one of the specified groups. Group
516 membership can be certified by different means, for example by
517 appropriate Attribute Certificates or by an AAA backend involved in the
518 authentication.
519 '';
520
521 cert_policy = mkCommaSepListParam [] ''
522 List of certificate policy OIDs the peer's certificate
523 must have. OIDs are specified using the numerical dotted representation.
524 '';
525
526 certs = mkCommaSepListParam [] ''
527 List of certificates to accept for authentication. The certificates may
528 use a relative path from the swanctl <literal>x509</literal> directory
529 or an absolute path.
530 '';
531
532 cert = mkPostfixedAttrsOfParams certParams ''
533 Section for a certificate candidate to use for
534 authentication. Certificates in certs are transmitted as binary blobs,
535 these sections offer more flexibility.
536 '';
537
538 cacerts = mkCommaSepListParam [] ''
539 List of CA certificates to accept for
540 authentication. The certificates may use a relative path from the
541 swanctl <literal>x509ca</literal> directory or an absolute path.
542 '';
543
544 cacert = mkPostfixedAttrsOfParams certParams ''
545 Section for a CA certificate to accept for authentication. Certificates
546 in cacerts are transmitted as binary blobs, these sections offer more
547 flexibility.
548 '';
549
550 pubkeys = mkCommaSepListParam [] ''
551 List of raw public keys to accept for
552 authentication. The public keys may use a relative path from the swanctl
553 <literal>pubkey</literal> directory or an absolute path.
554 '';
555
556 revocation = mkEnumParam ["strict" "ifuri" "relaxed"] "relaxed" ''
557 Certificate revocation policy for CRL or OCSP revocation.
558 <itemizedlist>
559 <listitem><para>
560 A <literal>strict</literal> revocation policy fails if no revocation information is
561 available, i.e. the certificate is not known to be unrevoked.
562 </para></listitem>
563 <listitem><para>
564 <literal>ifuri</literal> fails only if a CRL/OCSP URI is available, but certificate
565 revocation checking fails, i.e. there should be revocation information
566 available, but it could not be obtained.
567 </para></listitem>
568 <listitem><para>
569 The default revocation policy <literal>relaxed</literal> fails only if a certificate is
570 revoked, i.e. it is explicitly known that it is bad.
571 </para></listitem>
572 </itemizedlist>
573 '';
574
575 auth = mkStrParam "pubkey" ''
576 Authentication to expect from remote. See the <option>local</option>
577 section's <option>auth</option> keyword description about the details of
578 supported mechanisms.
579 </para><para>
580 Since 5.4.0, to require a trustchain public key strength for the remote
581 side, specify the key type followed by the minimum strength in bits (for
582 example <literal>ecdsa-384</literal> or
583 <literal>rsa-2048-ecdsa-256</literal>). To limit the acceptable set of
584 hashing algorithms for trustchain validation, append hash algorithms to
585 pubkey or a key strength definition (for example
586 <literal>pubkey-sha256-sha512</literal>,
587 <literal>rsa-2048-sha256-sha384-sha512</literal> or
588 <literal>rsa-2048-sha256-ecdsa-256-sha256-sha384</literal>).
589 Unless disabled in <literal>strongswan.conf</literal>, or explicit IKEv2
590 signature constraints are configured (refer to the description of the
591 <option>local</option> section's <option>auth</option> keyword for
592 details), such key types and hash algorithms are also applied as
593 constraints against IKEv2 signature authentication schemes used by the
594 remote side. To require RSASSA-PSS signatures use
595 <literal>rsa/pss</literal> instead of <literal>pubkey</literal> or
596 <literal>rsa</literal> as in e.g. <literal>rsa/pss-sha256</literal>. If
597 <literal>pubkey</literal> or <literal>rsa</literal> constraints are
598 configured RSASSA-PSS signatures will only be accepted if enabled in
599 <literal>strongswan.conf</literal>(5).
600 </para><para>
601 To specify trust chain constraints for EAP-(T)TLS, append a colon to the
602 EAP method, followed by the key type/size and hash algorithm as
603 discussed above (e.g. <literal>eap-tls:ecdsa-384-sha384</literal>).
604 '';
605
606 } ''
607 Section for a remote authentication round. A remote authentication round
608 defines the constraints how the peers must authenticate to use this
609 connection. Multiple rounds may be defined to use IKEv2 RFC 4739 Multiple
610 Authentication or IKEv1 XAuth.
611 </para><para>
612 Each round is defined in a section having <literal>remote</literal> as
613 prefix, and an optional unique suffix. To define a single authentication
614 round, the suffix may be omitted.
615 '';
616
617 children = mkAttrsOfParams {
618 ah_proposals = mkCommaSepListParam [] ''
619 AH proposals to offer for the CHILD_SA. A proposal is a set of
620 algorithms. For AH, this includes an integrity algorithm and an optional
621 Diffie-Hellman group. If a DH group is specified, CHILD_SA/Quick Mode
622 rekeying and initial negotiation uses a separate Diffie-Hellman exchange
623 using the specified group (refer to esp_proposals for details).
624 </para><para>
625 In IKEv2, multiple algorithms of the same kind can be specified in a
626 single proposal, from which one gets selected. In IKEv1, only one
627 algorithm per kind is allowed per proposal, more algorithms get
628 implicitly stripped. Use multiple proposals to offer different algorithms
629 combinations in IKEv1.
630 </para><para>
631 Algorithm keywords get separated using dashes. Multiple proposals may be
632 specified in a list. The special value <literal>default</literal> forms
633 a default proposal of supported algorithms considered safe, and is
634 usually a good choice for interoperability. By default no AH proposals
635 are included, instead ESP is proposed.
636 '';
637
638 esp_proposals = mkCommaSepListParam ["default"] ''
639 ESP proposals to offer for the CHILD_SA. A proposal is a set of
640 algorithms. For ESP non-AEAD proposals, this includes an integrity
641 algorithm, an encryption algorithm, an optional Diffie-Hellman group and
642 an optional Extended Sequence Number Mode indicator. For AEAD proposals,
643 a combined mode algorithm is used instead of the separate
644 encryption/integrity algorithms.
645 </para><para>
646 If a DH group is specified, CHILD_SA/Quick Mode rekeying and initial
647 negotiation use a separate Diffie-Hellman exchange using the specified
648 group. However, for IKEv2, the keys of the CHILD_SA created implicitly
649 with the IKE_SA will always be derived from the IKE_SA's key material. So
650 any DH group specified here will only apply when the CHILD_SA is later
651 rekeyed or is created with a separate CREATE_CHILD_SA exchange. A
652 proposal mismatch might, therefore, not immediately be noticed when the
653 SA is established, but may later cause rekeying to fail.
654 </para><para>
655 Extended Sequence Number support may be indicated with the
656 <literal>esn</literal> and <literal>noesn</literal> values, both may be
657 included to indicate support for both modes. If omitted,
658 <literal>noesn</literal> is assumed.
659 </para><para>
660 In IKEv2, multiple algorithms of the same kind can be specified in a
661 single proposal, from which one gets selected. In IKEv1, only one
662 algorithm per kind is allowed per proposal, more algorithms get
663 implicitly stripped. Use multiple proposals to offer different algorithms
664 combinations in IKEv1.
665 </para><para>
666 Algorithm keywords get separated using dashes. Multiple proposals may be
667 specified as a list. The special value <literal>default</literal> forms
668 a default proposal of supported algorithms considered safe, and is
669 usually a good choice for interoperability. If no algorithms are
670 specified for AH nor ESP, the default set of algorithms for ESP is
671 included.
672 '';
673
674 sha256_96 = mkYesNoParam no ''
675 HMAC-SHA-256 is used with 128-bit truncation with IPsec. For
676 compatibility with implementations that incorrectly use 96-bit truncation
677 this option may be enabled to configure the shorter truncation length in
678 the kernel. This is not negotiated, so this only works with peers that
679 use the incorrect truncation length (or have this option enabled).
680 '';
681
682 local_ts = mkCommaSepListParam ["dynamic"] ''
683 List of local traffic selectors to include in CHILD_SA. Each selector is
684 a CIDR subnet definition, followed by an optional proto/port
685 selector. The special value <literal>dynamic</literal> may be used
686 instead of a subnet definition, which gets replaced by the tunnel outer
687 address or the virtual IP, if negotiated. This is the default.
688 </para><para>
689 A protocol/port selector is surrounded by opening and closing square
690 brackets. Between these brackets, a numeric or getservent(3) protocol
691 name may be specified. After the optional protocol restriction, an
692 optional port restriction may be specified, separated by a slash. The
693 port restriction may be numeric, a getservent(3) service name, or the
694 special value <literal>opaque</literal> for RFC 4301 OPAQUE
695 selectors. Port ranges may be specified as well, none of the kernel
696 backends currently support port ranges, though.
697 </para><para>
698 When IKEv1 is used only the first selector is interpreted, except if the
699 Cisco Unity extension plugin is used. This is due to a limitation of the
700 IKEv1 protocol, which only allows a single pair of selectors per
701 CHILD_SA. So to tunnel traffic matched by several pairs of selectors when
702 using IKEv1 several children (CHILD_SAs) have to be defined that cover
703 the selectors. The IKE daemon uses traffic selector narrowing for IKEv1,
704 the same way it is standardized and implemented for IKEv2. However, this
705 may lead to problems with other implementations. To avoid that, configure
706 identical selectors in such scenarios.
707 '';
708
709 remote_ts = mkCommaSepListParam ["dynamic"] ''
710 List of remote selectors to include in CHILD_SA. See
711 <option>local_ts</option> for a description of the selector syntax.
712 '';
713
714 rekey_time = mkDurationParam "1h" ''
715 Time to schedule CHILD_SA rekeying. CHILD_SA rekeying refreshes key
716 material, optionally using a Diffie-Hellman exchange if a group is
717 specified in the proposal. To avoid rekey collisions initiated by both
718 ends simultaneously, a value in the range of <option>rand_time</option>
719 gets subtracted to form the effective soft lifetime.
720 </para><para>
721 By default CHILD_SA rekeying is scheduled every hour, minus
722 <option>rand_time</option>.
723 '';
724
725 life_time = mkOptionalDurationParam ''
726 Maximum lifetime before CHILD_SA gets closed. Usually this hard lifetime
727 is never reached, because the CHILD_SA gets rekeyed before. If that fails
728 for whatever reason, this limit closes the CHILD_SA. The default is 10%
729 more than the <option>rekey_time</option>.
730 '';
731
732 rand_time = mkOptionalDurationParam ''
733 Time range from which to choose a random value to subtract from
734 <option>rekey_time</option>. The default is the difference between
735 <option>life_time</option> and <option>rekey_time</option>.
736 '';
737
738 rekey_bytes = mkIntParam 0 ''
739 Number of bytes processed before initiating CHILD_SA rekeying. CHILD_SA
740 rekeying refreshes key material, optionally using a Diffie-Hellman
741 exchange if a group is specified in the proposal.
742 </para><para>
743 To avoid rekey collisions initiated by both ends simultaneously, a value
744 in the range of <option>rand_bytes</option> gets subtracted to form the
745 effective soft volume limit.
746 </para><para>
747 Volume based CHILD_SA rekeying is disabled by default.
748 '';
749
750 life_bytes = mkOptionalIntParam ''
751 Maximum bytes processed before CHILD_SA gets closed. Usually this hard
752 volume limit is never reached, because the CHILD_SA gets rekeyed
753 before. If that fails for whatever reason, this limit closes the
754 CHILD_SA. The default is 10% more than <option>rekey_bytes</option>.
755 '';
756
757 rand_bytes = mkOptionalIntParam ''
758 Byte range from which to choose a random value to subtract from
759 <option>rekey_bytes</option>. The default is the difference between
760 <option>life_bytes</option> and <option>rekey_bytes</option>.
761 '';
762
763 rekey_packets = mkIntParam 0 ''
764 Number of packets processed before initiating CHILD_SA rekeying. CHILD_SA
765 rekeying refreshes key material, optionally using a Diffie-Hellman
766 exchange if a group is specified in the proposal.
767 </para><para>
768 To avoid rekey collisions initiated by both ends simultaneously, a value
769 in the range of <option>rand_packets</option> gets subtracted to form
770 the effective soft packet count limit.
771 </para><para>
772 Packet count based CHILD_SA rekeying is disabled by default.
773 '';
774
775 life_packets = mkOptionalIntParam ''
776 Maximum number of packets processed before CHILD_SA gets closed. Usually
777 this hard packets limit is never reached, because the CHILD_SA gets
778 rekeyed before. If that fails for whatever reason, this limit closes the
779 CHILD_SA.
780 </para><para>
781 The default is 10% more than <option>rekey_bytes</option>.
782 '';
783
784 rand_packets = mkOptionalIntParam ''
785 Packet range from which to choose a random value to subtract from
786 <option>rekey_packets</option>. The default is the difference between
787 <option>life_packets</option> and <option>rekey_packets</option>.
788 '';
789
790 updown = mkOptionalStrParam ''
791 Updown script to invoke on CHILD_SA up and down events.
792 '';
793
794 hostaccess = mkYesNoParam yes ''
795 Hostaccess variable to pass to <literal>updown</literal> script.
796 '';
797
798 mode = mkEnumParam [ "tunnel"
799 "transport"
800 "transport_proxy"
801 "beet"
802 "pass"
803 "drop"
804 ] "tunnel" ''
805 IPsec Mode to establish CHILD_SA with.
806 <itemizedlist>
807 <listitem><para>
808 <literal>tunnel</literal> negotiates the CHILD_SA in IPsec Tunnel Mode,
809 </para></listitem>
810 <listitem><para>
811 whereas <literal>transport</literal> uses IPsec Transport Mode.
812 </para></listitem>
813 <listitem><para>
814 <literal>transport_proxy</literal> signifying the special Mobile IPv6
815 Transport Proxy Mode.
816 </para></listitem>
817 <listitem><para>
818 <literal>beet</literal> is the Bound End to End Tunnel mixture mode,
819 working with fixed inner addresses without the need to include them in
820 each packet.
821 </para></listitem>
822 <listitem><para>
823 Both <literal>transport</literal> and <literal>beet</literal> modes are
824 subject to mode negotiation; <literal>tunnel</literal> mode is
825 negotiated if the preferred mode is not available.
826 </para></listitem>
827 <listitem><para>
828 <literal>pass</literal> and <literal>drop</literal> are used to install
829 shunt policies which explicitly bypass the defined traffic from IPsec
830 processing or drop it, respectively.
831 </para></listitem>
832 </itemizedlist>
833 '';
834
835 policies = mkYesNoParam yes ''
836 Whether to install IPsec policies or not. Disabling this can be useful in
837 some scenarios e.g. MIPv6, where policies are not managed by the IKE
838 daemon. Since 5.3.3.
839 '';
840
841 policies_fwd_out = mkYesNoParam no ''
842 Whether to install outbound FWD IPsec policies or not. Enabling this is
843 required in case there is a drop policy that would match and block
844 forwarded traffic for this CHILD_SA. Since 5.5.1.
845 '';
846
847 dpd_action = mkEnumParam ["clear" "trap" "restart"] "clear" ''
848 Action to perform for this CHILD_SA on DPD timeout. The default clear
849 closes the CHILD_SA and does not take further action. trap installs a
850 trap policy, which will catch matching traffic and tries to re-negotiate
851 the tunnel on-demand. restart immediately tries to re-negotiate the
852 CHILD_SA under a fresh IKE_SA.
853 '';
854
855 ipcomp = mkYesNoParam no ''
856 Enable IPComp compression before encryption. If enabled, IKE tries to
857 negotiate IPComp compression to compress ESP payload data prior to
858 encryption.
859 '';
860
861 inactivity = mkDurationParam "0s" ''
862 Timeout before closing CHILD_SA after inactivity. If no traffic has been
863 processed in either direction for the configured timeout, the CHILD_SA
864 gets closed due to inactivity. The default value of 0 disables inactivity
865 checks.
866 '';
867
868 reqid = mkIntParam 0 ''
869 Fixed reqid to use for this CHILD_SA. This might be helpful in some
870 scenarios, but works only if each CHILD_SA configuration is instantiated
871 not more than once. The default of 0 uses dynamic reqids, allocated
872 incrementally.
873 '';
874
875 priority = mkIntParam 0 ''
876 Optional fixed priority for IPsec policies. This could be useful to
877 install high-priority drop policies. The default of 0 uses dynamically
878 calculated priorities based on the size of the traffic selectors.
879 '';
880
881 interface = mkOptionalStrParam ''
882 Optional interface name to restrict outbound IPsec policies.
883 '';
884
885 mark_in = mkStrParam "0/0x00000000" ''
886 Netfilter mark and mask for input traffic. On Linux, Netfilter may
887 require marks on each packet to match an SA/policy having that option
888 set. This allows installing duplicate policies and enables Netfilter
889 rules to select specific SAs/policies for incoming traffic. Note that
890 inbound marks are only set on policies, by default, unless
891 <option>mark_in_sa</option> is enabled. The special value
892 <literal>%unique</literal> sets a unique mark on each CHILD_SA instance,
893 beyond that the value <literal>%unique-dir</literal> assigns a different
894 unique mark for each
895 </para><para>
896 An additional mask may be appended to the mark, separated by
897 <literal>/</literal>. The default mask if omitted is
898 <literal>0xffffffff</literal>.
899 '';
900
901 mark_in_sa = mkYesNoParam no ''
902 Whether to set <option>mark_in</option> on the inbound SA. By default,
903 the inbound mark is only set on the inbound policy. The tuple destination
904 address, protocol and SPI is unique and the mark is not required to find
905 the correct SA, allowing to mark traffic after decryption instead (where
906 more specific selectors may be used) to match different policies. Marking
907 packets before decryption is still possible, even if no mark is set on
908 the SA.
909 '';
910
911 mark_out = mkStrParam "0/0x00000000" ''
912 Netfilter mark and mask for output traffic. On Linux, Netfilter may
913 require marks on each packet to match a policy/SA having that option
914 set. This allows installing duplicate policies and enables Netfilter
915 rules to select specific policies/SAs for outgoing traffic. The special
916 value <literal>%unique</literal> sets a unique mark on each CHILD_SA
917 instance, beyond that the value <literal>%unique-dir</literal> assigns a
918 different unique mark for each CHILD_SA direction (in/out).
919 </para><para>
920 An additional mask may be appended to the mark, separated by
921 <literal>/</literal>. The default mask if omitted is
922 <literal>0xffffffff</literal>.
923 '';
924
925 tfc_padding = mkParamOfType (with lib.types; either int (enum ["mtu"])) 0 ''
926 Pads ESP packets with additional data to have a consistent ESP packet
927 size for improved Traffic Flow Confidentiality. The padding defines the
928 minimum size of all ESP packets sent. The default value of
929 <literal>0</literal> disables TFC padding, the special value
930 <literal>mtu</literal> adds TFC padding to create a packet size equal to
931 the Path Maximum Transfer Unit.
932 '';
933
934 replay_window = mkIntParam 32 ''
935 IPsec replay window to configure for this CHILD_SA. Larger values than
936 the default of <literal>32</literal> are supported using the Netlink
937 backend only, a value of <literal>0</literal> disables IPsec replay
938 protection.
939 '';
940
941 hw_offload = mkEnumParam ["yes" "no" "auto"] "no" ''
942 Enable hardware offload for this CHILD_SA, if supported by the IPsec
943 implementation. The value <literal>yes</literal> enforces offloading
944 and the installation will fail if it's not supported by either kernel or
945 device. The value <literal>auto</literal> enables offloading, if it's
946 supported, but the installation does not fail otherwise.
947 '';
948
949 start_action = mkEnumParam ["none" "trap" "start"] "none" ''
950 Action to perform after loading the configuration.
951 <itemizedlist>
952 <listitem><para>
953 The default of <literal>none</literal> loads the connection only, which
954 then can be manually initiated or used as a responder configuration.
955 </para></listitem>
956 <listitem><para>
957 The value <literal>trap</literal> installs a trap policy, which triggers
958 the tunnel as soon as matching traffic has been detected.
959 </para></listitem>
960 <listitem><para>
961 The value <literal>start</literal> initiates the connection actively.
962 </para></listitem>
963 </itemizedlist>
964 When unloading or replacing a CHILD_SA configuration having a
965 <option>start_action</option> different from <literal>none</literal>,
966 the inverse action is performed. Configurations with
967 <literal>start</literal> get closed, while such with
968 <literal>trap</literal> get uninstalled.
969 '';
970
971 close_action = mkEnumParam ["none" "trap" "start"] "none" ''
972 Action to perform after a CHILD_SA gets closed by the peer.
973 <itemizedlist>
974 <listitem><para>
975 The default of <literal>none</literal> does not take any action,
976 </para></listitem>
977 <listitem><para>
978 <literal>trap</literal> installs a trap policy for the CHILD_SA.
979 </para></listitem>
980 <listitem><para>
981 <literal>start</literal> tries to re-create the CHILD_SA.
982 </para></listitem>
983 </itemizedlist>
984 </para><para>
985 <option>close_action</option> does not provide any guarantee that the
986 CHILD_SA is kept alive. It acts on explicit close messages only, but not
987 on negotiation failures. Use trap policies to reliably re-create failed
988 CHILD_SAs.
989 '';
990
991 } ''
992 CHILD_SA configuration sub-section. Each connection definition may have
993 one or more sections in its <option>children</option> subsection. The
994 section name defines the name of the CHILD_SA configuration, which must be
995 unique within the connection (denoted <child> below).
996 '';
997 } ''
998 Section defining IKE connection configurations, each in its own subsection
999 with an arbitrary yet unique name
1000 '';
1001
1002 secrets = let
1003 mkEapXauthParams = mkPrefixedAttrsOfParams {
1004 secret = mkOptionalStrParam ''
1005 Value of the EAP/XAuth secret. It may either be an ASCII string, a hex
1006 encoded string if it has a 0x prefix or a Base64 encoded string if it
1007 has a 0s prefix in its value.
1008 '';
1009
1010 id = mkPrefixedAttrsOfParam (mkOptionalStrParam "") ''
1011 Identity the EAP/XAuth secret belongs to. Multiple unique identities may
1012 be specified, each having an <literal>id</literal> prefix, if a secret
1013 is shared between multiple users.
1014 '';
1015
1016 } ''
1017 EAP secret section for a specific secret. Each EAP secret is defined in a
1018 unique section having the <literal>eap</literal> prefix. EAP secrets are
1019 used for XAuth authentication as well.
1020 '';
1021
1022 in {
1023
1024 eap = mkEapXauthParams;
1025 xauth = mkEapXauthParams;
1026
1027 ntlm = mkPrefixedAttrsOfParams {
1028 secret = mkOptionalStrParam ''
1029 Value of the NTLM secret, which is the NT Hash of the actual secret,
1030 that is, MD4(UTF-16LE(secret)). The resulting 16-byte value may either
1031 be given as a hex encoded string with a 0x prefix or as a Base64 encoded
1032 string with a 0s prefix.
1033 '';
1034
1035 id = mkPrefixedAttrsOfParam (mkOptionalStrParam "") ''
1036 Identity the NTLM secret belongs to. Multiple unique identities may be
1037 specified, each having an id prefix, if a secret is shared between
1038 multiple users.
1039 '';
1040 } ''
1041 NTLM secret section for a specific secret. Each NTLM secret is defined in
1042 a unique section having the <literal>ntlm</literal> prefix. NTLM secrets
1043 may only be used for EAP-MSCHAPv2 authentication.
1044 '';
1045
1046 ike = mkPrefixedAttrsOfParams {
1047 secret = mkOptionalStrParam ''
1048 Value of the IKE preshared secret. It may either be an ASCII string, a
1049 hex encoded string if it has a 0x prefix or a Base64 encoded string if
1050 it has a 0s prefix in its value.
1051 '';
1052
1053 id = mkPrefixedAttrsOfParam (mkOptionalStrParam "") ''
1054 IKE identity the IKE preshared secret belongs to. Multiple unique
1055 identities may be specified, each having an <literal>id</literal>
1056 prefix, if a secret is shared between multiple peers.
1057 '';
1058 } ''
1059 IKE preshared secret section for a specific secret. Each IKE PSK is
1060 defined in a unique section having the <literal>ike</literal> prefix.
1061 '';
1062
1063 private = mkPrefixedAttrsOfParams {
1064 file = mkOptionalStrParam ''
1065 File name in the private folder for which this passphrase should be used.
1066 '';
1067
1068 secret = mkOptionalStrParam ''
1069 Value of decryption passphrase for private key.
1070 '';
1071 } ''
1072 Private key decryption passphrase for a key in the
1073 <literal>private</literal> folder.
1074 '';
1075
1076 rsa = mkPrefixedAttrsOfParams {
1077 file = mkOptionalStrParam ''
1078 File name in the <literal>rsa</literal> folder for which this passphrase
1079 should be used.
1080 '';
1081 secret = mkOptionalStrParam ''
1082 Value of decryption passphrase for RSA key.
1083 '';
1084 } ''
1085 Private key decryption passphrase for a key in the <literal>rsa</literal>
1086 folder.
1087 '';
1088
1089 ecdsa = mkPrefixedAttrsOfParams {
1090 file = mkOptionalStrParam ''
1091 File name in the <literal>ecdsa</literal> folder for which this
1092 passphrase should be used.
1093 '';
1094 secret = mkOptionalStrParam ''
1095 Value of decryption passphrase for ECDSA key.
1096 '';
1097 } ''
1098 Private key decryption passphrase for a key in the
1099 <literal>ecdsa</literal> folder.
1100 '';
1101
1102 pkcs8 = mkPrefixedAttrsOfParams {
1103 file = mkOptionalStrParam ''
1104 File name in the <literal>pkcs8</literal> folder for which this
1105 passphrase should be used.
1106 '';
1107 secret = mkOptionalStrParam ''
1108 Value of decryption passphrase for PKCS#8 key.
1109 '';
1110 } ''
1111 Private key decryption passphrase for a key in the
1112 <literal>pkcs8</literal> folder.
1113 '';
1114
1115 pkcs12 = mkPrefixedAttrsOfParams {
1116 file = mkOptionalStrParam ''
1117 File name in the <literal>pkcs12</literal> folder for which this
1118 passphrase should be used.
1119 '';
1120 secret = mkOptionalStrParam ''
1121 Value of decryption passphrase for PKCS#12 container.
1122 '';
1123 } ''
1124 PKCS#12 decryption passphrase for a container in the
1125 <literal>pkcs12</literal> folder.
1126 '';
1127
1128 token = mkPrefixedAttrsOfParams {
1129 handle = mkOptionalHexParam ''
1130 Hex-encoded CKA_ID or handle of the private key on the token or TPM,
1131 respectively.
1132 '';
1133
1134 slot = mkOptionalIntParam ''
1135 Optional slot number to access the token.
1136 '';
1137
1138 module = mkOptionalStrParam ''
1139 Optional PKCS#11 module name to access the token.
1140 '';
1141
1142 pin = mkOptionalStrParam ''
1143 Optional PIN required to access the key on the token. If none is
1144 provided the user is prompted during an interactive
1145 <literal>--load-creds</literal> call.
1146 '';
1147 } ''Definition for a private key that's stored on a token/smartcard/TPM.'';
1148
1149 };
1150
1151 pools = mkAttrsOfParams {
1152 addrs = mkOptionalStrParam ''
1153 Subnet or range defining addresses allocated in pool. Accepts a single
1154 CIDR subnet defining the pool to allocate addresses from or an address
1155 range (<from>-<to>). Pools must be unique and non-overlapping.
1156 '';
1157
1158 dns = mkCommaSepListParam [] "Address or CIDR subnets";
1159 nbns = mkCommaSepListParam [] "Address or CIDR subnets";
1160 dhcp = mkCommaSepListParam [] "Address or CIDR subnets";
1161 netmask = mkCommaSepListParam [] "Address or CIDR subnets";
1162 server = mkCommaSepListParam [] "Address or CIDR subnets";
1163 subnet = mkCommaSepListParam [] "Address or CIDR subnets";
1164 split_include = mkCommaSepListParam [] "Address or CIDR subnets";
1165 split_exclude = mkCommaSepListParam [] "Address or CIDR subnets";
1166 } ''
1167 Section defining named pools. Named pools may be referenced by connections
1168 with the pools option to assign virtual IPs and other configuration
1169 attributes. Each pool must have a unique name (denoted <name> below).
1170 '';
1171}