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