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