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