Merge branch 'tpm2'
[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 and determine the action to perform on a timeout. With
353 .B clear
354 the connection is closed with no further actions taken.
355 .B hold
356 installs a trap policy, which will catch matching traffic and tries to
357 re-negotiate the connection on demand.
358 .B restart
359 will immediately trigger an attempt to re-negotiation the connection.
360 The default is
361 .B none
362 which disables the active sending of DPD messages.
363 .TP
364 .BR dpddelay " = " 30s " | <time>"
365 defines the period time interval with which R_U_THERE messages/INFORMATIONAL
366 exchanges are sent to the peer. These are only sent if no other traffic is
367 received. In IKEv2, a value of 0 sends no additional INFORMATIONAL
368 messages and uses only standard messages (such as those to rekey) to detect
369 dead peers.
370 .TP
371 .BR dpdtimeout " = " 150s " | <time>
372 defines the timeout interval, after which all connections to a peer are deleted
373 in case of inactivity. This only applies to IKEv1, in IKEv2 the default
374 retransmission timeout applies, as every exchange is used to detect dead peers.
375 .TP
376 .BR inactivity " = <time>"
377 defines the timeout interval, after which a CHILD_SA is closed if it did
378 not send or receive any traffic. The inactivity counter is reset during CHILD_SA
379 rekeying. This means that the inactivity timeout must be smaller than the
380 rekeying interval to have any effect.
381 .TP
382 .BR eap_identity " = <id>"
383 defines the identity the client uses to reply to an EAP Identity request.
384 If defined on the EAP server, the defined identity will be used as peer
385 identity during EAP authentication. The special value
386 .B %identity
387 uses the EAP Identity method to ask the client for an EAP identity. If not
388 defined, the IKEv2 identity will be used as EAP identity.
389 .TP
390 .BR esp " = <cipher suites>"
391 comma-separated list of ESP encryption/authentication algorithms to be used
392 for the connection, e.g.
393 .BR aes128-sha256 .
394 The notation is
395 .BR encryption-integrity[-dhgroup][-esnmode] .
396 For IKEv2, multiple algorithms (separated by -) of the same type can be included
397 in a single proposal. IKEv1 only includes the first algorithm in a proposal.
398 Only either the
399 .B ah
400 or
401 .B esp
402 keyword may be used, AH+ESP bundles are not supported.
403
404 Defaults to
405 .BR aes128-sha256 .
406 The daemon adds its extensive default proposal to this default
407 or the configured value.  To restrict it to the configured proposal an
408 exclamation mark
409 .RB ( ! )
410 can be added at the end.
411
412 .BR Note :
413 As a responder the daemon accepts the first supported proposal received from
414 the peer. In order to restrict a responder to only accept specific cipher
415 suites, the strict flag
416 .RB ( ! ,
417 exclamation mark) can be used, e.g: aes256-sha512-modp4096!
418 .br
419 If
420 .B dh-group
421 is specified, CHILD_SA/Quick Mode setup and rekeying include a separate
422 Diffie-Hellman exchange.  Valid values for
423 .B esnmode
424 (IKEv2 only) are
425 .B esn
426 and
427 .BR noesn .
428 Specifying both negotiates Extended Sequence Number support with the peer,
429 the default is
430 .B noesn.
431 .TP
432 .BR forceencaps " = yes | " no
433 force UDP encapsulation for ESP packets even if no NAT situation is detected.
434 This may help to surmount restrictive firewalls. In order to force the peer to
435 encapsulate packets, NAT detection payloads are faked.
436 .TP
437 .BR fragmentation " = yes | force | " no
438 whether to use IKE fragmentation (proprietary IKEv1 extension or IKEv2
439 fragmentation as per RFC 7383).  Acceptable values are
440 .BR yes ,
441 .B force
442 and
443 .B no
444 (the default). Fragmented IKE messages sent by a peer are always accepted
445 irrespective of the value of this option. If set to
446 .BR yes ,
447 and the peer supports it, larger IKE messages will be sent in fragments.
448 If set to
449 .B force
450 (only supported for IKEv1) the initial IKE message will already be fragmented
451 if required.
452 .TP
453 .BR ike " = <cipher suites>"
454 comma-separated list of IKE/ISAKMP SA encryption/authentication algorithms
455 to be used, e.g.
456 .BR aes128-sha256-modp3072 .
457 The notation is
458 .BR encryption-integrity[-prf]-dhgroup .
459 If no PRF is given, the algorithms defined for integrity are used for the PRF.
460 The prf keywords are the same as the integrity algorithms, but have a
461 .B prf
462 prefix (such as
463 .BR prfsha1 ,
464 .B prfsha256
465 or
466 .BR prfaesxcbc ).
467 .br
468 In IKEv2, multiple algorithms and proposals may be included, such as
469 .BR aes128-aes256-sha1-modp3072-modp2048,3des-sha1-md5-modp1024 .
470
471 Defaults to
472 .BR aes128-sha256-modp3072 .
473 The daemon adds its extensive default proposal to this
474 default or the configured value.  To restrict it to the configured proposal an
475 exclamation mark
476 .RB ( ! )
477 can be added at the end.
478
479 .BR Note :
480 As a responder the daemon accepts the first supported proposal received from
481 the peer.  In order to restrict a responder to only accept specific cipher
482 suites, the strict flag
483 .RB ( ! ,
484 exclamation mark) can be used, e.g:
485 .BR aes256-sha512-modp4096!
486 .TP
487 .BR ikedscp " = " 000000 " | <DSCP field>"
488 Differentiated Services Field Codepoint to set on outgoing IKE packets sent
489 from this connection. The value is a six digit binary encoded string defining
490 the Codepoint to set, as defined in RFC 2474.
491 .TP
492 .BR ikelifetime " = " 3h " | <time>"
493 how long the keying channel of a connection (ISAKMP or IKE SA)
494 should last before being renegotiated. Also see EXPIRY/REKEY below.
495 .TP
496 .BR installpolicy " = " yes " | no"
497 decides whether IPsec policies are installed in the kernel by the charon daemon
498 for a given connection. Allows peaceful cooperation e.g. with
499 the Mobile IPv6 daemon mip6d who wants to control the kernel policies.
500 Acceptable values are
501 .B yes
502 (the default) and
503 .BR no .
504 .TP
505 .BR keyexchange " = " ike " | ikev1 | ikev2"
506 which key exchange protocol should be used to initiate the connection.
507 Connections marked with
508 .B ike
509 use IKEv2 when initiating, but accept any protocol version when responding.
510 .TP
511 .BR keyingtries " = " 3 " | <number> | %forever"
512 how many attempts (a whole number or \fB%forever\fP) should be made to
513 negotiate a connection, or a replacement for one, before giving up
514 (default
515 .BR 3 ).
516 The value \fB%forever\fP
517 means 'never give up'.
518 Relevant only locally, other end need not agree on it.
519 .TP
520 .B keylife
521 synonym for
522 .BR lifetime .
523 .TP
524 .BR left " = <ip address> | <fqdn> | " %any " | <range> | <subnet> "
525 The IP address of the left participant's public-network interface
526 or one of several magic values.
527 The value
528 .B %any
529 (the default) for the local endpoint signifies an address to be filled in (by
530 automatic keying) during negotiation. If the local peer initiates the
531 connection setup the routing table will be queried to determine the correct
532 local IP address.
533 In case the local peer is responding to a connection setup then any IP address
534 that is assigned to a local interface will be accepted.
535
536 The prefix
537 .B %
538 in front of a fully-qualified domain name or an IP address will implicitly set
539 .BR leftallowany =yes.
540
541 If
542 .B %any
543 is used for the remote endpoint it literally means any IP address.
544
545 To limit the connection to a  specific range of hosts, a range (
546 .BR 10.1.0.0-10.2.255.255
547 ) or a subnet (
548 .BR 10.1.0.0/16
549 ) can be specified, and multiple addresses, ranges and subnets can be separated
550 by commas. While one can freely combine these items, to initiate the connection
551 at least one non-range/subnet is required.
552
553 Please note that with the usage of wildcards multiple connection descriptions
554 might match a given incoming connection attempt. The most specific description
555 is used in that case.
556 .TP
557 .BR leftallowany " = yes | " no
558 a modifier for
559 .BR left ,
560 making it behave as
561 .B %any
562 although a concrete IP address or domain name has been assigned.
563 .TP
564 .BR leftauth " = <auth method>"
565 Authentication method to use locally (left) or require from the remote (right)
566 side.
567 Acceptable values are
568 .B pubkey
569 for public key authentication (RSA/ECDSA),
570 .B psk
571 for pre-shared key authentication,
572 .B eap
573 to (require the) use of the Extensible Authentication Protocol in IKEv2, and
574 .B xauth
575 for IKEv1 eXtended Authentication.
576
577 To require a trustchain public key strength for the remote side, specify the
578 key type followed by the minimum strength in bits (for example
579 .BR ecdsa-384
580 or
581 .BR rsa-2048-ecdsa-256 ).
582 To limit the acceptable set of hashing algorithms for trustchain validation,
583 append hash algorithms to
584 .BR pubkey
585 or a key strength definition (for example
586 .BR pubkey-sha1-sha256
587 or
588 .BR rsa-2048-ecdsa-256-sha256-sha384-sha512 ).
589 Unless disabled in
590 .BR strongswan.conf (5),
591 or explicit IKEv2 signature constraints are configured (see below), such key
592 types and hash algorithms are also applied as constraints against IKEv2
593 signature authentication schemes used by the remote side.
594
595 If both peers support RFC 7427 ("Signature Authentication in IKEv2") specific
596 hash algorithms to be used during IKEv2 authentication may be configured.
597 The syntax is the same as above, but with ike: prefix. For example, with
598 .B ike:pubkey-sha384-sha256
599 a public key signature scheme with either SHA-384 or SHA-256 would get used for
600 authentication, in that order and depending on the hash algorithms supported by
601 the peer.  If no specific hash algorithms are configured, the default is to
602 prefer an algorithm that matches or exceeds the strength of the signature key.
603 If no constraints with ike: prefix are configured any signature scheme
604 constraint (without ike: prefix) will also apply to IKEv2 authentication, unless
605 this is disabled in
606 .BR strongswan.conf (5).
607
608 For
609 .BR eap ,
610 an optional EAP method can be appended. Currently defined methods are
611 .BR eap-aka ,
612 .BR eap-gtc ,
613 .BR eap-md5 ,
614 .BR eap-mschapv2 ,
615 .BR eap-peap ,
616 .BR eap-sim ,
617 .BR eap-tls ,
618 .BR eap-ttls ,
619 .BR eap-dynamic ,
620 and
621 .BR eap-radius .
622 Alternatively, IANA assigned EAP method numbers are accepted. Vendor specific
623 EAP methods are defined in the form
624 .B eap-type-vendor
625 .RB "(e.g. " eap-7-12345 ).
626 To specify signature and trust chain constraints for EAP-(T)TLS, append a colon
627 to the EAP method, followed by the key type/size and hash algorithm as discussed
628 above. For
629 .B xauth,
630 an XAuth authentication backend can be specified, such as
631 .B xauth-generic
632 or
633 .BR xauth-eap .
634 If XAuth is used in
635 .BR leftauth ,
636 Hybrid authentication is used. For traditional XAuth authentication, define
637 XAuth in
638 .BR lefauth2 .
639 .TP
640 .BR leftauth2 " = <auth method>"
641 Same as
642 .BR leftauth ,
643 but defines an additional authentication exchange. In IKEv1, only XAuth can be
644 used in the second authentication round. IKEv2 supports multiple complete
645 authentication rounds using "Multiple Authentication Exchanges" defined
646 in RFC 4739. This allows, for example, separated authentication
647 of host and user.
648 .TP
649 .BR leftca " = <issuer dn> | %same"
650 the distinguished name of a certificate authority which is required to
651 lie in the trust path going from the left participant's certificate up
652 to the root certification authority.
653 .B %same
654 means that the value configured for the right participant should be reused.
655 .TP
656 .BR leftca2 " = <issuer dn> | %same"
657 Same as
658 .BR leftca ,
659 but for the second authentication round (IKEv2 only).
660 .TP
661 .BR leftcert " = <path>"
662 the path to the left participant's X.509 certificate. The file can be encoded
663 either in PEM or DER format. OpenPGP certificates are supported as well.
664 Both absolute paths or paths relative to \fI/etc/ipsec.d/certs\fP
665 are accepted. By default
666 .B leftcert
667 sets
668 .B leftid
669 to the distinguished name of the certificate's subject.
670 The left participant's ID can be overridden by specifying a
671 .B leftid
672 value which must be certified by the certificate, though.
673 .br
674 A value in the form
675 .B %smartcard[<slot nr>[@<module>]]:<keyid>
676 defines a specific certificate to load from a PKCS#11 backend for this
677 connection. See ipsec.secrets(5) for details about smartcard definitions.
678 .B leftcert
679 is required only if selecting the certificate with
680 .B leftid
681 is not sufficient, for example if multiple certificates use the same subject.
682 .br
683 Multiple certificate paths or PKCS#11 backends can be specified in a comma
684 separated list. The daemon chooses the certificate based on the received
685 certificate requests if possible before enforcing the first.
686 .TP
687 .BR leftcert2 " = <path>"
688 Same as
689 .B leftcert,
690 but for the second authentication round (IKEv2 only).
691 .TP
692 .BR leftcertpolicy " = <OIDs>"
693 Comma separated list of certificate policy OIDs the peer's certificate must
694 have.
695 OIDs are specified using the numerical dotted representation.
696 .TP
697 .BR leftdns " = <servers>"
698 Comma separated list of DNS server addresses to exchange as configuration
699 attributes. On the initiator, a server is a fixed IPv4/IPv6 address, or
700 .BR %config4 / %config6
701 to request attributes without an address. On the responder,
702 only fixed IPv4/IPv6 addresses are allowed and define DNS servers assigned
703 to the client.
704 .TP
705 .BR leftfirewall " = yes | " no
706 whether the left participant is doing forwarding-firewalling
707 (including masquerading) using iptables for traffic from \fIleftsubnet\fR,
708 which should be turned off (for traffic to the other subnet)
709 once the connection is established;
710 acceptable values are
711 .B yes
712 and
713 .B no
714 (the default).
715 May not be used in the same connection description with
716 .BR leftupdown .
717 Implemented as a parameter to the default \fBipsec _updown\fR script.
718 See notes below.
719 Relevant only locally, other end need not agree on it.
720
721 If one or both security gateways are doing forwarding firewalling
722 (possibly including masquerading),
723 and this is specified using the firewall parameters,
724 tunnels established with IPsec are exempted from it
725 so that packets can flow unchanged through the tunnels.
726 (This means that all subnets connected in this manner must have
727 distinct, non-overlapping subnet address blocks.)
728 This is done by the default \fBipsec _updown\fR script.
729
730 In situations calling for more control,
731 it may be preferable for the user to supply his own
732 .I updown
733 script,
734 which makes the appropriate adjustments for his system.
735 .TP
736 .BR leftgroups " = <group list>"
737 a comma separated list of group names. If the
738 .B leftgroups
739 parameter is present then the peer must be a member of at least one
740 of the groups defined by the parameter.
741 .TP
742 .BR leftgroups2 " = <group list>"
743 Same as
744 .B leftgroups,
745 but for the second authentication round defined with
746 .B leftauth2.
747 .TP
748 .BR lefthostaccess " = yes | " no
749 inserts a pair of INPUT and OUTPUT iptables rules using the default
750 \fBipsec _updown\fR script, thus allowing access to the host itself
751 in the case where the host's internal interface is part of the
752 negotiated client subnet.
753 Acceptable values are
754 .B yes
755 and
756 .B no
757 (the default).
758 .TP
759 .BR leftid " = <id>"
760 how the left participant should be identified for authentication;
761 defaults to
762 .B left
763 or the subject of the certificate configured with
764 .BR leftcert .
765 If
766 .B leftcert
767 is configured the identity has to be confirmed by the certificate.
768
769 Can be an IP address, a fully-qualified domain name, an email address or a
770 Distinguished Name for which the ID type is determined automatically and the
771 string is converted to the appropriate encoding. The rules for this conversion
772 are described in IDENTITY PARSING below.
773
774 In certain special situations the identity parsing above might be inadequate
775 or produce the wrong result. Examples are the need to encode a FQDN as KEY_ID or
776 the string parser being unable to produce the correct binary ASN.1 encoding of
777 a certificate's DN.  For these situations it is possible to enforce a specific
778 identity type and to provide the binary encoding of the identity. To do this a
779 prefix may be used, followed by a colon (:). If the number sign (#) follows the
780 colon, the remaining data is interpreted as hex encoding, otherwise the string
781 is used as is as the identification data.
782 .BR Note :
783 The latter implies that no conversion is performed for non-string identities.
784 For example,
785 \fIipv4:10.0.0.1\fP does not create a valid ID_IPV4_ADDR IKE identity, as it
786 does not get converted to binary 0x0a000001. Instead, one could use
787 \fIipv4:#0a000001\fP to get a valid identity, but just using the implicit type
788 with automatic conversion is usually simpler. The same applies to the ASN.1
789 encoded types. The following prefixes are known:
790 .BR ipv4 ,
791 .BR ipv6 ,
792 .BR rfc822 ,
793 .BR email ,
794 .BR userfqdn ,
795 .BR fqdn ,
796 .BR dns ,
797 .BR asn1dn ,
798 .B asn1gn
799 and
800 .BR keyid .
801 Custom type prefixes may be specified by surrounding the numerical type value by
802 curly brackets.
803
804 For IKEv2 and
805 .B rightid
806 the prefix
807 .B %
808 in front of the identity prevents the daemon from sending IDr in its IKE_AUTH
809 request and will allow it to verify the configured identity against the subject
810 and subjectAltNames contained in the responder's certificate (otherwise it is
811 only compared with the IDr returned by the responder).  The IDr sent by the
812 initiator might otherwise prevent the responder from finding a config if it
813 has configured a different value for
814 .BR leftid .
815 .TP
816 .BR leftid2 " = <id>"
817 identity to use for a second authentication for the left participant
818 (IKEv2 only); defaults to
819 .BR leftid .
820 .TP
821 .BR leftikeport " = <port>"
822 UDP port the left participant uses for IKE communication.
823 If unspecified, port 500 is used with the port floating
824 to 4500 if a NAT is detected or MOBIKE is enabled. Specifying a local IKE port
825 different from the default additionally requires a socket implementation that
826 listens on this port.
827 .TP
828 .BR leftprotoport " = <protocol>/<port>"
829 restrict the traffic selector to a single protocol and/or port. This option
830 is now deprecated, protocol/port information can be defined for each subnet
831 directly in
832 .BR leftsubnet .
833 .TP
834 .BR leftsigkey " = <raw public key> | <path to public key>"
835 the left participant's public key for public key signature authentication,
836 in PKCS#1 format using hex (0x prefix) or base64 (0s prefix) encoding. With the
837 optional
838 .B dns:
839 or
840 .B ssh:
841 prefix in front of 0x or 0s, the public key is expected to be in either
842 the RFC 3110 (not the full RR, only RSA key part) or RFC 4253 public key format,
843 respectively.
844 Also accepted is the path to a file containing the public key in PEM, DER or SSH
845 encoding. Both absolute paths or paths relative to \fI/etc/ipsec.d/certs\fP
846 are accepted.
847 .TP
848 .BR leftsendcert " = never | no | " ifasked " | always | yes"
849 Accepted values are
850 .B never
851 or
852 .BR no ,
853 .B always
854 or
855 .BR yes ,
856 and
857 .BR ifasked " (the default),"
858 the latter meaning that the peer must send a certificate request payload in
859 order to get a certificate in return.
860 .TP
861 .BR leftsourceip " = %config4 | %config6 | <ip address>"
862 Comma separated list of internal source IPs to use in a tunnel, also known as
863 virtual IP. If the value is one of the synonyms
864 .BR %config ,
865 .BR %cfg ,
866 .BR %modeconfig ,
867 or
868 .BR %modecfg ,
869 an address (from the tunnel address family) is requested from the peer. With
870 .B %config4
871 and
872 .B %config6
873 an address of the given address family will be requested explicitly.
874 If an IP address is configured, it will be requested from the responder,
875 which is free to respond with a different address.
876 .TP
877 .BR rightsourceip " = %config | <network>/<netmask> | <from>-<to> | %poolname"
878 Comma separated list of internal source IPs to use in a tunnel for the remote
879 peer. If the value is
880 .B %config
881 on the responder side, the initiator must propose an address which is then
882 echoed back. Also supported are address pools expressed as
883 \fInetwork\fB/\fInetmask\fR
884 and
885 \fIfrom\fB-\fIto\fR
886 or the use of an external IP address pool using %\fIpoolname\fR,
887 where \fIpoolname\fR is the name of the IP address pool used for the lookup.
888 .TP
889 .BR leftsubnet " = <ip subnet>[[<proto/port>]][,...]"
890 private subnet behind the left participant, expressed as
891 \fInetwork\fB/\fInetmask\fR;
892 if omitted, essentially assumed to be \fIleft\fB/32\fR,
893 signifying that the left end of the connection goes to the left participant
894 only. Configured subnets of the peers may differ, the protocol narrows it to
895 the greatest common subnet. In IKEv1, this may lead to problems with other
896 implementations, make sure to configure identical subnets in such
897 configurations. IKEv2 supports multiple subnets separated by commas. IKEv1 only
898 interprets the first subnet of such a definition, unless the Cisco Unity
899 extension plugin is enabled.
900
901 The optional part after each subnet enclosed in square brackets specifies a
902 protocol/port to restrict the selector for that subnet.
903
904 Examples:
905 .BR leftsubnet=10.0.0.1[tcp/http],10.0.0.2[6/80] " or"
906 .BR leftsubnet=fec1::1[udp],10.0.0.0/16[/53] .
907 Instead of omitting either value
908 .B %any
909 can be used to the same effect, e.g.
910 .BR leftsubnet=fec1::1[udp/%any],10.0.0.0/16[%any/53] .
911
912 If the protocol is
913 .B icmp
914 or
915 .B ipv6-icmp
916 the port is interpreted as ICMP message type if it is less than 256 or as type
917 and code if it is greater or equal to 256, with the type in the most significant
918 8 bits and the code in the least significant 8 bits.
919
920 The port value can alternatively take the value
921 .B %opaque
922 for RFC 4301 OPAQUE selectors, or a numerical range in the form
923 .BR 1024-65535 .
924 None of the kernel backends currently supports opaque or port ranges and uses
925 .B %any
926 for policy installation instead.
927
928 Instead of specifying a subnet,
929 .B %dynamic
930 can be used to replace it with the IKE address, having the same effect
931 as omitting
932 .B leftsubnet
933 completely. Using
934 .B %dynamic
935 can be used to define multiple dynamic selectors, each having a potentially
936 different protocol/port definition.
937
938 .TP
939 .BR leftupdown " = <path>"
940 what ``updown'' script to run to adjust routing and/or firewalling
941 when the status of the connection
942 changes (default
943 .BR "ipsec _updown" ).
944 May include positional parameters separated by white space
945 (although this requires enclosing the whole string in quotes);
946 including shell metacharacters is unwise.
947 Relevant only locally, other end need not agree on it. Charon uses the updown
948 script to insert firewall rules only, since routing has been implemented
949 directly into the daemon.
950 .TP
951 .BR lifebytes " = <number>"
952 the number of bytes transmitted over an IPsec SA before it expires.
953 .TP
954 .BR lifepackets " = <number>"
955 the number of packets transmitted over an IPsec SA before it expires.
956 .TP
957 .BR lifetime " = " 1h " | <time>"
958 how long a particular instance of a connection
959 (a set of encryption/authentication keys for user packets) should last,
960 from successful negotiation to expiry;
961 acceptable values are an integer optionally followed by
962 .BR s
963 (a time in seconds)
964 or a decimal number followed by
965 .BR m ,
966 .BR h ,
967 or
968 .B d
969 (a time
970 in minutes, hours, or days respectively)
971 (default
972 .BR 1h ,
973 maximum
974 .BR 24h ).
975 Normally, the connection is renegotiated (via the keying channel)
976 before it expires (see
977 .BR margintime ).
978 The two ends need not exactly agree on
979 .BR lifetime ,
980 although if they do not,
981 there will be some clutter of superseded connections on the end
982 which thinks the lifetime is longer. Also see EXPIRY/REKEY below.
983 .TP
984 .BR marginbytes " = <number>"
985 how many bytes before IPsec SA expiry (see
986 .BR lifebytes )
987 should attempts to negotiate a replacement begin.
988 .TP
989 .BR marginpackets " = <number>"
990 how many packets before IPsec SA expiry (see
991 .BR lifepackets )
992 should attempts to negotiate a replacement begin.
993 .TP
994 .BR margintime " = " 9m " | <time>"
995 how long before connection expiry or keying-channel expiry
996 should attempts to
997 negotiate a replacement
998 begin; acceptable values as for
999 .B lifetime
1000 (default
1001 .BR 9m ).
1002 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
1003 below.
1004 .TP
1005 .BR mark " = <value>[/<mask>]"
1006 sets an XFRM mark in the inbound and outbound
1007 IPsec SAs and policies. If the mask is missing then a default
1008 mask of
1009 .B 0xffffffff
1010 is assumed. The special value
1011 .B %unique
1012 assigns a unique value to each newly created IPsec SA.
1013 .TP
1014 .BR mark_in " = <value>[/<mask>]"
1015 sets an XFRM mark in the inbound 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 mark_out " = <value>[/<mask>]"
1021 sets an XFRM mark in the outbound IPsec SA and
1022 policy. If the mask is missing then a default mask of
1023 .B 0xffffffff
1024 is assumed.
1025 .TP
1026 .BR mobike " = " yes " | no"
1027 enables the IKEv2 MOBIKE protocol defined by RFC 4555. Accepted values are
1028 .B yes
1029 (the default) and
1030 .BR no .
1031 If set to
1032 .BR no ,
1033 the charon daemon will not actively propose MOBIKE as initiator and
1034 ignore the MOBIKE_SUPPORTED notify as responder.
1035 .TP
1036 .BR modeconfig " = push | " pull
1037 defines which mode is used to assign a virtual IP.
1038 Accepted values are
1039 .B push
1040 and
1041 .B pull
1042 (the default).
1043 Push mode is currently not supported with IKEv2.
1044 .TP
1045 .BR reauth " = " yes " | no"
1046 whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1,
1047 reauthentication is always done. In IKEv2, a value of
1048 .B no
1049 rekeys without uninstalling the IPsec SAs, a value of
1050 .B yes
1051 (the default) creates a new IKE_SA from scratch and tries to recreate
1052 all IPsec SAs.
1053 .TP
1054 .BR rekey " = " yes " | no"
1055 whether a connection should be renegotiated when it is about to expire;
1056 acceptable values are
1057 .B yes
1058 (the default)
1059 and
1060 .BR no .
1061 The two ends need not agree, but while a value of
1062 .B no
1063 prevents charon from requesting renegotiation,
1064 it does not prevent responding to renegotiation requested from the other end,
1065 so
1066 .B no
1067 will be largely ineffective unless both ends agree on it. Also see
1068 .BR reauth .
1069 .TP
1070 .BR rekeyfuzz " = " 100% " | <percentage>"
1071 maximum percentage by which
1072 .BR marginbytes ,
1073 .B marginpackets
1074 and
1075 .B margintime
1076 should be randomly increased to randomize rekeying intervals
1077 (important for hosts with many connections);
1078 acceptable values are an integer,
1079 which may exceed 100,
1080 followed by a `%'
1081 (defaults to
1082 .BR 100% ).
1083 The value of
1084 .BR marginTYPE ,
1085 after this random increase,
1086 must not exceed
1087 .B lifeTYPE
1088 (where TYPE is one of
1089 .IR bytes ,
1090 .I packets
1091 or
1092 .IR time ).
1093 The value
1094 .B 0%
1095 will suppress randomization.
1096 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
1097 below.
1098 .TP
1099 .B rekeymargin
1100 synonym for
1101 .BR margintime .
1102 .TP
1103 .BR replay_window " = " \-1 " | <number>"
1104 The IPsec replay window size for this connection. With the default of \-1
1105 the value configured with
1106 .I charon.replay_window
1107 in
1108 .BR strongswan.conf (5)
1109 is used. Larger values than 32 are supported using the Netlink backend only,
1110 a value of 0 disables IPsec replay protection.
1111 .TP
1112 .BR reqid " = <number>"
1113 sets the reqid for a given connection to a pre-configured fixed value.
1114 .TP
1115 .BR tfc " = <value>"
1116 number of bytes to pad ESP payload data to. Traffic Flow Confidentiality
1117 is currently supported in IKEv2 and applies to outgoing packets only. The
1118 special value
1119 .BR %mtu
1120 fills up ESP packets with padding to have the size of the MTU.
1121 .TP
1122 .BR type " = " tunnel " | transport | transport_proxy | passthrough | drop"
1123 the type of the connection; currently the accepted values
1124 are
1125 .B tunnel
1126 (the default)
1127 signifying a host-to-host, host-to-subnet, or subnet-to-subnet tunnel;
1128 .BR transport ,
1129 signifying host-to-host transport mode;
1130 .BR transport_proxy ,
1131 signifying the special Mobile IPv6 transport proxy mode;
1132 .BR passthrough ,
1133 signifying that no IPsec processing should be done at all;
1134 .BR drop ,
1135 signifying that packets should be discarded.
1136 .TP
1137 .BR xauth " = " client " | server"
1138 specifies the role in the XAuth protocol if activated by
1139 .B authby=xauthpsk
1140 or
1141 .B authby=xauthrsasig.
1142 Accepted values are
1143 .B server
1144 and
1145 .B client
1146 (the default).
1147 .TP
1148 .BR xauth_identity " = <id>"
1149 defines the identity/username the client uses to reply to an XAuth request.
1150 If not defined, the IKEv1 identity will be used as XAuth identity.
1151
1152 .SS "CONN PARAMETERS: IKEv2 MEDIATION EXTENSION"
1153 The following parameters are relevant to IKEv2 Mediation Extension
1154 operation only.
1155 .TP
1156 .BR mediation " = yes | " no
1157 whether this connection is a mediation connection, ie. whether this
1158 connection is used to mediate other connections.  Mediation connections
1159 create no child SA. Acceptable values are
1160 .B no
1161 (the default) and
1162 .BR yes .
1163 .TP
1164 .BR mediated_by " = <name>"
1165 the name of the connection to mediate this connection through.  If given,
1166 the connection will be mediated through the named mediation connection.
1167 The mediation connection must set
1168 .BR mediation=yes .
1169 .TP
1170 .BR me_peerid " = <id>"
1171 ID as which the peer is known to the mediation server, ie. which the other
1172 end of this connection uses as its
1173 .B leftid
1174 on its connection to the mediation server.  This is the ID we request the
1175 mediation server to mediate us with.  If
1176 .B me_peerid
1177 is not given, the
1178 .B rightid
1179 of this connection will be used as peer ID.
1180
1181 .SH "CA SECTIONS"
1182 These are optional sections that can be used to assign special
1183 parameters to a Certification Authority (CA). Because the daemons
1184 automatically import CA certificates from \fI/etc/ipsec.d/cacerts\fP,
1185 there is no need to explicitly add them with a CA section, unless you
1186 want to assign special parameters (like a CRL) to a CA.
1187 .TP
1188 .BR also " = <name>"
1189 includes ca section
1190 .BR <name> .
1191 .TP
1192 .BR auto " = " ignore " | add"
1193 currently can have either the value
1194 .B ignore
1195 (the default) or
1196 .BR add .
1197 .TP
1198 .BR cacert " = <path>"
1199 defines a path to the CA certificate either relative to
1200 \fI/etc/ipsec.d/cacerts\fP or as an absolute path.
1201 .br
1202 A value in the form
1203 .B %smartcard[<slot nr>[@<module>]]:<keyid>
1204 defines a specific CA certificate to load from a PKCS#11 backend for this CA.
1205 See ipsec.secrets(5) for details about smartcard definitions.
1206 .TP
1207 .BR crluri " = <uri>"
1208 defines a CRL distribution point (ldap, http, or file URI)
1209 .TP
1210 .B crluri1
1211 synonym for
1212 .B crluri.
1213 .TP
1214 .BR crluri2 " = <uri>"
1215 defines an alternative CRL distribution point (ldap, http, or file URI)
1216 .TP
1217 .TP
1218 .BR ocspuri " = <uri>"
1219 defines an OCSP URI.
1220 .TP
1221 .B ocspuri1
1222 synonym for
1223 .B ocspuri.
1224 .TP
1225 .BR ocspuri2 " = <uri>"
1226 defines an alternative OCSP URI.
1227 .TP
1228 .BR certuribase " = <uri>"
1229 defines the base URI for the Hash and URL feature supported by IKEv2.
1230 Instead of exchanging complete certificates, IKEv2 allows one to send an URI
1231 that resolves to the DER encoded certificate. The certificate URIs are built
1232 by appending the SHA1 hash of the DER encoded certificates to this base URI.
1233 .SH "CONFIG SECTIONS"
1234 At present, the only
1235 .B config
1236 section known to the IPsec software is the one named
1237 .BR setup ,
1238 which contains information used when the software is being started.
1239 The currently-accepted
1240 .I parameter
1241 names in a
1242 .B config
1243 .B setup
1244 section are:
1245 .TP
1246 .BR cachecrls " = yes | " no
1247 if enabled, certificate revocation lists (CRLs) fetched via HTTP or LDAP will
1248 be cached in
1249 .I /etc/ipsec.d/crls/
1250 under a unique file name derived from the certification authority's public key.
1251 .TP
1252 .BR charondebug " = <debug list>"
1253 how much charon debugging output should be logged.
1254 A comma separated list containing type/level-pairs may
1255 be specified, e.g:
1256 .B dmn 3, ike 1, net -1.
1257 Acceptable values for types are
1258 .B dmn, mgr, ike, chd, job, cfg, knl, net, asn, enc, lib, esp, tls,
1259 .B tnc, imc, imv, pts
1260 and the level is one of
1261 .B -1, 0, 1, 2, 3, 4
1262 (for silent, audit, control, controlmore, raw, private).  By default, the level
1263 is set to
1264 .B 1
1265 for all types.  For more flexibility see LOGGER CONFIGURATION in
1266 .IR strongswan.conf (5).
1267 .TP
1268 .BR strictcrlpolicy " = yes | ifuri | " no
1269 defines if a fresh CRL must be available in order for the peer authentication
1270 based on RSA signatures to succeed.
1271 IKEv2 additionally recognizes
1272 .B ifuri
1273 which reverts to
1274 .B yes
1275 if at least one CRL URI is defined and to
1276 .B no
1277 if no URI is known.
1278 .TP
1279 .BR uniqueids " = " yes " | no | never | replace | keep"
1280 whether a particular participant ID should be kept unique,
1281 with any new IKE_SA using an ID deemed to replace all old ones using that ID;
1282 acceptable values are
1283 .B yes
1284 (the default),
1285 .B no
1286 and
1287 .BR never .
1288 Participant IDs normally \fIare\fR unique, so a new IKE_SA using the same ID is
1289 almost invariably intended to replace an old one. The difference between
1290 .B no
1291 and
1292 .B never
1293 is that the daemon will replace old IKE_SAs when receiving an INITIAL_CONTACT
1294 notify if the option is
1295 .B no
1296 but will ignore these notifies if
1297 .B never
1298 is configured.
1299 The daemon also accepts the value
1300 .B replace
1301 which is identical to
1302 .B yes
1303 and the value
1304 .B keep
1305 to reject new IKE_SA setups and keep the duplicate established earlier.
1306
1307 .SH IDENTITY PARSING
1308 The type and binary encoding of identity strings specified in \fIleftid\fR
1309 are detected as follows:
1310 .IP \[bu]
1311 If the string value contains an equal sign (=) it is assumed to be a
1312 Distinguished Name, with RDNs separated by commas (,) \fIor\fR slashes (/ - the string
1313 must start with a slash to use this syntax). An attempt is made to create a
1314 binary ASN.1 encoding from this string. If that fails the type is set to KEY_ID
1315 with the literal string value adopted as encoding.
1316 .IP \[bu]
1317 If the string value contains an @ the type depends on the position of that
1318 character:
1319 .RS
1320 .IP \[bu]
1321 If the string begins with @# the type is set to KEY_ID and the string following
1322 that prefix is assumed to be the hex-encoded binary value of the identity.
1323 .IP \[bu]
1324 If the string begins with @@ the type is set to USER_FQDN and the encoding is
1325 the literal string after that prefix.
1326 .IP \[bu]
1327 If the string begins with @ the type is set to FQDN and the encoding is the
1328 literal string after that prefix.
1329 .IP \[bu]
1330 All remaining strings containing an @ are assumed to be of type USER_FQDN/RFC822
1331 with the literal string value as encoding.
1332 .RE
1333 .IP \[bu]
1334 If the value does not contain any @ or = characters it is parsed as follows:
1335 .RS
1336 .IP \[bu]
1337 If the value is an empty string, or equals %any[6], 0.0.0.0, ::, or * the
1338 type is set to ID_ANY, which matches any other identity.
1339 .IP \[bu]
1340 If the value contains a colon (:) it is assumed to be an IPv6 address. But if
1341 parsing the address and converting it to its binary encoding fails the type is
1342 set to KEY_ID and the encoding is the literal value.
1343 .IP \[bu]
1344 For all other strings an attempt at parsing them as IPv4 addresses is made. If
1345 that fails the type is set to FQDN and the literal value is adopted as
1346 encoding (this is where domain names and simple names end up).
1347 .RE
1348
1349 .SH SA EXPIRY/REKEY
1350 The IKE SAs and IPsec SAs negotiated by the daemon can be configured to expire
1351 after a specific amount of time. For IPsec SAs this can also happen after a
1352 specified number of transmitted packets or transmitted bytes. The following
1353 settings can be used to configure this:
1354 .TS
1355 l r l r,- - - -,lB s lB s,a r a r.
1356 Setting Default Setting Default
1357 IKE SA  IPsec SA
1358 ikelifetime     3h      lifebytes       -
1359                 lifepackets     -
1360                 lifetime        1h
1361 .TE
1362 .SS Rekeying
1363 IKE SAs as well as IPsec SAs can be rekeyed before they expire. This can be
1364 configured using the following settings:
1365 .TS
1366 l r l r,- - - -,lB s lB s,a r a r.
1367 Setting Default Setting Default
1368 IKE and IPsec SA        IPsec SA
1369 margintime      9m      marginbytes     -
1370                 marginpackets   -
1371 .TE
1372 .SS Randomization
1373 To avoid collisions the specified margins are increased randomly before
1374 subtracting them from the expiration limits (see formula below). This is
1375 controlled by the
1376 .B rekeyfuzz
1377 setting:
1378 .TS
1379 l r,- -,lB s,a r.
1380 Setting Default
1381 IKE and IPsec SA
1382 rekeyfuzz       100%
1383 .TE
1384 .PP
1385 Randomization can be disabled by setting
1386 .BR rekeyfuzz " to " 0% .
1387 .SS Formula
1388 The following formula is used to calculate the rekey time of IPsec SAs:
1389 .PP
1390 .EX
1391  rekeytime = lifetime - (margintime + random(0, margintime * rekeyfuzz))
1392 .EE
1393 .PP
1394 It applies equally to IKE SAs and byte and packet limits for IPsec SAs.
1395 .SS Example
1396 Let's consider the default configuration:
1397 .PP
1398 .EX
1399         lifetime = 1h
1400         margintime = 9m
1401         rekeyfuzz = 100%
1402 .EE
1403 .PP
1404 From the formula above follows that the rekey time lies between:
1405 .PP
1406 .EX
1407         rekeytime_min = 1h - (9m + 9m) = 42m
1408         rekeytime_max = 1h - (9m + 0m) = 51m
1409 .EE
1410 .PP
1411 Thus, the daemon will attempt to rekey the IPsec SA at a random time
1412 between 42 and 51 minutes after establishing the SA. Or, in other words,
1413 between 9 and 18 minutes before the SA expires.
1414 .SS Notes
1415 .IP \[bu]
1416 Since the rekeying of an SA needs some time, the margin values must not be
1417 too low.
1418 .IP \[bu]
1419 The value
1420 .B margin... + margin... * rekeyfuzz
1421 must not exceed the original limit. For example, specifying
1422 .B margintime = 30m
1423 in the default configuration is a bad idea as there is a chance that the rekey
1424 time equals zero and, thus, rekeying gets disabled.
1425
1426 .SH FILES
1427 .nf
1428 /etc/ipsec.conf
1429 /etc/ipsec.d/aacerts
1430 /etc/ipsec.d/acerts
1431 /etc/ipsec.d/cacerts
1432 /etc/ipsec.d/certs
1433 /etc/ipsec.d/crls
1434
1435 .SH SEE ALSO
1436 strongswan.conf(5), ipsec.secrets(5), ipsec(8)
1437 .SH HISTORY
1438 Originally written for the FreeS/WAN project by Henry Spencer.
1439 Updated and extended for the strongSwan project <http://www.strongswan.org> by
1440 Tobias Brunner, Andreas Steffen and Martin Willi.