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