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