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