[strongswan.git] / src / starter / ipsec.conf.5
1 .TH IPSEC.CONF 5 "27 Jun 2007"
3 ipsec.conf \- IPsec configuration and connections
5 The optional
6 .I ipsec.conf
7 file
8 specifies most configuration and control information for the
9 strongSwan IPsec subsystem.
10 (The major exception is secrets for authentication;
11 see
12 .IR ipsec.secrets (5).)
13 Its contents are not security-sensitive.
14 .PP
15 The file is a text file, consisting of one or more
16 .IR sections .
17 White space followed by
18 .B #
19 followed by anything to the end of the line
20 is a comment and is ignored,
21 as are empty lines which are not within a section.
22 .PP
23 A line which contains
24 .B include
25 and a file name, separated by white space,
26 is replaced by the contents of that file,
27 preceded and followed by empty lines.
28 If the file name is not a full pathname,
29 it is considered to be relative to the directory containing the
30 including file.
31 Such inclusions can be nested.
32 Only a single filename may be supplied, and it may not contain white space,
33 but it may include shell wildcards (see
34 .IR sh (1));
35 for example:
36 .PP
37 .B include
38 .B "ipsec.*.conf"
39 .PP
40 The intention of the include facility is mostly to permit keeping
41 information on connections, or sets of connections,
42 separate from the main configuration file.
43 This permits such connection descriptions to be changed,
44 copied to the other security gateways involved, etc.,
45 without having to constantly extract them from the configuration
46 file and then insert them back into it.
47 Note also the
48 .B also
49 parameter (described below) which permits splitting a single logical
50 section (e.g. a connection description) into several actual sections.
51 .PP
52 A section
53 begins with a line of the form:
54 .PP
55 .I type
56 .I name
57 .PP
58 where
59 .I type
60 indicates what type of section follows, and
61 .I name
62 is an arbitrary name which distinguishes the section from others
63 of the same type.
64 (Names must start with a letter and may contain only
65 letters, digits, periods, underscores, and hyphens.)
66 All subsequent non-empty lines
67 which begin with white space are part of the section;
68 comments within a section must begin with white space too.
69 There may be only one section of a given type with a given name.
70 .PP
71 Lines within the section are generally of the form
72 .PP
73 \ \ \ \ \ \fIparameter\fB=\fIvalue\fR
74 .PP
75 (note the mandatory preceding white space).
76 There can be white space on either side of the
77 .BR = .
78 Parameter names follow the same syntax as section names,
79 and are specific to a section type.
80 Unless otherwise explicitly specified,
81 no parameter name may appear more than once in a section.
82 .PP
83 An empty
84 .I value
85 stands for the system default value (if any) of the parameter,
86 i.e. it is roughly equivalent to omitting the parameter line entirely.
87 A
88 .I value
89 may contain white space only if the entire
90 .I value
91 is enclosed in double quotes (\fB"\fR);
92 a
93 .I value
94 cannot itself contain a double quote,
95 nor may it be continued across more than one line.
96 .PP
97 Numeric values are specified to be either an ``integer''
98 (a sequence of digits) or a ``decimal number''
99 (sequence of digits optionally followed by `.' and another sequence of digits).
100 .PP
101 There is currently one parameter which is available in any type of
102 section:
103 .TP
104 .B also
105 the value is a section name;
106 the parameters of that section are appended to this section,
107 as if they had been written as part of it.
108 The specified section must exist, must follow the current one,
109 and must have the same section type.
110 (Nesting is permitted,
111 and there may be more than one
112 .B also
113 in a single section,
114 although it is forbidden to append the same section more than once.)
115 .PP
116 A section with name
117 .B %default
118 specifies defaults for sections of the same type.
119 For each parameter in it,
120 any section of that type which does not have a parameter of the same name
121 gets a copy of the one from the
122 .B %default
123 section.
124 There may be multiple
125 .B %default
126 sections of a given type,
127 but only one default may be supplied for any specific parameter name,
128 and all
129 .B %default
130 sections of a given type must precede all non-\c
131 .B %default
132 sections of that type.
133 .B %default
134 sections may not contain the
135 .B also
136 parameter.
137 .PP
138 Currently there are three types of sections:
139 a
140 .B config
141 section specifies general configuration information for IPsec, a
142 .B conn
143 section specifies an IPsec connection, while a
144 .B ca
145 section specifies special properties of a certification authority.
147 A
148 .B conn
149 section contains a
150 .IR "connection specification" ,
151 defining a network connection to be made using IPsec.
152 The name given is arbitrary, and is used to identify the connection.
153 Here's a simple example:
154 .PP
155 .ne 10
156 .nf
157 .ft B
158 .ta 1c
159 conn snt
160         left=
161         leftsubnet=
162         right=
163         rightsubnet=
164         keyingtries=%forever
165         auto=add
166 .ft
167 .fi
168 .PP
169 A note on terminology: There are two kinds of communications going on:
170 transmission of user IP packets, and gateway-to-gateway negotiations for
171 keying, rekeying, and general control.
172 The path to control the connection is called 'ISAKMP SA' in IKEv1 and
173 'IKE SA' in the IKEv2 protocol. That what is being negotiated, the kernel
174 level data path, is called 'IPsec SA'.
175 strongSwan currently uses two separate keying daemons. Pluto handles
176 all IKEv1 connections, Charon is the new daemon supporting the IKEv2 protocol.
177 Charon does not support all keywords yet.
178 .PP
179 To avoid trivial editing of the configuration file to suit it to each system
180 involved in a connection,
181 connection specifications are written in terms of
182 .I left
183 and
184 .I right
185 participants,
186 rather than in terms of local and remote.
187 Which participant is considered
188 .I left
189 or
190 .I right
191 is arbitrary;
192 IPsec figures out which one it is being run on based on internal information.
193 This permits using identical connection specifications on both ends.
194 There are cases where there is no symmetry; a good convention is to
195 use
196 .I left
197 for the local side and
198 .I right
199 for the remote side (the first letters are a good mnemonic).
200 .PP
201 Many of the parameters relate to one participant or the other;
202 only the ones for
203 .I left
204 are listed here, but every parameter whose name begins with
205 .B left
206 has a
207 .B right
208 counterpart,
209 whose description is the same but with
210 .B left
211 and
212 .B right
213 reversed.
214 .PP
215 Parameters are optional unless marked '(required)'.
217 Unless otherwise noted, for a connection to work,
218 in general it is necessary for the two ends to agree exactly
219 on the values of these parameters.
220 .TP 14
221 .B ah
222 AH authentication algorithm to be used
223 for the connection, e.g.
224 .B hmac-md5.
225 .TP
226 .B auth
227 whether authentication should be done as part of
228 ESP encryption, or separately using the AH protocol;
229 acceptable values are
230 .B esp
231 (the default) and
232 .BR ah .
233 The IKEv2 daemon currently supports only ESP.
234 .TP
235 .B authby
236 how the two security gateways should authenticate each other;
237 acceptable values are
238 .B secret
239 or
240 .B psk
241 for pre-shared secrets,
242 .B pubkey
243 (the default) for public key signatures as well as the synonyms
244 .B rsasig
245 for RSA digital signatures and
246 .B ecdsasig
247 for Elliptic Curve DSA signatures.
248 .B never
249 can be used if negotiation is never to be attempted or accepted (useful for
250 shunt-only conns).
251 Digital signatures are superior in every way to shared secrets.
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 This parameter is deprecated for IKEv2 connections, as two peers do not need
259 to agree on an authentication method. Use the
260 .B leftauth
261 parameter instead to define authentication methods in IKEv2.
262 .TP
263 .B auto
264 what operation, if any, should be done automatically at IPsec startup;
265 currently-accepted values are
266 .B add
267 ,
268 .B route
269 ,
270 .B start
271 and
272 .BR ignore .
273 .B add
274 loads a connection without starting it.
275 .B route
276 loads a connection and installs kernel traps. If traffic is detected between
277 .B leftsubnet
278 and
279 .B rightsubnet
280 , a connection is established.
281 .B start
282 loads a connection and brings it up immediatly.
283 .B ignore
284 ignores the connection. This is equal to delete a connection from the config
285 file.
286 Relevant only locally, other end need not agree on it
287 (but in general, for an intended-to-be-permanent connection,
288 both ends should use
289 .B auto=start
290 to ensure that any reboot causes immediate renegotiation).
291 .TP
292 .B compress
293 whether IPComp compression of content is proposed on the connection
294 (link-level compression does not work on encrypted data,
295 so to be effective, compression must be done \fIbefore\fR encryption);
296 acceptable values are
297 .B yes
298 and
299 .B no
300 (the default). A value of
301 .B yes
302 causes IPsec to propose both compressed and uncompressed,
303 and prefer compressed.
304 A value of
305 .B no
306 prevents IPsec from proposing compression;
307 a proposal to compress will still be accepted.
308 IKEv2 does not support IP compression yet.
309 .TP
310 .B dpdaction
311 controls the use of the Dead Peer Detection protocol (DPD, RFC 3706) where
312 R_U_THERE notification messages (IKEv1) or empty INFORMATIONAL messages (IKEv2)
313 are periodically sent in order to check the
314 liveliness of the IPsec peer. The values
315 .BR clear ,
316 .BR hold ,
317 and
318 .B restart
319 all activate DPD. If no activity is detected, all connections with a dead peer
320 are stopped and unrouted (
321 .B clear
322 ), put in the hold state (
323 .B hold
324 ) or restarted (
325 .B restart
326 ).
327 For IKEv1, the default is
328 .B none
329 which disables the active sending of R_U_THERE notifications.
330 Nevertheless pluto will always send the DPD Vendor ID during connection set up
331 in order to signal the readiness to act passively as a responder if the peer
332 wants to use DPD. For IKEv2,
333 .B none
334 does't make sense, since all messages are used to detect dead peers. If specified,
335 it has the same meaning as the default (
336 .B clear
337 ).
338 .TP
339 .B dpddelay
340 defines the period time interval with which R_U_THERE messages/INFORMATIONAL
341 exchanges are sent to the peer. These are only sent if no other traffic is
342 received. In IKEv2, a value of 0 sends no additional INFORMATIONAL
343 messages and uses only standard messages (such as those to rekey) to detect
344 dead peers.
345 .TP
346 .B dpdtimeout
347 defines the timeout interval, after which all connections to a peer are deleted
348 in case of inactivity. This only applies to IKEv1, in IKEv2 the default
349 retransmission timeout applies, as every exchange is used to detect dead peers.
350 .TP
351 .B inactivity
352 defines the timeout interval, after which a CHILD_SA is closed if it did
353 not send or receive any traffic. Currently supported in IKEv2 connections only.
354 .TP
355 .B eap
356 defines the EAP type to propose as server if the client requests EAP
357 authentication. This parameter is deprecated in the favour of
358 .B leftauth.
360 To forward EAP authentication to a RADIUS server using the EAP-RADIUS plugin,
361 set
362 .B eap=radius
363 .TP
364 .B eap_identity
365 defines the identity the client uses to reply to a EAP Identity request.
366 If defined on the EAP server, the defined identity will be used as peer
367 identity during EAP authentication. The special value
368 .B %identity
369 uses the EAP Identity method to ask the client for a EAP identity. If not
370 defined, the IKEv2 identity will be used as EAP identity.
371 .TP
372 .B esp
373 ESP encryption/authentication algorithm to be used
374 for the connection, e.g.
375 .B 3des-md5
376 (encryption-integrity-[dh-group]). If dh-group is specified, CHILD_SA setup
377 and rekeying include a separate diffe hellman exchange (IKEv2 only).
378 .TP
379 .B forceencaps
380 Force UDP encapsulation for ESP packets even if no NAT situation is detected.
381 This may help to hurdle restrictive firewalls. To enforce the peer to
382 encapsulate packets, NAT detection payloads are faked (IKEv2 only).
383 .TP
384 .B ike
385 IKE/ISAKMP SA encryption/authentication algorithm to be used, e.g.
386 .B aes128-sha1-modp2048
387 (encryption-integrity-dhgroup). In IKEv2, multiple algorithms and proposals
388 may be included, such as
389 .B aes128-aes256-sha1-modp1536-modp2048,3des-sha1-md5-modp1024.
390 .TP
391 .B ikelifetime
392 how long the keying channel of a connection ('ISAKMP/IKE SA')
393 should last before being renegotiated.
394 .TP
395 .B installpolicy
396 decides whether IPsec policies are installed in the kernel by the IKEv2
397 charon daemon for a given connection. Allows peaceful co-existence e.g. with
398 the Mobile IPv6 daemon mip6d who wants to control the kernel policies.
399 Acceptable values are
400 .B yes
401 (the default) and
402 .BR no .
403 .TP
404 .B keyexchange
405 method of key exchange;
406 which protocol should be used to initialize the connection. Connections marked with
407 .B ikev1
408 are initiated with pluto, those marked with
409 .B ikev2
410 with charon. An incoming request from the remote peer is handled by the correct
411 daemon, unaffected from the
412 .B keyexchange
413 setting. The default value
414 .B ike
415 currently behaves exactly as
416 .B ikev1.
417 .TP
418 .B keyingtries
419 how many attempts (a whole number or \fB%forever\fP) should be made to
420 negotiate a connection, or a replacement for one, before giving up
421 (default
422 .BR %forever ).
423 The value \fB%forever\fP
424 means 'never give up'.
425 Relevant only locally, other end need not agree on it.
426 .TP
427 .B keylife
428 synonym for
429 .BR lifetime .
430 .TP
431 .B left
432 (required)
433 the IP address of the left participant's public-network interface,
434 in any form accepted by
435 .IR ttoaddr (3)
436 or one of several magic values.
437 If it is
438 .BR %defaultroute ,
439 .B left
440 will be filled in automatically with the local address
441 of the default-route interface (as determined at IPsec startup time).
442 (Either
443 .B left
444 or
445 .B right
446 may be
447 .BR %defaultroute ,
448 but not both.)
449 The value
450 .B %any
451 signifies an address to be filled in (by automatic keying) during
452 negotiation. The prefix
453 .B  %
454 in front of a fully-qualified domain name or an IP address will implicitly set
455 .B leftallowany=yes.
456 If the domain name cannot be resolved into an IP address at IPsec startup or update time
457 then
458 .B left=%any
459 and
460 .B leftallowany=no
461 will be assumed.
462 .TP
463 .B leftallowany
464 a modifier for
465 .B left
466 , making it behave as
467 .B %any
468 although a concrete IP address has been assigned.
469 Recommended for dynamic IP addresses that can be resolved by DynDNS at IPsec startup or
470 update time.
471 Acceptable values are
472 .B yes
473 and
474 .B no
475 (the default).
476 .TP
477 .B leftauth
478 Authentication method to use (local) or require (remote) in this connection.
479 This parameter is supported in IKEv2 only. Acceptable values are
480 .B pubkey
481 for public key authentication (RSA/ECDSA),
482 .B psk
483 for pre-shared key authentication and
484 .B eap
485 to (require the) use of the Extensible Authentication Protocol. In the case
486 of
487 .B eap,
488 an optional EAP method can be appended. Currently defined methods are
489 .B eap-aka, eap-sim, eap-gtc, eap-md5
490 and
491 .B eap-mschapv2.
492 Alternatively, IANA assigned EAP method numbers are accepted. Vendor specific
493 EAP methods are defined in the form
494 .B eap-type-vendor
495 (e.g.
496 .B eap-7-12345
497 ).
498 .TP
499 .B leftauth2
500 Same as
501 .B leftauth,
502 but defines an additional authentication exchange. IKEv2 supports multiple
503 authentication rounds using "Multiple Authentication Exchanges" defined
504 in RFC4739. This allows, for example, separated authentication
505 of host and user (IKEv2 only).
506 .TP
507 .B leftca
508 the distinguished name of a certificate authority which is required to
509 lie in the trust path going from the left participant's certificate up
510 to the root certification authority.
511 .TP
512 .B leftca2
513 Same as
514 .B leftca,
515 but for the second authentication round (IKEv2 only).
516 .TP
517 .B leftcert
518 the path to the left participant's X.509 certificate. The file can be coded either in
519 PEM or DER format. OpenPGP certificates are supported as well.
520 Both absolute paths or paths relative to \fI/etc/ipsec.d/certs\fP
521 are accepted. By default
522 .B leftcert
523 sets
524 .B leftid
525 to the distinguished name of the certificate's subject and
526 .B leftca
527 to the distinguished name of the certificate's issuer.
528 The left participant's ID can be overriden by specifying a
529 .B leftid
530 value which must be certified by the certificate, though.
531 .TP
532 .B leftcert2
533 Same as
534 .B leftcert,
535 but for the second authentication round (IKEv2 only).
536 .TP
537 .B leftfirewall
538 whether the left participant is doing forwarding-firewalling
539 (including masquerading) using iptables for traffic from \fIleftsubnet\fR,
540 which should be turned off (for traffic to the other subnet)
541 once the connection is established;
542 acceptable values are
543 .B yes
544 and
545 .B no
546 (the default).
547 May not be used in the same connection description with
548 .BR leftupdown .
549 Implemented as a parameter to the default \fBipsec _updown\fR script.
550 See notes below.
551 Relevant only locally, other end need not agree on it.
553 If one or both security gateways are doing forwarding firewalling
554 (possibly including masquerading),
555 and this is specified using the firewall parameters,
556 tunnels established with IPsec are exempted from it
557 so that packets can flow unchanged through the tunnels.
558 (This means that all subnets connected in this manner must have
559 distinct, non-overlapping subnet address blocks.)
560 This is done by the default \fBipsec _updown\fR script (see
561 .IR pluto (8)).
563 In situations calling for more control,
564 it may be preferable for the user to supply his own
565 .I updown
566 script,
567 which makes the appropriate adjustments for his system.
568 .TP
569 .B leftgroups
570 a comma separated list of group names. If the
571 .B leftgroups
572 parameter is present then the peer must be a member of at least one
573 of the groups defined by the parameter. Group membership must be certified
574 by a valid attribute certificate stored in \fI/etc/ipsec.d/acerts/\fP thas has been
575 issued to the peer by a trusted Authorization Authority stored in
576 \fI/etc/ipsec.d/aacerts/\fP. Attribute certificates are not supported in IKEv2 yet.
577 .TP
578 .B lefthostaccess
579 inserts a pair of INPUT and OUTPUT iptables rules using the default
580 \fBipsec _updown\fR script, thus allowing access to the host itself
581 in the case where the host's internal interface is part of the
582 negotiated client subnet.
583 Acceptable values are
584 .B yes
585 and
586 .B no
587 (the default).
588 .TP
589 .B leftid
590 how
591 the left participant
592 should be identified for authentication;
593 defaults to
594 .BR left .
595 Can be an IP address (in any
596 .IR ttoaddr (3)
597 syntax)
598 or a fully-qualified domain name preceded by
599 .B @
600 (which is used as a literal string and not resolved).
601 .TP
602 .B leftid2
603 identity to use for a second authentication for the left participant
604 (IKEv2 only); defaults to
605 .BR leftid .
606 .TP
607 .B leftnexthop
608 this parameter is not needed any more because the NETKEY IPsec stack does
609 not require explicit routing entries for the traffic to be tunneled.
610 .TP
611 .B leftprotoport
612 restrict the traffic selector to a single protocol and/or port.
613 Examples:
614 .B leftprotoport=tcp/http
615 or
616 .B leftprotoport=6/80
617 or
618 .B leftprotoport=udp
619 .TP
620 .B leftrsasigkey
621 the left participant's
622 public key for RSA signature authentication,
623 in RFC 2537 format using
624 .IR ttodata (3)
625 encoding.
626 The magic value
627 .B %none
628 means the same as not specifying a value (useful to override a default).
629 The value
630 .B %cert
631 (the default)
632 means that the key is extracted from a certificate.
633 The identity used for the left participant
634 must be a specific host, not
635 .B %any
636 or another magic value.
637 .B Caution:
638 if two connection descriptions
639 specify different public keys for the same
640 .BR leftid ,
641 confusion and madness will ensue.
642 .TP
643 .B leftsendcert
644 Accepted values are
645 .B never
646 or
647 .BR no ,
648 .B always
649 or
650 .BR yes ,
651 and
652 .BR ifasked .
653 .TP
654 .B leftsourceip
655 The internal source IP to use in a tunnel, also known as virtual IP. If the
656 value is
657 .BR %modeconfig ,
658 .BR %modecfg ,
659 .BR %config ,
660 or
661 .B %cfg,
662 an address is requested from the peer. In IKEv2, a defined address is requested,
663 but the server may change it. If the server does not support it, the address
664 is enforced.
665 .TP
666 .B rightsourceip
667 The internal source IP to use in a tunnel for the remote peer. If the
668 value is
669 .B %config
670 on the responder side, the initiator must propose a address which is then echoed
671 back. The IKEv2 daemon also supports address pools expressed as
672 \fInetwork\fB/\fInetmask\fR
673 or the use of an external IP address pool using %\fIpoolname\fR
674 , where \fIpoolname\fR is the name of the IP address pool used for the lookup.
675 .TP
676 .B leftsubnet
677 private subnet behind the left participant, expressed as
678 \fInetwork\fB/\fInetmask\fR
679 (actually, any form acceptable to
680 .IR ttosubnet (3));
681 if omitted, essentially assumed to be \fIleft\fB/32\fR,
682 signifying that the left end of the connection goes to the left participant
683 only. When using IKEv2, the configured subnet of the peers may differ, the
684 protocol narrows it to the greatest common subnet. Further, IKEv2 supports
685 multiple subnets separated by commas. IKEv1 only interprets the first subnet
686 of such a definition.
687 .TP
688 .B leftsubnetwithin
689 the peer can propose any subnet or single IP address that fits within the
690 range defined by
691 .BR leftsubnetwithin.
692 Not relevant for IKEv2, as subnets are narrowed.
693 .TP
694 .B leftupdown
695 what ``updown'' script to run to adjust routing and/or firewalling
696 when the status of the connection
697 changes (default
698 .BR "ipsec _updown" ).
699 May include positional parameters separated by white space
700 (although this requires enclosing the whole string in quotes);
701 including shell metacharacters is unwise.
702 See
703 .IR pluto (8)
704 for details.
705 Relevant only locally, other end need not agree on it. IKEv2 uses the updown
706 script to insert firewall rules only. Routing is not support and will be
707 implemented directly into Charon.
708 .TP
709 .B lifebytes
710 the number of bytes transmitted over an IPsec SA before it expires (IKEv2
711 only).
712 .TP
713 .B lifepackets
714 the number of packets transmitted over an IPsec SA before it expires (IKEv2
715 only).
716 .TP
717 .B lifetime
718 how long a particular instance of a connection
719 (a set of encryption/authentication keys for user packets) should last,
720 from successful negotiation to expiry;
721 acceptable values are an integer optionally followed by
722 .BR s
723 (a time in seconds)
724 or a decimal number followed by
725 .BR m ,
726 .BR h ,
727 or
728 .B d
729 (a time
730 in minutes, hours, or days respectively)
731 (default
732 .BR 1h ,
733 maximum
734 .BR 24h ).
735 Normally, the connection is renegotiated (via the keying channel)
736 before it expires (see
737 .BR margintime ).
738 The two ends need not exactly agree on
739 .BR lifetime ,
740 although if they do not,
741 there will be some clutter of superseded connections on the end
742 which thinks the lifetime is longer.
743 .TP
744 .B marginbytes
745 how many bytes before IPsec SA expiry (see
746 .BR lifebytes )
747 should attempts to negotiate a replacement begin (IKEv2 only).
748 .TP
749 .B marginpackets
750 how many packets before IPsec SA expiry (see
751 .BR lifepackets )
752 should attempts to negotiate a replacement begin (IKEv2 only).
753 .TP
754 .B margintime
755 how long before connection expiry or keying-channel expiry
756 should attempts to
757 negotiate a replacement
758 begin; acceptable values as for
759 .B lifetime
760 (default
761 .BR 9m ).
762 Relevant only locally, other end need not agree on it.
763 .TP
764 .B mobike
765 enables the IKEv2 MOBIKE protocol defined by RFC 4555. Accepted values are
766 .B yes
767 (the default) and
768 .BR no .
769 If set to
770 .BR no ,
771 the IKEv2 charon daemon will not actively propose MOBIKE as initiator and
772 ignore the MOBIKE_SUPPORTED notify as responder.
773 .TP
774 .B modeconfig
775 defines which mode is used to assign a virtual IP.
776 Accepted values are
777 .B push
778 and
779 .B pull
780 (the default).
781 Currently relevant for IKEv1 only since IKEv2 always uses the configuration
782 payload in pull mode.
783 .TP
784 .B pfs
785 whether Perfect Forward Secrecy of keys is desired on the connection's
786 keying channel
787 (with PFS, penetration of the key-exchange protocol
788 does not compromise keys negotiated earlier);
789 acceptable values are
790 .B yes
791 (the default)
792 and
793 .BR no.
794 IKEv2 always uses PFS for IKE_SA rekeying whereas for CHILD_SA rekeying
795 PFS is enforced by defining a Diffie-Hellman modp group in the
796 .B esp
797 parameter.
798 .TP
799 .B pfsgroup
800 defines a Diffie-Hellman group for perfect forward secrecy in IKEv1 Quick Mode
801 differing from the DH group used for IKEv1 Main Mode (IKEv1 only).
802 .TP
803 .B reauth
804 whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1,
805 reauthentication is always done. In IKEv2, a value of
806 .B no
807 rekeys without uninstalling the IPsec SAs, a value of
808 .B yes
809 (the default) creates a new IKE_SA from scratch and tries to recreate
810 all IPsec SAs.
811 .TP
812 .B rekey
813 whether a connection should be renegotiated when it is about to expire;
814 acceptable values are
815 .B yes
816 (the default)
817 and
818 .BR no .
819 The two ends need not agree, but while a value of
820 .B no
821 prevents Pluto/Charon from requesting renegotiation,
822 it does not prevent responding to renegotiation requested from the other end,
823 so
824 .B no
825 will be largely ineffective unless both ends agree on it.
826 .TP
827 .B rekeyfuzz
828 maximum percentage by which
829 .BR marginbytes ,
830 .B marginpackets
831 and
832 .B margintime
833 should be randomly increased to randomize rekeying intervals
834 (important for hosts with many connections);
835 acceptable values are an integer,
836 which may exceed 100,
837 followed by a `%'
838 (defaults to
839 .BR 100% ).
840 The value of
841 .BR marginTYPE ,
842 after this random increase,
843 must not exceed
844 .B lifeTYPE
845 (where TYPE is one of
846 .IR bytes ,
847 .I packets
848 or
849 .IR time ).
850 The value
851 .B 0%
852 will suppress randomization.
853 Relevant only locally, other end need not agree on it.
854 .TP
855 .B rekeymargin
856 synonym for
857 .BR margintime .
858 .TP
859 .B type
860 the type of the connection; currently the accepted values
861 are
862 .B tunnel
863 (the default)
864 signifying a host-to-host, host-to-subnet, or subnet-to-subnet tunnel;
865 .BR transport ,
866 signifying host-to-host transport mode;
867 .BR transport_proxy ,
868 signifying the special Mobile IPv6 transport proxy mode;
869 .BR passthrough ,
870 signifying that no IPsec processing should be done at all;
871 .BR drop ,
872 signifying that packets should be discarded; and
873 .BR reject ,
874 signifying that packets should be discarded and a diagnostic ICMP returned.
875 Charon currently supports
876 .BR tunnel ,
877 .BR transport ,
878 and
879 .BR tunnel_proxy
880 connection types, only .
881 .TP
882 .B xauth
883 specifies the role in the XAUTH protocol if activated by
884 .B authby=xauthpsk
885 or
886 .B authby=xauthrsasig.
887 Accepted values are
888 .B server
889 and
890 .B client
891 (the default).
894 The following parameters are relevant to IKEv2 Mediation Extension
895 operation only.
896 .TP 14
897 .B mediation
898 whether this connection is a mediation connection, ie. whether this
899 connection is used to mediate other connections.  Mediation connections
900 create no child SA. Acceptable values are
901 .B no
902 (the default) and
903 .BR yes .
904 .TP
905 .B mediated_by
906 the name of the connection to mediate this connection through.  If given,
907 the connection will be mediated through the named mediation connection.
908 The mediation connection must set
909 .BR mediation=yes .
910 .TP
911 .B me_peerid
912 ID as which the peer is known to the mediation server, ie. which the other
913 end of this connection uses as its
914 .B leftid
915 on its connection to the mediation server.  This is the ID we request the
916 mediation server to mediate us with.  If
917 .B me_peerid
918 is not given, the
919 .B rightid
920 of this connection will be used as peer ID.
923 This are optional sections that can be used to assign special
924 parameters to a Certification Authority (CA). These parameters are not
925 supported in IKEv2 yet.
926 .TP 10
927 .B auto
928 currently can have either the value
929 .B ignore
930 or
931 .B add
932 .
933 .TP
934 .B cacert
935 defines a path to the CA certificate either relative to
936 \fI/etc/ipsec.d/cacerts\fP or as an absolute path.
937 .TP
938 .B crluri
939 defines a CRL distribution point (ldap, http, or file URI)
940 .TP
941 .B crluri1
942 synonym for
943 .B crluri.
944 .TP
945 .B crluri2
946 defines an alternative CRL distribution point (ldap, http, or file URI)
947 .TP
948 .B ldaphost
949 defines an ldap host. Currently used by IKEv1 only.
950 .TP
951 .B ocspuri
952 defines an OCSP URI.
953 .TP
954 .B ocspuri1
955 synonym for
956 .B ocspuri.
957 .TP
958 .B ocspuri2
959 defines an alternative OCSP URI. Currently used by IKEv2 only.
960 .B certuribase
961 defines the base URI for the Hash and URL feature supported by IKEv2.
962 Instead of exchanging complete certificates, IKEv2 allows to send an URI
963 that resolves to the DER encoded certificate. The certificate URIs are built
964 by appending the SHA1 hash of the DER encoded certificates to this base URI.
966 At present, the only
967 .B config
968 section known to the IPsec software is the one named
969 .BR setup ,
970 which contains information used when the software is being started
971 (see
972 .IR starter (8)).
973 Here's an example:
974 .PP
975 .ne 8
976 .nf
977 .ft B
978 .ta 1c
979 config setup
980         plutodebug=all
981         crlcheckinterval=10m
982         strictcrlpolicy=yes
983 .ft
984 .fi
985 .PP
986 Parameters are optional unless marked ``(required)''.
987 The currently-accepted
988 .I parameter
989 names in a
990 .B config
991 .B setup
992 section affecting both daemons are:
993 .TP 14
994 .B cachecrls
995 certificate revocation lists (CRLs) fetched via http or ldap will be cached in
996 \fI/etc/ipsec.d/crls/\fR under a unique file name derived from the certification
997 authority's public key.
998 Accepted values are
999 .B yes
1000 and
1001 .B no
1002 (the default).
1003 .TP
1004 .B charonstart
1005 whether to start the IKEv2 Charon daemon or not.
1006 Accepted values are
1007 .B yes
1008 or
1009 .BR no .
1010 The default is
1011 .B yes
1012 if starter was compiled with IKEv2 support.
1013 .TP
1014 .B dumpdir
1015 in what directory should things started by \fBipsec starter\fR
1016 (notably the Pluto and Charon daemons) be allowed to dump core?
1017 The empty value (the default) means they are not
1018 allowed to.
1019 This feature is currently not yet supported by \fBipsec starter\fR.
1020 .TP
1021 .B plutostart
1022 whether to start the IKEv1 Pluto daemon or not.
1023 Accepted values are
1024 .B yes
1025 or
1026 .BR no .
1027 The default is
1028 .B yes
1029 if starter was compiled with IKEv1 support.
1030 .TP
1031 .B strictcrlpolicy
1032 defines if a fresh CRL must be available in order for the peer authentication based
1033 on RSA signatures to succeed.
1034 Accepted values are
1035 .B yes
1036 and
1037 .B no
1038 (the default).
1039 IKEv2 additionally recognizes
1040 .B ifuri
1041 which reverts to
1042 .B yes
1043 if at least one CRL URI is defined and to
1044 .B no
1045 if no URI is known.
1046 .TP
1047 .B uniqueids
1048 whether a particular participant ID should be kept unique,
1049 with any new (automatically keyed)
1050 connection using an ID from a different IP address
1051 deemed to replace all old ones using that ID;
1052 acceptable values are
1053 .B yes
1054 (the default)
1055 and
1056 .BR no .
1057 Participant IDs normally \fIare\fR unique,
1058 so a new (automatically-keyed) connection using the same ID is
1059 almost invariably intended to replace an old one.
1060 The IKEv2 daemon also accepts the value
1061 .B replace
1062 wich is identical to
1063 .B yes
1064 and the value
1065 .B keep
1066 to reject new IKE_SA setups and keep the duplicate established earlier.
1067 .PP
1068 The following
1069 .B config section
1070 parameters are used by the IKEv1 Pluto daemon only:
1071 .TP
1072 .B crlcheckinterval
1073 interval in seconds. CRL fetching is enabled if the value is greater than zero.
1074 Asynchronous, periodic checking for fresh CRLs is currently done by the
1075 IKEv1 Pluto daemon only.
1076 .TP
1077 .B keep_alive
1078 interval in seconds between NAT keep alive packets, the default being 20 seconds.
1079 .TP
1080 .B nat_traversal
1081 activates NAT traversal by accepting source ISAKMP ports different from udp/500 and
1082 being able of floating to udp/4500 if a NAT situation is detected.
1083 Accepted values are
1084 .B yes
1085 and
1086 .B no
1087 (the default).
1088 Used by IKEv1 only, NAT traversal always being active in IKEv2.
1089 .TP
1090 .B nocrsend
1091 no certificate request payloads will be sent.
1092 Accepted values are
1093 .B yes
1094 and
1095 .B no
1096 (the default).
1097 .TP
1098 .B pkcs11initargs
1099 non-standard argument string for PKCS#11 C_Initialize() function;
1100 required by NSS softoken.
1101 .TP
1102 .B pkcs11module
1103 defines the path to a dynamically loadable PKCS #11 library.
1104 .TP
1105 .B pkcs11keepstate
1106 PKCS #11 login sessions will be kept during the whole lifetime of the keying
1107 daemon. Useful with pin-pad smart card readers.
1108 Accepted values are
1109 .B yes
1110 and
1111 .B no
1112 (the default).
1113 .TP
1114 .B pkcs11proxy
1115 Pluto will act as a PKCS #11 proxy accessible via the whack interface.
1116 Accepted values are
1117 .B yes
1118 and
1119 .B no
1120 (the default).
1121 .TP
1122 .B plutodebug
1123 how much Pluto debugging output should be logged.
1124 An empty value,
1125 or the magic value
1126 .BR none ,
1127 means no debugging output (the default).
1128 The magic value
1129 .B all
1130 means full output.
1131 Otherwise only the specified types of output
1132 (a quoted list, names without the
1133 .B \-\-debug\-
1134 prefix,
1135 separated by white space) are enabled;
1136 for details on available debugging types, see
1137 .IR pluto (8).
1138 .TP
1139 .B plutostderrlog
1140 Pluto will not use syslog, but rather log to stderr, and redirect stderr
1141 to the argument file.
1142 .TP
1143 .B postpluto
1144 shell command to run after starting Pluto
1145 (e.g., to remove a decrypted copy of the
1146 .I ipsec.secrets
1147 file).
1148 It's run in a very simple way;
1149 complexities like I/O redirection are best hidden within a script.
1150 Any output is redirected for logging,
1151 so running interactive commands is difficult unless they use
1152 .I /dev/tty
1153 or equivalent for their interaction.
1154 Default is none.
1155 .TP
1156 .B prepluto
1157 shell command to run before starting Pluto
1158 (e.g., to decrypt an encrypted copy of the
1159 .I ipsec.secrets
1160 file).
1161 It's run in a very simple way;
1162 complexities like I/O redirection are best hidden within a script.
1163 Any output is redirected for logging,
1164 so running interactive commands is difficult unless they use
1165 .I /dev/tty
1166 or equivalent for their interaction.
1167 Default is none.
1168 .TP
1169 .B virtual_private
1170 defines private networks using a wildcard notation.
1171 .PP
1172 The following
1173 .B config section
1174 parameters are used by the IKEv2 Charon daemon only:
1175 .TP
1176 .B charondebug
1177 how much Charon debugging output should be logged.
1178 A comma separated list containing type level/pairs may
1179 be specified, e.g:
1180 .B dmn 3, ike 1, net -1.
1181 Acceptable values for types are
1182 .B dmn, mgr, ike, chd, job, cfg, knl, net, enc, lib
1183 and the level is one of
1184 .B -1, 0, 1, 2, 3, 4
1185 (for silent, audit, control, controlmore, raw, private).
1186 .PP
1187 The following
1188 .B config section
1189 parameters only make sense if the KLIPS IPsec stack
1190 is used instead of the default NETKEY stack of the Linux 2.6 kernel:
1191 .TP
1192 .B fragicmp
1193 whether a tunnel's need to fragment a packet should be reported
1194 back with an ICMP message,
1195 in an attempt to make the sender lower his PMTU estimate;
1196 acceptable values are
1197 .B yes
1198 (the default)
1199 and
1200 .BR no .
1201 .TP
1202 .B hidetos
1203 whether a tunnel packet's TOS field should be set to
1204 .B 0
1205 rather than copied from the user packet inside;
1206 acceptable values are
1207 .B yes
1208 (the default)
1209 and
1210 .BR no
1211 .TP
1212 .B interfaces
1213 virtual and physical interfaces for IPsec to use:
1214 a single
1215 \fIvirtual\fB=\fIphysical\fR pair, a (quoted!) list of pairs separated
1216 by white space, or
1217 .BR %none .
1218 One of the pairs may be written as
1219 .BR %defaultroute ,
1220 which means: find the interface \fId\fR that the default route points to,
1221 and then act as if the value was ``\fBipsec0=\fId\fR''.
1222 .B %defaultroute
1223 is the default;
1224 .B %none
1225 must be used to denote no interfaces.
1226 .TP
1227 .B overridemtu
1228 value that the MTU of the ipsec\fIn\fR interface(s) should be set to,
1229 overriding IPsec's (large) default.
1231 .PP
1232 When choosing a connection to apply to an outbound packet caught with a
1233 .BR %trap,
1234 the system prefers the one with the most specific eroute that
1235 includes the packet's source and destination IP addresses.
1236 Source subnets are examined before destination subnets.
1237 For initiating, only routed connections are considered. For responding,
1238 unrouted but added connections are considered.
1239 .PP
1240 When choosing a connection to use to respond to a negotiation which
1241 doesn't match an ordinary conn, an opportunistic connection
1242 may be instantiated. Eventually, its instance will be /32 -> /32, but
1243 for earlier stages of the negotiation, there will not be enough
1244 information about the client subnets to complete the instantiation.
1245 .SH FILES
1246 .nf
1247 /etc/ipsec.conf
1248 /etc/ipsec.d/aacerts
1249 /etc/ipsec.d/acerts
1250 /etc/ipsec.d/cacerts
1251 /etc/ipsec.d/certs
1252 /etc/ipsec.d/crls
1255 ipsec(8), pluto(8), starter(8), ttoaddr(3), ttodata(3)
1257 Written  for  the  FreeS/WAN project by Henry Spencer.
1258 Extended for the strongSwan project
1259 <http://www.strongswan.org>
1260 by Andreas Steffen. IKEv2-specific features by Martin Willi.
1261 .SH BUGS
1262 .PP
1263 If conns are to be added before DNS is available, \fBleft=\fP\fIFQDN\fP
1264 will fail.