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