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