Description of new lifetime limits added to manpage.
[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 synonym for
425 .BR lifetime .
426 .TP
427 .B left
428 (required)
429 the IP address of the left participant's public-network interface,
430 in any form accepted by
431 .IR ttoaddr (3)
432 or one of several magic values.
433 If it is
434 .BR %defaultroute ,
435 .B left
436 will be filled in automatically with the local address
437 of the default-route interface (as determined at IPsec startup time).
438 (Either
439 .B left
440 or
441 .B right
442 may be
443 .BR %defaultroute ,
444 but not both.)
445 The value
446 .B %any
447 signifies an address to be filled in (by automatic keying) during
448 negotiation. The prefix
449 .B  %
450 in front of a fully-qualified domain name or an IP address will implicitly set
451 .B leftallowany=yes.
452 If the domain name cannot be resolved into an IP address at IPsec startup or update time
453 then
454 .B left=%any
455 and
456 .B leftallowany=no
457 will be assumed.
458 .TP
459 .B leftallowany
460 a modifier for
461 .B left
462 , making it behave as
463 .B %any
464 although a concrete IP address has been assigned.
465 Recommended for dynamic IP addresses that can be resolved by DynDNS at IPsec startup or
466 update time.
467 Acceptable values are
468 .B yes
469 and
470 .B no
471 (the default).
472 .TP
473 .B leftauth
474 Authentication method to use (local) or require (remote) in this connection.
475 This parameter is supported in IKEv2 only. Acceptable values are 
476 .B pubkey
477 for public key authentication (RSA/ECDSA), 
478 .B psk
479 for pre-shared key authentication and
480 .B eap
481 to (require the) use of the Extensible Authentication Protocol. In the case
482 of 
483 .B eap,
484 an optional EAP method can be appended. Currently defined methods are
485 .B eap-aka, eap-sim, eap-gtc, eap-md5
486 and
487 .B eap-mschapv2.
488 Alternatively, IANA assigned EAP method numbers are accepted. Vendor specific
489 EAP methods are defined in the form
490 .B eap-type-vendor
491 (e.g.
492 .B eap-7-12345
493 ).
494 .TP
495 .B leftauth2
496 Same as 
497 .B leftauth,
498 but defines an additional authentication exchange. IKEv2 supports multiple
499 authentication rounds using "Multiple Authentication Exchanges" defined
500 in RFC4739. This allows, for example, separated authentication
501 of host and user (IKEv2 only).
502 .TP
503 .B leftca
504 the distinguished name of a certificate authority which is required to
505 lie in the trust path going from the left participant's certificate up
506 to the root certification authority. 
507 .TP
508 .B leftca2
509 Same as
510 .B leftca,
511 but for the second authentication round (IKEv2 only).
512 .TP
513 .B leftcert
514 the path to the left participant's X.509 certificate. The file can be coded either in
515 PEM or DER format. OpenPGP certificates are supported as well.
516 Both absolute paths or paths relative to \fI/etc/ipsec.d/certs\fP
517 are accepted. By default
518 .B leftcert
519 sets 
520 .B leftid
521 to the distinguished name of the certificate's subject and
522 .B leftca
523 to the distinguished name of the certificate's issuer.
524 The left participant's ID can be overriden by specifying a
525 .B leftid
526 value which must be certified by the certificate, though.
527 .TP
528 .B leftcert2
529 Same as
530 .B leftcert,
531 but for the second authentication round (IKEv2 only).
532 .TP
533 .B leftfirewall
534 whether the left participant is doing forwarding-firewalling
535 (including masquerading) using iptables for traffic from \fIleftsubnet\fR,
536 which should be turned off (for traffic to the other subnet)
537 once the connection is established;
538 acceptable values are
539 .B yes
540 and
541 .B no
542 (the default).
543 May not be used in the same connection description with
544 .BR leftupdown .
545 Implemented as a parameter to the default \fBipsec _updown\fR script.
546 See notes below.
547 Relevant only locally, other end need not agree on it.
548
549 If one or both security gateways are doing forwarding firewalling
550 (possibly including masquerading),
551 and this is specified using the firewall parameters,
552 tunnels established with IPsec are exempted from it
553 so that packets can flow unchanged through the tunnels.
554 (This means that all subnets connected in this manner must have
555 distinct, non-overlapping subnet address blocks.)
556 This is done by the default \fBipsec _updown\fR script (see
557 .IR pluto (8)).
558
559 In situations calling for more control,
560 it may be preferable for the user to supply his own
561 .I updown
562 script,
563 which makes the appropriate adjustments for his system.
564 .TP
565 .B leftgroups
566 a comma separated list of group names. If the
567 .B leftgroups
568 parameter is present then the peer must be a member of at least one
569 of the groups defined by the parameter. Group membership must be certified
570 by a valid attribute certificate stored in \fI/etc/ipsec.d/acerts/\fP thas has been
571 issued to the peer by a trusted Authorization Authority stored in
572 \fI/etc/ipsec.d/aacerts/\fP. Attribute certificates are not supported in IKEv2 yet.
573 .TP
574 .B lefthostaccess
575 inserts a pair of INPUT and OUTPUT iptables rules using the default
576 \fBipsec _updown\fR script, thus allowing access to the host itself
577 in the case where the host's internal interface is part of the
578 negotiated client subnet.
579 Acceptable values are
580 .B yes
581 and
582 .B no
583 (the default).
584 .TP
585 .B leftid
586 how
587 the left participant
588 should be identified for authentication;
589 defaults to
590 .BR left .
591 Can be an IP address (in any
592 .IR ttoaddr (3)
593 syntax)
594 or a fully-qualified domain name preceded by
595 .B @
596 (which is used as a literal string and not resolved).
597 .TP
598 .B leftid2
599 identity to use for a second authentication for the left participant
600 (IKEv2 only); defaults to
601 .BR leftid .
602 .TP
603 .B leftnexthop
604 this parameter is not needed any more because the NETKEY IPsec stack does
605 not require explicit routing entries for the traffic to be tunneled.
606 .TP
607 .B leftprotoport
608 restrict the traffic selector to a single protocol and/or port.
609 Examples:
610 .B leftprotoport=tcp/http
611 or
612 .B leftprotoport=6/80
613 or
614 .B leftprotoport=udp
615 .TP
616 .B leftrsasigkey
617 the left participant's
618 public key for RSA signature authentication,
619 in RFC 2537 format using
620 .IR ttodata (3)
621 encoding.
622 The magic value
623 .B %none
624 means the same as not specifying a value (useful to override a default).
625 The value
626 .B %cert
627 (the default)
628 means that the key is extracted from a certificate.
629 The identity used for the left participant
630 must be a specific host, not
631 .B %any
632 or another magic value.
633 .B Caution:
634 if two connection descriptions
635 specify different public keys for the same
636 .BR leftid ,
637 confusion and madness will ensue.
638 .TP
639 .B leftsendcert
640 Accepted values are
641 .B never
642 or
643 .BR no ,
644 .B always
645 or
646 .BR yes ,
647 and
648 .BR ifasked .
649 .TP
650 .B leftsourceip
651 The internal source IP to use in a tunnel, also known as virtual IP. If the
652 value is
653 .BR %modeconfig ,
654 .BR %modecfg ,
655 .BR %config ,
656 or
657 .B %cfg,
658 an address is requested from the peer. In IKEv2, a defined address is requested,
659 but the server may change it. If the server does not support it, the address
660 is enforced. 
661 .TP
662 .B rightsourceip
663 The internal source IP to use in a tunnel for the remote peer. If the
664 value is
665 .B %config
666 on the responder side, the initiator must propose a address which is then echoed
667 back. The IKEv2 daemon also supports address pools expressed as
668 \fInetwork\fB/\fInetmask\fR
669 or the use of an external IP address pool using %\fIpoolname\fR
670 , where \fIpoolname\fR is the name of the IP address pool used for the lookup.
671 .TP
672 .B leftsubnet
673 private subnet behind the left participant, expressed as
674 \fInetwork\fB/\fInetmask\fR
675 (actually, any form acceptable to
676 .IR ttosubnet (3));
677 if omitted, essentially assumed to be \fIleft\fB/32\fR,
678 signifying that the left end of the connection goes to the left participant
679 only. When using IKEv2, the configured subnet of the peers may differ, the
680 protocol narrows it to the greatest common subnet. Further, IKEv2 supports
681 multiple subnets separated by commas. IKEv1 only interprets the first subnet
682 of such a definition.
683 .TP
684 .B leftsubnetwithin
685 the peer can propose any subnet or single IP address that fits within the
686 range defined by
687 .BR leftsubnetwithin.
688 Not relevant for IKEv2, as subnets are narrowed.
689 .TP
690 .B leftupdown
691 what ``updown'' script to run to adjust routing and/or firewalling
692 when the status of the connection
693 changes (default
694 .BR "ipsec _updown" ).
695 May include positional parameters separated by white space
696 (although this requires enclosing the whole string in quotes);
697 including shell metacharacters is unwise.
698 See
699 .IR pluto (8)
700 for details.
701 Relevant only locally, other end need not agree on it. IKEv2 uses the updown
702 script to insert firewall rules only. Routing is not support and will be
703 implemented directly into Charon.
704 .TP
705 .B lifebytes
706 the number of bytes transmitted over an IPsec SA before it expires (IKEv2
707 only).
708 .TP
709 .B lifepackets
710 the number of packets transmitted over an IPsec SA before it expires (IKEv2
711 only).
712 .TP
713 .B lifetime
714 how long a particular instance of a connection
715 (a set of encryption/authentication keys for user packets) should last,
716 from successful negotiation to expiry;
717 acceptable values are an integer optionally followed by
718 .BR s
719 (a time in seconds)
720 or a decimal number followed by
721 .BR m ,
722 .BR h ,
723 or
724 .B d
725 (a time
726 in minutes, hours, or days respectively)
727 (default
728 .BR 1h ,
729 maximum
730 .BR 24h ).
731 Normally, the connection is renegotiated (via the keying channel)
732 before it expires (see
733 .BR margintime ).
734 The two ends need not exactly agree on
735 .BR lifetime ,
736 although if they do not,
737 there will be some clutter of superseded connections on the end
738 which thinks the lifetime is longer.
739 .TP
740 .B marginbytes
741 how many bytes before IPsec SA expiry (see
742 .BR lifebytes )
743 should attempts to negotiate a replacement begin (IKEv2 only).
744 .TP
745 .B marginpackets
746 how many packets before IPsec SA expiry (see
747 .BR lifepackets )
748 should attempts to negotiate a replacement begin (IKEv2 only).
749 .TP
750 .B margintime
751 how long before connection expiry or keying-channel expiry
752 should attempts to
753 negotiate a replacement
754 begin; acceptable values as for
755 .B lifetime
756 (default
757 .BR 9m ).
758 Relevant only locally, other end need not agree on it.
759 .TP
760 .B mobike
761 enables the IKEv2 MOBIKE protocol defined by RFC 4555. Accepted values are
762 .B yes
763 (the default) and
764 .BR no .
765 If set to
766 .BR no ,
767 the IKEv2 charon daemon will not actively propose MOBIKE as initiator and
768 ignore the MOBIKE_SUPPORTED notify as responder.
769 .TP
770 .B modeconfig
771 defines which mode is used to assign a virtual IP.
772 Accepted values are
773 .B push
774 and
775 .B pull
776 (the default).
777 Currently relevant for IKEv1 only since IKEv2 always uses the configuration
778 payload in pull mode.
779 .TP
780 .B pfs
781 whether Perfect Forward Secrecy of keys is desired on the connection's
782 keying channel
783 (with PFS, penetration of the key-exchange protocol
784 does not compromise keys negotiated earlier);
785 acceptable values are
786 .B yes
787 (the default)
788 and
789 .BR no.
790 IKEv2 always uses PFS for IKE_SA rekeying whereas for CHILD_SA rekeying
791 PFS is enforced by defining a Diffie-Hellman modp group in the
792 .B esp
793 parameter.
794 .TP
795 .B pfsgroup 
796 defines a Diffie-Hellman group for perfect forward secrecy in IKEv1 Quick Mode
797 differing from the DH group used for IKEv1 Main Mode (IKEv1 only).
798 .TP
799 .B reauth
800 whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1,
801 reauthentication is always done. In IKEv2, a value of
802 .B no
803 rekeys without uninstalling the IPsec SAs, a value of
804 .B yes
805 (the default) creates a new IKE_SA from scratch and tries to recreate
806 all IPsec SAs.
807 .TP
808 .B rekey
809 whether a connection should be renegotiated when it is about to expire;
810 acceptable values are
811 .B yes
812 (the default)
813 and
814 .BR no .
815 The two ends need not agree, but while a value of
816 .B no
817 prevents Pluto/Charon from requesting renegotiation,
818 it does not prevent responding to renegotiation requested from the other end,
819 so
820 .B no
821 will be largely ineffective unless both ends agree on it.
822 .TP
823 .B rekeyfuzz
824 maximum percentage by which
825 .BR marginbytes ,
826 .B marginpackets
827 and
828 .B margintime
829 should be randomly increased to randomize rekeying intervals
830 (important for hosts with many connections);
831 acceptable values are an integer,
832 which may exceed 100,
833 followed by a `%'
834 (defaults to
835 .BR 100% ).
836 The value of
837 .BR marginTYPE ,
838 after this random increase,
839 must not exceed
840 .B lifeTYPE
841 (where TYPE is one of
842 .IR bytes ,
843 .I packets
844 or
845 .IR time ).
846 The value
847 .B 0%
848 will suppress randomization.
849 Relevant only locally, other end need not agree on it.
850 .TP
851 .B rekeymargin
852 synonym for
853 .BR margintime .
854 .TP
855 .B type
856 the type of the connection; currently the accepted values
857 are
858 .B tunnel
859 (the default)
860 signifying a host-to-host, host-to-subnet, or subnet-to-subnet tunnel;
861 .BR transport ,
862 signifying host-to-host transport mode;
863 .BR transport_proxy ,
864 signifying the special Mobile IPv6 transport proxy mode;
865 .BR passthrough ,
866 signifying that no IPsec processing should be done at all;
867 .BR drop ,
868 signifying that packets should be discarded; and
869 .BR reject ,
870 signifying that packets should be discarded and a diagnostic ICMP returned.
871 Charon currently supports
872 .BR tunnel ,
873 .BR transport ,
874 and
875 .BR tunnel_proxy
876 connection types, only .
877 .TP
878 .B xauth
879 specifies the role in the XAUTH protocol if activated by
880 .B authby=xauthpsk
881 or
882 .B authby=xauthrsasig.
883 Accepted values are
884 .B server
885 and
886 .B client
887 (the default).
888
889 .SS "CONN PARAMETERS: IKEv2 MEDIATION EXTENSION"
890 The following parameters are relevant to IKEv2 Mediation Extension 
891 operation only.
892 .TP 14
893 .B mediation
894 whether this connection is a mediation connection, ie. whether this
895 connection is used to mediate other connections.  Mediation connections
896 create no child SA. Acceptable values are
897 .B no
898 (the default) and
899 .BR yes .
900 .TP
901 .B mediated_by
902 the name of the connection to mediate this connection through.  If given,
903 the connection will be mediated through the named mediation connection.
904 The mediation connection must set
905 .BR mediation=yes .
906 .TP
907 .B me_peerid
908 ID as which the peer is known to the mediation server, ie. which the other
909 end of this connection uses as its
910 .B leftid
911 on its connection to the mediation server.  This is the ID we request the
912 mediation server to mediate us with.  If
913 .B me_peerid
914 is not given, the
915 .B rightid
916 of this connection will be used as peer ID.
917
918 .SH "CA SECTIONS"
919 This are optional sections that can be used to assign special
920 parameters to a Certification Authority (CA). These parameters are not 
921 supported in IKEv2 yet.
922 .TP 10
923 .B auto
924 currently can have either the value
925 .B ignore
926 or
927 .B add
928
929 .TP
930 .B cacert
931 defines a path to the CA certificate either relative to 
932 \fI/etc/ipsec.d/cacerts\fP or as an absolute path.
933 .TP
934 .B crluri
935 defines a CRL distribution point (ldap, http, or file URI)
936 .TP
937 .B crluri1
938 synonym for
939 .B crluri.
940 .TP
941 .B crluri2
942 defines an alternative CRL distribution point (ldap, http, or file URI)
943 .TP
944 .B ldaphost
945 defines an ldap host. Currently used by IKEv1 only.
946 .TP
947 .B ocspuri
948 defines an OCSP URI.
949 .TP
950 .B ocspuri1
951 synonym for
952 .B ocspuri.
953 .TP
954 .B ocspuri2
955 defines an alternative OCSP URI. Currently used by IKEv2 only.
956 .B certuribase
957 defines the base URI for the Hash and URL feature supported by IKEv2.
958 Instead of exchanging complete certificates, IKEv2 allows to send an URI
959 that resolves to the DER encoded certificate. The certificate URIs are built
960 by appending the SHA1 hash of the DER encoded certificates to this base URI.
961 .SH "CONFIG SECTIONS"
962 At present, the only
963 .B config
964 section known to the IPsec software is the one named
965 .BR setup ,
966 which contains information used when the software is being started
967 (see
968 .IR starter (8)).
969 Here's an example:
970 .PP
971 .ne 8
972 .nf
973 .ft B
974 .ta 1c
975 config setup
976         plutodebug=all
977         crlcheckinterval=10m
978         strictcrlpolicy=yes
979 .ft
980 .fi
981 .PP
982 Parameters are optional unless marked ``(required)''.
983 The currently-accepted
984 .I parameter
985 names in a
986 .B config
987 .B setup
988 section affecting both daemons are:
989 .TP 14
990 .B cachecrls
991 certificate revocation lists (CRLs) fetched via http or ldap will be cached in
992 \fI/etc/ipsec.d/crls/\fR under a unique file name derived from the certification
993 authority's public key.
994 Accepted values are
995 .B yes
996 and
997 .B no
998 (the default).
999 .TP
1000 .B charonstart
1001 whether to start the IKEv2 Charon daemon or not.
1002 Accepted values are
1003 .B yes
1004 or
1005 .BR no .
1006 The default is 
1007 .B yes
1008 if starter was compiled with IKEv2 support.
1009 .TP
1010 .B dumpdir
1011 in what directory should things started by \fBipsec starter\fR
1012 (notably the Pluto and Charon daemons) be allowed to dump core?
1013 The empty value (the default) means they are not
1014 allowed to.
1015 This feature is currently not yet supported by \fBipsec starter\fR.
1016 .TP
1017 .B plutostart
1018 whether to start the IKEv1 Pluto daemon or not.
1019 Accepted values are
1020 .B yes
1021 or
1022 .BR no .
1023 The default is 
1024 .B yes
1025 if starter was compiled with IKEv1 support.
1026 .TP
1027 .B strictcrlpolicy
1028 defines if a fresh CRL must be available in order for the peer authentication based
1029 on RSA signatures to succeed.
1030 Accepted values are
1031 .B yes
1032 and
1033 .B no
1034 (the default).
1035 IKEv2 additionally recognizes
1036 .B ifuri
1037 which reverts to
1038 .B yes
1039 if at least one CRL URI is defined and to
1040 .B no
1041 if no URI is known.
1042 .TP
1043 .B uniqueids
1044 whether a particular participant ID should be kept unique,
1045 with any new (automatically keyed)
1046 connection using an ID from a different IP address
1047 deemed to replace all old ones using that ID;
1048 acceptable values are
1049 .B yes
1050 (the default)
1051 and
1052 .BR no .
1053 Participant IDs normally \fIare\fR unique,
1054 so a new (automatically-keyed) connection using the same ID is
1055 almost invariably intended to replace an old one.
1056 The IKEv2 daemon also accepts the value
1057 .B replace
1058 wich is identical to
1059 .B yes
1060 and the value
1061 .B keep
1062 to reject new IKE_SA setups and keep the duplicate established earlier.
1063 .PP
1064 The following
1065 .B config section
1066 parameters are used by the IKEv1 Pluto daemon only:
1067 .TP
1068 .B crlcheckinterval
1069 interval in seconds. CRL fetching is enabled if the value is greater than zero.
1070 Asynchronous, periodic checking for fresh CRLs is currently done by the
1071 IKEv1 Pluto daemon only.
1072 .TP
1073 .B keep_alive
1074 interval in seconds between NAT keep alive packets, the default being 20 seconds.
1075 .TP
1076 .B nat_traversal
1077 activates NAT traversal by accepting source ISAKMP ports different from udp/500 and
1078 being able of floating to udp/4500 if a NAT situation is detected.
1079 Accepted values are
1080 .B yes
1081 and
1082 .B no
1083 (the default).
1084 Used by IKEv1 only, NAT traversal always being active in IKEv2.
1085 .TP
1086 .B nocrsend
1087 no certificate request payloads will be sent.
1088 Accepted values are
1089 .B yes
1090 and
1091 .B no
1092 (the default).
1093 .TP
1094 .B pkcs11initargs
1095 non-standard argument string for PKCS#11 C_Initialize() function;
1096 required by NSS softoken.
1097 .TP
1098 .B pkcs11module
1099 defines the path to a dynamically loadable PKCS #11 library.
1100 .TP
1101 .B pkcs11keepstate
1102 PKCS #11 login sessions will be kept during the whole lifetime of the keying
1103 daemon. Useful with pin-pad smart card readers.
1104 Accepted values are
1105 .B yes
1106 and
1107 .B no
1108 (the default).
1109 .TP
1110 .B pkcs11proxy
1111 Pluto will act as a PKCS #11 proxy accessible via the whack interface.
1112 Accepted values are
1113 .B yes
1114 and
1115 .B no
1116 (the default).
1117 .TP
1118 .B plutodebug
1119 how much Pluto debugging output should be logged.
1120 An empty value,
1121 or the magic value
1122 .BR none ,
1123 means no debugging output (the default).
1124 The magic value
1125 .B all
1126 means full output.
1127 Otherwise only the specified types of output
1128 (a quoted list, names without the
1129 .B \-\-debug\-
1130 prefix,
1131 separated by white space) are enabled;
1132 for details on available debugging types, see
1133 .IR pluto (8).
1134 .TP
1135 .B plutostderrlog
1136 Pluto will not use syslog, but rather log to stderr, and redirect stderr
1137 to the argument file.
1138 .TP
1139 .B postpluto
1140 shell command to run after starting Pluto
1141 (e.g., to remove a decrypted copy of the
1142 .I ipsec.secrets
1143 file).
1144 It's run in a very simple way;
1145 complexities like I/O redirection are best hidden within a script.
1146 Any output is redirected for logging,
1147 so running interactive commands is difficult unless they use
1148 .I /dev/tty
1149 or equivalent for their interaction.
1150 Default is none.
1151 .TP
1152 .B prepluto
1153 shell command to run before starting Pluto
1154 (e.g., to decrypt an encrypted copy of the
1155 .I ipsec.secrets
1156 file).
1157 It's run in a very simple way;
1158 complexities like I/O redirection are best hidden within a script.
1159 Any output is redirected for logging,
1160 so running interactive commands is difficult unless they use
1161 .I /dev/tty
1162 or equivalent for their interaction.
1163 Default is none.
1164 .TP
1165 .B virtual_private
1166 defines private networks using a wildcard notation.
1167 .PP
1168 The following
1169 .B config section
1170 parameters are used by the IKEv2 Charon daemon only:
1171 .TP
1172 .B charondebug
1173 how much Charon debugging output should be logged.
1174 A comma separated list containing type level/pairs may
1175 be specified, e.g:
1176 .B dmn 3, ike 1, net -1.
1177 Acceptable values for types are
1178 .B dmn, mgr, ike, chd, job, cfg, knl, net, enc, lib
1179 and the level is one of
1180 .B -1, 0, 1, 2, 3, 4
1181 (for silent, audit, control, controlmore, raw, private).
1182 .PP
1183 The following
1184 .B config section
1185 parameters only make sense if the KLIPS IPsec stack
1186 is used instead of the default NETKEY stack of the Linux 2.6 kernel:
1187 .TP
1188 .B fragicmp
1189 whether a tunnel's need to fragment a packet should be reported
1190 back with an ICMP message,
1191 in an attempt to make the sender lower his PMTU estimate;
1192 acceptable values are
1193 .B yes
1194 (the default)
1195 and
1196 .BR no .
1197 .TP
1198 .B hidetos
1199 whether a tunnel packet's TOS field should be set to
1200 .B 0
1201 rather than copied from the user packet inside;
1202 acceptable values are
1203 .B yes
1204 (the default)
1205 and
1206 .BR no
1207 .TP
1208 .B interfaces
1209 virtual and physical interfaces for IPsec to use:
1210 a single
1211 \fIvirtual\fB=\fIphysical\fR pair, a (quoted!) list of pairs separated
1212 by white space, or
1213 .BR %none .
1214 One of the pairs may be written as
1215 .BR %defaultroute ,
1216 which means: find the interface \fId\fR that the default route points to,
1217 and then act as if the value was ``\fBipsec0=\fId\fR''.
1218 .B %defaultroute
1219 is the default;
1220 .B %none
1221 must be used to denote no interfaces.
1222 .TP
1223 .B overridemtu
1224 value that the MTU of the ipsec\fIn\fR interface(s) should be set to,
1225 overriding IPsec's (large) default.
1226 .SH CHOOSING A CONNECTION
1227 .PP
1228 When choosing a connection to apply to an outbound packet caught with a 
1229 .BR %trap,
1230 the system prefers the one with the most specific eroute that
1231 includes the packet's source and destination IP addresses.
1232 Source subnets are examined before destination subnets.
1233 For initiating, only routed connections are considered. For responding,
1234 unrouted but added connections are considered.
1235 .PP
1236 When choosing a connection to use to respond to a negotiation which
1237 doesn't match an ordinary conn, an opportunistic connection
1238 may be instantiated. Eventually, its instance will be /32 -> /32, but
1239 for earlier stages of the negotiation, there will not be enough
1240 information about the client subnets to complete the instantiation.
1241 .SH FILES
1242 .nf
1243 /etc/ipsec.conf
1244 /etc/ipsec.d/aacerts
1245 /etc/ipsec.d/acerts
1246 /etc/ipsec.d/cacerts
1247 /etc/ipsec.d/certs
1248 /etc/ipsec.d/crls
1249
1250 .SH SEE ALSO
1251 ipsec(8), pluto(8), starter(8), ttoaddr(3), ttodata(3)
1252 .SH HISTORY
1253 Written  for  the  FreeS/WAN project by Henry Spencer.
1254 Extended for the strongSwan project
1255 <http://www.strongswan.org>
1256 by Andreas Steffen. IKEv2-specific features by Martin Willi.
1257 .SH BUGS
1258 .PP
1259 If conns are to be added before DNS is available, \fBleft=\fP\fIFQDN\fP
1260 will fail.