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