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