Project

General

Profile

ipsec.conf: conn Reference » History » Version 75

Tobias Brunner, 26.03.2015 12:07
Updated for 5.3.0

1 50 Tobias Brunner
{{title(ipsec.conf: conn Reference)}}
2 49 Tobias Brunner
3 49 Tobias Brunner
h1. ipsec.conf: conn <name>
4 1 Martin Willi
5 44 Tobias Brunner
{{>toc}}
6 1 Martin Willi
7 44 Tobias Brunner
h2. General Connection Parameters
8 21 Andreas Steffen
9 36 Andreas Steffen
_aaa_identity = <id>_
10 36 Andreas Steffen
11 36 Andreas Steffen
p((. defines the identity of the AAA backend used during IKEv2 EAP authentication. This is required if
12 36 Andreas Steffen
     the EAP client uses a method that verifies the server identity (such as EAP-TLS), but it does not
13 36 Andreas Steffen
     match the IKEv2 gateway identity.
14 36 Andreas Steffen
15 68 Tobias Brunner
_ah = <cipher suites>_
16 68 Tobias Brunner
17 68 Tobias Brunner
p((. comma-separated list of AH algorithms to be used for the connection, e.g. _sha1-sha256-modp1024_.
18 68 Tobias Brunner
     The notation is integrity[-dhgroup]. For IKEv2, multiple algorithms (separated by -) of the same type
19 68 Tobias Brunner
     can be included in a single proposal. IKEv1 only includes the first algorithm in a proposal.
20 68 Tobias Brunner
     Only either the *ah* or the *esp* keyword may be used, AH+ESP bundles are not supported.
21 68 Tobias Brunner
22 68 Tobias Brunner
p((. There is no default, by default ESP is used. The daemon adds its extensive default proposal to the configured
23 68 Tobias Brunner
     value. To restrict it to the configured proposal an exclamation mark (!) can be added at the end.
24 68 Tobias Brunner
     *Note:* As a responder the daemon accepts the first supported proposal received from the peer. In order
25 68 Tobias Brunner
     to restrict a responder to only accept specific cipher suites, the strict flag (!, exclamation mark)
26 68 Tobias Brunner
     can be used, e.g: sha256-sha512-modp2048!
27 68 Tobias Brunner
28 68 Tobias Brunner
p((. If dh-group is specified, CHILD_SA/Quick Mode setup and rekeying include a separate Diffe-Hellman exchange.
29 68 Tobias Brunner
30 68 Tobias Brunner
p((. Refer to [[IKEv1CipherSuites]] and [[IKEv2CipherSuites]] for a list of valid keywords.
31 68 Tobias Brunner
32 68 Tobias Brunner
p((. Available since [[5.1.1]].
33 68 Tobias Brunner
34 58 Tobias Brunner
_aggressive = yes | *no*_
35 58 Tobias Brunner
36 58 Tobias Brunner
p((. whether to use IKEv1 Aggressive or Main Mode (the default). Available since [[5.0.0]].
37 58 Tobias Brunner
38 31 Martin Willi
_also = <section name>_
39 1 Martin Willi
40 57 Tobias Brunner
p((. includes conn section <name>.
41 1 Martin Willi
42 58 Tobias Brunner
_authby = *pubkey* | rsasig | ecdsasig | psk | secret | xauthrsasig | xauthpsk | never_
43 24 Andreas Steffen
44 31 Martin Willi
p((. how the two security gateways should authenticate each other; acceptable values are *secret* or *psk*
45 58 Tobias Brunner
     for pre-shared secrets, *pubkey* (the default) for public key signatures as well as the synonyms *rsasig*
46 58 Tobias Brunner
     for RSA digital signatures and *ecdsasig* for Elliptic Curve DSA signatures.
47 58 Tobias Brunner
     *never*  can be used if negotiation is never to be attempted or accepted (useful for shunt-only conns).
48 58 Tobias Brunner
     Digital signatures are superior in every way to shared secrets. IKEv1 additionally supports the values
49 58 Tobias Brunner
     *xauthpsk* and *xauthrsasig* that will enable _eXtended Authentication (XAuth)_ in addition to IKEv1 main
50 58 Tobias Brunner
     mode based on shared secrets or digital RSA signatures,  respectively.
51 58 Tobias Brunner
     This parameter is deprecated for IKEv2 connections (and IKEv1 connections since [[5.0.0]]), as two peers
52 58 Tobias Brunner
     do not need to agree on an authentication method. Use the _left|rightauth_ parameter instead to define
53 58 Tobias Brunner
     authentication methods.
54 1 Martin Willi
55 31 Martin Willi
_auto = *ignore* | add | route | start_
56 23 Tobias Brunner
57 1 Martin Willi
p((. what operation, if any, should be done automatically at IPsec startup. *add* loads a connection without
58 21 Andreas Steffen
     starting it. *route* loads a connection and installs kernel traps. If traffic is detected between
59 21 Andreas Steffen
     _leftsubnet_ and _rightsubnet_, a connection is established. *start* loads a connection and brings
60 58 Tobias Brunner
     it up immediately. *ignore* ignores the connection. This is equal to deleting a connection from the config
61 57 Tobias Brunner
     file. Relevant only locally, other end need not agree on it.
62 1 Martin Willi
63 23 Tobias Brunner
_closeaction = *none* | clear | hold | restart_
64 47 Tobias Brunner
65 47 Tobias Brunner
p((. defines the action to take if the remote peer unexpectedly closes a CHILD_SA (IKEv2 only, see _dpdaction_ for
66 47 Tobias Brunner
     meaning of values). A _closeaction_ should not be used if the peer uses reauthentication or uniqueids checking,
67 57 Tobias Brunner
     as these events might trigger the defined action when not desired.
68 47 Tobias Brunner
69 23 Tobias Brunner
_compress = yes | *no*_
70 31 Martin Willi
71 23 Tobias Brunner
p((. whether IPComp compression of content is proposed on the connection (link-level compression does not work on
72 57 Tobias Brunner
     encrypted data, so to be effective, compression must be done before encryption). A value of *yes* causes the daemon
73 57 Tobias Brunner
     to propose both compressed and  uncompressed, and  prefer compressed. A value of *no* prevents the daemon from proposing or accepting compression.
74 1 Martin Willi
75 21 Andreas Steffen
_dpdaction = *none* | clear | hold | restart_
76 21 Andreas Steffen
77 21 Andreas Steffen
p((. controls the use of the Dead Peer Detection protocol (DPD, RFC 3706) where R_U_THERE notification messages
78 1 Martin Willi
     (IKEv1) or empty INFORMATIONAL messages (IKEv2) are periodically sent in order to check the liveliness of the
79 1 Martin Willi
     IPsec peer. The values *clear*, *hold*, and *restart* all activate DPD. If no activity is detected,
80 1 Martin Willi
     all  connections with a dead peer are stopped and unrouted (*clear*), put in the hold state (*hold*)
81 57 Tobias Brunner
     or restarted (*restart*). The default is *none* which disables the active sending of DPD messages.
82 21 Andreas Steffen
83 21 Andreas Steffen
_dpddelay = *30s* | <time>_
84 41 Tobias Brunner
85 1 Martin Willi
p((. defines  the  period time interval with which R_U_THERE messages/INFORMATIONAL exchanges are sent to the peer.
86 31 Martin Willi
     These are only sent if no other traffic is received. In IKEv2, a value of 0 sends no additional INFORMATIONAL
87 1 Martin Willi
     messages and uses only standard messages (such as those to rekey) to detect dead peers.
88 30 Martin Willi
89 31 Martin Willi
_dpdtimeout = *150s* | <time>_
90 30 Martin Willi
91 54 Andreas Steffen
p((. defines the timeout interval, after which all connections to a peer are deleted in case of inactivity.
92 23 Tobias Brunner
     This only applies to IKEv1, in IKEv2 the default [[Retransmission|retransmission timeout]] applies, as every exchange is used to
93 41 Tobias Brunner
     detect dead peers.
94 1 Martin Willi
95 1 Martin Willi
_inactivity = <time>_
96 65 Andreas Steffen
97 1 Martin Willi
p((. defines the timeout interval, after which a CHILD_SA is closed if it did not send or receive any traffic.
98 41 Tobias Brunner
     Not supported for IKEv1 connections prior to [[5.0.0]].
99 1 Martin Willi
100 23 Tobias Brunner
_eap_identity = <id>_
101 1 Martin Willi
102 31 Martin Willi
p((. defines the identity the client uses to reply to an EAP Identity request. If defined on the EAP server, the defined
103 23 Tobias Brunner
     identity  will be used as peer identity during EAP authentication. The special value _%identity_ uses the EAP Identity method
104 14 Martin Willi
     to ask the client for a EAP identity. If not defined, the IKEv2 identity will be used as EAP identity.
105 1 Martin Willi
106 1 Martin Willi
_esp = <cipher suites>_
107 57 Tobias Brunner
108 48 Tobias Brunner
p((. comma-separated list of ESP encryption/authentication algorithms to be used for the connection, e.g.
109 1 Martin Willi
     _aes128-sha256_. The notation is _encryption-integrity[-dhgroup][-esnmode]_.
110 68 Tobias Brunner
     For IKEv2, multiple algorithms (separated by -) of the same type can be included in a single proposal.
111 68 Tobias Brunner
     IKEv1 only includes the first algorithm in a proposal.  Only either the *ah* or the *esp* keyword may
112 68 Tobias Brunner
     be used, AH+ESP bundles are not supported.
113 68 Tobias Brunner
114 68 Tobias Brunner
p((. Defaults to *aes128-sha1,3des-sha1*. The daemon adds its extensive default proposal to
115 51 Tobias Brunner
     this default or the configured value. To restrict it to the configured proposal an exclamation mark (*&#33;*)
116 48 Tobias Brunner
     can be added at the end.
117 58 Tobias Brunner
     *Note*: As a responder both daemons accept the first supported proposal received from the peer. In order
118 1 Martin Willi
     to restrict a responder to only accept specific cipher suites, the strict flag (*&#33;*, exclamation mark)
119 1 Martin Willi
     can be used, e.g: _aes256-sha512-modp4096!_
120 68 Tobias Brunner
121 68 Tobias Brunner
p((. If _dh-group_ is specified, CHILD_SA setup and rekeying include a separate Diffe-Hellman exchange (since
122 58 Tobias Brunner
     [[5.0.0]] this also applies to IKEv1 Quick Mode).
123 68 Tobias Brunner
124 68 Tobias Brunner
p((. Valid values for _esnmode_ (IKEv2 only) are _esn_ and _noesn_.  Specifying both negotiates extended sequence
125 48 Tobias Brunner
     number support with the peer, the default is *noesn*.
126 1 Martin Willi
127 68 Tobias Brunner
p((. Refer to [[IKEv1CipherSuites]] and [[IKEv2CipherSuites]] for a list of valid keywords.
128 68 Tobias Brunner
129 1 Martin Willi
_forceencaps = yes | *no*_
130 48 Tobias Brunner
131 48 Tobias Brunner
p((.  force UDP encapsulation for ESP packets even if no NAT situation is detected.
132 43 Tobias Brunner
      This may help to surmount restrictive firewalls. In order to force the peer to
133 57 Tobias Brunner
      encapsulate packets, NAT detection payloads are faked.
134 65 Andreas Steffen
      Not supported for IKEv1 connections prior to [[5.0.0]].
135 1 Martin Willi
136 60 Tobias Brunner
_fragmentation = yes | force | *no*_
137 60 Tobias Brunner
138 74 Tobias Brunner
p((.  whether to use IKE fragmentation (proprietary IKEv1 extension or IKEv2 fragmentation as per "RFC 7383":http://tools.ietf.org/html/rfc7383).
139 74 Tobias Brunner
      Fragmented messages sent by a peer are always accepted irrespective of the value of this option.
140 74 Tobias Brunner
      If set to *yes* and the peer supports it, larger IKE messages will be sent in fragments (the maximum fragment size
141 74 Tobias Brunner
      can be configured in [[strongswan.conf]]). If set to *force* (only supported for IKEv1) the initial IKE message will already
142 74 Tobias Brunner
      be fragmented if required.
143 74 Tobias Brunner
      Available for IKEv1 connections since version:5.0.2 and for IKEv2 connections since version:5.2.1.
144 60 Tobias Brunner
145 31 Martin Willi
_ike = <cipher suites>_
146 1 Martin Willi
147 1 Martin Willi
p((. comma-separated list of IKE/ISAKMP SA encryption/authentication algorithms to be used, e.g.
148 59 Tobias Brunner
     _aes128-sha1-modp2048_. The notation is _encryption-integrity[-prf]-dhgroup_. In IKEv2, multiple algorithms
149 1 Martin Willi
     and proposals may be included, such as _aes128-aes256-sha1-modp1536-modp2048,3des-sha1-md5-modp1024_.
150 59 Tobias Brunner
     
151 59 Tobias Brunner
p((. The ability to configure a PRF algorithm different to that defined for integrity protection was added with [[5.0.2]].
152 59 Tobias Brunner
     If no PRF is configured, the algorithms defined for integrity are proposed as PRF.  The prf keywords are the same as
153 59 Tobias Brunner
     the integrity algorithms, but have a _prf_ prefix (such as _prfsha1_, _prfsha256_ or _prfaesxcbc_).
154 59 Tobias Brunner
155 59 Tobias Brunner
p((. Defaults to *aes128-sha1-modp2048,3des-sha1-modp1536* for IKEv1. The daemon adds its extensive default proposal
156 59 Tobias Brunner
     to this default or the configured value. To restrict it to the configured proposal an exclamation mark (*&#33;*) can be added at the end.
157 59 Tobias Brunner
     Refer to [[IKEv1CipherSuites]] and [[IKEv2CipherSuites]] for a list of valid keywords.
158 59 Tobias Brunner
     
159 59 Tobias Brunner
p((. *Note*: As a responder both daemons accept the first supported proposal received from the peer. In order
160 51 Tobias Brunner
     to restrict a responder to only accept specific cipher suites, the strict flag (*&#33;*, exclamation mark)
161 48 Tobias Brunner
     can be used, e.g: _aes256-sha512-modp4096!_
162 51 Tobias Brunner
163 62 Tobias Brunner
_ikedscp = *000000* | <DSCP field>_
164 62 Tobias Brunner
165 62 Tobias Brunner
p((. Differentiated Services Field Codepoint to set on outgoing IKE packets sent
166 62 Tobias Brunner
     from this connection. The value is a six digit binary encoded string defining
167 62 Tobias Brunner
     the Codepoint to set, as defined in "RFC 2474":http://tools.ietf.org/html/rfc2474.
168 62 Tobias Brunner
169 48 Tobias Brunner
_ikelifetime = *3h* | <time>_
170 43 Tobias Brunner
171 58 Tobias Brunner
p((. how long the keying channel of a connection (_ISAKMP or IKE SA_) should last before being renegotiated.
172 58 Tobias Brunner
     Also see [[ExpiryRekey|Expiry and Rekey]].
173 31 Martin Willi
174 40 Tobias Brunner
_installpolicy = *yes* | no_
175 1 Martin Willi
176 58 Tobias Brunner
p((. decides whether IPsec policies are installed in the kernel by the charon daemon for a given connection.
177 31 Martin Willi
     Allows peaceful cooperation e.g. with the Mobile IPv6  _mip6d_ daemon who wants to control the kernel policies.
178 23 Tobias Brunner
179 21 Andreas Steffen
_keyexchange = *ike* | ikev1 | ikev2_
180 1 Martin Willi
181 23 Tobias Brunner
p((. method of key exchange; which protocol should be used to initialize the connection.
182 58 Tobias Brunner
     Prior to [[5.0.0]] connections marked with *ikev1*  were initiated with Pluto, those marked with *ikev2* with Charon.
183 58 Tobias Brunner
     An incoming request from the remote peer was handled by the correct daemon, unaffected from the _keyexchange_ setting.
184 57 Tobias Brunner
     Starting with strongSwan [[4.5.0]] the default value *ike* is a synonym for *ikev2*, whereas in older strongSwan releases *ikev1* was assumed.
185 57 Tobias Brunner
     Since [[5.0.0]] both protocols are handled by Charon and connections marked with *ike* will use IKEv2 when initiating, but accept any protocol version when responding.
186 38 Andreas Steffen
187 38 Andreas Steffen
_keyingtries = *3* | <number> | %forever_
188 20 Andreas Steffen
189 45 Tobias Brunner
p((. how  many attempts (a positive integer or _%forever_) should be made to negotiate a connection, or a replacement
190 31 Martin Willi
     for one, before giving up (default 3). The value _%forever_ means 'never give up'.  Relevant  only  locally, other end need
191 46 Daniel Mentz
     not agree on it.
192 45 Tobias Brunner
193 1 Martin Willi
_keylife_
194 26 Tobias Brunner
195 31 Martin Willi
p((. synonym for _lifetime_.
196 26 Tobias Brunner
197 26 Tobias Brunner
_lifebytes = <number>_
198 31 Martin Willi
199 65 Andreas Steffen
p((. the number of bytes transmitted over an IPsec SA before it expires. Not supported for IKEv1 connections prior to [[5.0.0]].
200 26 Tobias Brunner
201 26 Tobias Brunner
_lifepackets = <number>_
202 1 Martin Willi
203 65 Andreas Steffen
p((. the number of packets transmitted over an IPsec SA before it expires. Not supported for IKEv1 connections prior to [[5.0.0]].
204 1 Martin Willi
205 31 Martin Willi
_lifetime = *1h* | <time>_
206 26 Tobias Brunner
207 31 Martin Willi
p((. how  long  a  particular  instance  of a connection (a set of encryption/authentication keys for user packets)
208 1 Martin Willi
     should last, from successful negotiation to expiry; acceptable values are an integer optionally followed by
209 1 Martin Willi
     _s_ (a time in seconds) or a decimal number followed by _m_, _h_, or _d_ (a time in minutes, hours,
210 21 Andreas Steffen
     or days respectively) (default _1h_, maximum _24h_).  Normally, the connection is renegotiated (via the
211 1 Martin Willi
     keying  channel) before it expires (see _margintime_).  The two ends need not exactly agree on _lifetime_, although if they
212 1 Martin Willi
     do not, there will be some clutter of superseded connections on the end which thinks the lifetime is longer.
213 1 Martin Willi
     Also see [[ExpiryRekey|Expiry and Rekey]].
214 40 Tobias Brunner
215 1 Martin Willi
_marginbytes = <number>_
216 26 Tobias Brunner
217 57 Tobias Brunner
p((. how many bytes before IPsec SA expiry (see _lifebytes_) should attempts to negotiate a replacement begin.
218 26 Tobias Brunner
219 26 Tobias Brunner
_marginpackets = <number>_
220 26 Tobias Brunner
221 57 Tobias Brunner
p((. how many packets before IPsec SA expiry (see _lifepackets_) should attempts to negotiate a replacement begin.
222 26 Tobias Brunner
223 40 Tobias Brunner
_margintime = *9m* | <time>_
224 1 Martin Willi
225 1 Martin Willi
p((. how long before connection expiry or keying-channel expiry should attempts to negotiate a replacement begin; acceptable values
226 26 Tobias Brunner
     as for _lifetime_ (default _9m_).  Relevant only locally, other end need not agree on it. Also see [[ExpiryRekey|Expiry and Rekey]].
227 35 Andreas Steffen
228 35 Andreas Steffen
_mark = <value>[/<mask>]_
229 37 Tobias Brunner
230 35 Andreas Steffen
p((. sets  an XFRM mark in the inbound and outbound IPsec SAs and policies. If the mask is missing then
231 75 Tobias Brunner
     a default mask of *0xffffffff* is assumed. Since version:5.3.0 the special value *%unique* assigns a unique
232 75 Tobias Brunner
     value to each newly created IPsec SA (used e.g. in combination with the [[forecast]] or [[connmark]] plugins).
233 35 Andreas Steffen
234 57 Tobias Brunner
_mark_in = <value>[/<mask>]_
235 1 Martin Willi
236 1 Martin Willi
p((. sets an XFRM mark in the inbound IPsec SA and policy. If the mask is missing then
237 57 Tobias Brunner
     a default mask of *0xffffffff* is assumed.
238 57 Tobias Brunner
239 39 Gerd v. Egidy
_mark_out = <value>[/<mask>]_
240 35 Andreas Steffen
241 1 Martin Willi
p((. sets an XFRM mark in the outbound IPsec SA and policy. If the mask is missing then
242 23 Tobias Brunner
     a default mask of *0xffffffff* is assumed.
243 31 Martin Willi
244 21 Andreas Steffen
_mobike = *yes* | no_
245 1 Martin Willi
246 1 Martin Willi
p((. enables the IKEv2 [[MobIke|MOBIKE]] protocol defined by RFC 4555. If set to *no*, the charon
247 23 Tobias Brunner
     daemon will not actively propose [[MobIke|MOBIKE]] as initiator and ignore the MOBIKE_SUPPORTED
248 31 Martin Willi
     notify as responder.
249 23 Tobias Brunner
250 57 Tobias Brunner
_modeconfig = push | *pull*_
251 21 Andreas Steffen
252 1 Martin Willi
p((. defines which mode is used to assign a virtual IP. Currently relevant for IKEv1 only since IKEv2 always uses
253 1 Martin Willi
     the configuration payload in *pull* mode. Cisco VPN gateways usually operate in *push* mode.
254 70 Tobias Brunner
     In versions prior to [[5.1.1]] the charon daemon did not support *push* mode.
255 57 Tobias Brunner
256 21 Andreas Steffen
_reauth = *yes* | no_
257 31 Martin Willi
258 20 Andreas Steffen
p((. whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1, reauthentication is always done.
259 1 Martin Willi
     In  IKEv2, a value of *no* rekeys without uninstalling the IPsec SAs, a value of *yes* (the default)
260 23 Tobias Brunner
     creates a new IKE_SA from scratch and tries to recreate all IPsec SAs.
261 23 Tobias Brunner
262 1 Martin Willi
_rekey = *yes* | no_
263 1 Martin Willi
264 1 Martin Willi
p((. whether a connection should be renegotiated when it is about to expire. The two ends need not agree, but
265 1 Martin Willi
     while a value of no prevents the daemon from requesting renegotiation, it does not prevent responding
266 58 Tobias Brunner
     to renegotiation requested from the other end, so no will be largely ineffective unless both ends agree on it.
267 58 Tobias Brunner
     Also see _reauth_.
268 1 Martin Willi
269 1 Martin Willi
_rekeyfuzz = *100%* | <percentage>_
270 1 Martin Willi
271 31 Martin Willi
p((. maximum percentage by which _marginbytes_, _marginpackets_ and _margintime_ should be randomly increased to randomize
272 1 Martin Willi
     rekeying intervals (important for hosts with many connections); acceptable values are an integer, which may exceed 100,
273 4 Martin Willi
     followed  by  a '%' .
274 23 Tobias Brunner
     The value of _marginTYPE_, after this random increase, must not exceed _lifeTYPE_ (where TYPE is one of bytes, packets or type).
275 31 Martin Willi
     The value _0%_ will suppress randomization. Relevant only locally, other end need not agree on it.
276 1 Martin Willi
     Also see [[ExpiryRekey|Expiry and Rekey]].
277 1 Martin Willi
278 1 Martin Willi
_rekeymargin_
279 1 Martin Willi
280 1 Martin Willi
p((.  synonym for _margintime_.
281 1 Martin Willi
282 71 Tobias Brunner
_replay_window = -1 | <number>_
283 71 Tobias Brunner
284 71 Tobias Brunner
p((. The  IPsec  replay  window  size  for  this connection. With the default of -1 the value configured with _charon.replay_window_  in
285 71 Tobias Brunner
     [[strongswan.conf]]  is used. Larger values than 32 are supported using the Netlink backend only, a  value  of  0  disables  IPsec
286 71 Tobias Brunner
     replay protection. Available since [[5.2.0]].
287 71 Tobias Brunner
288 1 Martin Willi
_reqid = <number>_
289 57 Tobias Brunner
290 26 Tobias Brunner
p((. sets the reqid for a given connection to a pre-configured fixed value.
291 57 Tobias Brunner
292 1 Martin Willi
_tfc = <value>_
293 57 Tobias Brunner
294 57 Tobias Brunner
p((. number of bytes to pad ESP payload data to. Traffic Flow Confidentiality is currently supported in IKEv2 and applies to outgoing packets only. The special value %mtu fills up ESP packets with padding to have the size of the MTU.
295 57 Tobias Brunner
296 57 Tobias Brunner
_type = *tunnel* | transport | transport_proxy | passthrough | drop_
297 1 Martin Willi
298 1 Martin Willi
p((. the type of the connection; currently the accepted values are *tunnel*, signifying a  host-to-host,
299 1 Martin Willi
     host-to-subnet, or subnet-to-subnet tunnel; *transport*, signifying host-to-host transport mode;
300 31 Martin Willi
     *transport_proxy*, signifying the special Mobile IPv6 transport proxy mode;
301 23 Tobias Brunner
     *passthrough*, signifying that no IPsec processing should be done at all; *drop*, signifying that packets
302 41 Tobias Brunner
     should be  discarded.
303 34 Tobias Brunner
304 57 Tobias Brunner
_xauth = *client* | server_
305 21 Andreas Steffen
306 1 Martin Willi
p((. specifies the role in the XAuth protocol if activated by _authby=xauthpsk_ or _authby=xauthrsasig_.
307 21 Andreas Steffen
308 23 Tobias Brunner
_xauth_identity = <id>_
309 20 Andreas Steffen
310 53 Tobias Brunner
p((. defines the identity/username the client uses to reply to an XAuth request. If not defined, the IKEv1 identity will be used as XAuth identity.
311 23 Tobias Brunner
312 20 Andreas Steffen
h2. left|right End Parameters
313 1 Martin Willi
314 1 Martin Willi
Connection descriptions are defined in terms of a left endpoint and a right endpoint. For example, the
315 1 Martin Willi
two parameters leftid and rightid specify the identity of the left and the right endpoint. For every
316 52 Tobias Brunner
connection description an attempt is made to figure out whether the local endpoint should act as the left or
317 52 Tobias Brunner
the right endpoint. This is done by matching the IP addresses defined for both endpoints with the
318 1 Martin Willi
IP addresses assigned to local network interfaces. If a match is found then the role (left or right) that
319 1 Martin Willi
matches is going to be considered "local". If no match is found during startup, "left" is considered "local".
320 1 Martin Willi
321 70 Tobias Brunner
_left|right = <ip address> | <fqdn> | *%any* | range | subnet_
322 52 Tobias Brunner
323 70 Tobias Brunner
p((. The IP address of the participant's public-network interface or one of several magic values.
324 57 Tobias Brunner
     The value _%any_ for the local endpoint signifies an address to be filled in
325 52 Tobias Brunner
     (by automatic keying) during negotiation. If the local peer initiates the connection setup the routing table
326 23 Tobias Brunner
     will be queried to determine the correct local IP address. In case the local peer is responding to a connection
327 1 Martin Willi
     setup then any IP address that is assigned to a local interface will be accepted.
328 1 Martin Willi
329 58 Tobias Brunner
p((. Prior to [[5.0.0]] specifying _%%any_ for the local endpoint was not supported for IKEv1 connections, instead
330 58 Tobias Brunner
     the keyword _%%defaultroute_ could be used, causing the value to be filled in automatically with the local
331 58 Tobias Brunner
     address of the default-route interface (as determined at IPsec startup time and during configuration
332 57 Tobias Brunner
     update). Either left or right may be _%defaultroute_, but not both.
333 57 Tobias Brunner
334 1 Martin Willi
p((. The prefix % in front of a fully-qualified domain name or an IP address will implicitly set _left|rightallowany=yes_.
335 1 Martin Willi
          
336 1 Martin Willi
p((. If _%any_ is used for the remote endpoint it literally means any IP address.
337 70 Tobias Brunner
338 70 Tobias Brunner
p((. Since [[5.1.1]] connections can be limited to a specific range of hosts. To do so a range (10.1.0.0-10.2.255.255)
339 70 Tobias Brunner
     or a subnet (10.1.0.0/16) can be specified, and multiple addresses, ranges and subnets can be separated by commas.
340 70 Tobias Brunner
     While one can freely combine these items, to initiate the connection at least one non-range/subnet is required.
341 1 Martin Willi
     
342 31 Martin Willi
p((. Please note that with the usage of wildcards multiple connection descriptions might match a given incoming
343 33 Tobias Brunner
     connection attempt. The most specific description is used in that case.
344 33 Tobias Brunner
345 33 Tobias Brunner
_left|rightallowany = yes | *no*_
346 1 Martin Willi
347 29 Daniel Mentz
p((. a modifier for _left|right_, making it behave as _%any_ although a concrete IP address has been
348 1 Martin Willi
     assigned. Recommended for dynamic IP addresses that can be resolved by DynDNS at IPsec startup or update time.
349 1 Martin Willi
350 1 Martin Willi
_left|rightauth = <auth method>_
351 1 Martin Willi
352 1 Martin Willi
p((. Authentication method to use locally (left) or require from the remote (right) side. Acceptable values are *pubkey*
353 1 Martin Willi
     for public key encryption (RSA/ECDSA), *psk* for pre-shared key authentication, *eap* to [require the] use of the Extensible Authentication Protocol, and *xauth* for IKEv1 eXtended Authentication.
354 75 Tobias Brunner
355 75 Tobias Brunner
p((. To require a trustchain public key strength for the remote side, specify the key type followed
356 75 Tobias Brunner
     by the minimum strength in bits (for example *ecdsa-384* or *rsa-2048-ecdsa-256*).
357 1 Martin Willi
     To limit the acceptable set of hashing algorithms for trustchain validation, append hash algorithms
358 1 Martin Willi
     to *pubkey* or a key strength definition (for example *pubkey-sha1-sha256* or *rsa-2048-ecdsa-256-sha256-sha384-sha512*).
359 75 Tobias Brunner
     Since version:5.3.0 and unless disabled in [[strongswan.conf]] such key types and hash algorithms are also
360 75 Tobias Brunner
     applied as constraints against IKEv2 signature authentication schemes used by the remote side.
361 75 Tobias Brunner
362 75 Tobias Brunner
p((. Since version:5.3.0 and if both peers support "RFC 7427":http://tools.ietf.org/html/rfc7427 ("Signature  Authentication in IKEv2") specific hash
363 75 Tobias Brunner
     algorithms to be used during IKEv2 authentication may be configured. The syntax is the same as above.
364 75 Tobias Brunner
     For  example, with pubkey-sha384-sha256 a public key signature scheme with either SHA-384 or SHA-256
365 75 Tobias Brunner
     would get used for authentication, in that order and depending on the hash algorithms supported by the peer.
366 75 Tobias Brunner
     If no specific hash algorithms are  configured, the default is to prefer an algorithm that matches or exceeds
367 75 Tobias Brunner
     the strength of the signature key.
368 75 Tobias Brunner
369 75 Tobias Brunner
p((. In the case of *eap*, an optional EAP method can be appended. Currently defined methods are *eap-aka*,
370 1 Martin Willi
     *eap-gtc*, *eap-md5*, *eap-mschapv2*, *eap-peap*, *eap-sim*, *eap-tls*, *eap-ttls*, *eap-dynamic*, and *eap-radius*.
371 75 Tobias Brunner
     Alternatively, IANA assigned EAP method numbers are accepted. Vendor specific EAP methods are defined
372 75 Tobias Brunner
     in the form *eap-type-vendor* (e.g. *eap-7-12345*).
373 75 Tobias Brunner
     Since version:5.3.0 signature and trust chain constraints for EAP-(T)TLS may be defined.  To do so, append a
374 75 Tobias Brunner
     colon to the EAP method, followed by the key type/size and hash algorithm as discussed above.
375 75 Tobias Brunner
     For *xauth*, an XAuth authentication backend can be specified, such as *xauth-generic* or *xauth-eap*.
376 75 Tobias Brunner
     If XAuth is used in _leftauth_, Hybrid authentication is used. For traditional XAuth authentication, define XAuth in _leftauth2_.
377 1 Martin Willi
378 57 Tobias Brunner
p((. Not supported for IKEv1 connections prior to [[5.0.0]].
379 27 Daniel Mentz
380 33 Tobias Brunner
381 58 Tobias Brunner
_left|rightauth2 = <auth method>_
382 58 Tobias Brunner
383 58 Tobias Brunner
p((. Same as _left|rightauth_, but defines an additional authentication exchange. In IKEv1, only XAuth can be used
384 57 Tobias Brunner
     in the second authentication round. IKEv2 supports multiple complete authentication rounds using
385 66 Andreas Steffen
     _Multiple Authentication Exchanges_ defined in "RFC 4739":http://tools.ietf.org/html/rfc4739. This allows e.g. a separate authentication of host and user.
386 7 Martin Willi
387 31 Martin Willi
p((. Not supported for IKEv1 connections prior to [[5.0.0]].
388 57 Tobias Brunner
    
389 23 Tobias Brunner
390 57 Tobias Brunner
_left|rightca = <issuer dn> | %same_
391 57 Tobias Brunner
392 58 Tobias Brunner
p((. the distinguished name of a certificate authority which is required to lie in the trust path going from the
393 56 Andreas Steffen
     _left|right_ participant's certificate up to the root certification authority.
394 1 Martin Willi
     *%same* means that the value configured for the other participant should be reused.
395 56 Andreas Steffen
396 23 Tobias Brunner
_left|rightca2 = <issuer dn> | %same_
397 21 Andreas Steffen
398 1 Martin Willi
p((. Same as _left|rightca_ but for the second authentication (IKev2 only).
399 1 Martin Willi
400 1 Martin Willi
_left|rightcert = <path>_
401 1 Martin Willi
402 23 Tobias Brunner
p((. the path to the left|right participant's X.509 certificate. The file can be coded either in PEM or DER format.
403 58 Tobias Brunner
     OpenPGP certificates are supported as well.  Both absolute paths or paths relative to
404 58 Tobias Brunner
     [[IpsecDirectoryCerts|/etc/ipsec.d/certs]] are accepted. By default _left|rightcert_ sets _left|rightid_
405 31 Martin Willi
     to the distinguished name of the certificate's subject. The _left|right_ participant's ID can be overridden
406 61 Tobias Brunner
     by specifying a _left|rightid_ value which must be certified by the certificate, though.
407 61 Tobias Brunner
408 61 Tobias Brunner
p((. Since [[5.0.2]] certificates can be configured in the form _%smartcard[<slot nr>[@<module>]]:<keyid>_, which
409 61 Tobias Brunner
     defines a specific certificate to load from a PKCS#11 backend for this connection (e.g. via the [[PKCS11Plugin|pkcs11 plugin]]).
410 61 Tobias Brunner
     See [[PinSecret|ipsec.secrets]] for details about smartcard definitions.
411 61 Tobias Brunner
     Defining a certificate on a smartcard with _left|rightcert_ is only required if the automatic selection via _left|rightid_
412 64 Tobias Brunner
     is not sufficient, for example, if multiple certificates use the same subject.
413 64 Tobias Brunner
414 64 Tobias Brunner
p((. Since [[5.0.3]] multiple certificate paths or PKCS#11 backends can be specified in a comma separated list.
415 64 Tobias Brunner
     The daemon chooses the certificate based on the received certificate requests, if possible, before enforcing
416 23 Tobias Brunner
     the first.
417 23 Tobias Brunner
418 57 Tobias Brunner
_left|rightcert2 = <path>_
419 21 Andreas Steffen
420 1 Martin Willi
p((. Same as _left|rightcert_ but for the second authentication round (IKEv2 only).
421 33 Tobias Brunner
422 7 Martin Willi
_left|rightcertpolicy = <OIDs>_
423 66 Andreas Steffen
424 1 Martin Willi
p((. Comma separated list of certificate policy OIDs the peer's certificate must have.
425 58 Tobias Brunner
     OIDs are specified using the numerical dotted representation. Not supported for IKEv1 connections prior to [[5.0.0]].
426 58 Tobias Brunner
427 58 Tobias Brunner
_left|rightdns = <servers>_
428 58 Tobias Brunner
429 58 Tobias Brunner
p((. Comma separated list of DNS server addresses to exchange as configuration attributes. On the initiator,
430 58 Tobias Brunner
     a server is a fixed IPv4/IPv6 address, or _%config4/%config6_ to request attributes without an address.
431 58 Tobias Brunner
     On the responder, only fixed IPv4/IPv6 addresses are allowed and define DNS servers assigned to the client.
432 1 Martin Willi
     Available since [[5.0.1]].
433 23 Tobias Brunner
434 1 Martin Willi
_left|rightfirewall = yes | *no*_
435 1 Martin Willi
436 1 Martin Willi
p((. whether the _left|right_ participant is doing forwarding-firewalling (including  masquerading)
437 1 Martin Willi
     using iptables for traffic from _left|rightsubnet_, which should be turned off for traffic to the
438 1 Martin Willi
     other subnet) once the connection is established. May not be used in the same connection description with
439 1 Martin Willi
     _left|rightupdown_. Implemented as a parameter to the default _ipsec _updown_ script. Relevant only
440 1 Martin Willi
     locally, other end need not agree on it.
441 23 Tobias Brunner
442 20 Andreas Steffen
p((. If one or  both security gateways are doing forwarding firewalling (possibly including masquerading),
443 23 Tobias Brunner
     and this is specified using the firewall parameters, tunnels  established with  IPsec  are exempted from
444 57 Tobias Brunner
     it so that packets can flow unchanged through the tunnels. (This means that all subnets connected in this
445 1 Martin Willi
     manner must have distinct, non-overlapping subnet address blocks.)  This is done by the default 
446 1 Martin Willi
     _ipsec _updown_ script.
447 1 Martin Willi
448 1 Martin Willi
p((. In situations calling for more control, it may be preferable for the user to supply his own _updown_ script,
449 1 Martin Willi
     which makes the appropriate adjustments for his system.
450 1 Martin Willi
451 31 Martin Willi
_left|rightgroups = <group list>_
452 58 Tobias Brunner
453 58 Tobias Brunner
p((. a comma-separated list of group names. If the _left|rightgroups_ parameter is present then the peer must
454 57 Tobias Brunner
     be a member of at least one of the groups defined by the parameter. Groups may be used together with the
455 58 Tobias Brunner
     [[EapRadius#Group-selection|eap-radius]] plugin.
456 1 Martin Willi
457 58 Tobias Brunner
_left|rightgroups2 = <group list>_
458 58 Tobias Brunner
459 58 Tobias Brunner
p((. Same as _left|rightgroups_ but for the second authentication round defined with _left|rightauth2_.
460 1 Martin Willi
     Available since [[5.0.1]].
461 1 Martin Willi
462 1 Martin Willi
_left|righthostaccess = yes | *no*_
463 1 Martin Willi
464 1 Martin Willi
p((. inserts a pair of INPUT and OUTPUT iptables rules using the default _ipsec _updown_ script,
465 33 Tobias Brunner
     thus allowing access to the host itself in the case where the host's internal interface is part
466 23 Tobias Brunner
     of the negotiated client subnet. 
467 57 Tobias Brunner
468 73 Tobias Brunner
_left|rightid = <id>_
469 73 Tobias Brunner
470 73 Tobias Brunner
p((. how the _left|right_ participant should be identified for authentication; defaults to _left|right_ or the subject of the certificate
471 1 Martin Willi
     configured with _left|rightcert_.  If _left|rightcert_ is configured the identity has to be confirmed by the certificate, that is,
472 73 Tobias Brunner
     it has to match the full subject DN or one of the subjectAltName extensions contained in the certificate.
473 73 Tobias Brunner
474 73 Tobias Brunner
p((. Can be an IP address, a fully-qualified domain name, an email address or a Distinguished Name for which the ID type is
475 73 Tobias Brunner
     determined automatically and the string is converted to the appropriate encoding.  In versions before [[5.0.0]] fully-qualified
476 73 Tobias Brunner
     domain names can be preceded by an @ to avoid them being resolved to an IP address.
477 73 Tobias Brunner
478 73 Tobias Brunner
p((. Since version:5.2.2 it is possible to enforce a specific identity type.  For this a prefix may be used, followed by a colon (:).
479 73 Tobias Brunner
     If the number sign (#) follows the colon, the remaining data is interpreted as hex encoding, otherwise the string is used as-is
480 73 Tobias Brunner
     as the identification data. Note that this implies that no conversion is performed for non-string identities.
481 73 Tobias Brunner
     For example, _ipv4:10.0.0.1_ does not create a valid ID_IPV4_ADDR IKE identity, as it does not get converted to binary
482 73 Tobias Brunner
     0x0a000001. Instead, one could use _ipv4:#0a000001_ to get a valid identity, but just using the implicit type with automatic
483 73 Tobias Brunner
     conversion is usually simpler. The same applies to the ASN.1 encoded types.
484 73 Tobias Brunner
     The following prefixes are known: _ipv4, ipv6, rfc822, email, userfqdn, fqdn, dns, asn1dn, asn1gn_ and _keyid_.
485 58 Tobias Brunner
     Custom type prefixes may be specified by surrounding the numerical type value with curly brackets.
486 58 Tobias Brunner
487 58 Tobias Brunner
p((. Since [[5.0.1]] _rightid_ for IKEv2 connections optionally takes a % as prefix in front of the identity.
488 58 Tobias Brunner
     If given it prevents the daemon from sending IDr in its IKE_AUTH request and will allow it to verify the 
489 58 Tobias Brunner
     configured identity against the subject and subjectAltNames contained in the responder's certificate (otherwise,
490 58 Tobias Brunner
     it is only compared with the IDr returned by the responder). The IDr sent by the initiator might otherwise 
491 33 Tobias Brunner
     prevent the responder from finding a config if it has configured a different value for _leftid_.
492 7 Martin Willi
493 23 Tobias Brunner
_left|rightid2 = <id>_
494 23 Tobias Brunner
495 21 Andreas Steffen
p((. Identity to use for the second authentication of the left participant (IKEv2 only).
496 1 Martin Willi
     Defaults to _left|rightid_.
497 1 Martin Willi
498 1 Martin Willi
_leftikeport = <port>_
499 1 Martin Willi
500 58 Tobias Brunner
p((. UDP port the left participant uses for IKE communication. If unspecified, port 500 is used with the port
501 58 Tobias Brunner
     floating to 4500 if a NAT is detected or MOBIKE is enabled.
502 63 Tobias Brunner
     Specifying a local IKE port different from the default additionally requires a socket implementation that
503 63 Tobias Brunner
     listens to this port. Not supported for IKEv1 connections prior to [[5.0.0]].
504 63 Tobias Brunner
505 70 Tobias Brunner
_left|rightprotoport = <protocol>/<port>_
506 70 Tobias Brunner
507 67 Tobias Brunner
p((. restrict the traffic selector to a single protocol and/or port.  Since [[5.1.0]] this option is deprecated
508 1 Martin Willi
     as protocol/port information can be defined for each subnet directly in _left|rightsubnet_.
509 1 Martin Willi
510 67 Tobias Brunner
_left|rightrsasigkey = <raw rsa public key> | <path to public key>_
511 67 Tobias Brunner
512 72 Tobias Brunner
p((. Since [[5.1.0]] a synonym for _left|rightsigkey_. Before that it denoted the left|right participant's public key
513 1 Martin Willi
for RSA signature authentication, in RFC 2537 format using hex (0x prefix) or base64 (0s prefix) encoding.
514 67 Tobias Brunner
Also accepted was the path to a file containing the public key in PEM or DER encoding.
515 67 Tobias Brunner
516 72 Tobias Brunner
_left|rightsigkey = <raw public key> | <path to public key>_
517 1 Martin Willi
518 72 Tobias Brunner
p((. Added with [[5.1.0]]. The left|right participant's public key for public key signature authentication, in PKCS#1
519 67 Tobias Brunner
format using  using hex (0x prefix) or base64 (0s prefix) encoding. With the optional _dns:_ or _ssh:_ prefix in front
520 72 Tobias Brunner
of 0x or 0s, the public key is expected in either the RFC 3110 (not the full RR, only the RSA key part) or
521 72 Tobias Brunner
RFC 4253 public key format, respectively.
522 1 Martin Willi
Also accepted is the path to a file containing the public key in PEM, DER or SSH encoding. Both absolute paths or
523 1 Martin Willi
paths relative to [[ipsecdirectorycerts|/etc/ipsec.d/certs]] are accepted.
524 1 Martin Willi
525 58 Tobias Brunner
_left|rightsendcert = never | no | *ifasked* | always | yes_
526 1 Martin Willi
527 58 Tobias Brunner
p((. Accepted values are *never* or *no*, *always* or *yes*, and *ifasked*, the latter meaning that 
528 58 Tobias Brunner
     the peer must send a certificate request (CR) payload in order to get a certificate in return.
529 58 Tobias Brunner
530 58 Tobias Brunner
_leftsourceip = %config4 | %config6 | <ip address>_
531 58 Tobias Brunner
532 31 Martin Willi
p((. The internal source IP to use in a tunnel, also known as [[VirtualIp|virtual IP]].
533 23 Tobias Brunner
     If the value is one of the synonyms _%config_, _%cfg_, _%modeconfig_ or _%modecfg_, an address (from
534 1 Martin Willi
     the tunnel address family) is requested from the peer.
535 57 Tobias Brunner
     Since [[5.0.1]] a comma-separated list is accepted to request multiple addresses, and with _%config4_ and
536 1 Martin Willi
     _%config6_ an address of the given address family will be requested explicitly.
537 1 Martin Willi
     If an IP address is configured, it will be requested from the responder, which is free to respond with a
538 73 Tobias Brunner
     different address.
539 7 Martin Willi
540 23 Tobias Brunner
_rightsourceip = %config | <network>/<netmask> | <from>-<to> | %poolname_
541 31 Martin Willi
542 73 Tobias Brunner
p((. The internal source IP to use in a tunnel for the remote peer. If the value is %config on the responder
543 73 Tobias Brunner
     side, the initiator must propose an address which is then echoed back. Also supported are address pools
544 1 Martin Willi
     expressed as _<network>/<netmask>_ and _<from>-<to>_ (since version:5.2.2) or the use of an external IP address pool
545 73 Tobias Brunner
     using _%%poolname_ where _poolname_ is the name of the IP address pool used for the lookup (see [[VirtualIp|virtual IP]] for details).
546 57 Tobias Brunner
     Since [[5.0.1]] a comma-separated list of IP addresses / pools is accepted, for instance, to define pools of
547 67 Tobias Brunner
     different address families.
548 1 Martin Willi
549 1 Martin Willi
_left|rightsubnet = <ip subnet>![[<proto/port>]][,...]_
550 1 Martin Willi
551 1 Martin Willi
p((. private subnet behind the left participant, expressed as network/netmask; if omitted, essentially assumed
552 57 Tobias Brunner
     to be _left_/32|128, signifying that the _left|right_ end of the connection goes to the _left|right_ participant only.
553 58 Tobias Brunner
     The configured subnets of the peers may differ, the protocol narrows it to the greatest common subnet.
554 58 Tobias Brunner
     Since [[5.0.0]] this is also done for IKEv1, but as this may lead to problems with other implementations,
555 58 Tobias Brunner
     make sure to configure identical subnets in such configurations.
556 58 Tobias Brunner
     IKEv2 supports multiple subnets separated by commas, IKEv1 only interprets the first subnet of such a definition,
557 1 Martin Willi
     unless the Cisco Unity extension plugin is enabled (available since [[5.0.1]]). 
558 1 Martin Willi
559 70 Tobias Brunner
p((. Since [[5.1.0]] the optional part after each subnet enclosed in square brackets specifies a protocol/port to restrict
560 70 Tobias Brunner
     the selector for that subnet. *Examples:* leftsubnet=10.0.0.1[tcp/http],10.0.0.2[6/80] or leftsubnet=fec1::1[udp],10.0.0.0/16[/53].
561 70 Tobias Brunner
     Instead of omitting either value _%any_ can be used to the same effect, e.g. leftsubnet=fec1::1[udp/%any],10.0.0.0/16[%any/53].
562 70 Tobias Brunner
563 70 Tobias Brunner
p((. Since [[5.1.1]], if the protocol is _icmp_ or _ipv6-icmp_ the port is interpreted as ICMP message type if it is less than 256,
564 67 Tobias Brunner
     or as type and code if it greater or equal to 256, with the type in the most significant 8 bits and the code in the
565 67 Tobias Brunner
     least significant 8 bits.
566 67 Tobias Brunner
567 67 Tobias Brunner
p((. The port value can alternatively take the value _%opaque_ for RFC 4301 OPAQUE selectors, or a numerical range
568 67 Tobias Brunner
     in the form 1024-65535. None of the kernel backends currently supports opaque or port ranges and uses _%any_
569 67 Tobias Brunner
     for policy installation instead.
570 67 Tobias Brunner
571 67 Tobias Brunner
p((. Instead of specifying a subnet, _%dynamic_ can be used to replace it with the IKE address, having the same effect
572 23 Tobias Brunner
     as omitting _left|rightsubnet_ completely. Using _%dynamic_ can be used to define multiple dynamic selectors,
573 21 Andreas Steffen
     each having a potentially different protocol/port definition.
574 1 Martin Willi
575 31 Martin Willi
_left|rightupdown = <path>_
576 1 Martin Willi
577 33 Tobias Brunner
p((. what _updown_ script to run to adjust routing and/or firewalling when the status of the connection
578 33 Tobias Brunner
     changes (default _ipsec _updown_). Relevant only locally, other end need not agree on it.
579 33 Tobias Brunner
     Charon uses the _updown_ script to insert firewall rules only, since routing has been implemented directly
580 33 Tobias Brunner
     into the daemon.
581 33 Tobias Brunner
582 33 Tobias Brunner
h2. IKEv2 Mediation Extension Parameters
583 33 Tobias Brunner
584 23 Tobias Brunner
The following parameters are relevant to IKEv2 Mediation Extension operation only.
585 23 Tobias Brunner
586 31 Martin Willi
_mediation = yes | *no*_
587 57 Tobias Brunner
588 57 Tobias Brunner
p((. whether this connection is a mediation connection,  ie.  whether this connection is used to mediate other
589 57 Tobias Brunner
     connections.  Mediation connections create no child SA. Acceptable values  are  no (the default) and yes.
590 57 Tobias Brunner
591 57 Tobias Brunner
_mediated_by = <name>_
592 21 Andreas Steffen
593 1 Martin Willi
p((. the  name  of the connection to mediate this connection through. If given, the connection will  be  mediated
594 31 Martin Willi
     through  the  named mediation  connection.  The mediation connection must set *mediation=yes*.
595 1 Martin Willi
596 57 Tobias Brunner
_me_peerid = <id>_
597 1 Martin Willi
598 1 Martin Willi
p((. ID as which the peer is known to the mediation server, ie. which the  other end of this connection uses as
599 58 Tobias Brunner
     its leftid on its connection to the mediation server.  This is the ID we request  the mediation server to
600 58 Tobias Brunner
     mediate us with.  If me_peerid is not given, the rightid of this connection will be used as peer ID.
601 58 Tobias Brunner
602 58 Tobias Brunner
h2. Removed parameters (since 5.0.0)
603 58 Tobias Brunner
604 58 Tobias Brunner
_auth = *esp* | ah_
605 58 Tobias Brunner
606 58 Tobias Brunner
p((. whether authentication should be done as part of ESP encryption, or separately using the AH protocol.
607 69 Tobias Brunner
	Only supported by the IKEv1 daemon pluto.
608 69 Tobias Brunner
609 58 Tobias Brunner
p((. Since [[5.1.1]] the *ah* keyword can be used to configure AH with the charon IKE daemon.
610 58 Tobias Brunner
611 58 Tobias Brunner
_pfs = *yes* | no_
612 58 Tobias Brunner
613 58 Tobias Brunner
p((. whether _Perfect Forward Secrecy_ of keys is desired on the connection's keying channel (with PFS,
614 58 Tobias Brunner
     penetration of the key-exchange protocol does not compromise keys negotiated earlier). IKEv2 always uses
615 58 Tobias Brunner
     PFS for IKE_SA rekeying whereas for CHILD_SA rekeying PFS is enforced by defining a Diffie-Hellman dhgroup
616 58 Tobias Brunner
     in the _esp_ parameter.  Since [[5.0.0]] the latter also applies to IKEv1 and this parameter has no effect anymore.
617 58 Tobias Brunner
618 58 Tobias Brunner
_pfsgroup = <modp group>_
619 58 Tobias Brunner
620 58 Tobias Brunner
p((. defines a Diffie-Hellman group for _perfect forward secrecy_ in IKEv1 Quick Mode differing from the DH group
621 58 Tobias Brunner
     used for IKEv1 Main Mode (IKEv1 pluto daemon only).
622 58 Tobias Brunner
623 58 Tobias Brunner
_left|rightnexthop = %direct | %defaultroute | <ip address> | <fqdn>_
624 58 Tobias Brunner
625 58 Tobias Brunner
p((. This parameter is usually not needed any more because the NETKEY IPsec stack does not require
626 58 Tobias Brunner
     explicit routing entries for the traffic to be tunneled. If _left|sourceip_ is used with IKEv1
627 58 Tobias Brunner
     then _left|rightnexthop_ must still be set in order for the source routes to work properly.
628 58 Tobias Brunner
629 58 Tobias Brunner
_left|rightsubnetwithin = <ip subnet>_
630 58 Tobias Brunner
631 1 Martin Willi
p((. the  peer can propose any subnet or single IP address that fits within the range defined by
632 1 Martin Willi
     _left|rightsubnetwithin_.  Is a synonym for _left|rightsubnet_ since [[5.0.0]], as subnets are narrowed.