Added notes about expiry and rekey to ipsec.conf(5) man page.
[strongswan.git] / man / ipsec.conf.5.in
1 .TH IPSEC.CONF 5 "2010-10-19" "@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 currently uses two separate keying daemons. \fIpluto\fP handles
176 all IKEv1 connections, \fIcharon\fP is the daemon handling the IKEv2
177 protocol.
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 14
231 .B aaa_identity
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 .B ah
237 AH authentication algorithm to be used
238 for the connection, e.g.
239 .B hmac-md5.
240 .TP
241 .B auth
242 whether authentication should be done as part of
243 ESP encryption, or separately using the AH protocol;
244 acceptable values are
245 .B esp
246 (the default) and
247 .BR ah .
248 .br
249 The IKEv2 daemon currently supports ESP only.
250 .TP
251 .B authby
252 how the two security gateways should authenticate each other;
253 acceptable values are
254 .B secret
255 or
256 .B psk
257 for pre-shared secrets,
258 .B pubkey
259 (the default) for public key signatures as well as the synonyms
260 .B rsasig
261 for RSA digital signatures and
262 .B ecdsasig
263 for Elliptic Curve DSA signatures.
264 .B never
265 can be used if negotiation is never to be attempted or accepted (useful for
266 shunt-only conns).
267 Digital signatures are superior in every way to shared secrets.
268 IKEv1 additionally supports the values
269 .B xauthpsk
270 and
271 .B xauthrsasig
272 that will enable eXtended AUTHentication (XAUTH) in addition to IKEv1 main mode
273 based on shared secrets  or digital RSA signatures, respectively.
274 IKEv2 additionally supports the value
275 .BR eap ,
276 which indicates an initiator to request EAP authentication. The EAP method
277 to use is selected by the server (see
278 .BR eap ).
279 This parameter is deprecated for IKEv2 connections, as two peers do not need
280 to agree on an authentication method. Use the
281 .B leftauth
282 parameter instead to define authentication methods in IKEv2.
283 .TP
284 .B auto
285 what operation, if any, should be done automatically at IPsec startup;
286 currently-accepted values are
287 .BR add ,
288 .BR route ,
289 .B start
290 and
291 .B ignore
292 (the default).
293 .B add
294 loads a connection without starting it.
295 .B route
296 loads a connection and installs kernel traps. If traffic is detected between
297 .B leftsubnet
298 and
299 .B rightsubnet
300 , a connection is established.
301 .B start
302 loads a connection and brings it up immediatly.
303 .B ignore
304 ignores the connection. This is equal to delete a connection from the config
305 file.
306 Relevant only locally, other end need not agree on it
307 (but in general, for an intended-to-be-permanent connection,
308 both ends should use
309 .B auto=start
310 to ensure that any reboot causes immediate renegotiation).
311 .TP
312 .B compress
313 whether IPComp compression of content is proposed on the connection
314 (link-level compression does not work on encrypted data,
315 so to be effective, compression must be done \fIbefore\fR encryption);
316 acceptable values are
317 .B yes
318 and
319 .B no
320 (the default). A value of
321 .B yes
322 causes IPsec to propose both compressed and uncompressed,
323 and prefer compressed.
324 A value of
325 .B no
326 prevents IPsec from proposing compression;
327 a proposal to compress will still be accepted.
328 .TP
329 .B dpdaction
330 controls the use of the Dead Peer Detection protocol (DPD, RFC 3706) where
331 R_U_THERE notification messages (IKEv1) or empty INFORMATIONAL messages (IKEv2)
332 are periodically sent in order to check the
333 liveliness of the IPsec peer. The values
334 .BR clear ,
335 .BR hold ,
336 and
337 .B restart
338 all activate DPD. If no activity is detected, all connections with a dead peer
339 are stopped and unrouted
340 .RB ( clear ),
341 put in the hold state
342 .RB ( hold )
343 or restarted
344 .RB ( restart ).
345 For IKEv1, the default is
346 .B none
347 which disables the active sending of R_U_THERE notifications.
348 Nevertheless pluto will always send the DPD Vendor ID during connection set up
349 in order to signal the readiness to act passively as a responder if the peer
350 wants to use DPD. For IKEv2,
351 .B none
352 does't make sense, since all messages are used to detect dead peers. If specified,
353 it has the same meaning as the default
354 .RB ( clear ).
355 .TP
356 .B dpddelay
357 defines the period time interval with which R_U_THERE messages/INFORMATIONAL
358 exchanges are sent to the peer. These are only sent if no other traffic is
359 received. In IKEv2, a value of 0 sends no additional INFORMATIONAL
360 messages and uses only standard messages (such as those to rekey) to detect
361 dead peers.
362 .TP
363 .B dpdtimeout
364 defines the timeout interval, after which all connections to a peer are deleted
365 in case of inactivity. This only applies to IKEv1, in IKEv2 the default
366 retransmission timeout applies, as every exchange is used to detect dead peers.
367 .TP
368 .B inactivity
369 defines the timeout interval, after which a CHILD_SA is closed if it did
370 not send or receive any traffic. Currently supported in IKEv2 connections only.
371 .TP
372 .B eap
373 defines the EAP type to propose as server if the client requests EAP
374 authentication. Currently supported values are
375 .B aka
376 for EAP-AKA,
377 .B gtc
378 for EAP-GTC,
379 .B md5
380 for EAP-MD5,
381 .B mschapv2
382 for EAP-MS-CHAPv2,
383 .B radius
384 for the EAP-RADIUS proxy and
385 .B sim
386 for EAP-SIM. Additionally, IANA assigned EAP method numbers are accepted, or a
387 definition in the form
388 .B eap=type-vendor
389 (e.g. eap=7-12345) can be used to specify vendor specific EAP types.
390 This parameter is deprecated in the favour of
391 .B leftauth.
392
393 To forward EAP authentication to a RADIUS server using the EAP-RADIUS plugin,
394 set
395 .BR eap=radius .
396 .TP
397 .B eap_identity
398 defines the identity the client uses to reply to a EAP Identity request.
399 If defined on the EAP server, the defined identity will be used as peer
400 identity during EAP authentication. The special value
401 .B %identity
402 uses the EAP Identity method to ask the client for an EAP identity. If not
403 defined, the IKEv2 identity will be used as EAP identity.
404 .TP
405 .B esp
406 comma-separated list of ESP encryption/authentication algorithms to be used
407 for the connection, e.g.
408 .BR 3des-md5 .
409 The notation is
410 .BR encryption-integrity-[dh-group] .
411 .br
412 If
413 .B dh-group
414 is specified, CHILD_SA setup and rekeying include a separate diffe hellman
415 exchange (IKEv2 only).
416 .TP
417 .B forceencaps
418 Force UDP encapsulation for ESP packets even if no NAT situation is detected.
419 This may help to surmount restrictive firewalls. In order to force the peer to
420 encapsulate packets, NAT detection payloads are faked (IKEv2 only).
421 .TP
422 .B ike
423 comma-separated list of IKE/ISAKMP SA encryption/authentication algorithms
424 to be used, e.g.
425 .BR aes128-sha1-modp2048 .
426 The notation is
427 .BR encryption-integrity-dhgroup .
428 In IKEv2, multiple algorithms and proposals may be included, such as
429 .B aes128-aes256-sha1-modp1536-modp2048,3des-sha1-md5-modp1024.
430 .TP
431 .B ikelifetime
432 how long the keying channel of a connection (ISAKMP or IKE SA)
433 should last before being renegotiated. Also see EXPIRY/REKEY below.
434 .TP
435 .B installpolicy
436 decides whether IPsec policies are installed in the kernel by the IKEv2
437 charon daemon for a given connection. Allows peaceful cooperation e.g. with
438 the Mobile IPv6 daemon mip6d who wants to control the kernel policies.
439 Acceptable values are
440 .B yes
441 (the default) and
442 .BR no .
443 .TP
444 .B keyexchange
445 method of key exchange;
446 which protocol should be used to initialize the connection. Connections marked with
447 .B ikev1
448 are initiated with pluto, those marked with
449 .B ikev2
450 with charon. An incoming request from the remote peer is handled by the correct
451 daemon, unaffected from the
452 .B keyexchange
453 setting. Starting with strongSwan 4.5 the default value
454 .B ike
455 is a synonym for
456 .BR ikev2 ,
457 whereas in older strongSwan releases
458 .B ikev1
459 was assumed.
460 .TP
461 .B keyingtries
462 how many attempts (a whole number or \fB%forever\fP) should be made to
463 negotiate a connection, or a replacement for one, before giving up
464 (default
465 .BR %forever ).
466 The value \fB%forever\fP
467 means 'never give up'.
468 Relevant only locally, other end need not agree on it.
469 .TP
470 .B keylife
471 synonym for
472 .BR lifetime .
473 .TP
474 .B left
475 (required)
476 the IP address of the left participant's public-network interface
477 or one of several magic values.
478 If it is
479 .BR %defaultroute ,
480 .B left
481 will be filled in automatically with the local address
482 of the default-route interface (as determined at IPsec startup time and
483 during configuration update).
484 Either
485 .B left
486 or
487 .B right
488 may be
489 .BR %defaultroute ,
490 but not both.
491 The prefix
492 .B  %
493 in front of a fully-qualified domain name or an IP address will implicitly set
494 .B leftallowany=yes.
495 If the domain name cannot be resolved into an IP address at IPsec startup or
496 update time then
497 .B left=%any
498 and
499 .B leftallowany=no
500 will be assumed.
501
502 In case of an IKEv2 connection, the value
503 .B %any
504 for the local endpoint signifies an address to be filled in (by automatic
505 keying) during negotiation. If the local peer initiates the connection setup
506 the routing table will be queried to determine the correct local IP address.
507 In case the local peer is responding to a connection setup then any IP address
508 that is assigned to a local interface will be accepted.
509 .br
510 Note that specifying
511 .B %any
512 for the local endpoint is not supported by the IKEv1 pluto daemon.
513
514 If
515 .B %any
516 is used for the remote endpoint it literally means any IP address.
517
518 Please note that with the usage of wildcards multiple connection descriptions
519 might match a given incoming connection attempt. The most specific description
520 is used in that case.
521 .TP
522 .B leftallowany
523 a modifier for
524 .B left
525 , making it behave as
526 .B %any
527 although a concrete IP address has been assigned.
528 Recommended for dynamic IP addresses that can be resolved by DynDNS at IPsec
529 startup or update time.
530 Acceptable values are
531 .B yes
532 and
533 .B no
534 (the default).
535 .TP
536 .B leftauth
537 Authentication method to use locally (left) or require from the remote (right)
538 side.
539 This parameter is supported in IKEv2 only. Acceptable values are
540 .B pubkey
541 for public key authentication (RSA/ECDSA),
542 .B psk
543 for pre-shared key authentication and
544 .B eap
545 to (require the) use of the Extensible Authentication Protocol. In the case
546 of
547 .B eap,
548 an optional EAP method can be appended. Currently defined methods are
549 .BR eap-aka ,
550 .BR eap-gtc ,
551 .BR eap-md5 ,
552 .BR eap-tls ,
553 .B eap-mschapv2
554 and
555 .BR eap-sim .
556 Alternatively, IANA assigned EAP method numbers are accepted. Vendor specific
557 EAP methods are defined in the form
558 .B eap-type-vendor
559 .RB "(e.g. " eap-7-12345 ).
560 .TP
561 .B leftauth2
562 Same as
563 .BR leftauth ,
564 but defines an additional authentication exchange. IKEv2 supports multiple
565 authentication rounds using "Multiple Authentication Exchanges" defined
566 in RFC4739. This allows, for example, separated authentication
567 of host and user (IKEv2 only).
568 .TP
569 .B leftca
570 the distinguished name of a certificate authority which is required to
571 lie in the trust path going from the left participant's certificate up
572 to the root certification authority.
573 .TP
574 .B leftca2
575 Same as
576 .B leftca,
577 but for the second authentication round (IKEv2 only).
578 .TP
579 .B leftcert
580 the path to the left participant's X.509 certificate. The file can be encoded
581 either in PEM or DER format. OpenPGP certificates are supported as well.
582 Both absolute paths or paths relative to \fI/etc/ipsec.d/certs\fP
583 are accepted. By default
584 .B leftcert
585 sets
586 .B leftid
587 to the distinguished name of the certificate's subject and
588 .B leftca
589 to the distinguished name of the certificate's issuer.
590 The left participant's ID can be overriden by specifying a
591 .B leftid
592 value which must be certified by the certificate, though.
593 .TP
594 .B leftcert2
595 Same as
596 .B leftcert,
597 but for the second authentication round (IKEv2 only).
598 .TP
599 .B leftfirewall
600 whether the left participant is doing forwarding-firewalling
601 (including masquerading) using iptables for traffic from \fIleftsubnet\fR,
602 which should be turned off (for traffic to the other subnet)
603 once the connection is established;
604 acceptable values are
605 .B yes
606 and
607 .B no
608 (the default).
609 May not be used in the same connection description with
610 .BR leftupdown .
611 Implemented as a parameter to the default \fBipsec _updown\fR script.
612 See notes below.
613 Relevant only locally, other end need not agree on it.
614
615 If one or both security gateways are doing forwarding firewalling
616 (possibly including masquerading),
617 and this is specified using the firewall parameters,
618 tunnels established with IPsec are exempted from it
619 so that packets can flow unchanged through the tunnels.
620 (This means that all subnets connected in this manner must have
621 distinct, non-overlapping subnet address blocks.)
622 This is done by the default \fBipsec _updown\fR script (see
623 .IR pluto (8)).
624
625 In situations calling for more control,
626 it may be preferable for the user to supply his own
627 .I updown
628 script,
629 which makes the appropriate adjustments for his system.
630 .TP
631 .B leftgroups
632 a comma separated list of group names. If the
633 .B leftgroups
634 parameter is present then the peer must be a member of at least one
635 of the groups defined by the parameter. Group membership must be certified
636 by a valid attribute certificate stored in \fI/etc/ipsec.d/acerts/\fP thas has
637 been issued to the peer by a trusted Authorization Authority stored in
638 \fI/etc/ipsec.d/aacerts/\fP.
639 .br
640 Attribute certificates are not supported in IKEv2 yet.
641 .TP
642 .B lefthostaccess
643 inserts a pair of INPUT and OUTPUT iptables rules using the default
644 \fBipsec _updown\fR script, thus allowing access to the host itself
645 in the case where the host's internal interface is part of the
646 negotiated client subnet.
647 Acceptable values are
648 .B yes
649 and
650 .B no
651 (the default).
652 .TP
653 .B leftid
654 how the left participant should be identified for authentication;
655 defaults to
656 .BR left .
657 Can be an IP address or a fully-qualified domain name preceded by
658 .B @
659 (which is used as a literal string and not resolved).
660 .TP
661 .B leftid2
662 identity to use for a second authentication for the left participant
663 (IKEv2 only); defaults to
664 .BR leftid .
665 .TP
666 .B leftikeport
667 UDP port the left participant uses for IKE communication. Currently supported in
668 IKEv2 connections only. 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 .B leftnexthop
674 this parameter is usually not needed any more because the NETKEY IPsec stack
675 does not require explicit routing entries for the traffic to be tunneled. If
676 .B leftsourceip
677 is used with IKEv1 then
678 .B leftnexthop
679 must still be set in order for the source routes to work properly.
680 .TP
681 .B leftprotoport
682 restrict the traffic selector to a single protocol and/or port.
683 Examples:
684 .B leftprotoport=tcp/http
685 or
686 .B leftprotoport=6/80
687 or
688 .B leftprotoport=udp
689 .TP
690 .B leftrsasigkey
691 the left participant's
692 public key for RSA signature authentication,
693 in RFC 2537 format using
694 .IR ttodata (3)
695 encoding.
696 The magic value
697 .B %none
698 means the same as not specifying a value (useful to override a default).
699 The value
700 .B %cert
701 (the default)
702 means that the key is extracted from a certificate.
703 The identity used for the left participant
704 must be a specific host, not
705 .B %any
706 or another magic value.
707 .B Caution:
708 if two connection descriptions
709 specify different public keys for the same
710 .BR leftid ,
711 confusion and madness will ensue.
712 .TP
713 .B leftsendcert
714 Accepted values are
715 .B never
716 or
717 .BR no ,
718 .B always
719 or
720 .BR yes ,
721 and
722 .BR ifasked ,
723 the latter meaning that the peer must send a certificate request payload in
724 order to get a certificate in return.
725 .TP
726 .B leftsourceip
727 The internal source IP to use in a tunnel, also known as virtual IP. If the
728 value is one of the synonyms
729 .BR %modeconfig ,
730 .BR %modecfg ,
731 .BR %config ,
732 or
733 .BR %cfg ,
734 an address is requested from the peer. In IKEv2, a statically defined address
735 is also requested, since the server may change it.
736 .TP
737 .B rightsourceip
738 The internal source IP to use in a tunnel for the remote peer. If the
739 value is
740 .B %config
741 on the responder side, the initiator must propose an address which is then
742 echoed back. Also supported are address pools expressed as
743 \fInetwork\fB/\fInetmask\fR
744 or the use of an external IP address pool using %\fIpoolname\fR,
745 where \fIpoolname\fR is the name of the IP address pool used for the lookup.
746 .TP
747 .B leftsubnet
748 private subnet behind the left participant, expressed as
749 \fInetwork\fB/\fInetmask\fR;
750 if omitted, essentially assumed to be \fIleft\fB/32\fR,
751 signifying that the left end of the connection goes to the left participant
752 only. When using IKEv2, the configured subnet of the peers may differ, the
753 protocol narrows it to the greatest common subnet. Further, IKEv2 supports
754 multiple subnets separated by commas. IKEv1 only interprets the first subnet
755 of such a definition.
756 .TP
757 .B leftsubnetwithin
758 the peer can propose any subnet or single IP address that fits within the
759 range defined by
760 .BR leftsubnetwithin.
761 Not relevant for IKEv2, as subnets are narrowed.
762 .TP
763 .B leftupdown
764 what ``updown'' script to run to adjust routing and/or firewalling
765 when the status of the connection
766 changes (default
767 .BR "ipsec _updown" ).
768 May include positional parameters separated by white space
769 (although this requires enclosing the whole string in quotes);
770 including shell metacharacters is unwise.
771 See
772 .IR pluto (8)
773 for details.
774 Relevant only locally, other end need not agree on it. IKEv2 uses the updown
775 script to insert firewall rules only, since routing has been implemented
776 directly into charon.
777 .TP
778 .B lifebytes
779 the number of bytes transmitted over an IPsec SA before it expires (IKEv2
780 only).
781 .TP
782 .B lifepackets
783 the number of packets transmitted over an IPsec SA before it expires (IKEv2
784 only).
785 .TP
786 .B lifetime
787 how long a particular instance of a connection
788 (a set of encryption/authentication keys for user packets) should last,
789 from successful negotiation to expiry;
790 acceptable values are an integer optionally followed by
791 .BR s
792 (a time in seconds)
793 or a decimal number followed by
794 .BR m ,
795 .BR h ,
796 or
797 .B d
798 (a time
799 in minutes, hours, or days respectively)
800 (default
801 .BR 1h ,
802 maximum
803 .BR 24h ).
804 Normally, the connection is renegotiated (via the keying channel)
805 before it expires (see
806 .BR margintime ).
807 The two ends need not exactly agree on
808 .BR lifetime ,
809 although if they do not,
810 there will be some clutter of superseded connections on the end
811 which thinks the lifetime is longer. Also see EXPIRY/REKEY below.
812 .TP
813 .B marginbytes
814 how many bytes before IPsec SA expiry (see
815 .BR lifebytes )
816 should attempts to negotiate a replacement begin (IKEv2 only).
817 .TP
818 .B marginpackets
819 how many packets before IPsec SA expiry (see
820 .BR lifepackets )
821 should attempts to negotiate a replacement begin (IKEv2 only).
822 .TP
823 .B margintime
824 how long before connection expiry or keying-channel expiry
825 should attempts to
826 negotiate a replacement
827 begin; acceptable values as for
828 .B lifetime
829 (default
830 .BR 9m ).
831 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
832 below.
833 .TP
834 .B mark
835 sets an XFRM mark of the form <value>[/<mask>] in the inbound and outbound
836 IPsec SAs and policies. If the mask is missing then a default
837 mask of
838 .B 0xffffffff
839 is assumed.
840 .TP
841 .B mark_in
842 sets an XFRM mark of the form <value>[/<mask>] in the inbound IPsec SA and
843 policy. If the mask is missing then a default mask of
844 .B 0xffffffff
845 is assumed.
846 .TP
847 .B mark_out
848 sets an XFRM mark of the form <value>[/<mask>] in the outbound IPsec SA and
849 policy. If the mask is missing then a default mask of
850 .B 0xffffffff
851 is assumed.
852 .TP
853 .B mobike
854 enables the IKEv2 MOBIKE protocol defined by RFC 4555. Accepted values are
855 .B yes
856 (the default) and
857 .BR no .
858 If set to
859 .BR no ,
860 the IKEv2 charon daemon will not actively propose MOBIKE as initiator and
861 ignore the MOBIKE_SUPPORTED notify as responder.
862 .TP
863 .B modeconfig
864 defines which mode is used to assign a virtual IP.
865 Accepted values are
866 .B push
867 and
868 .B pull
869 (the default).
870 Currently relevant for IKEv1 only since IKEv2 always uses the configuration
871 payload in pull mode. Cisco VPN gateways usually operate in
872 .B push
873 mode.
874 .TP
875 .B pfs
876 whether Perfect Forward Secrecy of keys is desired on the connection's
877 keying channel
878 (with PFS, penetration of the key-exchange protocol
879 does not compromise keys negotiated earlier);
880 acceptable values are
881 .B yes
882 (the default)
883 and
884 .BR no.
885 IKEv2 always uses PFS for IKE_SA rekeying whereas for CHILD_SA rekeying
886 PFS is enforced by defining a Diffie-Hellman modp group in the
887 .B esp
888 parameter.
889 .TP
890 .B pfsgroup
891 defines a Diffie-Hellman group for perfect forward secrecy in IKEv1 Quick Mode
892 differing from the DH group used for IKEv1 Main Mode (IKEv1 only).
893 .TP
894 .B reauth
895 whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1,
896 reauthentication is always done. In IKEv2, a value of
897 .B no
898 rekeys without uninstalling the IPsec SAs, a value of
899 .B yes
900 (the default) creates a new IKE_SA from scratch and tries to recreate
901 all IPsec SAs.
902 .TP
903 .B rekey
904 whether a connection should be renegotiated when it is about to expire;
905 acceptable values are
906 .B yes
907 (the default)
908 and
909 .BR no .
910 The two ends need not agree, but while a value of
911 .B no
912 prevents pluto/charon from requesting renegotiation,
913 it does not prevent responding to renegotiation requested from the other end,
914 so
915 .B no
916 will be largely ineffective unless both ends agree on it.
917 .TP
918 .B rekeyfuzz
919 maximum percentage by which
920 .BR marginbytes ,
921 .B marginpackets
922 and
923 .B margintime
924 should be randomly increased to randomize rekeying intervals
925 (important for hosts with many connections);
926 acceptable values are an integer,
927 which may exceed 100,
928 followed by a `%'
929 (defaults to
930 .BR 100% ).
931 The value of
932 .BR marginTYPE ,
933 after this random increase,
934 must not exceed
935 .B lifeTYPE
936 (where TYPE is one of
937 .IR bytes ,
938 .I packets
939 or
940 .IR time ).
941 The value
942 .B 0%
943 will suppress randomization.
944 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
945 below.
946 .TP
947 .B rekeymargin
948 synonym for
949 .BR margintime .
950 .TP
951 .B reqid
952 sets the reqid for a given connection to a pre-configured fixed value.
953 .TP
954 .B type
955 the type of the connection; currently the accepted values
956 are
957 .B tunnel
958 (the default)
959 signifying a host-to-host, host-to-subnet, or subnet-to-subnet tunnel;
960 .BR transport ,
961 signifying host-to-host transport mode;
962 .BR transport_proxy ,
963 signifying the special Mobile IPv6 transport proxy mode;
964 .BR passthrough ,
965 signifying that no IPsec processing should be done at all;
966 .BR drop ,
967 signifying that packets should be discarded; and
968 .BR reject ,
969 signifying that packets should be discarded and a diagnostic ICMP returned.
970 The IKEv2 daemon charon currently supports
971 .BR tunnel ,
972 .BR transport ,
973 and
974 .BR tunnel_proxy
975 connection types, only.
976 .TP
977 .B xauth
978 specifies the role in the XAUTH protocol if activated by
979 .B authby=xauthpsk
980 or
981 .B authby=xauthrsasig.
982 Accepted values are
983 .B server
984 and
985 .B client
986 (the default).
987
988 .SS "CONN PARAMETERS: IKEv2 MEDIATION EXTENSION"
989 The following parameters are relevant to IKEv2 Mediation Extension
990 operation only.
991 .TP 14
992 .B mediation
993 whether this connection is a mediation connection, ie. whether this
994 connection is used to mediate other connections.  Mediation connections
995 create no child SA. Acceptable values are
996 .B no
997 (the default) and
998 .BR yes .
999 .TP
1000 .B mediated_by
1001 the name of the connection to mediate this connection through.  If given,
1002 the connection will be mediated through the named mediation connection.
1003 The mediation connection must set
1004 .BR mediation=yes .
1005 .TP
1006 .B me_peerid
1007 ID as which the peer is known to the mediation server, ie. which the other
1008 end of this connection uses as its
1009 .B leftid
1010 on its connection to the mediation server.  This is the ID we request the
1011 mediation server to mediate us with.  If
1012 .B me_peerid
1013 is not given, the
1014 .B rightid
1015 of this connection will be used as peer ID.
1016
1017 .SH "CA SECTIONS"
1018 This are optional sections that can be used to assign special
1019 parameters to a Certification Authority (CA).
1020 .TP 10
1021 .B auto
1022 currently can have either the value
1023 .B ignore
1024 or
1025 .B add
1026 .
1027 .TP
1028 .B cacert
1029 defines a path to the CA certificate either relative to
1030 \fI/etc/ipsec.d/cacerts\fP or as an absolute path.
1031 .TP
1032 .B crluri
1033 defines a CRL distribution point (ldap, http, or file URI)
1034 .TP
1035 .B crluri1
1036 synonym for
1037 .B crluri.
1038 .TP
1039 .B crluri2
1040 defines an alternative CRL distribution point (ldap, http, or file URI)
1041 .TP
1042 .B ldaphost
1043 defines an ldap host. Currently used by IKEv1 only.
1044 .TP
1045 .B ocspuri
1046 defines an OCSP URI.
1047 .TP
1048 .B ocspuri1
1049 synonym for
1050 .B ocspuri.
1051 .TP
1052 .B ocspuri2
1053 defines an alternative OCSP URI. Currently used by IKEv2 only.
1054 .TP
1055 .B certuribase
1056 defines the base URI for the Hash and URL feature supported by IKEv2.
1057 Instead of exchanging complete certificates, IKEv2 allows to send an URI
1058 that resolves to the DER encoded certificate. The certificate URIs are built
1059 by appending the SHA1 hash of the DER encoded certificates to this base URI.
1060 .SH "CONFIG SECTIONS"
1061 At present, the only
1062 .B config
1063 section known to the IPsec software is the one named
1064 .BR setup ,
1065 which contains information used when the software is being started.
1066 Here's an example:
1067 .PP
1068 .ne 8
1069 .nf
1070 .ft B
1071 .ta 1c
1072 config setup
1073         plutodebug=all
1074         crlcheckinterval=10m
1075         strictcrlpolicy=yes
1076 .ft
1077 .fi
1078 .PP
1079 Parameters are optional unless marked ``(required)''.
1080 The currently-accepted
1081 .I parameter
1082 names in a
1083 .B config
1084 .B setup
1085 section affecting both daemons are:
1086 .TP 14
1087 .B cachecrls
1088 certificate revocation lists (CRLs) fetched via http or ldap will be cached in
1089 \fI/etc/ipsec.d/crls/\fR under a unique file name derived from the certification
1090 authority's public key.
1091 Accepted values are
1092 .B yes
1093 and
1094 .B no
1095 (the default).
1096 .TP
1097 .B charonstart
1098 whether to start the IKEv2 Charon daemon or not.
1099 Accepted values are
1100 .B yes
1101 or
1102 .BR no .
1103 The default is
1104 .B yes
1105 if starter was compiled with IKEv2 support.
1106 .TP
1107 .B dumpdir
1108 in what directory should things started by \fBipsec starter\fR
1109 (notably the Pluto and Charon daemons) be allowed to dump core?
1110 The empty value (the default) means they are not
1111 allowed to.
1112 This feature is currently not yet supported by \fBipsec starter\fR.
1113 .TP
1114 .B plutostart
1115 whether to start the IKEv1 Pluto daemon or not.
1116 Accepted values are
1117 .B yes
1118 or
1119 .BR no .
1120 The default is
1121 .B yes
1122 if starter was compiled with IKEv1 support.
1123 .TP
1124 .B strictcrlpolicy
1125 defines if a fresh CRL must be available in order for the peer authentication based
1126 on RSA signatures to succeed.
1127 Accepted values are
1128 .B yes
1129 and
1130 .B no
1131 (the default).
1132 IKEv2 additionally recognizes
1133 .B ifuri
1134 which reverts to
1135 .B yes
1136 if at least one CRL URI is defined and to
1137 .B no
1138 if no URI is known.
1139 .TP
1140 .B uniqueids
1141 whether a particular participant ID should be kept unique,
1142 with any new (automatically keyed)
1143 connection using an ID from a different IP address
1144 deemed to replace all old ones using that ID;
1145 acceptable values are
1146 .B yes
1147 (the default)
1148 and
1149 .BR no .
1150 Participant IDs normally \fIare\fR unique,
1151 so a new (automatically-keyed) connection using the same ID is
1152 almost invariably intended to replace an old one.
1153 The IKEv2 daemon also accepts the value
1154 .B replace
1155 wich is identical to
1156 .B yes
1157 and the value
1158 .B keep
1159 to reject new IKE_SA setups and keep the duplicate established earlier.
1160 .PP
1161 The following
1162 .B config section
1163 parameters are used by the IKEv1 Pluto daemon only:
1164 .TP
1165 .B crlcheckinterval
1166 interval in seconds. CRL fetching is enabled if the value is greater than zero.
1167 Asynchronous, periodic checking for fresh CRLs is currently done by the
1168 IKEv1 Pluto daemon only.
1169 .TP
1170 .B keep_alive
1171 interval in seconds between NAT keep alive packets, the default being 20 seconds.
1172 .TP
1173 .B nat_traversal
1174 activates NAT traversal by accepting source ISAKMP ports different from udp/500 and
1175 being able of floating to udp/4500 if a NAT situation is detected.
1176 Accepted values are
1177 .B yes
1178 and
1179 .B no
1180 (the default).
1181 Used by IKEv1 only, NAT traversal always being active in IKEv2.
1182 .TP
1183 .B nocrsend
1184 no certificate request payloads will be sent.
1185 Accepted values are
1186 .B yes
1187 and
1188 .B no
1189 (the default).
1190 .TP
1191 .B pkcs11initargs
1192 non-standard argument string for PKCS#11 C_Initialize() function;
1193 required by NSS softoken.
1194 .TP
1195 .B pkcs11module
1196 defines the path to a dynamically loadable PKCS #11 library.
1197 .TP
1198 .B pkcs11keepstate
1199 PKCS #11 login sessions will be kept during the whole lifetime of the keying
1200 daemon. Useful with pin-pad smart card readers.
1201 Accepted values are
1202 .B yes
1203 and
1204 .B no
1205 (the default).
1206 .TP
1207 .B pkcs11proxy
1208 Pluto will act as a PKCS #11 proxy accessible via the whack interface.
1209 Accepted values are
1210 .B yes
1211 and
1212 .B no
1213 (the default).
1214 .TP
1215 .B plutodebug
1216 how much Pluto debugging output should be logged.
1217 An empty value,
1218 or the magic value
1219 .BR none ,
1220 means no debugging output (the default).
1221 The magic value
1222 .B all
1223 means full output.
1224 Otherwise only the specified types of output
1225 (a quoted list, names without the
1226 .B \-\-debug\-
1227 prefix,
1228 separated by white space) are enabled;
1229 for details on available debugging types, see
1230 .IR pluto (8).
1231 .TP
1232 .B plutostderrlog
1233 Pluto will not use syslog, but rather log to stderr, and redirect stderr
1234 to the argument file.
1235 .TP
1236 .B postpluto
1237 shell command to run after starting Pluto
1238 (e.g., to remove a decrypted copy of the
1239 .I ipsec.secrets
1240 file).
1241 It's run in a very simple way;
1242 complexities like I/O redirection are best hidden within a script.
1243 Any output is redirected for logging,
1244 so running interactive commands is difficult unless they use
1245 .I /dev/tty
1246 or equivalent for their interaction.
1247 Default is none.
1248 .TP
1249 .B prepluto
1250 shell command to run before starting Pluto
1251 (e.g., to decrypt an encrypted copy of the
1252 .I ipsec.secrets
1253 file).
1254 It's run in a very simple way;
1255 complexities like I/O redirection are best hidden within a script.
1256 Any output is redirected for logging,
1257 so running interactive commands is difficult unless they use
1258 .I /dev/tty
1259 or equivalent for their interaction.
1260 Default is none.
1261 .TP
1262 .B virtual_private
1263 defines private networks using a wildcard notation.
1264 .PP
1265 The following
1266 .B config section
1267 parameters are used by the IKEv2 Charon daemon only:
1268 .TP
1269 .B charondebug
1270 how much Charon debugging output should be logged.
1271 A comma separated list containing type level/pairs may
1272 be specified, e.g:
1273 .B dmn 3, ike 1, net -1.
1274 Acceptable values for types are
1275 .B dmn, mgr, ike, chd, job, cfg, knl, net, enc, lib
1276 and the level is one of
1277 .B -1, 0, 1, 2, 3, 4
1278 (for silent, audit, control, controlmore, raw, private).
1279 .PP
1280 The following
1281 .B config section
1282 parameters only make sense if the KLIPS IPsec stack
1283 is used instead of the default NETKEY stack of the Linux 2.6 kernel:
1284 .TP
1285 .B fragicmp
1286 whether a tunnel's need to fragment a packet should be reported
1287 back with an ICMP message,
1288 in an attempt to make the sender lower his PMTU estimate;
1289 acceptable values are
1290 .B yes
1291 (the default)
1292 and
1293 .BR no .
1294 .TP
1295 .B hidetos
1296 whether a tunnel packet's TOS field should be set to
1297 .B 0
1298 rather than copied from the user packet inside;
1299 acceptable values are
1300 .B yes
1301 (the default)
1302 and
1303 .BR no
1304 .TP
1305 .B interfaces
1306 virtual and physical interfaces for IPsec to use:
1307 a single
1308 \fIvirtual\fB=\fIphysical\fR pair, a (quoted!) list of pairs separated
1309 by white space, or
1310 .BR %none .
1311 One of the pairs may be written as
1312 .BR %defaultroute ,
1313 which means: find the interface \fId\fR that the default route points to,
1314 and then act as if the value was ``\fBipsec0=\fId\fR''.
1315 .B %defaultroute
1316 is the default;
1317 .B %none
1318 must be used to denote no interfaces.
1319 .TP
1320 .B overridemtu
1321 value that the MTU of the ipsec\fIn\fR interface(s) should be set to,
1322 overriding IPsec's (large) default.
1323 .SH IKEv2 EXPIRY/REKEY
1324 The IKE SAs and IPsec SAs negotiated by the daemon can be configured to expire
1325 after a specific amount of time. For IPsec SAs this can also happen after a
1326 specified number of transmitted packets or transmitted bytes. The following
1327 settings can be used to configure this:
1328 .TS
1329 l r l r,- - - -,lB s lB s,a r a r.
1330 Setting Default Setting Default
1331 IKE SA  IPsec SA
1332 ikelifetime     3h      lifebytes       -
1333                 lifepackets     -
1334                 lifetime        1h
1335 .TE
1336 .SS Rekeying
1337 IKE SAs as well as IPsec SAs can be rekeyed before they expire. This can be
1338 configured using the following settings:
1339 .TS
1340 l r l r,- - - -,lB s lB s,a r a r.
1341 Setting Default Setting Default
1342 IKE and IPsec SA        IPsec SA
1343 margintime      9m      marginbytes     -
1344                 marginpackets   -
1345 .TE
1346 .SS Randomization
1347 To avoid collisions the specified margins are increased randomly before
1348 subtracting them from the expiration limits (see formula below). This is
1349 controlled by the
1350 .B rekeyfuzz
1351 setting:
1352 .TS
1353 l r,- -,lB s,a r.
1354 Setting Default
1355 IKE and IPsec SA
1356 rekeyfuzz       100%
1357 .TE
1358 .PP
1359 Randomization can be disabled by setting
1360 .BR rekeyfuzz " to " 0% .
1361 .SS Formula
1362 The following formula is used to calculate the rekey time of IPsec SAs:
1363 .PP
1364 .EX
1365  rekeytime = lifetime - (margintime + random(0, margintime * rekeyfuzz))
1366 .EE
1367 .PP
1368 It applies equally to IKE SAs and byte and packet limits for IPsec SAs.
1369 .SS Example
1370 Let's consider the default configuration:
1371 .PP
1372 .EX
1373         lifetime = 1h
1374         margintime = 9m
1375         rekeyfuzz = 100%
1376 .EE
1377 .PP
1378 From the formula above follows that the rekey time lies between:
1379 .PP
1380 .EX
1381         rekeytime_min = 1h - (9m + 9m) = 42m
1382         rekeytime_max = 1h - (9m + 0m) = 51m
1383 .EE
1384 .PP
1385 Thus, the daemon will attempt to rekey the IPsec SA at a random time
1386 between 42 and 51 minutes after establishing the SA. Or, in other words,
1387 between 9 and 18 minutes before the SA expires.
1388 .SS Notes
1389 .IP \[bu]
1390 Since the rekeying of an SA needs some time, the margin values must not be
1391 too low.
1392 .IP \[bu]
1393 The value
1394 .B margin... + margin... * rekeyfuzz
1395 must not exceed the original limit. For example, specifying
1396 .B margintime = 30m
1397 in the default configuration is a bad idea as there is a chance that the rekey
1398 time equals zero and, thus, rekeying gets disabled.
1399 .SH FILES
1400 .nf
1401 /etc/ipsec.conf
1402 /etc/ipsec.d/aacerts
1403 /etc/ipsec.d/acerts
1404 /etc/ipsec.d/cacerts
1405 /etc/ipsec.d/certs
1406 /etc/ipsec.d/crls
1407
1408 .SH SEE ALSO
1409 ipsec(8), pluto(8), starter(8)
1410 .SH HISTORY
1411 Originally written for the FreeS/WAN project by Henry Spencer.
1412 Updated and extended for the strongSwan project <http://www.strongswan.org> by
1413 Tobias Brunner, Andreas Steffen and Martin Willi.
1414 .SH BUGS
1415 .PP
1416 If conns are to be added before DNS is available, \fBleft=\fP\fIFQDN\fP
1417 will fail.