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