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