Documentation for eap-dynamic added
[strongswan.git] / man / ipsec.conf.5.in
1 .TH IPSEC.CONF 5 "2012-06-26" "@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 previously used two separate keying daemons, \fIpluto\fP and
176 \fIcharon\fP. This manual does not discuss \fIpluto\fP options anymore, but
177 only \fIcharon\fP that since strongSwan 5.0 supports both IKEv1 and IKEv2.
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 authby " = " pubkey " | rsasig | ecdsasig | psk | secret | never | xauthpsk | xauthrsasig"
241 how the two security gateways should authenticate each other;
242 acceptable values are
243 .B psk
244 or
245 .B secret
246 for pre-shared secrets,
247 .B pubkey
248 (the default) for public key signatures as well as the synonyms
249 .B rsasig
250 for RSA digital signatures and
251 .B ecdsasig
252 for Elliptic Curve DSA signatures.
253 .B never
254 can be used if negotiation is never to be attempted or accepted (useful for
255 shunt-only conns).
256 Digital signatures are superior in every way to shared secrets.
257 IKEv1 additionally supports the values
258 .B xauthpsk
259 and
260 .B xauthrsasig
261 that will enable eXtended AUTHentication (XAUTH) in addition to IKEv1 main mode
262 based on shared secrets or digital RSA signatures, respectively.
263 This parameter is deprecated, as two peers do not need to agree on an
264 authentication method in IKEv2. Use the
265 .B leftauth
266 parameter instead to define authentication methods.
267 .TP
268 .BR auto " = " ignore " | add | route | start"
269 what operation, if any, should be done automatically at IPsec startup;
270 currently-accepted values are
271 .BR add ,
272 .BR route ,
273 .B start
274 and
275 .B ignore
276 (the default).
277 .B add
278 loads a connection without starting it.
279 .B route
280 loads a connection and installs kernel traps. If traffic is detected between
281 .B leftsubnet
282 and
283 .B rightsubnet
284 , a connection is established.
285 .B start
286 loads a connection and brings it up immediately.
287 .B ignore
288 ignores the connection. This is equal to delete a connection from the config
289 file.
290 Relevant only locally, other end need not agree on it.
291 .TP
292 .BR closeaction " = " none " | clear | hold | restart"
293 defines the action to take if the remote peer unexpectedly closes a CHILD_SA
294 (see
295 .B dpdaction
296 for meaning of values).
297 A
298 .B closeaction should not be
299 used if the peer uses reauthentication or uniquids checking, as these events
300 might trigger the defined action when not desired. Currently not supported with
301 IKEv1.
302 .TP
303 .BR compress " = yes | " no
304 whether IPComp compression of content is proposed on the connection
305 (link-level compression does not work on encrypted data,
306 so to be effective, compression must be done \fIbefore\fR encryption);
307 acceptable values are
308 .B yes
309 and
310 .B no
311 (the default). A value of
312 .B yes
313 causes the daemon to propose both compressed and uncompressed,
314 and prefer compressed.
315 A value of
316 .B no
317 prevents the daemon from proposing or accepting compression.
318 .TP
319 .BR dpdaction " = " none " | clear | hold | restart"
320 controls the use of the Dead Peer Detection protocol (DPD, RFC 3706) where
321 R_U_THERE notification messages (IKEv1) or empty INFORMATIONAL messages (IKEv2)
322 are periodically sent in order to check the
323 liveliness of the IPsec peer. The values
324 .BR clear ,
325 .BR hold ,
326 and
327 .B restart
328 all activate DPD. If no activity is detected, all connections with a dead peer
329 are stopped and unrouted
330 .RB ( clear ),
331 put in the hold state
332 .RB ( hold )
333 or restarted
334 .RB ( restart ).
335 The default is
336 .B none
337 which disables the active sending of DPD messages.
338 .TP
339 .BR dpddelay " = " 30s " | <time>"
340 defines the period time interval with which R_U_THERE messages/INFORMATIONAL
341 exchanges are sent to the peer. These are only sent if no other traffic is
342 received. In IKEv2, a value of 0 sends no additional INFORMATIONAL
343 messages and uses only standard messages (such as those to rekey) to detect
344 dead peers.
345 .TP
346 .BR dpdtimeout " = " 150s " | <time>
347 defines the timeout interval, after which all connections to a peer are deleted
348 in case of inactivity. This only applies to IKEv1, in IKEv2 the default
349 retransmission timeout applies, as every exchange is used to detect dead peers.
350 .TP
351 .BR inactivity " = <time>"
352 defines the timeout interval, after which a CHILD_SA is closed if it did
353 not send or receive any traffic.
354 .TP
355 .BR eap_identity " = <id>"
356 defines the identity the client uses to reply to a EAP Identity request.
357 If defined on the EAP server, the defined identity will be used as peer
358 identity during EAP authentication. The special value
359 .B %identity
360 uses the EAP Identity method to ask the client for an EAP identity. If not
361 defined, the IKEv2 identity will be used as EAP identity.
362 .TP
363 .BR esp " = <cipher suites>"
364 comma-separated list of ESP encryption/authentication algorithms to be used
365 for the connection, e.g.
366 .BR aes128-sha256 .
367 The notation is
368 .BR encryption-integrity[-dhgroup][-esnmode] .
369 .br
370 Defaults to
371 .BR aes128-sha1,3des-sha1 .
372 The daemon adds its extensive default proposal to this default
373 or the configured value.  To restrict it to the configured proposal an
374 exclamation mark
375 .RB ( ! )
376 can be added at the end.
377 .br
378 .BR Note :
379 As a responder the daemon accepts the first supported proposal received from
380 the peer. In order to restrict a responder to only accept specific cipher
381 suites, the strict flag
382 .RB ( ! ,
383 exclamation mark) can be used, e.g: aes256-sha512-modp4096!
384 .br
385 If
386 .B dh-group
387 is specified, CHILD_SA/Quick Mode setup and rekeying include a separate
388 Diffie-Hellman exchange.  Valid values for
389 .B esnmode
390 (IKEv2 only) are
391 .B esn
392 and
393 .BR noesn .
394 Specifying both negotiates Extended Sequence Number support with the peer,
395 the default is
396 .B noesn.
397 .TP
398 .BR forceencaps " = yes | " no
399 force UDP encapsulation for ESP packets even if no NAT situation is detected.
400 This may help to surmount restrictive firewalls. In order to force the peer to
401 encapsulate packets, NAT detection payloads are faked.
402 .TP
403 .BR ike " = <cipher suites>"
404 comma-separated list of IKE/ISAKMP SA encryption/authentication algorithms
405 to be used, e.g.
406 .BR aes128-sha1-modp2048 .
407 The notation is
408 .BR encryption-integrity-dhgroup .
409 In IKEv2, multiple algorithms and proposals may be included, such as
410 aes128-aes256-sha1-modp1536-modp2048,3des-sha1-md5-modp1024.
411 .br
412 Defaults to
413 .B aes128-sha1-modp2048,3des-sha1-modp1536 .
414 The daemon adds its extensive default proposal to this
415 default or the configured value.  To restrict it to the configured proposal an
416 exclamation mark
417 .RB ( ! )
418 can be added at the end.
419 .br
420 .BR Note :
421 As a responder the daemon accepts the first supported proposal received from
422 the peer.  In order to restrict a responder to only accept specific cipher
423 suites, the strict flag
424 .BR ( ! ,
425 exclamation mark) can be used, e.g: aes256-sha512-modp4096!
426 .TP
427 .BR ikelifetime " = " 3h " | <time>"
428 how long the keying channel of a connection (ISAKMP or IKE SA)
429 should last before being renegotiated. Also see EXPIRY/REKEY below.
430 .TP
431 .BR installpolicy " = " yes " | no"
432 decides whether IPsec policies are installed in the kernel by the charon daemon
433 for a given connection. Allows peaceful cooperation e.g. with
434 the Mobile IPv6 daemon mip6d who wants to control the kernel policies.
435 Acceptable values are
436 .B yes
437 (the default) and
438 .BR no .
439 .TP
440 .BR keyexchange " = " ike " | ikev1 | ikev2"
441 method of key exchange;
442 which protocol should be used to initialize the connection. Connections marked with
443 .B ike
444 use IKEv2 when initiating, but accept any protocol version when responding.
445 .TP
446 .BR keyingtries " = " 3 " | <number> | %forever"
447 how many attempts (a whole number or \fB%forever\fP) should be made to
448 negotiate a connection, or a replacement for one, before giving up
449 (default
450 .BR 3 ).
451 The value \fB%forever\fP
452 means 'never give up'.
453 Relevant only locally, other end need not agree on it.
454 .TP
455 .B keylife
456 synonym for
457 .BR lifetime .
458 .TP
459 .BR left " = <ip address> | <fqdn> | " %any
460 (required)
461 the IP address of the left participant's public-network interface
462 or one of several magic values.
463 The value
464 .B %any
465 for the local endpoint signifies an address to be filled in (by automatic
466 keying) during negotiation. If the local peer initiates the connection setup
467 the routing table will be queried to determine the correct local IP address.
468 In case the local peer is responding to a connection setup then any IP address
469 that is assigned to a local interface will be accepted.
470
471 The prefix
472 .B %
473 in front of a fully-qualified domain name or an IP address will implicitly set
474 .BR leftallowany =yes.
475
476 If
477 .B %any
478 is used for the remote endpoint it literally means any IP address.
479
480 Please note that with the usage of wildcards multiple connection descriptions
481 might match a given incoming connection attempt. The most specific description
482 is used in that case.
483 .TP
484 .BR leftallowany " = yes | " no
485 a modifier for
486 .BR left ,
487 making it behave as
488 .B %any
489 although a concrete IP address or domain name has been assigned.
490 .TP
491 .BR leftauth " = <auth method>"
492 Authentication method to use locally (left) or require from the remote (right)
493 side.
494 Acceptable values are
495 .B pubkey
496 for public key authentication (RSA/ECDSA),
497 .B psk
498 for pre-shared key authentication,
499 .B eap
500 to (require the) use of the Extensible Authentication Protocol in IKEv2, and
501 .B xauth
502 for IKEv1 eXtended Authentication.
503 To require a trustchain public key strength for the remote side, specify the
504 key type followed by the minimum strength in bits (for example
505 .BR ecdsa-384
506 or
507 .BR rsa-2048-ecdsa-256 ).
508 To limit the acceptable set of hashing algorithms for trustchain validation,
509 append hash algorithms to
510 .BR pubkey
511 or a key strength definition (for example
512 .BR pubkey-sha1-sha256
513 or
514 .BR rsa-2048-ecdsa-256-sha256-sha384-sha512 ).
515 For
516 .B eap ,
517 an optional EAP method can be appended. Currently defined methods are
518 .BR eap-aka ,
519 .BR eap-gtc ,
520 .BR eap-md5 ,
521 .BR eap-mschapv2 ,
522 .BR eap-peap ,
523 .BR eap-sim ,
524 .BR eap-tls ,
525 .BR eap-ttls ,
526 .BR eap-dynamic ,
527 and
528 .BR eap-radius .
529 Alternatively, IANA assigned EAP method numbers are accepted. Vendor specific
530 EAP methods are defined in the form
531 .B eap-type-vendor
532 .RB "(e.g. " eap-7-12345 ).
533 For
534 .B xauth,
535 an XAuth authentication backend can be specified, such as
536 .B xauth-generic
537 or
538 .BR xauth-eap .
539 If XAuth is used in
540 .BR leftauth ,
541 Hybrid authentication is used. For traditional XAuth authentication, define
542 XAuth in
543 .BR lefauth2 .
544 .TP
545 .BR leftauth2 " = <auth method>"
546 Same as
547 .BR leftauth ,
548 but defines an additional authentication exchange. In IKEv1, only XAuth can be
549 used in the second authentication round. IKEv2 supports multiple complete
550 authentication rounds using "Multiple Authentication Exchanges" defined
551 in RFC4739. This allows, for example, separated authentication
552 of host and user.
553 .TP
554 .BR leftca " = <issuer dn> | %same"
555 the distinguished name of a certificate authority which is required to
556 lie in the trust path going from the left participant's certificate up
557 to the root certification authority.
558 .TP
559 .BR leftca2 " = <issuer dn> | %same"
560 Same as
561 .BR leftca ,
562 but for the second authentication round (IKEv2 only).
563 .TP
564 .BR leftcert " = <path>"
565 the path to the left participant's X.509 certificate. The file can be encoded
566 either in PEM or DER format. OpenPGP certificates are supported as well.
567 Both absolute paths or paths relative to \fI/etc/ipsec.d/certs\fP
568 are accepted. By default
569 .B leftcert
570 sets
571 .B leftid
572 to the distinguished name of the certificate's subject and
573 .B leftca
574 to the distinguished name of the certificate's issuer.
575 The left participant's ID can be overridden by specifying a
576 .B leftid
577 value which must be certified by the certificate, though.
578 .TP
579 .BR leftcert2 " = <path>"
580 Same as
581 .B leftcert,
582 but for the second authentication round (IKEv2 only).
583 .TP
584 .BR leftcertpolicy " = <OIDs>"
585 Comma separated list of certificate policy OIDs the peer's certificate must
586 have.
587 OIDs are specified using the numerical dotted representation.
588 .TP
589 .BR leftfirewall " = yes | " no
590 whether the left participant is doing forwarding-firewalling
591 (including masquerading) using iptables for traffic from \fIleftsubnet\fR,
592 which should be turned off (for traffic to the other subnet)
593 once the connection is established;
594 acceptable values are
595 .B yes
596 and
597 .B no
598 (the default).
599 May not be used in the same connection description with
600 .BR leftupdown .
601 Implemented as a parameter to the default \fBipsec _updown\fR script.
602 See notes below.
603 Relevant only locally, other end need not agree on it.
604
605 If one or both security gateways are doing forwarding firewalling
606 (possibly including masquerading),
607 and this is specified using the firewall parameters,
608 tunnels established with IPsec are exempted from it
609 so that packets can flow unchanged through the tunnels.
610 (This means that all subnets connected in this manner must have
611 distinct, non-overlapping subnet address blocks.)
612 This is done by the default \fBipsec _updown\fR script.
613
614 In situations calling for more control,
615 it may be preferable for the user to supply his own
616 .I updown
617 script,
618 which makes the appropriate adjustments for his system.
619 .TP
620 .BR leftgroups " = <group list>"
621 a comma separated list of group names. If the
622 .B leftgroups
623 parameter is present then the peer must be a member of at least one
624 of the groups defined by the parameter.
625 .TP
626 .BR leftgroups2 " = <group list>"
627 Same as
628 .B leftgroups,
629 but for the second authentication round defined with
630 .B leftauth2.
631 .TP
632 .BR lefthostaccess " = yes | " no
633 inserts a pair of INPUT and OUTPUT iptables rules using the default
634 \fBipsec _updown\fR script, thus allowing access to the host itself
635 in the case where the host's internal interface is part of the
636 negotiated client subnet.
637 Acceptable values are
638 .B yes
639 and
640 .B no
641 (the default).
642 .TP
643 .BR leftid " = <id>"
644 how the left participant should be identified for authentication;
645 defaults to
646 .B left
647 or the subject of the certificate configured with
648 .BR leftcert .
649 Can be an IP address, a fully-qualified domain name, an email address, or
650 a keyid.
651 .TP
652 .BR leftid2 " = <id>"
653 identity to use for a second authentication for the left participant
654 (IKEv2 only); defaults to
655 .BR leftid .
656 .TP
657 .BR leftikeport " = <port>"
658 UDP port the left participant uses for IKE communication.
659 If unspecified, port 500 is used with the port floating
660 to 4500 if a NAT is detected or MOBIKE is enabled. Specifying a local IKE port
661 different from the default additionally requires a socket implementation that
662 listens to this port.
663 .TP
664 .BR leftprotoport " = <protocol>/<port>"
665 restrict the traffic selector to a single protocol and/or port.
666 Examples:
667 .B leftprotoport=tcp/http
668 or
669 .B leftprotoport=6/80
670 or
671 .B leftprotoport=udp
672 .TP
673 .BR leftrsasigkey " = " %cert " | <raw rsa public key> | <path to public key>"
674 the left participant's public key for RSA signature authentication, in RFC 2537
675 format using hex (0x prefix) or base64 (0s prefix) encoding. Also accepted is
676 the path to a file containing the public key in PEM or DER encoding.
677 The default value
678 .B %cert
679 means that the key is extracted from a certificate.
680 .TP
681 .BR leftsendcert " = never | no | " ifasked " | always | yes"
682 Accepted values are
683 .B never
684 or
685 .BR no ,
686 .B always
687 or
688 .BR yes ,
689 and
690 .BR ifasked " (the default),"
691 the latter meaning that the peer must send a certificate request payload in
692 order to get a certificate in return.
693 .TP
694 .BR leftsourceip " = %config | %cfg | %modeconfig | %modecfg | <ip address>"
695 The internal source IP to use in a tunnel, also known as virtual IP. If the
696 value is one of the synonyms
697 .BR %config ,
698 .BR %cfg ,
699 .BR %modeconfig ,
700 or
701 .BR %modecfg ,
702 an address is requested from the peer.
703 .TP
704 .BR rightsourceip " = %config | <network>/<netmask> | %poolname"
705 The internal source IP to use in a tunnel for the remote peer. If the
706 value is
707 .B %config
708 on the responder side, the initiator must propose an address which is then
709 echoed back. Also supported are address pools expressed as
710 \fInetwork\fB/\fInetmask\fR
711 or the use of an external IP address pool using %\fIpoolname\fR,
712 where \fIpoolname\fR is the name of the IP address pool used for the lookup.
713 .TP
714 .BR leftsubnet " = <ip subnet>"
715 private subnet behind the left participant, expressed as
716 \fInetwork\fB/\fInetmask\fR;
717 if omitted, essentially assumed to be \fIleft\fB/32\fR,
718 signifying that the left end of the connection goes to the left participant
719 only. Configured subnets of the peers may differ, the protocol narrows it to
720 the greatest common subnet. In IKEv1, this may lead to problems with other
721 implementations, make sure to configure identical subnets in such
722 configurations. IKEv2 supports multiple subnets separated by commas, IKEv1 only
723 interprets the first subnet of such a definition.
724 .TP
725 .BR leftupdown " = <path>"
726 what ``updown'' script to run to adjust routing and/or firewalling
727 when the status of the connection
728 changes (default
729 .BR "ipsec _updown" ).
730 May include positional parameters separated by white space
731 (although this requires enclosing the whole string in quotes);
732 including shell metacharacters is unwise.
733 Relevant only locally, other end need not agree on it. Charon uses the updown
734 script to insert firewall rules only, since routing has been implemented
735 directly into the daemon.
736 .TP
737 .BR lifebytes " = <number>"
738 the number of bytes transmitted over an IPsec SA before it expires.
739 .TP
740 .BR lifepackets " = <number>"
741 the number of packets transmitted over an IPsec SA before it expires.
742 .TP
743 .BR lifetime " = " 1h " | <time>"
744 how long a particular instance of a connection
745 (a set of encryption/authentication keys for user packets) should last,
746 from successful negotiation to expiry;
747 acceptable values are an integer optionally followed by
748 .BR s
749 (a time in seconds)
750 or a decimal number followed by
751 .BR m ,
752 .BR h ,
753 or
754 .B d
755 (a time
756 in minutes, hours, or days respectively)
757 (default
758 .BR 1h ,
759 maximum
760 .BR 24h ).
761 Normally, the connection is renegotiated (via the keying channel)
762 before it expires (see
763 .BR margintime ).
764 The two ends need not exactly agree on
765 .BR lifetime ,
766 although if they do not,
767 there will be some clutter of superseded connections on the end
768 which thinks the lifetime is longer. Also see EXPIRY/REKEY below.
769 .TP
770 .BR marginbytes " = <number>"
771 how many bytes before IPsec SA expiry (see
772 .BR lifebytes )
773 should attempts to negotiate a replacement begin.
774 .TP
775 .BR marginpackets " = <number>"
776 how many packets before IPsec SA expiry (see
777 .BR lifepackets )
778 should attempts to negotiate a replacement begin.
779 .TP
780 .BR margintime " = " 9m " | <time>"
781 how long before connection expiry or keying-channel expiry
782 should attempts to
783 negotiate a replacement
784 begin; acceptable values as for
785 .B lifetime
786 (default
787 .BR 9m ).
788 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
789 below.
790 .TP
791 .BR mark " = <value>[/<mask>]"
792 sets an XFRM mark in the inbound and outbound
793 IPsec SAs and policies. If the mask is missing then a default
794 mask of
795 .B 0xffffffff
796 is assumed.
797 .TP
798 .BR mark_in " = <value>[/<mask>]"
799 sets an XFRM mark in the inbound IPsec SA and
800 policy. If the mask is missing then a default mask of
801 .B 0xffffffff
802 is assumed.
803 .TP
804 .BR mark_out " = <value>[/<mask>]"
805 sets an XFRM mark in the outbound IPsec SA and
806 policy. If the mask is missing then a default mask of
807 .B 0xffffffff
808 is assumed.
809 .TP
810 .BR mobike " = " yes " | no"
811 enables the IKEv2 MOBIKE protocol defined by RFC 4555. Accepted values are
812 .B yes
813 (the default) and
814 .BR no .
815 If set to
816 .BR no ,
817 the charon daemon will not actively propose MOBIKE as initiator and
818 ignore the MOBIKE_SUPPORTED notify as responder.
819 .TP
820 .BR modeconfig " = push | " pull
821 defines which mode is used to assign a virtual IP.
822 Accepted values are
823 .B push
824 and
825 .B pull
826 (the default).
827 Push mode is currently not supported in charon, hence this parameter has no
828 effect.
829 .TP
830 .BR reauth " = " yes " | no"
831 whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1,
832 reauthentication is always done. In IKEv2, a value of
833 .B no
834 rekeys without uninstalling the IPsec SAs, a value of
835 .B yes
836 (the default) creates a new IKE_SA from scratch and tries to recreate
837 all IPsec SAs.
838 .TP
839 .BR rekey " = " yes " | no"
840 whether a connection should be renegotiated when it is about to expire;
841 acceptable values are
842 .B yes
843 (the default)
844 and
845 .BR no .
846 The two ends need not agree, but while a value of
847 .B no
848 prevents charon from requesting renegotiation,
849 it does not prevent responding to renegotiation requested from the other end,
850 so
851 .B no
852 will be largely ineffective unless both ends agree on it. Also see
853 .BR reauth .
854 .TP
855 .BR rekeyfuzz " = " 100% " | <percentage>"
856 maximum percentage by which
857 .BR marginbytes ,
858 .B marginpackets
859 and
860 .B margintime
861 should be randomly increased to randomize rekeying intervals
862 (important for hosts with many connections);
863 acceptable values are an integer,
864 which may exceed 100,
865 followed by a `%'
866 (defaults to
867 .BR 100% ).
868 The value of
869 .BR marginTYPE ,
870 after this random increase,
871 must not exceed
872 .B lifeTYPE
873 (where TYPE is one of
874 .IR bytes ,
875 .I packets
876 or
877 .IR time ).
878 The value
879 .B 0%
880 will suppress randomization.
881 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
882 below.
883 .TP
884 .B rekeymargin
885 synonym for
886 .BR margintime .
887 .TP
888 .BR reqid " = <number>"
889 sets the reqid for a given connection to a pre-configured fixed value.
890 .TP
891 .BR tfc " = <value>"
892 number of bytes to pad ESP payload data to. Traffic Flow Confidentiality
893 is currently supported in IKEv2 and applies to outgoing packets only. The
894 special value
895 .BR %mtu
896 fills up ESP packets with padding to have the size of the MTU.
897 .TP
898 .BR type " = " tunnel " | transport | transport_proxy | passthrough | drop"
899 the type of the connection; currently the accepted values
900 are
901 .B tunnel
902 (the default)
903 signifying a host-to-host, host-to-subnet, or subnet-to-subnet tunnel;
904 .BR transport ,
905 signifying host-to-host transport mode;
906 .BR transport_proxy ,
907 signifying the special Mobile IPv6 transport proxy mode;
908 .BR passthrough ,
909 signifying that no IPsec processing should be done at all;
910 .BR drop ,
911 signifying that packets should be discarded.
912 .TP
913 .BR xauth " = " client " | server"
914 specifies the role in the XAuth protocol if activated by
915 .B authby=xauthpsk
916 or
917 .B authby=xauthrsasig.
918 Accepted values are
919 .B server
920 and
921 .B client
922 (the default).
923 .TP
924 .BR xauth_identity " = <id>"
925 defines the identity/username the client uses to reply to an XAuth request.
926 If not defined, the IKEv1 identity will be used as XAuth identity.
927
928 .SS "CONN PARAMETERS: IKEv2 MEDIATION EXTENSION"
929 The following parameters are relevant to IKEv2 Mediation Extension
930 operation only.
931 .TP
932 .BR mediation " = yes | " no
933 whether this connection is a mediation connection, ie. whether this
934 connection is used to mediate other connections.  Mediation connections
935 create no child SA. Acceptable values are
936 .B no
937 (the default) and
938 .BR yes .
939 .TP
940 .BR mediated_by " = <name>"
941 the name of the connection to mediate this connection through.  If given,
942 the connection will be mediated through the named mediation connection.
943 The mediation connection must set
944 .BR mediation=yes .
945 .TP
946 .BR me_peerid " = <id>"
947 ID as which the peer is known to the mediation server, ie. which the other
948 end of this connection uses as its
949 .B leftid
950 on its connection to the mediation server.  This is the ID we request the
951 mediation server to mediate us with.  If
952 .B me_peerid
953 is not given, the
954 .B rightid
955 of this connection will be used as peer ID.
956
957 .SH "CA SECTIONS"
958 These are optional sections that can be used to assign special
959 parameters to a Certification Authority (CA). Because the daemons
960 automatically import CA certificates from \fI/etc/ipsec.d/cacerts\fP,
961 there is no need to explicitly add them with a CA section, unless you
962 want to assign special parameters (like a CRL) to a CA.
963 .TP
964 .BR also " = <name>"
965 includes ca section
966 .BR <name> .
967 .TP
968 .BR auto " = " ignore " | add"
969 currently can have either the value
970 .B ignore
971 (the default) or
972 .BR add .
973 .TP
974 .BR cacert " = <path>"
975 defines a path to the CA certificate either relative to
976 \fI/etc/ipsec.d/cacerts\fP or as an absolute path.
977 .TP
978 .BR crluri " = <uri>"
979 defines a CRL distribution point (ldap, http, or file URI)
980 .TP
981 .B crluri1
982 synonym for
983 .B crluri.
984 .TP
985 .BR crluri2 " = <uri>"
986 defines an alternative CRL distribution point (ldap, http, or file URI)
987 .TP
988 .TP
989 .BR ocspuri " = <uri>"
990 defines an OCSP URI.
991 .TP
992 .B ocspuri1
993 synonym for
994 .B ocspuri.
995 .TP
996 .BR ocspuri2 " = <uri>"
997 defines an alternative OCSP URI.
998 .TP
999 .BR certuribase " = <uri>"
1000 defines the base URI for the Hash and URL feature supported by IKEv2.
1001 Instead of exchanging complete certificates, IKEv2 allows to send an URI
1002 that resolves to the DER encoded certificate. The certificate URIs are built
1003 by appending the SHA1 hash of the DER encoded certificates to this base URI.
1004 .SH "CONFIG SECTIONS"
1005 At present, the only
1006 .B config
1007 section known to the IPsec software is the one named
1008 .BR setup ,
1009 which contains information used when the software is being started.
1010 The currently-accepted
1011 .I parameter
1012 names in a
1013 .B config
1014 .B setup
1015 section are:
1016 .TP
1017 .BR strictcrlpolicy " = yes | ifuri | " no
1018 defines if a fresh CRL must be available in order for the peer authentication
1019 based on RSA signatures to succeed.
1020 IKEv2 additionally recognizes
1021 .B ifuri
1022 which reverts to
1023 .B yes
1024 if at least one CRL URI is defined and to
1025 .B no
1026 if no URI is known.
1027 .TP
1028 .BR uniqueids " = " yes " | no | replace | keep"
1029 whether a particular participant ID should be kept unique,
1030 with any new (automatically keyed)
1031 connection using an ID from a different IP address
1032 deemed to replace all old ones using that ID;
1033 acceptable values are
1034 .B yes
1035 (the default)
1036 and
1037 .BR no .
1038 Participant IDs normally \fIare\fR unique,
1039 so a new (automatically-keyed) connection using the same ID is
1040 almost invariably intended to replace an old one.
1041 The daemon also accepts the value
1042 .B replace
1043 which is identical to
1044 .B yes
1045 and the value
1046 .B keep
1047 to reject new IKE_SA setups and keep the duplicate established earlier.
1048 .TP
1049 .BR charondebug " = <debug list>"
1050 how much charon debugging output should be logged.
1051 A comma separated list containing type/level-pairs may
1052 be specified, e.g:
1053 .B dmn 3, ike 1, net -1.
1054 Acceptable values for types are
1055 .B dmn, mgr, ike, chd, job, cfg, knl, net, asn, enc, lib, esp, tls,
1056 .B tnc, imc, imv, pts
1057 and the level is one of
1058 .B -1, 0, 1, 2, 3, 4
1059 (for silent, audit, control, controlmore, raw, private).  By default, the level
1060 is set to
1061 .B 1
1062 for all types.  For more flexibility see LOGGER CONFIGURATION in
1063 .IR strongswan.conf (5).
1064
1065 .SH SA EXPIRY/REKEY
1066 The IKE SAs and IPsec SAs negotiated by the daemon can be configured to expire
1067 after a specific amount of time. For IPsec SAs this can also happen after a
1068 specified number of transmitted packets or transmitted bytes. The following
1069 settings can be used to configure this:
1070 .TS
1071 l r l r,- - - -,lB s lB s,a r a r.
1072 Setting Default Setting Default
1073 IKE SA  IPsec SA
1074 ikelifetime     3h      lifebytes       -
1075                 lifepackets     -
1076                 lifetime        1h
1077 .TE
1078 .SS Rekeying
1079 IKE SAs as well as IPsec SAs can be rekeyed before they expire. This can be
1080 configured using the following settings:
1081 .TS
1082 l r l r,- - - -,lB s lB s,a r a r.
1083 Setting Default Setting Default
1084 IKE and IPsec SA        IPsec SA
1085 margintime      9m      marginbytes     -
1086                 marginpackets   -
1087 .TE
1088 .SS Randomization
1089 To avoid collisions the specified margins are increased randomly before
1090 subtracting them from the expiration limits (see formula below). This is
1091 controlled by the
1092 .B rekeyfuzz
1093 setting:
1094 .TS
1095 l r,- -,lB s,a r.
1096 Setting Default
1097 IKE and IPsec SA
1098 rekeyfuzz       100%
1099 .TE
1100 .PP
1101 Randomization can be disabled by setting
1102 .BR rekeyfuzz " to " 0% .
1103 .SS Formula
1104 The following formula is used to calculate the rekey time of IPsec SAs:
1105 .PP
1106 .EX
1107  rekeytime = lifetime - (margintime + random(0, margintime * rekeyfuzz))
1108 .EE
1109 .PP
1110 It applies equally to IKE SAs and byte and packet limits for IPsec SAs.
1111 .SS Example
1112 Let's consider the default configuration:
1113 .PP
1114 .EX
1115         lifetime = 1h
1116         margintime = 9m
1117         rekeyfuzz = 100%
1118 .EE
1119 .PP
1120 From the formula above follows that the rekey time lies between:
1121 .PP
1122 .EX
1123         rekeytime_min = 1h - (9m + 9m) = 42m
1124         rekeytime_max = 1h - (9m + 0m) = 51m
1125 .EE
1126 .PP
1127 Thus, the daemon will attempt to rekey the IPsec SA at a random time
1128 between 42 and 51 minutes after establishing the SA. Or, in other words,
1129 between 9 and 18 minutes before the SA expires.
1130 .SS Notes
1131 .IP \[bu]
1132 Since the rekeying of an SA needs some time, the margin values must not be
1133 too low.
1134 .IP \[bu]
1135 The value
1136 .B margin... + margin... * rekeyfuzz
1137 must not exceed the original limit. For example, specifying
1138 .B margintime = 30m
1139 in the default configuration is a bad idea as there is a chance that the rekey
1140 time equals zero and, thus, rekeying gets disabled.
1141 .SH FILES
1142 .nf
1143 /etc/ipsec.conf
1144 /etc/ipsec.d/aacerts
1145 /etc/ipsec.d/acerts
1146 /etc/ipsec.d/cacerts
1147 /etc/ipsec.d/certs
1148 /etc/ipsec.d/crls
1149
1150 .SH SEE ALSO
1151 strongswan.conf(5), ipsec.secrets(5), ipsec(8)
1152 .SH HISTORY
1153 Originally written for the FreeS/WAN project by Henry Spencer.
1154 Updated and extended for the strongSwan project <http://www.strongswan.org> by
1155 Tobias Brunner, Andreas Steffen and Martin Willi.