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