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