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