Add leftcert ipsec.conf.5 documentation about smartcard certificates
[strongswan.git] / man / ipsec.conf.5.in
1 .TH IPSEC.CONF 5 "2012-06-26" "@IPSEC_VERSION@" "strongSwan"
2 .SH NAME
3 ipsec.conf \- IPsec configuration and connections
4 .SH DESCRIPTION
5 The optional
6 .I ipsec.conf
7 file
8 specifies most configuration and control information for the
9 strongSwan IPsec subsystem.
10 The major exception is secrets for authentication;
11 see
12 .IR ipsec.secrets (5).
13 Its contents are not security-sensitive.
14 .PP
15 The file is a text file, consisting of one or more
16 .IR sections .
17 White space followed by
18 .B #
19 followed by anything to the end of the line
20 is a comment and is ignored,
21 as are empty lines which are not within a section.
22 .PP
23 A line which contains
24 .B include
25 and a file name, separated by white space,
26 is replaced by the contents of that file,
27 preceded and followed by empty lines.
28 If the file name is not a full pathname,
29 it is considered to be relative to the directory containing the
30 including file.
31 Such inclusions can be nested.
32 Only a single filename may be supplied, and it may not contain white space,
33 but it may include shell wildcards (see
34 .IR sh (1));
35 for example:
36 .PP
37 .B include
38 .B "ipsec.*.conf"
39 .PP
40 The intention of the include facility is mostly to permit keeping
41 information on connections, or sets of connections,
42 separate from the main configuration file.
43 This permits such connection descriptions to be changed,
44 copied to the other security gateways involved, etc.,
45 without having to constantly extract them from the configuration
46 file and then insert them back into it.
47 Note also the
48 .B also
49 parameter (described below) which permits splitting a single logical
50 section (e.g. a connection description) into several actual sections.
51 .PP
52 A section
53 begins with a line of the form:
54 .PP
55 .I type
56 .I name
57 .PP
58 where
59 .I type
60 indicates what type of section follows, and
61 .I name
62 is an arbitrary name which distinguishes the section from others
63 of the same type.
64 Names must start with a letter and may contain only
65 letters, digits, periods, underscores, and hyphens.
66 All subsequent non-empty lines
67 which begin with white space are part of the section;
68 comments within a section must begin with white space too.
69 There may be only one section of a given type with a given name.
70 .PP
71 Lines within the section are generally of the form
72 .PP
73 \ \ \ \ \ \fIparameter\fB=\fIvalue\fR
74 .PP
75 (note the mandatory preceding white space).
76 There can be white space on either side of the
77 .BR = .
78 Parameter names follow the same syntax as section names,
79 and are specific to a section type.
80 Unless otherwise explicitly specified,
81 no parameter name may appear more than once in a section.
82 .PP
83 An empty
84 .I value
85 stands for the system default value (if any) of the parameter,
86 i.e. it is roughly equivalent to omitting the parameter line entirely.
87 A
88 .I value
89 may contain white space only if the entire
90 .I value
91 is enclosed in double quotes (\fB"\fR);
92 a
93 .I value
94 cannot itself contain a double quote,
95 nor may it be continued across more than one line.
96 .PP
97 Numeric values are specified to be either an ``integer''
98 (a sequence of digits) or a ``decimal number''
99 (sequence of digits optionally followed by `.' and another sequence of digits).
100 .PP
101 There is currently one parameter which is available in any type of
102 section:
103 .TP
104 .B also
105 the value is a section name;
106 the parameters of that section are appended to this section,
107 as if they had been written as part of it.
108 The specified section must exist, must follow the current one,
109 and must have the same section type.
110 (Nesting is permitted,
111 and there may be more than one
112 .B also
113 in a single section,
114 although it is forbidden to append the same section more than once.)
115 .PP
116 A section with name
117 .B %default
118 specifies defaults for sections of the same type.
119 For each parameter in it,
120 any section of that type which does not have a parameter of the same name
121 gets a copy of the one from the
122 .B %default
123 section.
124 There may be multiple
125 .B %default
126 sections of a given type,
127 but only one default may be supplied for any specific parameter name,
128 and all
129 .B %default
130 sections of a given type must precede all non-\c
131 .B %default
132 sections of that type.
133 .B %default
134 sections may not contain the
135 .B also
136 parameter.
137 .PP
138 Currently there are three types of sections:
139 a
140 .B config
141 section specifies general configuration information for IPsec, a
142 .B conn
143 section specifies an IPsec connection, while a
144 .B ca
145 section specifies special properties of a certification authority.
146 .SH "CONN SECTIONS"
147 A
148 .B conn
149 section contains a
150 .IR "connection specification" ,
151 defining a network connection to be made using IPsec.
152 The name given is arbitrary, and is used to identify the connection.
153 Here's a simple example:
154 .PP
155 .ne 10
156 .nf
157 .ft B
158 .ta 1c
159 conn snt
160         left=192.168.0.1
161         leftsubnet=10.1.0.0/16
162         right=192.168.0.2
163         rightsubnet=10.1.0.0/16
164         keyingtries=%forever
165         auto=add
166 .ft
167 .fi
168 .PP
169 A note on terminology: There are two kinds of communications going on:
170 transmission of user IP packets, and gateway-to-gateway negotiations for
171 keying, rekeying, and general control.
172 The path to control the connection is called 'ISAKMP SA' in IKEv1
173 and 'IKE SA' in the IKEv2 protocol. That what is being negotiated, the kernel
174 level data path, is called 'IPsec SA' or 'Child SA'.
175 strongSwan previously used two separate keying daemons, \fIpluto\fP and
176 \fIcharon\fP. This manual does not discuss \fIpluto\fP options anymore, but
177 only \fIcharon\fP that since strongSwan 5.0 supports both IKEv1 and IKEv2.
178 .PP
179 To avoid trivial editing of the configuration file to suit it to each system
180 involved in a connection,
181 connection specifications are written in terms of
182 .I left
183 and
184 .I right
185 participants,
186 rather than in terms of local and remote.
187 Which participant is considered
188 .I left
189 or
190 .I right
191 is arbitrary;
192 for every connection description an attempt is made to figure out whether
193 the local endpoint should act as the
194 .I left
195 or
196 .I right
197 endpoint. This is done by matching the IP addresses defined for both endpoints
198 with the IP addresses assigned to local network interfaces. If a match is found
199 then the role (left or right) that matches is going to be considered local.
200 If no match is found during startup,
201 .I left
202 is considered local.
203 This permits using identical connection specifications on both ends.
204 There are cases where there is no symmetry; a good convention is to
205 use
206 .I left
207 for the local side and
208 .I right
209 for the remote side (the first letters are a good mnemonic).
210 .PP
211 Many of the parameters relate to one participant or the other;
212 only the ones for
213 .I left
214 are listed here, but every parameter whose name begins with
215 .B left
216 has a
217 .B right
218 counterpart,
219 whose description is the same but with
220 .B left
221 and
222 .B right
223 reversed.
224 .PP
225 Parameters are optional unless marked '(required)'.
226 .SS "CONN PARAMETERS"
227 Unless otherwise noted, for a connection to work,
228 in general it is necessary for the two ends to agree exactly
229 on the values of these parameters.
230 .TP
231 .BR aaa_identity " = <id>"
232 defines the identity of the AAA backend used during IKEv2 EAP authentication.
233 This is required if the EAP client uses a method that verifies the server
234 identity (such as EAP-TLS), but it does not match the IKEv2 gateway identity.
235 .TP
236 .BR aggressive " = yes | " no
237 whether to use IKEv1 Aggressive or Main Mode (the default).
238 .TP
239 .BR also " = <name>"
240 includes conn section
241 .BR <name> .
242 .TP
243 .BR authby " = " pubkey " | rsasig | ecdsasig | psk | secret | never | xauthpsk | xauthrsasig"
244 how the two security gateways should authenticate each other;
245 acceptable values are
246 .B psk
247 or
248 .B secret
249 for pre-shared secrets,
250 .B pubkey
251 (the default) for public key signatures as well as the synonyms
252 .B rsasig
253 for RSA digital signatures and
254 .B ecdsasig
255 for Elliptic Curve DSA signatures.
256 .B never
257 can be used if negotiation is never to be attempted or accepted (useful for
258 shunt-only conns).
259 Digital signatures are superior in every way to shared secrets.
260 IKEv1 additionally supports the values
261 .B xauthpsk
262 and
263 .B xauthrsasig
264 that will enable eXtended AUTHentication (XAUTH) in addition to IKEv1 main mode
265 based on shared secrets or digital RSA signatures, respectively.
266 This parameter is deprecated, as two peers do not need to agree on an
267 authentication method in IKEv2. Use the
268 .B leftauth
269 parameter instead to define authentication methods.
270 .TP
271 .BR auto " = " ignore " | add | route | start"
272 what operation, if any, should be done automatically at IPsec startup;
273 currently-accepted values are
274 .BR add ,
275 .BR route ,
276 .B start
277 and
278 .B ignore
279 (the default).
280 .B add
281 loads a connection without starting it.
282 .B route
283 loads a connection and installs kernel traps. If traffic is detected between
284 .B leftsubnet
285 and
286 .BR rightsubnet ,
287 a connection is established.
288 .B start
289 loads a connection and brings it up immediately.
290 .B ignore
291 ignores the connection. This is equal to deleting a connection from the config
292 file.
293 Relevant only locally, other end need not agree on it.
294 .TP
295 .BR closeaction " = " none " | clear | hold | restart"
296 defines the action to take if the remote peer unexpectedly closes a CHILD_SA
297 (see
298 .B dpdaction
299 for meaning of values).
300 A
301 .B closeaction should not be
302 used if the peer uses reauthentication or uniquids checking, as these events
303 might trigger the defined action when not desired. Currently not supported with
304 IKEv1.
305 .TP
306 .BR compress " = yes | " no
307 whether IPComp compression of content is proposed on the connection
308 (link-level compression does not work on encrypted data,
309 so to be effective, compression must be done \fIbefore\fR encryption);
310 acceptable values are
311 .B yes
312 and
313 .B no
314 (the default). A value of
315 .B yes
316 causes the daemon to propose both compressed and uncompressed,
317 and prefer compressed.
318 A value of
319 .B no
320 prevents the daemon from proposing or accepting compression.
321 .TP
322 .BR dpdaction " = " none " | clear | hold | restart"
323 controls the use of the Dead Peer Detection protocol (DPD, RFC 3706) where
324 R_U_THERE notification messages (IKEv1) or empty INFORMATIONAL messages (IKEv2)
325 are periodically sent in order to check the
326 liveliness of the IPsec peer. The values
327 .BR clear ,
328 .BR hold ,
329 and
330 .B restart
331 all activate DPD. If no activity is detected, all connections with a dead peer
332 are stopped and unrouted
333 .RB ( clear ),
334 put in the hold state
335 .RB ( hold )
336 or restarted
337 .RB ( restart ).
338 The default is
339 .B none
340 which disables the active sending of DPD messages.
341 .TP
342 .BR dpddelay " = " 30s " | <time>"
343 defines the period time interval with which R_U_THERE messages/INFORMATIONAL
344 exchanges are sent to the peer. These are only sent if no other traffic is
345 received. In IKEv2, a value of 0 sends no additional INFORMATIONAL
346 messages and uses only standard messages (such as those to rekey) to detect
347 dead peers.
348 .TP
349 .BR dpdtimeout " = " 150s " | <time>
350 defines the timeout interval, after which all connections to a peer are deleted
351 in case of inactivity. This only applies to IKEv1, in IKEv2 the default
352 retransmission timeout applies, as every exchange is used to detect dead peers.
353 .TP
354 .BR inactivity " = <time>"
355 defines the timeout interval, after which a CHILD_SA is closed if it did
356 not send or receive any traffic.
357 .TP
358 .BR eap_identity " = <id>"
359 defines the identity the client uses to reply to an EAP Identity request.
360 If defined on the EAP server, the defined identity will be used as peer
361 identity during EAP authentication. The special value
362 .B %identity
363 uses the EAP Identity method to ask the client for an EAP identity. If not
364 defined, the IKEv2 identity will be used as EAP identity.
365 .TP
366 .BR esp " = <cipher suites>"
367 comma-separated list of ESP encryption/authentication algorithms to be used
368 for the connection, e.g.
369 .BR aes128-sha256 .
370 The notation is
371 .BR encryption-integrity[-dhgroup][-esnmode] .
372
373 Defaults to
374 .BR aes128-sha1,3des-sha1 .
375 The daemon adds its extensive default proposal to this default
376 or the configured value.  To restrict it to the configured proposal an
377 exclamation mark
378 .RB ( ! )
379 can be added at the end.
380
381 .BR Note :
382 As a responder the daemon accepts the first supported proposal received from
383 the peer. In order to restrict a responder to only accept specific cipher
384 suites, the strict flag
385 .RB ( ! ,
386 exclamation mark) can be used, e.g: aes256-sha512-modp4096!
387 .br
388 If
389 .B dh-group
390 is specified, CHILD_SA/Quick Mode setup and rekeying include a separate
391 Diffie-Hellman exchange.  Valid values for
392 .B esnmode
393 (IKEv2 only) are
394 .B esn
395 and
396 .BR noesn .
397 Specifying both negotiates Extended Sequence Number support with the peer,
398 the default is
399 .B noesn.
400 .TP
401 .BR forceencaps " = yes | " no
402 force UDP encapsulation for ESP packets even if no NAT situation is detected.
403 This may help to surmount restrictive firewalls. In order to force the peer to
404 encapsulate packets, NAT detection payloads are faked.
405 .TP
406 .BR ike " = <cipher suites>"
407 comma-separated list of IKE/ISAKMP SA encryption/authentication algorithms
408 to be used, e.g.
409 .BR aes128-sha1-modp2048 .
410 The notation is
411 .BR encryption-integrity[-prf]-dhgroup .
412 If no PRF is given, the algorithms defined for integrity are used for the PRF.
413 The prf keywords are the same as the integrity algorithms, but have a
414 .B prf
415 prefix (such as
416 .BR prfsha1 ,
417 .B prfsha256
418 or
419 .BR prfaesxcbc ).
420 .br
421 In IKEv2, multiple algorithms and proposals may be included, such as
422 .BR aes128-aes256-sha1-modp1536-modp2048,3des-sha1-md5-modp1024 .
423
424 Defaults to
425 .BR aes128-sha1-modp2048,3des-sha1-modp1536 .
426 The daemon adds its extensive default proposal to this
427 default or the configured value.  To restrict it to the configured proposal an
428 exclamation mark
429 .RB ( ! )
430 can be added at the end.
431
432 .BR Note :
433 As a responder the daemon accepts the first supported proposal received from
434 the peer.  In order to restrict a responder to only accept specific cipher
435 suites, the strict flag
436 .RB ( ! ,
437 exclamation mark) can be used, e.g:
438 .BR aes256-sha512-modp4096!
439 .TP
440 .BR ikelifetime " = " 3h " | <time>"
441 how long the keying channel of a connection (ISAKMP or IKE SA)
442 should last before being renegotiated. Also see EXPIRY/REKEY below.
443 .TP
444 .BR installpolicy " = " yes " | no"
445 decides whether IPsec policies are installed in the kernel by the charon daemon
446 for a given connection. Allows peaceful cooperation e.g. with
447 the Mobile IPv6 daemon mip6d who wants to control the kernel policies.
448 Acceptable values are
449 .B yes
450 (the default) and
451 .BR no .
452 .TP
453 .BR keyexchange " = " ike " | ikev1 | ikev2"
454 which key exchange protocol should be used to initiate the connection.
455 Connections marked with
456 .B ike
457 use IKEv2 when initiating, but accept any protocol version when responding.
458 .TP
459 .BR keyingtries " = " 3 " | <number> | %forever"
460 how many attempts (a whole number or \fB%forever\fP) should be made to
461 negotiate a connection, or a replacement for one, before giving up
462 (default
463 .BR 3 ).
464 The value \fB%forever\fP
465 means 'never give up'.
466 Relevant only locally, other end need not agree on it.
467 .TP
468 .B keylife
469 synonym for
470 .BR lifetime .
471 .TP
472 .BR left " = <ip address> | <fqdn> | " %any
473 (required)
474 the IP address of the left participant's public-network interface
475 or one of several magic values.
476 The value
477 .B %any
478 (the default) for the local endpoint signifies an address to be filled in (by
479 automatic keying) during negotiation. If the local peer initiates the
480 connection setup the routing table will be queried to determine the correct
481 local IP address.
482 In case the local peer is responding to a connection setup then any IP address
483 that is assigned to a local interface will be accepted.
484
485 The prefix
486 .B %
487 in front of a fully-qualified domain name or an IP address will implicitly set
488 .BR leftallowany =yes.
489
490 If
491 .B %any
492 is used for the remote endpoint it literally means any IP address.
493
494 Please note that with the usage of wildcards multiple connection descriptions
495 might match a given incoming connection attempt. The most specific description
496 is used in that case.
497 .TP
498 .BR leftallowany " = yes | " no
499 a modifier for
500 .BR left ,
501 making it behave as
502 .B %any
503 although a concrete IP address or domain name has been assigned.
504 .TP
505 .BR leftauth " = <auth method>"
506 Authentication method to use locally (left) or require from the remote (right)
507 side.
508 Acceptable values are
509 .B pubkey
510 for public key authentication (RSA/ECDSA),
511 .B psk
512 for pre-shared key authentication,
513 .B eap
514 to (require the) use of the Extensible Authentication Protocol in IKEv2, and
515 .B xauth
516 for IKEv1 eXtended Authentication.
517 To require a trustchain public key strength for the remote side, specify the
518 key type followed by the minimum strength in bits (for example
519 .BR ecdsa-384
520 or
521 .BR rsa-2048-ecdsa-256 ).
522 To limit the acceptable set of hashing algorithms for trustchain validation,
523 append hash algorithms to
524 .BR pubkey
525 or a key strength definition (for example
526 .BR pubkey-sha1-sha256
527 or
528 .BR rsa-2048-ecdsa-256-sha256-sha384-sha512 ).
529 For
530 .BR eap ,
531 an optional EAP method can be appended. Currently defined methods are
532 .BR eap-aka ,
533 .BR eap-gtc ,
534 .BR eap-md5 ,
535 .BR eap-mschapv2 ,
536 .BR eap-peap ,
537 .BR eap-sim ,
538 .BR eap-tls ,
539 .BR eap-ttls ,
540 .BR eap-dynamic ,
541 and
542 .BR eap-radius .
543 Alternatively, IANA assigned EAP method numbers are accepted. Vendor specific
544 EAP methods are defined in the form
545 .B eap-type-vendor
546 .RB "(e.g. " eap-7-12345 ).
547 For
548 .B xauth,
549 an XAuth authentication backend can be specified, such as
550 .B xauth-generic
551 or
552 .BR xauth-eap .
553 If XAuth is used in
554 .BR leftauth ,
555 Hybrid authentication is used. For traditional XAuth authentication, define
556 XAuth in
557 .BR lefauth2 .
558 .TP
559 .BR leftauth2 " = <auth method>"
560 Same as
561 .BR leftauth ,
562 but defines an additional authentication exchange. In IKEv1, only XAuth can be
563 used in the second authentication round. IKEv2 supports multiple complete
564 authentication rounds using "Multiple Authentication Exchanges" defined
565 in RFC 4739. This allows, for example, separated authentication
566 of host and user.
567 .TP
568 .BR leftca " = <issuer dn> | %same"
569 the distinguished name of a certificate authority which is required to
570 lie in the trust path going from the left participant's certificate up
571 to the root certification authority.
572 .B %same
573 means that the value configured for the right participant should be reused.
574 .TP
575 .BR leftca2 " = <issuer dn> | %same"
576 Same as
577 .BR leftca ,
578 but for the second authentication round (IKEv2 only).
579 .TP
580 .BR leftcert " = <path>"
581 the path to the left participant's X.509 certificate. The file can be encoded
582 either in PEM or DER format. OpenPGP certificates are supported as well.
583 Both absolute paths or paths relative to \fI/etc/ipsec.d/certs\fP
584 are accepted. By default
585 .B leftcert
586 sets
587 .B leftid
588 to the distinguished name of the certificate's subject.
589 The left participant's ID can be overridden by specifying a
590 .B leftid
591 value which must be certified by the certificate, though.
592 .br
593 A value in the form
594 .B %smartcard:<keyid>
595 defines a specific certificate to load from a PKCS#11 backend for this
596 connection.
597 .B <keyid>
598 has to be a hex encoded key identifier under which the certificate is stored
599 on any of the configured smartcards.
600 .B leftcert
601 is required only if selecting the certificate with
602 .B leftid
603 is not sufficient, for example if multiple certificates use the same subject.
604 .TP
605 .BR leftcert2 " = <path>"
606 Same as
607 .B leftcert,
608 but for the second authentication round (IKEv2 only).
609 .TP
610 .BR leftcertpolicy " = <OIDs>"
611 Comma separated list of certificate policy OIDs the peer's certificate must
612 have.
613 OIDs are specified using the numerical dotted representation.
614 .TP
615 .BR leftdns " = <servers>"
616 Comma separated list of DNS server addresses to exchange as configuration
617 attributes. On the initiator, a server is a fixed IPv4/IPv6 address, or
618 .BR %config4 / %config6
619 to request attributes without an address. On the responder,
620 only fixed IPv4/IPv6 addresses are allowed and define DNS servers assigned
621 to the client.
622 .TP
623 .BR leftfirewall " = yes | " no
624 whether the left participant is doing forwarding-firewalling
625 (including masquerading) using iptables for traffic from \fIleftsubnet\fR,
626 which should be turned off (for traffic to the other subnet)
627 once the connection is established;
628 acceptable values are
629 .B yes
630 and
631 .B no
632 (the default).
633 May not be used in the same connection description with
634 .BR leftupdown .
635 Implemented as a parameter to the default \fBipsec _updown\fR script.
636 See notes below.
637 Relevant only locally, other end need not agree on it.
638
639 If one or both security gateways are doing forwarding firewalling
640 (possibly including masquerading),
641 and this is specified using the firewall parameters,
642 tunnels established with IPsec are exempted from it
643 so that packets can flow unchanged through the tunnels.
644 (This means that all subnets connected in this manner must have
645 distinct, non-overlapping subnet address blocks.)
646 This is done by the default \fBipsec _updown\fR script.
647
648 In situations calling for more control,
649 it may be preferable for the user to supply his own
650 .I updown
651 script,
652 which makes the appropriate adjustments for his system.
653 .TP
654 .BR leftgroups " = <group list>"
655 a comma separated list of group names. If the
656 .B leftgroups
657 parameter is present then the peer must be a member of at least one
658 of the groups defined by the parameter.
659 .TP
660 .BR leftgroups2 " = <group list>"
661 Same as
662 .B leftgroups,
663 but for the second authentication round defined with
664 .B leftauth2.
665 .TP
666 .BR lefthostaccess " = yes | " no
667 inserts a pair of INPUT and OUTPUT iptables rules using the default
668 \fBipsec _updown\fR script, thus allowing access to the host itself
669 in the case where the host's internal interface is part of the
670 negotiated client subnet.
671 Acceptable values are
672 .B yes
673 and
674 .B no
675 (the default).
676 .TP
677 .BR leftid " = <id>"
678 how the left participant should be identified for authentication;
679 defaults to
680 .B left
681 or the subject of the certificate configured with
682 .BR leftcert .
683 Can be an IP address, a fully-qualified domain name, an email address, or
684 a keyid. If
685 .B leftcert
686 is configured the identity has to be confirmed by the certificate.
687
688 For IKEv2 and
689 .B rightid
690 the prefix
691 .B %
692 in front of the identity prevents the daemon from sending IDr in its IKE_AUTH
693 request and will allow it to verify the configured identity against the subject
694 and subjectAltNames contained in the responder's certificate (otherwise it is
695 only compared with the IDr returned by the responder).  The IDr sent by the
696 initiator might otherwise prevent the responder from finding a config if it
697 has configured a different value for
698 .BR leftid .
699 .TP
700 .BR leftid2 " = <id>"
701 identity to use for a second authentication for the left participant
702 (IKEv2 only); defaults to
703 .BR leftid .
704 .TP
705 .BR leftikeport " = <port>"
706 UDP port the left participant uses for IKE communication.
707 If unspecified, port 500 is used with the port floating
708 to 4500 if a NAT is detected or MOBIKE is enabled. Specifying a local IKE port
709 different from the default additionally requires a socket implementation that
710 listens on this port.
711 .TP
712 .BR leftprotoport " = <protocol>/<port>"
713 restrict the traffic selector to a single protocol and/or port.
714 Examples:
715 .B leftprotoport=tcp/http
716 or
717 .B leftprotoport=6/80
718 or
719 .B leftprotoport=udp
720 or
721 .BR leftprotoport=/53 .
722 Instead of omitting either value
723 .B %any
724 can be used to the same effect, e.g.
725 .B leftprotoport=udp/%any
726 or
727 .BR leftprotoport=%any/53 .
728 .TP
729 .BR leftrsasigkey " = <raw rsa public key> | <path to public key>"
730 the left participant's public key for RSA signature authentication, in RFC 2537
731 format using hex (0x prefix) or base64 (0s prefix) encoding. Also accepted is
732 the path to a file containing the public key in PEM or DER encoding.
733 .TP
734 .BR leftsendcert " = never | no | " ifasked " | always | yes"
735 Accepted values are
736 .B never
737 or
738 .BR no ,
739 .B always
740 or
741 .BR yes ,
742 and
743 .BR ifasked " (the default),"
744 the latter meaning that the peer must send a certificate request payload in
745 order to get a certificate in return.
746 .TP
747 .BR leftsourceip " = %config4 | %config6 | <ip address>"
748 Comma separated list of internal source IPs to use in a tunnel, also known as
749 virtual IP. If the value is one of the synonyms
750 .BR %config ,
751 .BR %cfg ,
752 .BR %modeconfig ,
753 or
754 .BR %modecfg ,
755 an address (from the tunnel address family) is requested from the peer. With
756 .B %config4
757 and
758 .B %config6
759 an address of the given address family will be requested explicitly.
760 If an IP address is configured, it will be requested from the responder,
761 which is free to respond with a different address.
762 .TP
763 .BR rightsourceip " = %config | <network>/<netmask> | %poolname"
764 Comma separated list of internal source IPs to use in a tunnel for the remote
765 peer. If the 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. Configured subnets of the peers may differ, the protocol narrows it to
779 the greatest common subnet. In IKEv1, this may lead to problems with other
780 implementations, make sure to configure identical subnets in such
781 configurations. IKEv2 supports multiple subnets separated by commas. IKEv1 only
782 interprets the first subnet of such a definition, unless the Cisco Unity
783 extension plugin is enabled.
784 .TP
785 .BR leftupdown " = <path>"
786 what ``updown'' script to run to adjust routing and/or firewalling
787 when the status of the connection
788 changes (default
789 .BR "ipsec _updown" ).
790 May include positional parameters separated by white space
791 (although this requires enclosing the whole string in quotes);
792 including shell metacharacters is unwise.
793 Relevant only locally, other end need not agree on it. Charon uses the updown
794 script to insert firewall rules only, since routing has been implemented
795 directly into the daemon.
796 .TP
797 .BR lifebytes " = <number>"
798 the number of bytes transmitted over an IPsec SA before it expires.
799 .TP
800 .BR lifepackets " = <number>"
801 the number of packets transmitted over an IPsec SA before it expires.
802 .TP
803 .BR lifetime " = " 1h " | <time>"
804 how long a particular instance of a connection
805 (a set of encryption/authentication keys for user packets) should last,
806 from successful negotiation to expiry;
807 acceptable values are an integer optionally followed by
808 .BR s
809 (a time in seconds)
810 or a decimal number followed by
811 .BR m ,
812 .BR h ,
813 or
814 .B d
815 (a time
816 in minutes, hours, or days respectively)
817 (default
818 .BR 1h ,
819 maximum
820 .BR 24h ).
821 Normally, the connection is renegotiated (via the keying channel)
822 before it expires (see
823 .BR margintime ).
824 The two ends need not exactly agree on
825 .BR lifetime ,
826 although if they do not,
827 there will be some clutter of superseded connections on the end
828 which thinks the lifetime is longer. Also see EXPIRY/REKEY below.
829 .TP
830 .BR marginbytes " = <number>"
831 how many bytes before IPsec SA expiry (see
832 .BR lifebytes )
833 should attempts to negotiate a replacement begin.
834 .TP
835 .BR marginpackets " = <number>"
836 how many packets before IPsec SA expiry (see
837 .BR lifepackets )
838 should attempts to negotiate a replacement begin.
839 .TP
840 .BR margintime " = " 9m " | <time>"
841 how long before connection expiry or keying-channel expiry
842 should attempts to
843 negotiate a replacement
844 begin; acceptable values as for
845 .B lifetime
846 (default
847 .BR 9m ).
848 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
849 below.
850 .TP
851 .BR mark " = <value>[/<mask>]"
852 sets an XFRM mark in the inbound and outbound
853 IPsec SAs and policies. If the mask is missing then a default
854 mask of
855 .B 0xffffffff
856 is assumed.
857 .TP
858 .BR mark_in " = <value>[/<mask>]"
859 sets an XFRM mark in the inbound IPsec SA and
860 policy. If the mask is missing then a default mask of
861 .B 0xffffffff
862 is assumed.
863 .TP
864 .BR mark_out " = <value>[/<mask>]"
865 sets an XFRM mark in the outbound IPsec SA and
866 policy. If the mask is missing then a default mask of
867 .B 0xffffffff
868 is assumed.
869 .TP
870 .BR mobike " = " yes " | no"
871 enables the IKEv2 MOBIKE protocol defined by RFC 4555. Accepted values are
872 .B yes
873 (the default) and
874 .BR no .
875 If set to
876 .BR no ,
877 the charon daemon will not actively propose MOBIKE as initiator and
878 ignore the MOBIKE_SUPPORTED notify as responder.
879 .TP
880 .BR modeconfig " = push | " pull
881 defines which mode is used to assign a virtual IP.
882 Accepted values are
883 .B push
884 and
885 .B pull
886 (the default).
887 Push mode is currently not supported in charon, hence this parameter has no
888 effect.
889 .TP
890 .BR reauth " = " yes " | no"
891 whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1,
892 reauthentication is always done. In IKEv2, a value of
893 .B no
894 rekeys without uninstalling the IPsec SAs, a value of
895 .B yes
896 (the default) creates a new IKE_SA from scratch and tries to recreate
897 all IPsec SAs.
898 .TP
899 .BR rekey " = " yes " | no"
900 whether a connection should be renegotiated when it is about to expire;
901 acceptable values are
902 .B yes
903 (the default)
904 and
905 .BR no .
906 The two ends need not agree, but while a value of
907 .B no
908 prevents charon from requesting renegotiation,
909 it does not prevent responding to renegotiation requested from the other end,
910 so
911 .B no
912 will be largely ineffective unless both ends agree on it. Also see
913 .BR reauth .
914 .TP
915 .BR rekeyfuzz " = " 100% " | <percentage>"
916 maximum percentage by which
917 .BR marginbytes ,
918 .B marginpackets
919 and
920 .B margintime
921 should be randomly increased to randomize rekeying intervals
922 (important for hosts with many connections);
923 acceptable values are an integer,
924 which may exceed 100,
925 followed by a `%'
926 (defaults to
927 .BR 100% ).
928 The value of
929 .BR marginTYPE ,
930 after this random increase,
931 must not exceed
932 .B lifeTYPE
933 (where TYPE is one of
934 .IR bytes ,
935 .I packets
936 or
937 .IR time ).
938 The value
939 .B 0%
940 will suppress randomization.
941 Relevant only locally, other end need not agree on it. Also see EXPIRY/REKEY
942 below.
943 .TP
944 .B rekeymargin
945 synonym for
946 .BR margintime .
947 .TP
948 .BR reqid " = <number>"
949 sets the reqid for a given connection to a pre-configured fixed value.
950 .TP
951 .BR tfc " = <value>"
952 number of bytes to pad ESP payload data to. Traffic Flow Confidentiality
953 is currently supported in IKEv2 and applies to outgoing packets only. The
954 special value
955 .BR %mtu
956 fills up ESP packets with padding to have the size of the MTU.
957 .TP
958 .BR type " = " tunnel " | transport | transport_proxy | passthrough | drop"
959 the type of the connection; currently the accepted values
960 are
961 .B tunnel
962 (the default)
963 signifying a host-to-host, host-to-subnet, or subnet-to-subnet tunnel;
964 .BR transport ,
965 signifying host-to-host transport mode;
966 .BR transport_proxy ,
967 signifying the special Mobile IPv6 transport proxy mode;
968 .BR passthrough ,
969 signifying that no IPsec processing should be done at all;
970 .BR drop ,
971 signifying that packets should be discarded.
972 .TP
973 .BR xauth " = " client " | server"
974 specifies the role in the XAuth protocol if activated by
975 .B authby=xauthpsk
976 or
977 .B authby=xauthrsasig.
978 Accepted values are
979 .B server
980 and
981 .B client
982 (the default).
983 .TP
984 .BR xauth_identity " = <id>"
985 defines the identity/username the client uses to reply to an XAuth request.
986 If not defined, the IKEv1 identity will be used as XAuth identity.
987
988 .SS "CONN PARAMETERS: IKEv2 MEDIATION EXTENSION"
989 The following parameters are relevant to IKEv2 Mediation Extension
990 operation only.
991 .TP
992 .BR mediation " = yes | " no
993 whether this connection is a mediation connection, ie. whether this
994 connection is used to mediate other connections.  Mediation connections
995 create no child SA. Acceptable values are
996 .B no
997 (the default) and
998 .BR yes .
999 .TP
1000 .BR mediated_by " = <name>"
1001 the name of the connection to mediate this connection through.  If given,
1002 the connection will be mediated through the named mediation connection.
1003 The mediation connection must set
1004 .BR mediation=yes .
1005 .TP
1006 .BR me_peerid " = <id>"
1007 ID as which the peer is known to the mediation server, ie. which the other
1008 end of this connection uses as its
1009 .B leftid
1010 on its connection to the mediation server.  This is the ID we request the
1011 mediation server to mediate us with.  If
1012 .B me_peerid
1013 is not given, the
1014 .B rightid
1015 of this connection will be used as peer ID.
1016
1017 .SH "CA SECTIONS"
1018 These are optional sections that can be used to assign special
1019 parameters to a Certification Authority (CA). Because the daemons
1020 automatically import CA certificates from \fI/etc/ipsec.d/cacerts\fP,
1021 there is no need to explicitly add them with a CA section, unless you
1022 want to assign special parameters (like a CRL) to a CA.
1023 .TP
1024 .BR also " = <name>"
1025 includes ca section
1026 .BR <name> .
1027 .TP
1028 .BR auto " = " ignore " | add"
1029 currently can have either the value
1030 .B ignore
1031 (the default) or
1032 .BR add .
1033 .TP
1034 .BR cacert " = <path>"
1035 defines a path to the CA certificate either relative to
1036 \fI/etc/ipsec.d/cacerts\fP or as an absolute path.
1037 .TP
1038 .BR crluri " = <uri>"
1039 defines a CRL distribution point (ldap, http, or file URI)
1040 .TP
1041 .B crluri1
1042 synonym for
1043 .B crluri.
1044 .TP
1045 .BR crluri2 " = <uri>"
1046 defines an alternative CRL distribution point (ldap, http, or file URI)
1047 .TP
1048 .TP
1049 .BR ocspuri " = <uri>"
1050 defines an OCSP URI.
1051 .TP
1052 .B ocspuri1
1053 synonym for
1054 .B ocspuri.
1055 .TP
1056 .BR ocspuri2 " = <uri>"
1057 defines an alternative OCSP URI.
1058 .TP
1059 .BR certuribase " = <uri>"
1060 defines the base URI for the Hash and URL feature supported by IKEv2.
1061 Instead of exchanging complete certificates, IKEv2 allows one to send an URI
1062 that resolves to the DER encoded certificate. The certificate URIs are built
1063 by appending the SHA1 hash of the DER encoded certificates to this base URI.
1064 .SH "CONFIG SECTIONS"
1065 At present, the only
1066 .B config
1067 section known to the IPsec software is the one named
1068 .BR setup ,
1069 which contains information used when the software is being started.
1070 The currently-accepted
1071 .I parameter
1072 names in a
1073 .B config
1074 .B setup
1075 section are:
1076 .TP
1077 .BR cachecrls " = yes | " no
1078 if enabled, certificate revocation lists (CRLs) fetched via HTTP or LDAP will
1079 be cached in
1080 .I /etc/ipsec.d/crls/
1081 under a unique file name derived from the certification authority's public key.
1082 .TP
1083 .BR charondebug " = <debug list>"
1084 how much charon debugging output should be logged.
1085 A comma separated list containing type/level-pairs may
1086 be specified, e.g:
1087 .B dmn 3, ike 1, net -1.
1088 Acceptable values for types are
1089 .B dmn, mgr, ike, chd, job, cfg, knl, net, asn, enc, lib, esp, tls,
1090 .B tnc, imc, imv, pts
1091 and the level is one of
1092 .B -1, 0, 1, 2, 3, 4
1093 (for silent, audit, control, controlmore, raw, private).  By default, the level
1094 is set to
1095 .B 1
1096 for all types.  For more flexibility see LOGGER CONFIGURATION in
1097 .IR strongswan.conf (5).
1098 .TP
1099 .BR strictcrlpolicy " = yes | ifuri | " no
1100 defines if a fresh CRL must be available in order for the peer authentication
1101 based on RSA signatures to succeed.
1102 IKEv2 additionally recognizes
1103 .B ifuri
1104 which reverts to
1105 .B yes
1106 if at least one CRL URI is defined and to
1107 .B no
1108 if no URI is known.
1109 .TP
1110 .BR uniqueids " = " yes " | no | never | replace | keep"
1111 whether a particular participant ID should be kept unique,
1112 with any new IKE_SA using an ID deemed to replace all old ones using that ID;
1113 acceptable values are
1114 .B yes
1115 (the default),
1116 .B no
1117 and
1118 .BR never .
1119 Participant IDs normally \fIare\fR unique, so a new IKE_SA using the same ID is
1120 almost invariably intended to replace an old one. The difference between
1121 .B no
1122 and
1123 .B never
1124 is that the daemon will replace old IKE_SAs when receiving an INITIAL_CONTACT
1125 notify if the option is
1126 .B no
1127 but will ignore these notifies if
1128 .B never
1129 is configured.
1130 The daemon also accepts the value
1131 .B replace
1132 which is identical to
1133 .B yes
1134 and the value
1135 .B keep
1136 to reject new IKE_SA setups and keep the duplicate established earlier.
1137
1138 .SH SA EXPIRY/REKEY
1139 The IKE SAs and IPsec SAs negotiated by the daemon can be configured to expire
1140 after a specific amount of time. For IPsec SAs this can also happen after a
1141 specified number of transmitted packets or transmitted bytes. The following
1142 settings can be used to configure this:
1143 .TS
1144 l r l r,- - - -,lB s lB s,a r a r.
1145 Setting Default Setting Default
1146 IKE SA  IPsec SA
1147 ikelifetime     3h      lifebytes       -
1148                 lifepackets     -
1149                 lifetime        1h
1150 .TE
1151 .SS Rekeying
1152 IKE SAs as well as IPsec SAs can be rekeyed before they expire. This can be
1153 configured using the following settings:
1154 .TS
1155 l r l r,- - - -,lB s lB s,a r a r.
1156 Setting Default Setting Default
1157 IKE and IPsec SA        IPsec SA
1158 margintime      9m      marginbytes     -
1159                 marginpackets   -
1160 .TE
1161 .SS Randomization
1162 To avoid collisions the specified margins are increased randomly before
1163 subtracting them from the expiration limits (see formula below). This is
1164 controlled by the
1165 .B rekeyfuzz
1166 setting:
1167 .TS
1168 l r,- -,lB s,a r.
1169 Setting Default
1170 IKE and IPsec SA
1171 rekeyfuzz       100%
1172 .TE
1173 .PP
1174 Randomization can be disabled by setting
1175 .BR rekeyfuzz " to " 0% .
1176 .SS Formula
1177 The following formula is used to calculate the rekey time of IPsec SAs:
1178 .PP
1179 .EX
1180  rekeytime = lifetime - (margintime + random(0, margintime * rekeyfuzz))
1181 .EE
1182 .PP
1183 It applies equally to IKE SAs and byte and packet limits for IPsec SAs.
1184 .SS Example
1185 Let's consider the default configuration:
1186 .PP
1187 .EX
1188         lifetime = 1h
1189         margintime = 9m
1190         rekeyfuzz = 100%
1191 .EE
1192 .PP
1193 From the formula above follows that the rekey time lies between:
1194 .PP
1195 .EX
1196         rekeytime_min = 1h - (9m + 9m) = 42m
1197         rekeytime_max = 1h - (9m + 0m) = 51m
1198 .EE
1199 .PP
1200 Thus, the daemon will attempt to rekey the IPsec SA at a random time
1201 between 42 and 51 minutes after establishing the SA. Or, in other words,
1202 between 9 and 18 minutes before the SA expires.
1203 .SS Notes
1204 .IP \[bu]
1205 Since the rekeying of an SA needs some time, the margin values must not be
1206 too low.
1207 .IP \[bu]
1208 The value
1209 .B margin... + margin... * rekeyfuzz
1210 must not exceed the original limit. For example, specifying
1211 .B margintime = 30m
1212 in the default configuration is a bad idea as there is a chance that the rekey
1213 time equals zero and, thus, rekeying gets disabled.
1214 .SH FILES
1215 .nf
1216 /etc/ipsec.conf
1217 /etc/ipsec.d/aacerts
1218 /etc/ipsec.d/acerts
1219 /etc/ipsec.d/cacerts
1220 /etc/ipsec.d/certs
1221 /etc/ipsec.d/crls
1222
1223 .SH SEE ALSO
1224 strongswan.conf(5), ipsec.secrets(5), ipsec(8)
1225 .SH HISTORY
1226 Originally written for the FreeS/WAN project by Henry Spencer.
1227 Updated and extended for the strongSwan project <http://www.strongswan.org> by
1228 Tobias Brunner, Andreas Steffen and Martin Willi.