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