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