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