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