conf: Fix declaration of default values for imc-hcd options
[strongswan.git] / man / ipsec.conf.5.in
1 .TH IPSEC.CONF 5 "2012-06-26" "@PACKAGE_VERSION@" "strongSwan"
2 .SH NAME
3 ipsec.conf \- IPsec configuration and connections
4 .SH DESCRIPTION
5 The optional
6 .I ipsec.conf
7 file
8 specifies most configuration and control information for the
9 strongSwan IPsec subsystem.
10 The major exception is secrets for authentication;
11 see
12 .IR ipsec.secrets (5).
13 Its contents are not security-sensitive.
14 .PP
15 The file is a text file, consisting of one or more
16 .IR sections .
17 White space followed by
18 .B #
19 followed by anything to the end of the line
20 is a comment and is ignored,
21 as are empty lines which are not within a section.
22 .PP
23 A line which contains
24 .B include
25 and a file name, separated by white space,
26 is replaced by the contents of that file.
27 If the file name is not a full pathname,
28 it is considered to be relative to the directory containing the
29 including file.
30 Such inclusions can be nested.
31 Only a single filename may be supplied, and it may not contain white space,
32 but it may include shell wildcards (see
33 .IR sh (1));
34 for example:
35 .PP
36 .B include
37 .B "ipsec.*.conf"
38 .PP
39 The intention of the include facility is mostly to permit keeping
40 information on connections, or sets of connections,
41 separate from the main configuration file.
42 This permits such connection descriptions to be changed,
43 copied to the other security gateways involved, etc.,
44 without having to constantly extract them from the configuration
45 file and then insert them back into it.
46 Note also the
47 .B also
48 parameter (described below) which permits splitting a single logical
49 section (e.g. a connection description) into several actual sections.
50 .PP
51 A section
52 begins with a line of the form:
53 .PP
54 .I type
55 .I name
56 .PP
57 where
58 .I type
59 indicates what type of section follows, and
60 .I name
61 is an arbitrary name which distinguishes the section from others
62 of the same type.
63 All subsequent non-empty lines
64 which begin with white space are part of the section.
65 Sections of the same type that share the same name are merged.
66 .PP
67 Lines within the section are generally of the form
68 .PP
69 \ \ \ \ \ \fIparameter\fB=\fIvalue\fR
70 .PP
71 (note the mandatory preceding white space).
72 There can be white space on either side of the
73 .BR = .
74 Parameter names are specific to a section type.
75 .PP
76 An empty
77 .I value
78 stands for the system default value (if any) of the parameter,
79 i.e. it is roughly equivalent to omitting the parameter line entirely. This may
80 be useful to clear a setting inherited from a
81 .B %default
82 section or via
83 .B also
84 parameter (see below).
85 A
86 .I value
87 may contain single spaces (additional white space is reduced to one space).
88 To preserve white space as written enclose the entire
89 .I value
90 in double quotes (\fB"\fR); in such values double quotes themselves may be
91 escaped by prefixing them with
92 .B \\\\
93 characters. A double-quoted string may span multiple lines by ending them with
94 .B \\\\
95 characters (following lines don't have to begin with white space, as that will
96 be preserved). Additionally, the following control characters may be encoded in
97 double-quoted strings: \\n, \\r, \\t, \\b, \\f.
98 .PP
99 Numeric values are specified to be either an ``integer''
100 (a sequence of digits) or a ``decimal number''
101 (sequence of digits optionally followed by `.' and another sequence of digits).
102 .PP
103 There is currently one parameter which is available in any type of
104 section:
105 .TP
106 .B also
107 the value is a section name; the parameters of that section are inherited by
108 the current section. Parameters in the current section always override inherited
109 parameters, even if an
110 .B also
111 follows after them.
112 The specified section must exist and must have the same section type; it doesn't
113 if it is defined before or after the current section.
114 Nesting is permitted, and there may be more than one
115 .B also
116 in a single section (parameters from referenced sections are inherited and
117 overridden in the order of these
118 .B also
119 parameters).
120 .PP
121 A section with name
122 .B %default
123 specifies defaults for sections of the same type. All parameters in it, are
124 inherited by all other sections of that type.
125 .PP
126 Currently there are three types of sections:
127 a
128 .B config
129 section specifies general configuration information for IPsec, a
130 .B conn
131 section specifies an IPsec connection, while a
132 .B ca
133 section specifies special properties of a certification authority.
134 .SH "CONN SECTIONS"
135 A
136 .B conn
137 section contains a
138 .IR "connection specification" ,
139 defining a network connection to be made using IPsec.
140 The name given is arbitrary, and is used to identify the connection.
141 Here's a simple example:
142 .PP
143 .ne 10
144 .nf
145 .ft B
146 .ta 1c
147 conn snt
148         left=192.168.0.1
149         leftsubnet=10.1.0.0/16
150         right=192.168.0.2
151         rightsubnet=10.1.0.0/16
152         keyingtries=%forever
153         auto=add
154 .ft
155 .fi
156 .PP
157 A note on terminology: There are two kinds of communications going on:
158 transmission of user IP packets, and gateway-to-gateway negotiations for
159 keying, rekeying, and general control.
160 The path to control the connection is called 'ISAKMP SA' in IKEv1
161 and 'IKE SA' in the IKEv2 protocol. That what is being negotiated, the kernel
162 level data path, is called 'IPsec SA' or 'Child SA'.
163 strongSwan previously used two separate keying daemons, \fIpluto\fP and
164 \fIcharon\fP. This manual does not discuss \fIpluto\fP options anymore, but
165 only \fIcharon\fP that since strongSwan 5.0 supports both IKEv1 and IKEv2.
166 .PP
167 To avoid trivial editing of the configuration file to suit it to each system
168 involved in a connection,
169 connection specifications are written in terms of
170 .I left
171 and
172 .I right
173 participants,
174 rather than in terms of local and remote.
175 Which participant is considered
176 .I left
177 or
178 .I right
179 is arbitrary;
180 for every connection description an attempt is made to figure out whether
181 the local endpoint should act as the
182 .I left
183 or
184 .I right
185 endpoint. This is done by matching the IP addresses defined for both endpoints
186 with the IP addresses assigned to local network interfaces. If a match is found
187 then the role (left or right) that matches is going to be considered local.
188 If no match is found during startup,
189 .I left
190 is considered local.
191 This permits using identical connection specifications on both ends.
192 There are cases where there is no symmetry; a good convention is to
193 use
194 .I left
195 for the local side and
196 .I right
197 for the remote side (the first letters are a good mnemonic).
198 .PP
199 Many of the parameters relate to one participant or the other;
200 only the ones for
201 .I left
202 are listed here, but every parameter whose name begins with
203 .B left
204 has a
205 .B right
206 counterpart,
207 whose description is the same but with
208 .B left
209 and
210 .B right
211 reversed.
212 .PP
213 Parameters are optional unless marked '(required)'.
214 .SS "CONN PARAMETERS"
215 Unless otherwise noted, for a connection to work,
216 in general it is necessary for the two ends to agree exactly
217 on the values of these parameters.
218 .TP
219 .BR aaa_identity " = <id>"
220 defines the identity of the AAA backend used during IKEv2 EAP authentication.
221 This is required if the EAP client uses a method that verifies the server
222 identity (such as EAP-TLS), but it does not match the IKEv2 gateway identity.
223 .TP
224 .BR aggressive " = yes | " no
225 whether to use IKEv1 Aggressive or Main Mode (the default).
226 .TP
227 .BR ah " = <cipher suites>"
228 comma-separated list of AH algorithms to be used for the connection, e.g.
229 .BR sha1-sha256-modp1024 .
230 The notation is
231 .BR integrity[-dhgroup] .
232 For IKEv2, multiple algorithms (separated by -) of the same type can be included
233 in a single proposal. IKEv1 only includes the first algorithm in a proposal.
234 Only either the
235 .B ah
236 or
237 .B esp
238 keyword may be used, AH+ESP bundles are not supported.
239
240 There is no default AH cipher suite since by default ESP is used.
241 The daemon adds its extensive default proposal to the configured value. To
242 restrict it to the configured proposal an
243 exclamation mark
244 .RB ( ! )
245 can be added at the end.
246
247 If
248 .B dh-group
249 is specified, CHILD_SA/Quick Mode setup and rekeying include a separate
250 Diffie-Hellman exchange.
251 .TP
252 .BR also " = <name>"
253 includes conn section
254 .BR <name> .
255 .TP
256 .BR auth " = <value>"
257 was used by the
258 .B pluto
259 IKEv1 daemon to use AH integrity protection for ESP encrypted packets, but is
260 not supported in charon. The
261 .B ah
262 keyword specifies algorithms to use for integrity protection with AH, but
263 without encryption. AH+ESP bundles are not supported.
264 .TP
265 .BR authby " = " pubkey " | rsasig | ecdsasig | psk | secret | never | xauthpsk | xauthrsasig"
266 how the two security gateways should authenticate each other;
267 acceptable values are
268 .B psk
269 or
270 .B secret
271 for pre-shared secrets,
272 .B pubkey
273 (the default) for public key signatures as well as the synonyms
274 .B rsasig
275 for RSA digital signatures and
276 .B ecdsasig
277 for Elliptic Curve DSA signatures.
278 .B never
279 can be used if negotiation is never to be attempted or accepted (useful for
280 shunt-only conns).
281 Digital signatures are superior in every way to shared secrets.
282 IKEv1 additionally supports the values
283 .B xauthpsk
284 and
285 .B xauthrsasig
286 that will enable eXtended AUTHentication (XAUTH) in addition to IKEv1 main mode
287 based on shared secrets or digital RSA signatures, respectively.
288 This parameter is deprecated, as two peers do not need to agree on an
289 authentication method in IKEv2. Use the
290 .B leftauth
291 parameter instead to define authentication methods.
292 .TP
293 .BR auto " = " ignore " | add | route | start"
294 what operation, if any, should be done automatically at IPsec startup;
295 currently-accepted values are
296 .BR add ,
297 .BR route ,
298 .B start
299 and
300 .B ignore
301 (the default).
302 .B add
303 loads a connection without starting it.
304 .B route
305 loads a connection and installs kernel traps. If traffic is detected between
306 .B leftsubnet
307 and
308 .BR rightsubnet ,
309 a connection is established.
310 .B start
311 loads a connection and brings it up immediately.
312 .B ignore
313 ignores the connection. This is equal to deleting a connection from the config
314 file.
315 Relevant only locally, other end need not agree on it.
316 .TP
317 .BR closeaction " = " none " | clear | hold | restart"
318 defines the action to take if the remote peer unexpectedly closes a CHILD_SA
319 (see
320 .B dpdaction
321 for meaning of values).
322 A
323 .B closeaction should not be
324 used if the peer uses reauthentication or uniquids checking, as these events
325 might trigger the defined action when not desired.
326 .TP
327 .BR compress " = yes | " no
328 whether IPComp compression of content is proposed on the connection
329 (link-level compression does not work on encrypted data,
330 so to be effective, compression must be done \fIbefore\fR encryption);
331 acceptable values are
332 .B yes
333 and
334 .B no
335 (the default). A value of
336 .B yes
337 causes the daemon to propose both compressed and uncompressed,
338 and prefer compressed.
339 A value of
340 .B no
341 prevents the daemon from proposing or accepting compression.
342 .TP
343 .BR dpdaction " = " none " | clear | hold | restart"
344 controls the use of the Dead Peer Detection protocol (DPD, RFC 3706) where
345 R_U_THERE notification messages (IKEv1) or empty INFORMATIONAL messages (IKEv2)
346 are periodically sent in order to check the
347 liveliness of the IPsec peer. The values
348 .BR clear ,
349 .BR hold ,
350 and
351 .B restart
352 all activate DPD. If no activity is detected, all connections with a dead peer
353 are stopped and unrouted
354 .RB ( clear ),
355 put in the hold state
356 .RB ( hold )
357 or restarted
358 .RB ( restart ).
359 The default is
360 .B none
361 which disables the active sending of DPD messages.
362 .TP
363 .BR dpddelay " = " 30s " | <time>"
364 defines the period time interval with which R_U_THERE messages/INFORMATIONAL
365 exchanges are sent to the peer. These are only sent if no other traffic is
366 received. In IKEv2, a value of 0 sends no additional INFORMATIONAL
367 messages and uses only standard messages (such as those to rekey) to detect
368 dead peers.
369 .TP
370 .BR dpdtimeout " = " 150s " | <time>
371 defines the timeout interval, after which all connections to a peer are deleted
372 in case of inactivity. This only applies to IKEv1, in IKEv2 the default
373 retransmission timeout applies, as every exchange is used to detect dead peers.
374 .TP
375 .BR inactivity " = <time>"
376 defines the timeout interval, after which a CHILD_SA is closed if it did
377 not send or receive any traffic. The inactivity counter is reset during CHILD_SA
378 rekeying. This means that the inactivity timeout must be smaller than the
379 rekeying interval to have any effect.
380 .TP
381 .BR eap_identity " = <id>"
382 defines the identity the client uses to reply to an EAP Identity request.
383 If defined on the EAP server, the defined identity will be used as peer
384 identity during EAP authentication. The special value
385 .B %identity
386 uses the EAP Identity method to ask the client for an EAP identity. If not
387 defined, the IKEv2 identity will be used as EAP identity.
388 .TP
389 .BR esp " = <cipher suites>"
390 comma-separated list of ESP encryption/authentication algorithms to be used
391 for the connection, e.g.
392 .BR aes128-sha256 .
393 The notation is
394 .BR encryption-integrity[-dhgroup][-esnmode] .
395 For IKEv2, multiple algorithms (separated by -) of the same type can be included
396 in a single proposal. IKEv1 only includes the first algorithm in a proposal.
397 Only either the
398 .B ah
399 or
400 .B esp
401 keyword may be used, AH+ESP bundles are not supported.
402
403 Defaults to
404 .BR aes128-sha1,3des-sha1 .
405 The daemon adds its extensive default proposal to this default
406 or the configured value.  To restrict it to the configured proposal an
407 exclamation mark
408 .RB ( ! )
409 can be added at the end.
410
411 .BR Note :
412 As a responder the daemon accepts the first supported proposal received from
413 the peer. In order to restrict a responder to only accept specific cipher
414 suites, the strict flag
415 .RB ( ! ,
416 exclamation mark) can be used, e.g: aes256-sha512-modp4096!
417 .br
418 If
419 .B dh-group
420 is specified, CHILD_SA/Quick Mode setup and rekeying include a separate
421 Diffie-Hellman exchange.  Valid values for
422 .B esnmode
423 (IKEv2 only) are
424 .B esn
425 and
426 .BR noesn .
427 Specifying both negotiates Extended Sequence Number support with the peer,
428 the default is
429 .B noesn.
430 .TP
431 .BR forceencaps " = yes | " no
432 force UDP encapsulation for ESP packets even if no NAT situation is detected.
433 This may help to surmount restrictive firewalls. In order to force the peer to
434 encapsulate packets, NAT detection payloads are faked.
435 .TP
436 .BR fragmentation " = yes | force | " no
437 whether to use IKE fragmentation (proprietary IKEv1 extension or IKEv2
438 fragmentation as per RFC 7383).  Acceptable values are
439 .BR yes ,
440 .B force
441 and
442 .B no
443 (the default). Fragmented IKE messages sent by a peer are always accepted
444 irrespective of the value of this option. If set to
445 .BR yes ,
446 and the peer supports it, larger IKE messages will be sent in fragments.
447 If set to
448 .B force
449 (only supported for IKEv1) the initial IKE message will already be fragmented
450 if required.
451 .TP
452 .BR ike " = <cipher suites>"
453 comma-separated list of IKE/ISAKMP SA encryption/authentication algorithms
454 to be used, e.g.
455 .BR aes128-sha1-modp2048 .
456 The notation is
457 .BR encryption-integrity[-prf]-dhgroup .
458 If no PRF is given, the algorithms defined for integrity are used for the PRF.
459 The prf keywords are the same as the integrity algorithms, but have a
460 .B prf
461 prefix (such as
462 .BR prfsha1 ,
463 .B prfsha256
464 or
465 .BR prfaesxcbc ).
466 .br
467 In IKEv2, multiple algorithms and proposals may be included, such as
468 .BR aes128-aes256-sha1-modp1536-modp2048,3des-sha1-md5-modp1024 .
469
470 Defaults to
471 .BR aes128-sha1-modp2048,3des-sha1-modp1536 .
472 The daemon adds its extensive default proposal to this
473 default or the configured value.  To restrict it to the configured proposal an
474 exclamation mark
475 .RB ( ! )
476 can be added at the end.
477
478 .BR Note :
479 As a responder the daemon accepts the first supported proposal received from
480 the peer.  In order to restrict a responder to only accept specific cipher
481 suites, the strict flag
482 .RB ( ! ,
483 exclamation mark) can be used, e.g:
484 .BR aes256-sha512-modp4096!
485 .TP
486 .BR ikedscp " = " 000000 " | <DSCP field>"
487 Differentiated Services Field Codepoint to set on outgoing IKE packets sent
488 from this connection. The value is a six digit binary encoded string defining
489 the Codepoint to set, as defined in RFC 2474.
490 .TP
491 .BR ikelifetime " = " 3h " | <time>"
492 how long the keying channel of a connection (ISAKMP or IKE SA)
493 should last before being renegotiated. Also see EXPIRY/REKEY below.
494 .TP
495 .BR installpolicy " = " yes " | no"
496 decides whether IPsec policies are installed in the kernel by the charon daemon
497 for a given connection. Allows peaceful cooperation e.g. with
498 the Mobile IPv6 daemon mip6d who wants to control the kernel policies.
499 Acceptable values are
500 .B yes
501 (the default) and
502 .BR no .
503 .TP
504 .BR keyexchange " = " ike " | ikev1 | ikev2"
505 which key exchange protocol should be used to initiate the connection.
506 Connections marked with
507 .B ike
508 use IKEv2 when initiating, but accept any protocol version when responding.
509 .TP
510 .BR keyingtries " = " 3 " | <number> | %forever"
511 how many attempts (a whole number or \fB%forever\fP) should be made to
512 negotiate a connection, or a replacement for one, before giving up
513 (default
514 .BR 3 ).
515 The value \fB%forever\fP
516 means 'never give up'.
517 Relevant only locally, other end need not agree on it.
518 .TP
519 .B keylife
520 synonym for
521 .BR lifetime .
522 .TP
523 .BR left " = <ip address> | <fqdn> | " %any " | <range> | <subnet> "
524 The IP address of the left participant's public-network interface
525 or one of several magic values.
526 The value
527 .B %any
528 (the default) for the local endpoint signifies an address to be filled in (by
529 automatic keying) during negotiation. If the local peer initiates the
530 connection setup the routing table will be queried to determine the correct
531 local IP address.
532 In case the local peer is responding to a connection setup then any IP address
533 that is assigned to a local interface will be accepted.
534
535 The prefix
536 .B %
537 in front of a fully-qualified domain name or an IP address will implicitly set
538 .BR leftallowany =yes.
539
540 If
541 .B %any
542 is used for the remote endpoint it literally means any IP address.
543
544 To limit the connection to a  specific range of hosts, a range (
545 .BR 10.1.0.0-10.2.255.255
546 ) or a subnet (
547 .BR 10.1.0.0/16
548 ) can be specified, and multiple addresses, ranges and subnets can be separated
549 by commas. While one can freely combine these items, to initiate the connection
550 at least one non-range/subnet is required.
551
552 Please note that with the usage of wildcards multiple connection descriptions
553 might match a given incoming connection attempt. The most specific description
554 is used in that case.
555 .TP
556 .BR leftallowany " = yes | " no
557 a modifier for
558 .BR left ,
559 making it behave as
560 .B %any
561 although a concrete IP address or domain name has been assigned.
562 .TP
563 .BR leftauth " = <auth method>"
564 Authentication method to use locally (left) or require from the remote (right)
565 side.
566 Acceptable values are
567 .B pubkey
568 for public key authentication (RSA/ECDSA),
569 .B psk
570 for pre-shared key authentication,
571 .B eap
572 to (require the) use of the Extensible Authentication Protocol in IKEv2, and
573 .B xauth
574 for IKEv1 eXtended Authentication.
575
576 To require a trustchain public key strength for the remote side, specify the
577 key type followed by the minimum strength in bits (for example
578 .BR ecdsa-384
579 or
580 .BR rsa-2048-ecdsa-256 ).
581 To limit the acceptable set of hashing algorithms for trustchain validation,
582 append hash algorithms to
583 .BR pubkey
584 or a key strength definition (for example
585 .BR pubkey-sha1-sha256
586 or
587 .BR rsa-2048-ecdsa-256-sha256-sha384-sha512 ).
588 Unless disabled in
589 .BR strongswan.conf (5)
590 such key types and hash algorithms are also applied as constraints against IKEv2
591 signature authentication schemes used by the remote side.
592
593 If both peers support RFC 7427 ("Signature Authentication in IKEv2") specific
594 hash algorithms to be used during IKEv2 authentication may be configured.
595 The syntax is the same as above. For example, with
596 .B pubkey-sha384-sha256
597 a public key signature scheme with either SHA-384 or SHA-256 would get used for
598 authentication, in that order and depending on the hash algorithms supported by
599 the peer.  If no specific hash algorithms are configured, the default is to
600 prefer an algorithm that matches or exceeds the strength of the signature key.
601
602 For
603 .BR eap ,
604 an optional EAP method can be appended. Currently defined methods are
605 .BR eap-aka ,
606 .BR eap-gtc ,
607 .BR eap-md5 ,
608 .BR eap-mschapv2 ,
609 .BR eap-peap ,
610 .BR eap-sim ,
611 .BR eap-tls ,
612 .BR eap-ttls ,
613 .BR eap-dynamic ,
614 and
615 .BR eap-radius .
616 Alternatively, IANA assigned EAP method numbers are accepted. Vendor specific
617 EAP methods are defined in the form
618 .B eap-type-vendor
619 .RB "(e.g. " eap-7-12345 ).
620 To specify signature and trust chain constraints for EAP-(T)TLS, append a colon
621 to the EAP method, followed by the key type/size and hash algorithm as discussed
622 above. For
623 .B xauth,
624 an XAuth authentication backend can be specified, such as
625 .B xauth-generic
626 or
627 .BR xauth-eap .
628 If XAuth is used in
629 .BR leftauth ,
630 Hybrid authentication is used. For traditional XAuth authentication, define
631 XAuth in
632 .BR lefauth2 .
633 .TP
634 .BR leftauth2 " = <auth method>"
635 Same as
636 .BR leftauth ,
637 but defines an additional authentication exchange. In IKEv1, only XAuth can be
638 used in the second authentication round. IKEv2 supports multiple complete
639 authentication rounds using "Multiple Authentication Exchanges" defined
640 in RFC 4739. This allows, for example, separated authentication
641 of host and user.
642 .TP
643 .BR leftca " = <issuer dn> | %same"
644 the distinguished name of a certificate authority which is required to
645 lie in the trust path going from the left participant's certificate up
646 to the root certification authority.
647 .B %same
648 means that the value configured for the right participant should be reused.
649 .TP
650 .BR leftca2 " = <issuer dn> | %same"
651 Same as
652 .BR leftca ,
653 but for the second authentication round (IKEv2 only).
654 .TP
655 .BR leftcert " = <path>"
656 the path to the left participant's X.509 certificate. The file can be encoded
657 either in PEM or DER format. OpenPGP certificates are supported as well.
658 Both absolute paths or paths relative to \fI/etc/ipsec.d/certs\fP
659 are accepted. By default
660 .B leftcert
661 sets
662 .B leftid
663 to the distinguished name of the certificate's subject.
664 The left participant's ID can be overridden by specifying a
665 .B leftid
666 value which must be certified by the certificate, though.
667 .br
668 A value in the form
669 .B %smartcard[<slot nr>[@<module>]]:<keyid>
670 defines a specific certificate to load from a PKCS#11 backend for this
671 connection. See ipsec.secrets(5) for details about smartcard definitions.
672 .B leftcert
673 is required only if selecting the certificate with
674 .B leftid
675 is not sufficient, for example if multiple certificates use the same subject.
676 .br
677 Multiple certificate paths or PKCS#11 backends can be specified in a comma
678 separated list. The daemon chooses the certificate based on the received
679 certificate requests if possible before enforcing the first.
680 .TP
681 .BR leftcert2 " = <path>"
682 Same as
683 .B leftcert,
684 but for the second authentication round (IKEv2 only).
685 .TP
686 .BR leftcertpolicy " = <OIDs>"
687 Comma separated list of certificate policy OIDs the peer's certificate must
688 have.
689 OIDs are specified using the numerical dotted representation.
690 .TP
691 .BR leftdns " = <servers>"
692 Comma separated list of DNS server addresses to exchange as configuration
693 attributes. On the initiator, a server is a fixed IPv4/IPv6 address, or
694 .BR %config4 / %config6
695 to request attributes without an address. On the responder,
696 only fixed IPv4/IPv6 addresses are allowed and define DNS servers assigned
697 to the client.
698 .TP
699 .BR leftfirewall " = yes | " no
700 whether the left participant is doing forwarding-firewalling
701 (including masquerading) using iptables for traffic from \fIleftsubnet\fR,
702 which should be turned off (for traffic to the other subnet)
703 once the connection is established;
704 acceptable values are
705 .B yes
706 and
707 .B no
708 (the default).
709 May not be used in the same connection description with
710 .BR leftupdown .
711 Implemented as a parameter to the default \fBipsec _updown\fR script.
712 See notes below.
713 Relevant only locally, other end need not agree on it.
714
715 If one or both security gateways are doing forwarding firewalling
716 (possibly including masquerading),
717 and this is specified using the firewall parameters,
718 tunnels established with IPsec are exempted from it
719 so that packets can flow unchanged through the tunnels.
720 (This means that all subnets connected in this manner must have
721 distinct, non-overlapping subnet address blocks.)
722 This is done by the default \fBipsec _updown\fR script.
723
724 In situations calling for more control,
725 it may be preferable for the user to supply his own
726 .I updown
727 script,
728 which makes the appropriate adjustments for his system.
729 .TP
730 .BR leftgroups " = <group list>"
731 a comma separated list of group names. If the
732 .B leftgroups
733 parameter is present then the peer must be a member of at least one
734 of the groups defined by the parameter.
735 .TP
736 .BR leftgroups2 " = <group list>"
737 Same as
738 .B leftgroups,
739 but for the second authentication round defined with
740 .B leftauth2.
741 .TP
742 .BR lefthostaccess " = yes | " no
743 inserts a pair of INPUT and OUTPUT iptables rules using the default
744 \fBipsec _updown\fR script, thus allowing access to the host itself
745 in the case where the host's internal interface is part of the
746 negotiated client subnet.
747 Acceptable values are
748 .B yes
749 and
750 .B no
751 (the default).
752 .TP
753 .BR leftid " = <id>"
754 how the left participant should be identified for authentication;
755 defaults to
756 .B left
757 or the subject of the certificate configured with
758 .BR leftcert .
759 If
760 .B leftcert
761 is configured the identity has to be confirmed by the certificate.
762
763 Can be an IP address, a fully-qualified domain name, an email address or a
764 Distinguished Name for which the ID type is determined automatically and the
765 string is converted to the appropriate encoding. The rules for this conversion
766 are described in IDENTITY PARSING below.
767
768 In certain special situations the identity parsing above might be inadequate
769 or produce the wrong result. Examples are the need to encode a FQDN as KEY_ID or
770 the string parser being unable to produce the correct binary ASN.1 encoding of
771 a certificate's DN.  For these situations it is possible to enforce a specific
772 identity type and to provide the binary encoding of the identity. To do this a
773 prefix may be used, followed by a colon (:). If the number sign (#) follows the
774 colon, the remaining data is interpreted as hex encoding, otherwise the string
775 is used as is as the identification data.
776 .BR Note :
777 The latter implies that no conversion is performed for non-string identities.
778 For example,
779 \fIipv4:10.0.0.1\fP does not create a valid ID_IPV4_ADDR IKE identity, as it
780 does not get converted to binary 0x0a000001. Instead, one could use
781 \fIipv4:#0a000001\fP to get a valid identity, but just using the implicit type
782 with automatic conversion is usually simpler. The same applies to the ASN.1
783 encoded types. The following prefixes are known:
784 .BR ipv4 ,
785 .BR ipv6 ,
786 .BR rfc822 ,
787 .BR email ,
788 .BR userfqdn ,
789 .BR fqdn ,
790 .BR dns ,
791 .BR asn1dn ,
792 .B asn1gn
793 and
794 .BR keyid .
795 Custom type prefixes may be specified by surrounding the numerical type value by
796 curly brackets.
797
798 For IKEv2 and
799 .B rightid
800 the prefix
801 .B %
802 in front of the identity prevents the daemon from sending IDr in its IKE_AUTH
803 request and will allow it to verify the configured identity against the subject
804 and subjectAltNames contained in the responder's certificate (otherwise it is
805 only compared with the IDr returned by the responder).  The IDr sent by the
806 initiator might otherwise prevent the responder from finding a config if it
807 has configured a different value for
808 .BR leftid .
809 .TP
810 .BR leftid2 " = <id>"
811 identity to use for a second authentication for the left participant
812 (IKEv2 only); defaults to
813 .BR leftid .
814 .TP
815 .BR leftikeport " = <port>"
816 UDP port the left participant uses for IKE communication.
817 If unspecified, port 500 is used with the port floating
818 to 4500 if a NAT is detected or MOBIKE is enabled. Specifying a local IKE port
819 different from the default additionally requires a socket implementation that
820 listens on this port.
821 .TP
822 .BR leftprotoport " = <protocol>/<port>"
823 restrict the traffic selector to a single protocol and/or port. This option
824 is now deprecated, protocol/port information can be defined for each subnet
825 directly in
826 .BR leftsubnet .
827 .TP
828 .BR leftsigkey " = <raw public key> | <path to public key>"
829 the left participant's public key for public key signature authentication,
830 in PKCS#1 format using hex (0x prefix) or base64 (0s prefix) encoding. With the
831 optional
832 .B dns:
833 or
834 .B ssh:
835 prefix in front of 0x or 0s, the public key is expected to be in either
836 the RFC 3110 (not the full RR, only RSA key part) or RFC 4253 public key format,
837 respectively.
838 Also accepted is the path to a file containing the public key in PEM, DER or SSH
839 encoding. Both absolute paths or paths relative to \fI/etc/ipsec.d/certs\fP
840 are accepted.
841 .TP
842 .BR leftsendcert " = never | no | " ifasked " | always | yes"
843 Accepted values are
844 .B never
845 or
846 .BR no ,
847 .B always
848 or
849 .BR yes ,
850 and
851 .BR ifasked " (the default),"
852 the latter meaning that the peer must send a certificate request payload in
853 order to get a certificate in return.
854 .TP
855 .BR leftsourceip " = %config4 | %config6 | <ip address>"
856 Comma separated list of internal source IPs to use in a tunnel, also known as
857 virtual IP. If the value is one of the synonyms
858 .BR %config ,
859 .BR %cfg ,
860 .BR %modeconfig ,
861 or
862 .BR %modecfg ,
863 an address (from the tunnel address family) is requested from the peer. With
864 .B %config4
865 and
866 .B %config6
867 an address of the given address family will be requested explicitly.
868 If an IP address is configured, it will be requested from the responder,
869 which is free to respond with a different address.
870 .TP
871 .BR rightsourceip " = %config | <network>/<netmask> | <from>-<to> | %poolname"
872 Comma separated list of internal source IPs to use in a tunnel for the remote
873 peer. If the value is
874 .B %config
875 on the responder side, the initiator must propose an address which is then
876 echoed back. Also supported are address pools expressed as
877 \fInetwork\fB/\fInetmask\fR
878 and
879 \fIfrom\fB-\fIto\fR
880 or the use of an external IP address pool using %\fIpoolname\fR,
881 where \fIpoolname\fR is the name of the IP address pool used for the lookup.
882 .TP
883 .BR leftsubnet " = <ip subnet>[[<proto/port>]][,...]"
884 private subnet behind the left participant, expressed as
885 \fInetwork\fB/\fInetmask\fR;
886 if omitted, essentially assumed to be \fIleft\fB/32\fR,
887 signifying that the left end of the connection goes to the left participant
888 only. Configured subnets of the peers may differ, the protocol narrows it to
889 the greatest common subnet. In IKEv1, this may lead to problems with other
890 implementations, make sure to configure identical subnets in such
891 configurations. IKEv2 supports multiple subnets separated by commas. IKEv1 only
892 interprets the first subnet of such a definition, unless the Cisco Unity
893 extension plugin is enabled.
894
895 The optional part after each subnet enclosed in square brackets specifies a
896 protocol/port to restrict the selector for that subnet.
897
898 Examples:
899 .BR leftsubnet=10.0.0.1[tcp/http],10.0.0.2[6/80] " or"
900 .BR leftsubnet=fec1::1[udp],10.0.0.0/16[/53] .
901 Instead of omitting either value
902 .B %any
903 can be used to the same effect, e.g.
904 .BR leftsubnet=fec1::1[udp/%any],10.0.0.0/16[%any/53] .
905
906 If the protocol is
907 .B icmp
908 or
909 .B ipv6-icmp
910 the port is interpreted as ICMP message type if it is less than 256 or as type
911 and code if it is greater or equal to 256, with the type in the most significant
912 8 bits and the code in the least significant 8 bits.
913
914 The port value can alternatively take the value
915 .B %opaque
916 for RFC 4301 OPAQUE selectors, or a numerical range in the form
917 .BR 1024-65535 .
918 None of the kernel backends currently supports opaque or port ranges and uses
919 .B %any
920 for policy installation instead.
921
922 Instead of specifying a subnet,
923 .B %dynamic
924 can be used to replace it with the IKE address, having the same effect
925 as omitting
926 .B leftsubnet
927 completely. Using
928 .B %dynamic
929 can be used to define multiple dynamic selectors, each having a potentially
930 different protocol/port definition.
931
932 .TP
933 .BR leftupdown " = <path>"
934 what ``updown'' script to run to adjust routing and/or firewalling
935 when the status of the connection
936 changes (default
937 .BR "ipsec _updown" ).
938 May include positional parameters separated by white space
939 (although this requires enclosing the whole string in quotes);
940 including shell metacharacters is unwise.
941 Relevant only locally, other end need not agree on it. Charon uses the updown
942 script to insert firewall rules only, since routing has been implemented
943 directly into the daemon.
944 .TP
945 .BR lifebytes " = <number>"
946 the number of bytes transmitted over an IPsec SA before it expires.
947 .TP
948 .BR lifepackets " = <number>"
949 the number of packets transmitted over an IPsec SA before it expires.
950 .TP
951 .BR lifetime " = " 1h " | <time>"
952 how long a particular instance of a connection
953 (a set of encryption/authentication keys for user packets) should last,
954 from successful negotiation to expiry;
955 acceptable values are an integer optionally followed by
956 .BR s
957 (a time in seconds)
958 or a decimal number followed by
959 .BR m ,
960 .BR h ,
961 or
962 .B d
963 (a time
964 in minutes, hours, or days respectively)
965 (default
966 .BR 1h ,
967 maximum
968 .BR 24h ).
969 Normally, the connection is renegotiated (via the keying channel)
970 before it expires (see
971 .BR margintime ).
972 The two ends need not exactly agree on
973 .BR lifetime ,
974 although if they do not,
975 there will be some clutter of superseded connections on the end
976 which thinks the lifetime is longer. Also see EXPIRY/REKEY below.
977 .TP
978 .BR marginbytes " = <number>"
979 how many bytes before IPsec SA expiry (see
980 .BR lifebytes )
981 should attempts to negotiate a replacement begin.
982 .TP
983 .BR marginpackets " = <number>"
984 how many packets before IPsec SA expiry (see
985 .BR lifepackets )
986 should attempts to negotiate a replacement begin.
987 .TP
988 .BR margintime " = " 9m " | <time>"
989 how long before connection expiry or keying-channel expiry
990 should attempts to
991 negotiate a replacement
992 begin; acceptable values as for
993 .B lifetime
994 (default
995 .BR 9m ).
996 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
997 below.
998 .TP
999 .BR mark " = <value>[/<mask>]"
1000 sets an XFRM mark in the inbound and outbound
1001 IPsec SAs and policies. If the mask is missing then a default
1002 mask of
1003 .B 0xffffffff
1004 is assumed. The special value
1005 .B %unique
1006 assigns a unique value to each newly created IPsec SA.
1007 .TP
1008 .BR mark_in " = <value>[/<mask>]"
1009 sets an XFRM mark in the inbound IPsec SA and
1010 policy. If the mask is missing then a default mask of
1011 .B 0xffffffff
1012 is assumed.
1013 .TP
1014 .BR mark_out " = <value>[/<mask>]"
1015 sets an XFRM mark in the outbound IPsec SA and
1016 policy. If the mask is missing then a default mask of
1017 .B 0xffffffff
1018 is assumed.
1019 .TP
1020 .BR mobike " = " yes " | no"
1021 enables the IKEv2 MOBIKE protocol defined by RFC 4555. Accepted values are
1022 .B yes
1023 (the default) and
1024 .BR no .
1025 If set to
1026 .BR no ,
1027 the charon daemon will not actively propose MOBIKE as initiator and
1028 ignore the MOBIKE_SUPPORTED notify as responder.
1029 .TP
1030 .BR modeconfig " = push | " pull
1031 defines which mode is used to assign a virtual IP.
1032 Accepted values are
1033 .B push
1034 and
1035 .B pull
1036 (the default).
1037 Push mode is currently not supported with IKEv2.
1038 .TP
1039 .BR reauth " = " yes " | no"
1040 whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1,
1041 reauthentication is always done. In IKEv2, a value of
1042 .B no
1043 rekeys without uninstalling the IPsec SAs, a value of
1044 .B yes
1045 (the default) creates a new IKE_SA from scratch and tries to recreate
1046 all IPsec SAs.
1047 .TP
1048 .BR rekey " = " yes " | no"
1049 whether a connection should be renegotiated when it is about to expire;
1050 acceptable values are
1051 .B yes
1052 (the default)
1053 and
1054 .BR no .
1055 The two ends need not agree, but while a value of
1056 .B no
1057 prevents charon from requesting renegotiation,
1058 it does not prevent responding to renegotiation requested from the other end,
1059 so
1060 .B no
1061 will be largely ineffective unless both ends agree on it. Also see
1062 .BR reauth .
1063 .TP
1064 .BR rekeyfuzz " = " 100% " | <percentage>"
1065 maximum percentage by which
1066 .BR marginbytes ,
1067 .B marginpackets
1068 and
1069 .B margintime
1070 should be randomly increased to randomize rekeying intervals
1071 (important for hosts with many connections);
1072 acceptable values are an integer,
1073 which may exceed 100,
1074 followed by a `%'
1075 (defaults to
1076 .BR 100% ).
1077 The value of
1078 .BR marginTYPE ,
1079 after this random increase,
1080 must not exceed
1081 .B lifeTYPE
1082 (where TYPE is one of
1083 .IR bytes ,
1084 .I packets
1085 or
1086 .IR time ).
1087 The value
1088 .B 0%
1089 will suppress randomization.
1090 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
1091 below.
1092 .TP
1093 .B rekeymargin
1094 synonym for
1095 .BR margintime .
1096 .TP
1097 .BR replay_window " = " \-1 " | <number>"
1098 The IPsec replay window size for this connection. With the default of \-1
1099 the value configured with
1100 .I charon.replay_window
1101 in
1102 .BR strongswan.conf (5)
1103 is used. Larger values than 32 are supported using the Netlink backend only,
1104 a value of 0 disables IPsec replay protection.
1105 .TP
1106 .BR reqid " = <number>"
1107 sets the reqid for a given connection to a pre-configured fixed value.
1108 .TP
1109 .BR tfc " = <value>"
1110 number of bytes to pad ESP payload data to. Traffic Flow Confidentiality
1111 is currently supported in IKEv2 and applies to outgoing packets only. The
1112 special value
1113 .BR %mtu
1114 fills up ESP packets with padding to have the size of the MTU.
1115 .TP
1116 .BR type " = " tunnel " | transport | transport_proxy | passthrough | drop"
1117 the type of the connection; currently the accepted values
1118 are
1119 .B tunnel
1120 (the default)
1121 signifying a host-to-host, host-to-subnet, or subnet-to-subnet tunnel;
1122 .BR transport ,
1123 signifying host-to-host transport mode;
1124 .BR transport_proxy ,
1125 signifying the special Mobile IPv6 transport proxy mode;
1126 .BR passthrough ,
1127 signifying that no IPsec processing should be done at all;
1128 .BR drop ,
1129 signifying that packets should be discarded.
1130 .TP
1131 .BR xauth " = " client " | server"
1132 specifies the role in the XAuth protocol if activated by
1133 .B authby=xauthpsk
1134 or
1135 .B authby=xauthrsasig.
1136 Accepted values are
1137 .B server
1138 and
1139 .B client
1140 (the default).
1141 .TP
1142 .BR xauth_identity " = <id>"
1143 defines the identity/username the client uses to reply to an XAuth request.
1144 If not defined, the IKEv1 identity will be used as XAuth identity.
1145
1146 .SS "CONN PARAMETERS: IKEv2 MEDIATION EXTENSION"
1147 The following parameters are relevant to IKEv2 Mediation Extension
1148 operation only.
1149 .TP
1150 .BR mediation " = yes | " no
1151 whether this connection is a mediation connection, ie. whether this
1152 connection is used to mediate other connections.  Mediation connections
1153 create no child SA. Acceptable values are
1154 .B no
1155 (the default) and
1156 .BR yes .
1157 .TP
1158 .BR mediated_by " = <name>"
1159 the name of the connection to mediate this connection through.  If given,
1160 the connection will be mediated through the named mediation connection.
1161 The mediation connection must set
1162 .BR mediation=yes .
1163 .TP
1164 .BR me_peerid " = <id>"
1165 ID as which the peer is known to the mediation server, ie. which the other
1166 end of this connection uses as its
1167 .B leftid
1168 on its connection to the mediation server.  This is the ID we request the
1169 mediation server to mediate us with.  If
1170 .B me_peerid
1171 is not given, the
1172 .B rightid
1173 of this connection will be used as peer ID.
1174
1175 .SH "CA SECTIONS"
1176 These are optional sections that can be used to assign special
1177 parameters to a Certification Authority (CA). Because the daemons
1178 automatically import CA certificates from \fI/etc/ipsec.d/cacerts\fP,
1179 there is no need to explicitly add them with a CA section, unless you
1180 want to assign special parameters (like a CRL) to a CA.
1181 .TP
1182 .BR also " = <name>"
1183 includes ca section
1184 .BR <name> .
1185 .TP
1186 .BR auto " = " ignore " | add"
1187 currently can have either the value
1188 .B ignore
1189 (the default) or
1190 .BR add .
1191 .TP
1192 .BR cacert " = <path>"
1193 defines a path to the CA certificate either relative to
1194 \fI/etc/ipsec.d/cacerts\fP or as an absolute path.
1195 .br
1196 A value in the form
1197 .B %smartcard[<slot nr>[@<module>]]:<keyid>
1198 defines a specific CA certificate to load from a PKCS#11 backend for this CA.
1199 See ipsec.secrets(5) for details about smartcard definitions.
1200 .TP
1201 .BR crluri " = <uri>"
1202 defines a CRL distribution point (ldap, http, or file URI)
1203 .TP
1204 .B crluri1
1205 synonym for
1206 .B crluri.
1207 .TP
1208 .BR crluri2 " = <uri>"
1209 defines an alternative CRL distribution point (ldap, http, or file URI)
1210 .TP
1211 .TP
1212 .BR ocspuri " = <uri>"
1213 defines an OCSP URI.
1214 .TP
1215 .B ocspuri1
1216 synonym for
1217 .B ocspuri.
1218 .TP
1219 .BR ocspuri2 " = <uri>"
1220 defines an alternative OCSP URI.
1221 .TP
1222 .BR certuribase " = <uri>"
1223 defines the base URI for the Hash and URL feature supported by IKEv2.
1224 Instead of exchanging complete certificates, IKEv2 allows one to send an URI
1225 that resolves to the DER encoded certificate. The certificate URIs are built
1226 by appending the SHA1 hash of the DER encoded certificates to this base URI.
1227 .SH "CONFIG SECTIONS"
1228 At present, the only
1229 .B config
1230 section known to the IPsec software is the one named
1231 .BR setup ,
1232 which contains information used when the software is being started.
1233 The currently-accepted
1234 .I parameter
1235 names in a
1236 .B config
1237 .B setup
1238 section are:
1239 .TP
1240 .BR cachecrls " = yes | " no
1241 if enabled, certificate revocation lists (CRLs) fetched via HTTP or LDAP will
1242 be cached in
1243 .I /etc/ipsec.d/crls/
1244 under a unique file name derived from the certification authority's public key.
1245 .TP
1246 .BR charondebug " = <debug list>"
1247 how much charon debugging output should be logged.
1248 A comma separated list containing type/level-pairs may
1249 be specified, e.g:
1250 .B dmn 3, ike 1, net -1.
1251 Acceptable values for types are
1252 .B dmn, mgr, ike, chd, job, cfg, knl, net, asn, enc, lib, esp, tls,
1253 .B tnc, imc, imv, pts
1254 and the level is one of
1255 .B -1, 0, 1, 2, 3, 4
1256 (for silent, audit, control, controlmore, raw, private).  By default, the level
1257 is set to
1258 .B 1
1259 for all types.  For more flexibility see LOGGER CONFIGURATION in
1260 .IR strongswan.conf (5).
1261 .TP
1262 .BR strictcrlpolicy " = yes | ifuri | " no
1263 defines if a fresh CRL must be available in order for the peer authentication
1264 based on RSA signatures to succeed.
1265 IKEv2 additionally recognizes
1266 .B ifuri
1267 which reverts to
1268 .B yes
1269 if at least one CRL URI is defined and to
1270 .B no
1271 if no URI is known.
1272 .TP
1273 .BR uniqueids " = " yes " | no | never | replace | keep"
1274 whether a particular participant ID should be kept unique,
1275 with any new IKE_SA using an ID deemed to replace all old ones using that ID;
1276 acceptable values are
1277 .B yes
1278 (the default),
1279 .B no
1280 and
1281 .BR never .
1282 Participant IDs normally \fIare\fR unique, so a new IKE_SA using the same ID is
1283 almost invariably intended to replace an old one. The difference between
1284 .B no
1285 and
1286 .B never
1287 is that the daemon will replace old IKE_SAs when receiving an INITIAL_CONTACT
1288 notify if the option is
1289 .B no
1290 but will ignore these notifies if
1291 .B never
1292 is configured.
1293 The daemon also accepts the value
1294 .B replace
1295 which is identical to
1296 .B yes
1297 and the value
1298 .B keep
1299 to reject new IKE_SA setups and keep the duplicate established earlier.
1300
1301 .SH IDENTITY PARSING
1302 The type and binary encoding of identity strings specified in \fIleftid\fR
1303 are detected as follows:
1304 .IP \[bu]
1305 If the string value contains an equal sign (=) it is assumed to be a
1306 Distinguished Name, with RDNs separated by commas (,) \fIor\fR slashes (/ - the string
1307 must start with a slash to use this syntax). An attempt is made to create a
1308 binary ASN.1 encoding from this string. If that fails the type is set to KEY_ID
1309 with the literal string value adopted as encoding.
1310 .IP \[bu]
1311 If the string value contains an @ the type depends on the position of that
1312 character:
1313 .RS
1314 .IP \[bu]
1315 If the string begins with @# the type is set to KEY_ID and the string following
1316 that prefix is assumed to be the hex-encoded binary value of the identity.
1317 .IP \[bu]
1318 If the string begins with @@ the type is set to USER_FQDN and the encoding is
1319 the literal string after that prefix.
1320 .IP \[bu]
1321 If the string begins with @ the type is set to FQDN and the encoding is the
1322 literal string after that prefix.
1323 .IP \[bu]
1324 All remaining strings containing an @ are assumed to be of type USER_FQDN/RFC822
1325 with the literal string value as encoding.
1326 .RE
1327 .IP \[bu]
1328 If the value does not contain any @ or = characters it is parsed as follows:
1329 .RS
1330 .IP \[bu]
1331 If the value is an empty string, or equals %any[6], 0.0.0.0, ::, or * the
1332 type is set to ID_ANY, which matches any other identity.
1333 .IP \[bu]
1334 If the value contains a colon (:) it is assumed to be an IPv6 address. But if
1335 parsing the address and converting it to its binary encoding fails the type is
1336 set to KEY_ID and the encoding is the literal value.
1337 .IP \[bu]
1338 For all other strings an attempt at parsing them as IPv4 addresses is made. If
1339 that fails the type is set to FQDN and the literal value is adopted as
1340 encoding (this is where domain names and simple names end up).
1341 .RE
1342
1343 .SH SA EXPIRY/REKEY
1344 The IKE SAs and IPsec SAs negotiated by the daemon can be configured to expire
1345 after a specific amount of time. For IPsec SAs this can also happen after a
1346 specified number of transmitted packets or transmitted bytes. The following
1347 settings can be used to configure this:
1348 .TS
1349 l r l r,- - - -,lB s lB s,a r a r.
1350 Setting Default Setting Default
1351 IKE SA  IPsec SA
1352 ikelifetime     3h      lifebytes       -
1353                 lifepackets     -
1354                 lifetime        1h
1355 .TE
1356 .SS Rekeying
1357 IKE SAs as well as IPsec SAs can be rekeyed before they expire. This can be
1358 configured using the following settings:
1359 .TS
1360 l r l r,- - - -,lB s lB s,a r a r.
1361 Setting Default Setting Default
1362 IKE and IPsec SA        IPsec SA
1363 margintime      9m      marginbytes     -
1364                 marginpackets   -
1365 .TE
1366 .SS Randomization
1367 To avoid collisions the specified margins are increased randomly before
1368 subtracting them from the expiration limits (see formula below). This is
1369 controlled by the
1370 .B rekeyfuzz
1371 setting:
1372 .TS
1373 l r,- -,lB s,a r.
1374 Setting Default
1375 IKE and IPsec SA
1376 rekeyfuzz       100%
1377 .TE
1378 .PP
1379 Randomization can be disabled by setting
1380 .BR rekeyfuzz " to " 0% .
1381 .SS Formula
1382 The following formula is used to calculate the rekey time of IPsec SAs:
1383 .PP
1384 .EX
1385  rekeytime = lifetime - (margintime + random(0, margintime * rekeyfuzz))
1386 .EE
1387 .PP
1388 It applies equally to IKE SAs and byte and packet limits for IPsec SAs.
1389 .SS Example
1390 Let's consider the default configuration:
1391 .PP
1392 .EX
1393         lifetime = 1h
1394         margintime = 9m
1395         rekeyfuzz = 100%
1396 .EE
1397 .PP
1398 From the formula above follows that the rekey time lies between:
1399 .PP
1400 .EX
1401         rekeytime_min = 1h - (9m + 9m) = 42m
1402         rekeytime_max = 1h - (9m + 0m) = 51m
1403 .EE
1404 .PP
1405 Thus, the daemon will attempt to rekey the IPsec SA at a random time
1406 between 42 and 51 minutes after establishing the SA. Or, in other words,
1407 between 9 and 18 minutes before the SA expires.
1408 .SS Notes
1409 .IP \[bu]
1410 Since the rekeying of an SA needs some time, the margin values must not be
1411 too low.
1412 .IP \[bu]
1413 The value
1414 .B margin... + margin... * rekeyfuzz
1415 must not exceed the original limit. For example, specifying
1416 .B margintime = 30m
1417 in the default configuration is a bad idea as there is a chance that the rekey
1418 time equals zero and, thus, rekeying gets disabled.
1419
1420 .SH FILES
1421 .nf
1422 /etc/ipsec.conf
1423 /etc/ipsec.d/aacerts
1424 /etc/ipsec.d/acerts
1425 /etc/ipsec.d/cacerts
1426 /etc/ipsec.d/certs
1427 /etc/ipsec.d/crls
1428
1429 .SH SEE ALSO
1430 strongswan.conf(5), ipsec.secrets(5), ipsec(8)
1431 .SH HISTORY
1432 Originally written for the FreeS/WAN project by Henry Spencer.
1433 Updated and extended for the strongSwan project <http://www.strongswan.org> by
1434 Tobias Brunner, Andreas Steffen and Martin Willi.