Do not fire roam events based on local route changes.
[strongswan.git] / man / ipsec.conf.5.in
1 .TH IPSEC.CONF 5 "2010-05-30" "@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.
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.
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.
832 .TP
833 .B mark
834 sets an XFRM mark of the form <value>[/<mask>] in the inbound and outbound
835 IPsec SAs and policies. If the mask is missing then a default
836 mask of
837 .B 0xffffffff
838 is assumed.
839 .TP
840 .B mark_in
841 sets an XFRM mark of the form <value>[/<mask>] in the inbound IPsec SA and
842 policy. If the mask is missing then a default mask of
843 .B 0xffffffff
844 is assumed.
845 .TP
846 .B mark_out
847 sets an XFRM mark of the form <value>[/<mask>] in the outbound IPsec SA and
848 policy. If the mask is missing then a default mask of
849 .B 0xffffffff
850 is assumed.
851 .TP
852 .B mobike
853 enables the IKEv2 MOBIKE protocol defined by RFC 4555. Accepted values are
854 .B yes
855 (the default) and
856 .BR no .
857 If set to
858 .BR no ,
859 the IKEv2 charon daemon will not actively propose MOBIKE as initiator and
860 ignore the MOBIKE_SUPPORTED notify as responder.
861 .TP
862 .B modeconfig
863 defines which mode is used to assign a virtual IP.
864 Accepted values are
865 .B push
866 and
867 .B pull
868 (the default).
869 Currently relevant for IKEv1 only since IKEv2 always uses the configuration
870 payload in pull mode. Cisco VPN gateways usually operate in
871 .B push
872 mode.
873 .TP
874 .B pfs
875 whether Perfect Forward Secrecy of keys is desired on the connection's
876 keying channel
877 (with PFS, penetration of the key-exchange protocol
878 does not compromise keys negotiated earlier);
879 acceptable values are
880 .B yes
881 (the default)
882 and
883 .BR no.
884 IKEv2 always uses PFS for IKE_SA rekeying whereas for CHILD_SA rekeying
885 PFS is enforced by defining a Diffie-Hellman modp group in the
886 .B esp
887 parameter.
888 .TP
889 .B pfsgroup
890 defines a Diffie-Hellman group for perfect forward secrecy in IKEv1 Quick Mode
891 differing from the DH group used for IKEv1 Main Mode (IKEv1 only).
892 .TP
893 .B reauth
894 whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1,
895 reauthentication is always done. In IKEv2, a value of
896 .B no
897 rekeys without uninstalling the IPsec SAs, a value of
898 .B yes
899 (the default) creates a new IKE_SA from scratch and tries to recreate
900 all IPsec SAs.
901 .TP
902 .B rekey
903 whether a connection should be renegotiated when it is about to expire;
904 acceptable values are
905 .B yes
906 (the default)
907 and
908 .BR no .
909 The two ends need not agree, but while a value of
910 .B no
911 prevents pluto/charon from requesting renegotiation,
912 it does not prevent responding to renegotiation requested from the other end,
913 so
914 .B no
915 will be largely ineffective unless both ends agree on it.
916 .TP
917 .B rekeyfuzz
918 maximum percentage by which
919 .BR marginbytes ,
920 .B marginpackets
921 and
922 .B margintime
923 should be randomly increased to randomize rekeying intervals
924 (important for hosts with many connections);
925 acceptable values are an integer,
926 which may exceed 100,
927 followed by a `%'
928 (defaults to
929 .BR 100% ).
930 The value of
931 .BR marginTYPE ,
932 after this random increase,
933 must not exceed
934 .B lifeTYPE
935 (where TYPE is one of
936 .IR bytes ,
937 .I packets
938 or
939 .IR time ).
940 The value
941 .B 0%
942 will suppress randomization.
943 Relevant only locally, other end need not agree on it.
944 .TP
945 .B rekeymargin
946 synonym for
947 .BR margintime .
948 .TP
949 .B reqid
950 sets the reqid for a given connection to a pre-configured fixed value.
951 .TP
952 .B type
953 the type of the connection; currently the accepted values
954 are
955 .B tunnel
956 (the default)
957 signifying a host-to-host, host-to-subnet, or subnet-to-subnet tunnel;
958 .BR transport ,
959 signifying host-to-host transport mode;
960 .BR transport_proxy ,
961 signifying the special Mobile IPv6 transport proxy mode;
962 .BR passthrough ,
963 signifying that no IPsec processing should be done at all;
964 .BR drop ,
965 signifying that packets should be discarded; and
966 .BR reject ,
967 signifying that packets should be discarded and a diagnostic ICMP returned.
968 The IKEv2 daemon charon currently supports
969 .BR tunnel ,
970 .BR transport ,
971 and
972 .BR tunnel_proxy
973 connection types, only.
974 .TP
975 .B xauth
976 specifies the role in the XAUTH protocol if activated by
977 .B authby=xauthpsk
978 or
979 .B authby=xauthrsasig.
980 Accepted values are
981 .B server
982 and
983 .B client
984 (the default).
985
986 .SS "CONN PARAMETERS: IKEv2 MEDIATION EXTENSION"
987 The following parameters are relevant to IKEv2 Mediation Extension
988 operation only.
989 .TP 14
990 .B mediation
991 whether this connection is a mediation connection, ie. whether this
992 connection is used to mediate other connections.  Mediation connections
993 create no child SA. Acceptable values are
994 .B no
995 (the default) and
996 .BR yes .
997 .TP
998 .B mediated_by
999 the name of the connection to mediate this connection through.  If given,
1000 the connection will be mediated through the named mediation connection.
1001 The mediation connection must set
1002 .BR mediation=yes .
1003 .TP
1004 .B me_peerid
1005 ID as which the peer is known to the mediation server, ie. which the other
1006 end of this connection uses as its
1007 .B leftid
1008 on its connection to the mediation server.  This is the ID we request the
1009 mediation server to mediate us with.  If
1010 .B me_peerid
1011 is not given, the
1012 .B rightid
1013 of this connection will be used as peer ID.
1014
1015 .SH "CA SECTIONS"
1016 This are optional sections that can be used to assign special
1017 parameters to a Certification Authority (CA).
1018 .TP 10
1019 .B auto
1020 currently can have either the value
1021 .B ignore
1022 or
1023 .B add
1024 .
1025 .TP
1026 .B cacert
1027 defines a path to the CA certificate either relative to
1028 \fI/etc/ipsec.d/cacerts\fP or as an absolute path.
1029 .TP
1030 .B crluri
1031 defines a CRL distribution point (ldap, http, or file URI)
1032 .TP
1033 .B crluri1
1034 synonym for
1035 .B crluri.
1036 .TP
1037 .B crluri2
1038 defines an alternative CRL distribution point (ldap, http, or file URI)
1039 .TP
1040 .B ldaphost
1041 defines an ldap host. Currently used by IKEv1 only.
1042 .TP
1043 .B ocspuri
1044 defines an OCSP URI.
1045 .TP
1046 .B ocspuri1
1047 synonym for
1048 .B ocspuri.
1049 .TP
1050 .B ocspuri2
1051 defines an alternative OCSP URI. Currently used by IKEv2 only.
1052 .TP
1053 .B certuribase
1054 defines the base URI for the Hash and URL feature supported by IKEv2.
1055 Instead of exchanging complete certificates, IKEv2 allows to send an URI
1056 that resolves to the DER encoded certificate. The certificate URIs are built
1057 by appending the SHA1 hash of the DER encoded certificates to this base URI.
1058 .SH "CONFIG SECTIONS"
1059 At present, the only
1060 .B config
1061 section known to the IPsec software is the one named
1062 .BR setup ,
1063 which contains information used when the software is being started.
1064 Here's an example:
1065 .PP
1066 .ne 8
1067 .nf
1068 .ft B
1069 .ta 1c
1070 config setup
1071         plutodebug=all
1072         crlcheckinterval=10m
1073         strictcrlpolicy=yes
1074 .ft
1075 .fi
1076 .PP
1077 Parameters are optional unless marked ``(required)''.
1078 The currently-accepted
1079 .I parameter
1080 names in a
1081 .B config
1082 .B setup
1083 section affecting both daemons are:
1084 .TP 14
1085 .B cachecrls
1086 certificate revocation lists (CRLs) fetched via http or ldap will be cached in
1087 \fI/etc/ipsec.d/crls/\fR under a unique file name derived from the certification
1088 authority's public key.
1089 Accepted values are
1090 .B yes
1091 and
1092 .B no
1093 (the default).
1094 .TP
1095 .B charonstart
1096 whether to start the IKEv2 Charon daemon or not.
1097 Accepted values are
1098 .B yes
1099 or
1100 .BR no .
1101 The default is
1102 .B yes
1103 if starter was compiled with IKEv2 support.
1104 .TP
1105 .B dumpdir
1106 in what directory should things started by \fBipsec starter\fR
1107 (notably the Pluto and Charon daemons) be allowed to dump core?
1108 The empty value (the default) means they are not
1109 allowed to.
1110 This feature is currently not yet supported by \fBipsec starter\fR.
1111 .TP
1112 .B plutostart
1113 whether to start the IKEv1 Pluto daemon or not.
1114 Accepted values are
1115 .B yes
1116 or
1117 .BR no .
1118 The default is
1119 .B yes
1120 if starter was compiled with IKEv1 support.
1121 .TP
1122 .B strictcrlpolicy
1123 defines if a fresh CRL must be available in order for the peer authentication based
1124 on RSA signatures to succeed.
1125 Accepted values are
1126 .B yes
1127 and
1128 .B no
1129 (the default).
1130 IKEv2 additionally recognizes
1131 .B ifuri
1132 which reverts to
1133 .B yes
1134 if at least one CRL URI is defined and to
1135 .B no
1136 if no URI is known.
1137 .TP
1138 .B uniqueids
1139 whether a particular participant ID should be kept unique,
1140 with any new (automatically keyed)
1141 connection using an ID from a different IP address
1142 deemed to replace all old ones using that ID;
1143 acceptable values are
1144 .B yes
1145 (the default)
1146 and
1147 .BR no .
1148 Participant IDs normally \fIare\fR unique,
1149 so a new (automatically-keyed) connection using the same ID is
1150 almost invariably intended to replace an old one.
1151 The IKEv2 daemon also accepts the value
1152 .B replace
1153 wich is identical to
1154 .B yes
1155 and the value
1156 .B keep
1157 to reject new IKE_SA setups and keep the duplicate established earlier.
1158 .PP
1159 The following
1160 .B config section
1161 parameters are used by the IKEv1 Pluto daemon only:
1162 .TP
1163 .B crlcheckinterval
1164 interval in seconds. CRL fetching is enabled if the value is greater than zero.
1165 Asynchronous, periodic checking for fresh CRLs is currently done by the
1166 IKEv1 Pluto daemon only.
1167 .TP
1168 .B keep_alive
1169 interval in seconds between NAT keep alive packets, the default being 20 seconds.
1170 .TP
1171 .B nat_traversal
1172 activates NAT traversal by accepting source ISAKMP ports different from udp/500 and
1173 being able of floating to udp/4500 if a NAT situation is detected.
1174 Accepted values are
1175 .B yes
1176 and
1177 .B no
1178 (the default).
1179 Used by IKEv1 only, NAT traversal always being active in IKEv2.
1180 .TP
1181 .B nocrsend
1182 no certificate request payloads will be sent.
1183 Accepted values are
1184 .B yes
1185 and
1186 .B no
1187 (the default).
1188 .TP
1189 .B pkcs11initargs
1190 non-standard argument string for PKCS#11 C_Initialize() function;
1191 required by NSS softoken.
1192 .TP
1193 .B pkcs11module
1194 defines the path to a dynamically loadable PKCS #11 library.
1195 .TP
1196 .B pkcs11keepstate
1197 PKCS #11 login sessions will be kept during the whole lifetime of the keying
1198 daemon. Useful with pin-pad smart card readers.
1199 Accepted values are
1200 .B yes
1201 and
1202 .B no
1203 (the default).
1204 .TP
1205 .B pkcs11proxy
1206 Pluto will act as a PKCS #11 proxy accessible via the whack interface.
1207 Accepted values are
1208 .B yes
1209 and
1210 .B no
1211 (the default).
1212 .TP
1213 .B plutodebug
1214 how much Pluto debugging output should be logged.
1215 An empty value,
1216 or the magic value
1217 .BR none ,
1218 means no debugging output (the default).
1219 The magic value
1220 .B all
1221 means full output.
1222 Otherwise only the specified types of output
1223 (a quoted list, names without the
1224 .B \-\-debug\-
1225 prefix,
1226 separated by white space) are enabled;
1227 for details on available debugging types, see
1228 .IR pluto (8).
1229 .TP
1230 .B plutostderrlog
1231 Pluto will not use syslog, but rather log to stderr, and redirect stderr
1232 to the argument file.
1233 .TP
1234 .B postpluto
1235 shell command to run after starting Pluto
1236 (e.g., to remove a decrypted copy of the
1237 .I ipsec.secrets
1238 file).
1239 It's run in a very simple way;
1240 complexities like I/O redirection are best hidden within a script.
1241 Any output is redirected for logging,
1242 so running interactive commands is difficult unless they use
1243 .I /dev/tty
1244 or equivalent for their interaction.
1245 Default is none.
1246 .TP
1247 .B prepluto
1248 shell command to run before starting Pluto
1249 (e.g., to decrypt an encrypted copy of the
1250 .I ipsec.secrets
1251 file).
1252 It's run in a very simple way;
1253 complexities like I/O redirection are best hidden within a script.
1254 Any output is redirected for logging,
1255 so running interactive commands is difficult unless they use
1256 .I /dev/tty
1257 or equivalent for their interaction.
1258 Default is none.
1259 .TP
1260 .B virtual_private
1261 defines private networks using a wildcard notation.
1262 .PP
1263 The following
1264 .B config section
1265 parameters are used by the IKEv2 Charon daemon only:
1266 .TP
1267 .B charondebug
1268 how much Charon debugging output should be logged.
1269 A comma separated list containing type level/pairs may
1270 be specified, e.g:
1271 .B dmn 3, ike 1, net -1.
1272 Acceptable values for types are
1273 .B dmn, mgr, ike, chd, job, cfg, knl, net, enc, lib
1274 and the level is one of
1275 .B -1, 0, 1, 2, 3, 4
1276 (for silent, audit, control, controlmore, raw, private).
1277 .PP
1278 The following
1279 .B config section
1280 parameters only make sense if the KLIPS IPsec stack
1281 is used instead of the default NETKEY stack of the Linux 2.6 kernel:
1282 .TP
1283 .B fragicmp
1284 whether a tunnel's need to fragment a packet should be reported
1285 back with an ICMP message,
1286 in an attempt to make the sender lower his PMTU estimate;
1287 acceptable values are
1288 .B yes
1289 (the default)
1290 and
1291 .BR no .
1292 .TP
1293 .B hidetos
1294 whether a tunnel packet's TOS field should be set to
1295 .B 0
1296 rather than copied from the user packet inside;
1297 acceptable values are
1298 .B yes
1299 (the default)
1300 and
1301 .BR no
1302 .TP
1303 .B interfaces
1304 virtual and physical interfaces for IPsec to use:
1305 a single
1306 \fIvirtual\fB=\fIphysical\fR pair, a (quoted!) list of pairs separated
1307 by white space, or
1308 .BR %none .
1309 One of the pairs may be written as
1310 .BR %defaultroute ,
1311 which means: find the interface \fId\fR that the default route points to,
1312 and then act as if the value was ``\fBipsec0=\fId\fR''.
1313 .B %defaultroute
1314 is the default;
1315 .B %none
1316 must be used to denote no interfaces.
1317 .TP
1318 .B overridemtu
1319 value that the MTU of the ipsec\fIn\fR interface(s) should be set to,
1320 overriding IPsec's (large) default.
1321 .SH FILES
1322 .nf
1323 /etc/ipsec.conf
1324 /etc/ipsec.d/aacerts
1325 /etc/ipsec.d/acerts
1326 /etc/ipsec.d/cacerts
1327 /etc/ipsec.d/certs
1328 /etc/ipsec.d/crls
1329
1330 .SH SEE ALSO
1331 ipsec(8), pluto(8), starter(8)
1332 .SH HISTORY
1333 Originally written for the FreeS/WAN project by Henry Spencer.
1334 Updated and extended for the strongSwan project <http://www.strongswan.org> by
1335 Tobias Brunner, Andreas Steffen and Martin Willi.
1336 .SH BUGS
1337 .PP
1338 If conns are to be added before DNS is available, \fBleft=\fP\fIFQDN\fP
1339 will fail.