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