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