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