Project

General

Profile

ipsec.conf: conn Reference » History » Version 45

Tobias Brunner, 31.05.2011 09:06
Default value for keyingtries corrected.

1 21 Andreas Steffen
h1. conn <name>
2 1 Martin Willi
3 44 Tobias Brunner
{{>toc}}
4 1 Martin Willi
5 44 Tobias Brunner
h2. General Connection Parameters
6 21 Andreas Steffen
7 36 Andreas Steffen
_aaa_identity = <id>_
8 36 Andreas Steffen
9 36 Andreas Steffen
p((. defines the identity of the AAA backend used during IKEv2 EAP authentication. This is required if
10 36 Andreas Steffen
     the EAP client uses a method that verifies the server identity (such as EAP-TLS), but it does not
11 36 Andreas Steffen
     match the IKEv2 gateway identity.
12 36 Andreas Steffen
13 23 Tobias Brunner
_also = <section name>_
14 31 Martin Willi
15 23 Tobias Brunner
p((. includes conn section <name>.
16 1 Martin Willi
17 23 Tobias Brunner
_auth = *esp* | ah_
18 31 Martin Willi
19 23 Tobias Brunner
p((. whether authentication should be done as part of ESP encryption, or separately using the AH protocol.
20 1 Martin Willi
     The IKEv2 daemon currently supports ESP only.
21 1 Martin Willi
22 24 Andreas Steffen
_authby = *pubkey* | rsasig | ecdsasig | psk | secret | xauthrsasig | xauthpsk | eap | never_
23 31 Martin Willi
24 1 Martin Willi
p((. how the two security gateways should authenticate each other; acceptable values are *secret* or *psk*
25 25 Andreas Steffen
     for pre-shared secrets, *pubkey* for public key signatures as well as the synonyms *rsasig* for RSA digital
26 24 Andreas Steffen
     signatures and *ecdsasig* for Elliptic Curve DSA signatures. *never*  can be used if  negotiation is  never
27 24 Andreas Steffen
     to be attempted or accepted (useful for shunt-only conns). Digital signatures are superior in every way to
28 24 Andreas Steffen
     shared secrets. In IKEv2, the two ends must not agree on this parameter, it is relevant for the out-bound 
29 21 Andreas Steffen
     authentication  method only. IKEv1 additionally supports the values *xauthpsk* and *xauthrsasig* that
30 21 Andreas Steffen
     will enable _eXtended AUTHentication (XAUTH)_ in addition to IKEv1 main mode based on shared secrets
31 21 Andreas Steffen
     or digital RSA signatures,  respectively. IKEv2 additionally supports the value *eap*, which indicates
32 21 Andreas Steffen
     an initiator to request EAP authentication. The EAP method to use is selected by the server (see _eap_).
33 20 Andreas Steffen
     This parameter is deprecated for IKEv2 connections, as two peers do ot need to agree on an authentication
34 21 Andreas Steffen
     method. Use the _left|rightauth_ parameter to define authentication methods in IKEv2.
35 20 Andreas Steffen
36 23 Tobias Brunner
_auto = *ignore* | add | route | start_
37 31 Martin Willi
38 23 Tobias Brunner
p((. what operation, if any, should be done automatically at IPsec startup. *add* loads a connection without
39 21 Andreas Steffen
     starting it. *route* loads a connection and installs kernel traps. If traffic is detected between
40 21 Andreas Steffen
     _leftsubnet_ and _rightsubnet_, a connection is established. *start* loads a connection and brings
41 21 Andreas Steffen
     it up immediatly. *ignore* ignores the connection. This is equal to delete a connection from the config
42 1 Martin Willi
     file. Relevant only locally, other end need not agree on it (but in general, for an intended-to-be-permanent
43 23 Tobias Brunner
     connection, both ends should use _auto = *start*_ to ensure that any reboot causes immediate renegotiation).
44 1 Martin Willi
45 23 Tobias Brunner
_compress = yes | *no*_
46 31 Martin Willi
47 23 Tobias Brunner
p((. whether IPComp compression of content is proposed on the connection (link-level compression does not work on
48 21 Andreas Steffen
     encrypted data, so to be effective, compression must be done before encryption). A value of *yes* causes IPsec
49 4 Martin Willi
     to propose both compressed and  uncompressed, and  prefer compressed. A value of no prevents IPsec from proposing
50 33 Tobias Brunner
     compression; a proposal to compress will still be accepted.
51 1 Martin Willi
52 23 Tobias Brunner
_dpdaction = *none* | clear | hold | restart_
53 31 Martin Willi
54 23 Tobias Brunner
p((. controls the use of the Dead Peer Detection protocol (DPD, RFC 3706) where R_U_THERE notification messages
55 1 Martin Willi
     (IKEv1) or empty INFORMATIONAL messages (IKEv2) are periodically sent in order to check the liveliness of the
56 21 Andreas Steffen
     IPsec peer. The values *clear*, *hold*, and *restart* all activate DPD. If no activity is detected,
57 21 Andreas Steffen
     all  connections with a dead peer are stopped and unrouted (*clear*), put in the hold state (*hold*)
58 21 Andreas Steffen
     or restarted (*restart*). For IKEv1, the default is *none* which disables the active sending of
59 1 Martin Willi
     R_U_THERE  notifications. Nevertheless Pluto will always send the DPD Vendor ID during connection set up
60 1 Martin Willi
     in order to signal the readiness to act passively as a responder if the peer wants to use DPD. For IKEv2,
61 1 Martin Willi
     *none* does't make sense, since all messages are used to detect dead peers. If specified, it has the
62 21 Andreas Steffen
     same meaning as the default (*clear*).
63 21 Andreas Steffen
64 41 Tobias Brunner
_dpddelay = *30s* | <time>_
65 1 Martin Willi
66 31 Martin Willi
p((. defines  the  period time interval with which R_U_THERE messages/INFORMATIONAL exchanges are sent to the peer.
67 23 Tobias Brunner
     These are only sent if no other traffic is received. In IKEv2, a value of 0 sends no additional INFORMATIONAL
68 1 Martin Willi
     messages and uses only standard messages (such as those to rekey) to detect dead peers.
69 1 Martin Willi
70 41 Tobias Brunner
_dpdtimeout = *150s* | <time>_
71 31 Martin Willi
72 23 Tobias Brunner
p((. defines the timeout interval, after which all connections to a peer are deleted in case of inactivity.
73 41 Tobias Brunner
     This only applies to IKEv1, in IKEv2 the default [[Retransmission|retransmission timeout]] applies, as every exchange is used to
74 1 Martin Willi
     detect dead peers.
75 20 Andreas Steffen
76 1 Martin Willi
_inactivity = <time>_
77 30 Martin Willi
78 31 Martin Willi
p((. defines the timeout interval, after which a CHILD_SA is closed if it did not send or receive any traffic.
79 30 Martin Willi
     Currently supported in IKEv2 connections only.
80 30 Martin Willi
81 1 Martin Willi
_eap = aka | gtc | md5 | mschapv2 | radius | sim | <type> | <type>-<vendor>_
82 23 Tobias Brunner
83 41 Tobias Brunner
p((. defines the EAP type to propose as server if the client requests EAP authentication. Currently supported values are *aka*
84 23 Tobias Brunner
     for EAP-AKA, *gtc* for EAP-GTC, *md5* for EAP-MD5, *mschapv2* for EAP-MS-CHAPv2, *radius* for the
85 21 Andreas Steffen
     EAP-RADIUS proxy  and *sim* for EAP-SIM.
86 21 Andreas Steffen
     Additionally, IANA assigned EAP method numbers are accepted, or a definition in the form *eap=type-vendor*
87 21 Andreas Steffen
     (e.g. eap=7-12345 ) can be used to specify vendor specific EAP types. For IKEv2 this parameter is deprecated
88 1 Martin Willi
     in favour of _left|rightauth_.
89 41 Tobias Brunner
     To forward EAP authentication to a RADIUS server using the [[EapRadius|EAP-RADIUS plugin]], set *eap=radius*.
90 5 Martin Willi
91 23 Tobias Brunner
_eap_identity = <id>_
92 1 Martin Willi
93 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
94 23 Tobias Brunner
     identity  will be used as peer identity during EAP authentication. The special value _%identity_ uses the EAP Identity method
95 14 Martin Willi
     to ask the client for a EAP identity. If not defined, the IKEv2 identity will be used as EAP identity.
96 1 Martin Willi
97 1 Martin Willi
_esp = <cipher suites>_
98 23 Tobias Brunner
99 23 Tobias Brunner
p((. comma-separated list of ESP encryption/authentication algorithms to be used for the connection, e.g.
100 43 Tobias Brunner
     _aes128-sha256_. The notation is _encryption-integrity[-dhgroup]_. If _dh-group_ is specified,
101 1 Martin Willi
     CHILD_SA setup and rekeying include a separate Diffe-Hellman exchange (IKEv2 only).
102 43 Tobias Brunner
     Refer to [[IKEv1CipherSuites]] and [[IKEv2CipherSuites]] for a list of valid keywords.
103 1 Martin Willi
104 23 Tobias Brunner
_forceencaps = yes | *no*_
105 31 Martin Willi
106 41 Tobias Brunner
p((.  force UDP encapsulation for ESP packets even if no NAT situation is detected.
107 1 Martin Willi
      This may help to surmount restrictive firewalls. In order to force the peer to
108 1 Martin Willi
      encapsulate packets, NAT detection payloads are faked (IKEv2 only). 
109 1 Martin Willi
110 23 Tobias Brunner
_ike = <cipher suites>_
111 31 Martin Willi
112 23 Tobias Brunner
p((. comma-separated list of IKE/ISAKMP SA encryption/authentication algorithms to be used, e.g.
113 21 Andreas Steffen
     _aes128-sha1-modp2048_. The notation is _encryption-integrity-dhgroup_. In IKEv2, multiple algorithms
114 1 Martin Willi
     and proposals may be included, such as _aes128-aes256-sha1-modp1536-modp2048,3des-sha1-md5-modp1024_.
115 43 Tobias Brunner
     Refer to [[IKEv1CipherSuites]] and [[IKEv2CipherSuites]] for a list of valid keywords.
116 20 Andreas Steffen
117 23 Tobias Brunner
_ikelifetime = *3h* | <time>_
118 31 Martin Willi
119 40 Tobias Brunner
p((. how long the keying channel of a connection (_ISAKMP or IKE SA_) should last before being renegotiated. Also see [[ExpiryRekey|Expiry and Rekey]].
120 1 Martin Willi
121 23 Tobias Brunner
_installpolicy = *yes* | no_
122 31 Martin Willi
123 23 Tobias Brunner
p((. decides whether IPsec policies are installed in the kernel by the IKEv2 charon daemon for a given connection.
124 21 Andreas Steffen
     Allows peaceful cooperation e.g. with the Mobile IPv6  _mip6d_ daemon who wants to control the kernel policies.
125 1 Martin Willi
126 23 Tobias Brunner
_keyexchange = *ike* | ikev1 | ikev2_
127 31 Martin Willi
128 23 Tobias Brunner
p((. method of key exchange; which protocol should be used to initialize the connection. Connections marked with
129 21 Andreas Steffen
     *ikev1*  are initiated with Pluto, those marked with *ikev2* with Charon. An incoming request from 
130 38 Andreas Steffen
     the remote peer is handled by the correct daemon, unaffected from the _keyexchange_ setting. Starting with
131 38 Andreas Steffen
     strongSwan 4.5 the default value *ike* is a synonym for *ikev2*, whereas in older strongSwan releases *ikev1*
132 38 Andreas Steffen
     was assumed.
133 20 Andreas Steffen
134 45 Tobias Brunner
_keyingtries = *3* | <number> | %forever_
135 31 Martin Willi
136 23 Tobias Brunner
p((. how  many attempts (a whole number or _%forever_) should be made to negotiate a connection, or a replacement
137 45 Tobias Brunner
     for one, before giving up (default 3). The value _%forever_ means 'never give up'.  Relevant  only  locally, other end need
138 1 Martin Willi
     not agree on it.
139 5 Martin Willi
140 26 Tobias Brunner
_keylife_
141 31 Martin Willi
142 26 Tobias Brunner
p((. synonym for _lifetime_.
143 26 Tobias Brunner
144 26 Tobias Brunner
_lifebytes = <number>_
145 31 Martin Willi
146 26 Tobias Brunner
p((. the number of bytes transmitted over an IPsec SA before it expires (IKEv2 only).
147 26 Tobias Brunner
148 26 Tobias Brunner
_lifepackets = <number>_
149 31 Martin Willi
150 26 Tobias Brunner
p((. the number of packets transmitted over an IPsec SA before it expires (IKEv2 only).
151 26 Tobias Brunner
152 26 Tobias Brunner
_lifetime = *1h* | <time>_
153 31 Martin Willi
154 1 Martin Willi
p((. how  long  a  particular  instance  of a connection (a set of encryption/authentication keys for user packets)
155 21 Andreas Steffen
     should last, from successful negotiation to expiry; acceptable values are an integer optionally followed by
156 1 Martin Willi
     _s_ (a time in seconds) or a decimal number followed by _m_, _h_, or _d_ (a time in minutes, hours,
157 21 Andreas Steffen
     or days respectively) (default _1h_, maximum _24h_).  Normally, the connection is renegotiated (via the
158 26 Tobias Brunner
     keying  channel) before it expires (see _margintime_).  The two ends need not exactly agree on _lifetime_, although if they
159 1 Martin Willi
     do not, there will be some clutter of superseded connections on the end which thinks the lifetime is longer.
160 40 Tobias Brunner
     Also see [[ExpiryRekey|Expiry and Rekey]].
161 1 Martin Willi
162 26 Tobias Brunner
_marginbytes = <number>_
163 31 Martin Willi
164 26 Tobias Brunner
p((. how many bytes before IPsec SA expiry (see _lifebytes_) should attempts to negotiate a replacement begin (IKEv2 only).
165 26 Tobias Brunner
166 26 Tobias Brunner
_marginpackets = <number>_
167 31 Martin Willi
168 26 Tobias Brunner
p((. how many packets before IPsec SA expiry (see _lifepackets_) should attempts to negotiate a replacement begin (IKEv2 only).
169 26 Tobias Brunner
170 26 Tobias Brunner
_margintime = *9m* | <time>_
171 1 Martin Willi
172 26 Tobias Brunner
p((. how long before connection expiry or keying-channel expiry should attempts to negotiate a replacement begin; acceptable values
173 40 Tobias Brunner
     as for _lifetime_ (default _9m_).  Relevant only locally, other end need not agree on it. Also see [[ExpiryRekey|Expiry and Rekey]].
174 26 Tobias Brunner
175 35 Andreas Steffen
_mark = <value>[/<mask>]_
176 35 Andreas Steffen
177 37 Tobias Brunner
p((. sets  an XFRM mark in the inbound and outbound IPsec SAs and policies. If the mask is missing then
178 35 Andreas Steffen
     a default mask of *0xffffffff* is assumed.
179 39 Gerd v. Egidy
     If using not the default mask make sure that the mark <value> given is the first <value> value valid 
180 39 Gerd v. Egidy
     in this mark (Bits which are zero in the <mask> must be zero in the <value> too).
181 35 Andreas Steffen
182 35 Andreas Steffen
_mark_in = <value>[/<mask>]_
183 35 Andreas Steffen
184 37 Tobias Brunner
p((. sets an XFRM mark in the inbound IPsec SA and policy. If the mask is missing then
185 35 Andreas Steffen
     a default mask of *0xffffffff* is assumed.
186 39 Gerd v. Egidy
     If using not the default mask make sure that the mark <value> given is the first <value> value valid 
187 39 Gerd v. Egidy
     in this mark (Bits which are zero in the <mask> must be zero in the <value> too).
188 35 Andreas Steffen
189 35 Andreas Steffen
_mark_out = <value>[/<mask>]_
190 35 Andreas Steffen
191 37 Tobias Brunner
p((. sets an XFRM mark in the outbound IPsec SA and policy. If the mask is missing then
192 35 Andreas Steffen
     a default mask of *0xffffffff* is assumed.
193 39 Gerd v. Egidy
     If using not the default mask make sure that the mark <value> given is the first <value> value valid 
194 39 Gerd v. Egidy
     in this mark (Bits which are zero in the <mask> must be zero in the <value> too).
195 35 Andreas Steffen
196 23 Tobias Brunner
_mobike = *yes* | no_
197 31 Martin Willi
198 23 Tobias Brunner
p((. enables the IKEv2 [[MobIke|MOBIKE]] protocol defined by RFC 4555. If set to *no*, the IKEv2 charon
199 21 Andreas Steffen
     daemon will not actively propose [[MobIke|MOBIKE]] but will still accept and support the mobility protocol
200 1 Martin Willi
     as a responder.
201 1 Martin Willi
202 23 Tobias Brunner
_modeconfig = push | *pull*_
203 31 Martin Willi
204 23 Tobias Brunner
p((. defines which mode is used to assign a virtual IP. Currently relevant for IKEv1 only since IKEv2 always uses
205 21 Andreas Steffen
     the configuration payload in *pull* mode. Cisco VPN gateways usually operate in *push* mode.
206 1 Martin Willi
207 21 Andreas Steffen
_pfs = *yes* | no_
208 31 Martin Willi
209 1 Martin Willi
p((. whether _Perfect Forward Secrecy_ of keys is desired on the connection's keying channel (with PFS,
210 1 Martin Willi
     penetration of the key-exchange protocol does not compromise keys negotiated earlier). IKEv2 always uses
211 23 Tobias Brunner
     PFS for IKE_SA rekeying whereas for CHILD_SA rekeying PFS is enforced by defining a Diffie-Hellman dhgroup
212 23 Tobias Brunner
     in the _esp_ parameter.
213 21 Andreas Steffen
214 20 Andreas Steffen
_pfsgroup = <modp group>_
215 31 Martin Willi
216 20 Andreas Steffen
p((. defines a Diffie-Hellman group for _perfect forward secrecy_ in IKEv1 Quick Mode differing from the DH group
217 23 Tobias Brunner
     used for IKEv1 Main Mode (IKEv1 pluto daemon only). 
218 23 Tobias Brunner
219 1 Martin Willi
_reauth = *yes* | no_
220 31 Martin Willi
221 1 Martin Willi
p((. whether rekeying of an IKE_SA should also reauthenticate the peer. In IKEv1, reauthentication is always done.
222 4 Martin Willi
     In  IKEv2, a value of *no* rekeys without uninstalling the IPsec SAs, a value of *yes* (the default)
223 23 Tobias Brunner
     creates a new IKE_SA from scratch and tries to recreate all IPsec SAs.
224 23 Tobias Brunner
225 1 Martin Willi
_rekey = *yes* | no_
226 31 Martin Willi
227 1 Martin Willi
p((. whether a connection should be renegotiated when it is about to expire. The two ends need not agree, but
228 1 Martin Willi
     while a value of no prevents Pluto/Charon from requesting renegotiation, it does not prevent responding
229 1 Martin Willi
     to renegotiation requested from the other end, so no will be largely ineffective unless both ends agree on it.
230 1 Martin Willi
231 1 Martin Willi
_rekeyfuzz = *100%* | <percentage>_
232 31 Martin Willi
233 26 Tobias Brunner
p((. maximum percentage by which _marginbytes_, _marginpackets_ and _margintime_ should be randomly increased to randomize
234 1 Martin Willi
     rekeying intervals (important for hosts with many connections); acceptable values are an integer, which may exceed 100,
235 26 Tobias Brunner
     followed  by  a '%' .
236 26 Tobias Brunner
     The value of _marginTYPE_, after this random increase, must not exceed _lifeTYPE_ (where TYPE is one of bytes, packets or type).
237 26 Tobias Brunner
     The value _0%_ will suppress randomization. Relevant only locally, other end need not agree on it.
238 40 Tobias Brunner
     Also see [[ExpiryRekey|Expiry and Rekey]].
239 16 Andreas Steffen
240 26 Tobias Brunner
_rekeymargin_
241 31 Martin Willi
242 26 Tobias Brunner
p((.  synonym for _margintime_.
243 23 Tobias Brunner
244 41 Tobias Brunner
_reqid = <number>_
245 34 Tobias Brunner
246 34 Tobias Brunner
p((. sets the reqid for a given connection to a pre-configured fixed value (IKEv2 only).
247 34 Tobias Brunner
248 21 Andreas Steffen
_type = *tunnel* | transport | transport_proxy | passthrough | drop | reject_
249 31 Martin Willi
250 21 Andreas Steffen
p((. the type of the connection; currently the accepted values are *tunnel*, signifying a  host-to-host,
251 21 Andreas Steffen
     host-to-subnet, or subnet-to-subnet tunnel; *transport*, signifying host-to-host transport mode;
252 21 Andreas Steffen
     *transport_proxy*, signifying the special Mobile IPv6 transport proxy mode;
253 23 Tobias Brunner
     *passthrough*, signifying that no IPsec processing should be done at all; *drop*, signifying that packets
254 20 Andreas Steffen
     should be  discarded; and *reject*, signifying that packets should be discarded and a diagnostic ICMP
255 23 Tobias Brunner
     returned. Charon currently supports only *tunnel*, transport, and transport_proxy connection types.
256 23 Tobias Brunner
257 20 Andreas Steffen
_xauth = *client* | server_
258 31 Martin Willi
259 1 Martin Willi
p((. specifies the role in the XAUTH protocol if activated by _authby=xauthpsk_ or _authby=xauthrsasig_.
260 20 Andreas Steffen
261 44 Tobias Brunner
h2. left|right End Parameters
262 23 Tobias Brunner
263 27 Daniel Mentz
Connection descriptions are defined in terms of a left endpoint and a right endpoint. For example, the
264 27 Daniel Mentz
two parameters leftid and rightid specify the identity of the left and the right endpoint. For every
265 27 Daniel Mentz
connection description an attempt is made to figure out whether the local endpoint should act as the left or
266 27 Daniel Mentz
the right endpoint. This is done by matching the IP addresses defined for both endpoints with the
267 27 Daniel Mentz
IP addresses assigned to local network interfaces. If a match is found then the role (left or right) that
268 27 Daniel Mentz
matches is going to be considered "local". If no match is found during startup, "left" is considered "local".
269 27 Daniel Mentz
270 1 Martin Willi
_left|right = <ip address> | <fqdn> | %defaultroute | %any_
271 31 Martin Willi
272 33 Tobias Brunner
p((. (required) the IP address of the participant's public-network interface or one of several magic values.
273 33 Tobias Brunner
     If it is _%%defaultroute_, the value will be filled in automatically with the local address of
274 33 Tobias Brunner
     the default-route interface (as determined at IPsec startup time and during configuration
275 33 Tobias Brunner
     update). Either left or right may be _%%defaultroute_, but not both. The prefix % in front of a
276 29 Daniel Mentz
     fully-qualified domain name or an IP address will implicitly set _leftallowany=yes_. If the domain name
277 29 Daniel Mentz
     cannot be resolved into an IP address at IPsec startup or update time then _left=%any_ and _leftallowany=no_
278 29 Daniel Mentz
     will be assumed.
279 1 Martin Willi
     
280 32 Daniel Mentz
p((. In case of an IKEv2 connection, the value _%any_ for the local endpoint signifies an address to be filled in
281 32 Daniel Mentz
     (by automatic keying) during negotiation. If the local peer initiates the connection setup the routing table
282 32 Daniel Mentz
     will be queried to determine the correct local IP address. In case the local peer is responding to a connection
283 33 Tobias Brunner
     setup then any IP address that is assigned to a local interface will be accepted. Note that specifying _%any_
284 33 Tobias Brunner
     for the local endpoint is not supported by the IKEv1 pluto daemon.
285 27 Daniel Mentz
     
286 33 Tobias Brunner
p((. If _%any_ is used for the remote endpoint it literally means any IP address.
287 27 Daniel Mentz
     
288 33 Tobias Brunner
p((. Please note that with the usage of wildcards multiple connection descriptions might match a given incoming
289 29 Daniel Mentz
     connection attempt. The most specific description is used in that case.
290 21 Andreas Steffen
291 21 Andreas Steffen
_left|rightallowany = yes | *no*_
292 31 Martin Willi
293 21 Andreas Steffen
p((. a modifier for _left|right_, making it behave as _%any_ although a concrete IP address has been
294 21 Andreas Steffen
     assigned. Recommended for dynamic IP addresses that can be resolved by DynDNS at IPsec startup or update time.
295 21 Andreas Steffen
296 7 Martin Willi
_left|rightauth = <auth method>_
297 31 Martin Willi
298 23 Tobias Brunner
p((. Authentication method to use locally (left) or require from the remote (right) side. This parameter is 
299 23 Tobias Brunner
     supported in IKEv2 only. Acceptable values are *pubkey* for public key encryption (RSA/ECDSA), *psk*
300 21 Andreas Steffen
     for pre-shared key authentication, and *eap* to [require the] use of the Extensible Authentication Protocol.
301 20 Andreas Steffen
     In the case of *eap*, an optional EAP method can be appended. Currently defined methods are *eap-aka*,
302 20 Andreas Steffen
     *eap-sim*, *eap-gtc*, *eap-md5*, and *eap-mschapv2*.  Alternatively, IANA assigned EAP method
303 7 Martin Willi
     numbers are accepted. Vendor specific EAP methods are defined in the form *eap-type-vendor* (e.g.
304 23 Tobias Brunner
     *eap-7-12345*).
305 23 Tobias Brunner
306 21 Andreas Steffen
_left|rightauth2 = <auth method>_
307 31 Martin Willi
308 1 Martin Willi
p((. Same as _left|rightauth_, but defines a second authentication exchange. IKEv2 supports multiple authentication
309 23 Tobias Brunner
     rounds using _Multiple Authentication Exchanges_ defined in "RFC 4739":http://tools.ietf.org/html/rfc4739.
310 23 Tobias Brunner
     This allows e.g. a separate authentication of host and user (IKEv2 only).
311 1 Martin Willi
    
312 31 Martin Willi
313 23 Tobias Brunner
_left|rightca = <issuer dn> | %same_
314 23 Tobias Brunner
315 23 Tobias Brunner
p((. the distinguished name of a certificate authority which is required to lie in the trust path going from the
316 23 Tobias Brunner
     _left|right_ participant's certificate up to the root certification authority.
317 31 Martin Willi
318 21 Andreas Steffen
_left|rightca2 = <issuer dn> | %same_
319 1 Martin Willi
320 33 Tobias Brunner
p((. Same as _left|rightca_ but for the second authentication (IKev2 only).
321 7 Martin Willi
322 23 Tobias Brunner
_left|rightcert = <path>_
323 31 Martin Willi
324 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.
325 1 Martin Willi
     OpenPGP certificates are supported as well (IKEv1 only).  Both absolute paths or paths relative to
326 23 Tobias Brunner
     [[IpsecDirectoryCerts|/etc/ipsec.d/certs]] are accepted. By default _left|rightcert_ sets _left|rightid_
327 23 Tobias Brunner
     to the distinguished name of the certificate's subject and _left|rightca_ to the distinguished name of
328 21 Andreas Steffen
     the certificate's issuer. The _left|right_ participant's ID can be overridden by specifying a _left|rightid_
329 7 Martin Willi
     value which must be certified by the certificate, though.
330 21 Andreas Steffen
331 33 Tobias Brunner
_left|rightcert2 = <path>_
332 31 Martin Willi
333 1 Martin Willi
p((. Same as _left|rightcert_ but for the second authentication round (IKEv2 only).
334 23 Tobias Brunner
335 7 Martin Willi
_left|rightfirewall = yes | *no*_
336 31 Martin Willi
337 7 Martin Willi
p((. whether the _left|right_ participant is doing forwarding-firewalling (including  masquerading)
338 1 Martin Willi
     using iptables for traffic from _left|rightsubnet_, which should be turned off for traffic to the
339 21 Andreas Steffen
     other subnet) once the connection is established. May not be used in the same connection description with
340 20 Andreas Steffen
     _left|rightupdown_. Implemented as a parameter to the default _ipsec _updown_ script. Relevant only
341 23 Tobias Brunner
     locally, other end need not agree on it.
342 20 Andreas Steffen
343 20 Andreas Steffen
p((. If one or  both security gateways are doing forwarding firewalling (possibly including masquerading),
344 23 Tobias Brunner
     and this is specified using the firewall parameters, tunnels  established with  IPsec  are exempted from
345 23 Tobias Brunner
     it so that packets can flow unchanged through the tunnels. (This means that all subnets connected in this
346 7 Martin Willi
     manner must have distinct, non-overlapping subnet address blocks.)  This is done by the default 
347 23 Tobias Brunner
     _ipsec _updown_ script (see pluto(8)).
348 23 Tobias Brunner
349 1 Martin Willi
p((. In situations calling for more control, it may be preferable for the user to supply his own updown script,
350 7 Martin Willi
     which makes the appropriate adjustments for his system.
351 23 Tobias Brunner
352 23 Tobias Brunner
_left|rightgroups = <group list>_
353 31 Martin Willi
354 1 Martin Willi
p((. a comma-separated list of group names. If the _left|rightgroups_ parameter is present then the peer must
355 7 Martin Willi
     be a member of at least one of the groups defined by the parameter. Group membership must be certified by a
356 1 Martin Willi
     valid attribute certificate stored in [[IpsecDirectoryAcerts|/etc/ipsec.d/acerts]] that has been issued
357 7 Martin Willi
     to the peer by a trusted Authorization Authority stored in [[IpsecDirectoryAacerts|/etc/ipsec.d/aacerts]].
358 23 Tobias Brunner
     Attribute certificates are not supported in IKEv2 yet.
359 1 Martin Willi
360 12 Martin Willi
_left|righthostaccess = yes | *no*_
361 1 Martin Willi
362 1 Martin Willi
p((. inserts a pair of INPUT and OUTPUT iptables rules using the default _ipsec _updown_ script,
363 1 Martin Willi
     thus allowing access to the host itself in the case where the host's internal interface is part
364 1 Martin Willi
     of the negotiated client subnet. 
365 1 Martin Willi
366 1 Martin Willi
_left|rightid = <id>_
367 31 Martin Willi
368 1 Martin Willi
p((. how the _left|right_ participant should be identified for authentication; defaults to _left|right_.
369 33 Tobias Brunner
     Can be an IP address or a fully-qualified domain name preceded by @ (which is used as a literal string and not resolved).
370 23 Tobias Brunner
371 21 Andreas Steffen
_left|rightid2 = <id>_
372 8 Martin Willi
373 31 Martin Willi
p((. Identity to use for the second authentication of the left participant (IKEv2 only).
374 33 Tobias Brunner
     Defaults to _left|rightid_.
375 23 Tobias Brunner
376 33 Tobias Brunner
_leftikeport = <port>_
377 33 Tobias Brunner
378 33 Tobias Brunner
p((. UDP port the left participant uses for IKE communication. Currently supported in IKEv2 connections only.
379 33 Tobias Brunner
     If unspecified, port 500 is used with the port floating to 4500 if a NAT is detected or MOBIKE is enabled.
380 33 Tobias Brunner
     Specifying a local IKE port different from the default additionally requires a socket implementation that
381 33 Tobias Brunner
     listens to this port.
382 33 Tobias Brunner
383 7 Martin Willi
_left|rightnexthop = %direct | %defaultroute | <ip address> | <fqdn>_
384 23 Tobias Brunner
385 23 Tobias Brunner
p((. this parameter is usually not needed any more because the NETKEY IPsec stack does not require
386 21 Andreas Steffen
     explicit routing entries for the traffic to be tunneled. If _left|sourceip_ is used with IKEv1
387 1 Martin Willi
     then _left|rightnexthop_ must still be set in order for the source routes to work properly.
388 1 Martin Willi
389 23 Tobias Brunner
_left|rightprotoport = <protocol>/<port>_
390 31 Martin Willi
391 23 Tobias Brunner
p((. restrict the traffic selector to a single protocol and/or port. Examples: _leftprotoport=tcp/http_
392 1 Martin Willi
     or _leftprotoport=6/80_ or _rightprotoport=udp_
393 7 Martin Willi
394 23 Tobias Brunner
_left|rightrsasigkey = *%cert* | <raw rsa public key>_
395 31 Martin Willi
396 23 Tobias Brunner
p((. the left participant's public key for RSA signature authentication, in RFC 2537 format using ttodata(3)
397 1 Martin Willi
     encoding. The default value _%cert_ means that the key is extracted from a certificate.
398 1 Martin Willi
399 1 Martin Willi
_left|rightsendcert = never | no | *ifasked* | always | yes_
400 1 Martin Willi
401 1 Martin Willi
p((. Accepted values are *never* or *no*, *always* or *yes*, and *ifasked*, the latter meaning that 
402 1 Martin Willi
     the peer must send a certificate request (CR) payload in order to get a certificate in return.
403 1 Martin Willi
404 33 Tobias Brunner
_leftsourceip = %config | %cfg | %modeconfig | %modecfg | <ip address>_
405 7 Martin Willi
406 1 Martin Willi
p((. The internal source IP to use in a tunnel, also known as [[VirtualIp|virtual IP]].
407 31 Martin Willi
     If the value is one of the synonyms _%modeconfig, %modecfg, %config_, or _%cfg_, an address is
408 1 Martin Willi
     requested from the peer. In IKEv2, a statically defined address is also requested, since the server
409 23 Tobias Brunner
     may change it.
410 21 Andreas Steffen
411 1 Martin Willi
p((. If _leftsourceip=%config_ is set to request a [[VirtualIp|virtual IP]] from the peer then the
412 31 Martin Willi
     responder must define the address-to-be-assigned using a separate conn section with a _rightsourceip_
413 1 Martin Willi
     statement for each client.
414 33 Tobias Brunner
415 33 Tobias Brunner
_rightsourceip = %config | <network>/<netmask> | %poolname_
416 33 Tobias Brunner
417 33 Tobias Brunner
p((. The internal source IP to use in a tunnel for the remote peer. If the value is %config on the responder
418 33 Tobias Brunner
     side, the initiator must propose an address which is then echoed back. Also supported are address pools
419 33 Tobias Brunner
     expressed as _<network>/<netmask>_ or the use of an external IP address pool using _%%poolname_ where
420 33 Tobias Brunner
     _poolname_ is the name of the IP address pool used for the lookup (see [[VirtualIp|virtual IP]] for details). 
421 23 Tobias Brunner
422 23 Tobias Brunner
_left|rightsubnet = <ip subnet>_
423 31 Martin Willi
424 21 Andreas Steffen
p((. private subnet behind the left participant, expressed as network/netmask (actually, any form acceptable to
425 1 Martin Willi
     ttosubnet(3)); if omitted, essentially assumed to be left/32, signifying that the _left|right_ end of the
426 23 Tobias Brunner
     connection goes to the _left|right_ participant only. When using IKEv2, the configured subnet of the peers
427 23 Tobias Brunner
     may differ, the  protocol  narrows  it  to  the greatest common subnet. Further, IKEv2 supports multiple
428 21 Andreas Steffen
     subnets separated by commas. IKEv1 only interprets the first subnet of such a definition. 
429 21 Andreas Steffen
430 1 Martin Willi
_left|rightsubnetwithin = <ip subnet>_
431 31 Martin Willi
432 1 Martin Willi
p((. the  peer can propose any subnet or single IP address that fits within the range defined by
433 1 Martin Willi
     _left|rightsubnetwithin_.  Not relevant for IKEv2, as subnets are narrowed.
434 1 Martin Willi
435 1 Martin Willi
_left|rightupdown = <path>_
436 31 Martin Willi
437 1 Martin Willi
p((. what _updown_ script to run to adjust routing and/or firewalling when the status of the connection
438 1 Martin Willi
     changes (default _ipsec _updown_). Relevant only locally, other end need not agree on it.
439 1 Martin Willi
     IKEv2 uses the _updown_ script to insert firewall rules only, since routing has been implemented directly
440 1 Martin Willi
     into Charon.
441 42 Tobias Brunner
442 44 Tobias Brunner
h2. IKEv2 Mediation Extension Parameters
443 42 Tobias Brunner
444 42 Tobias Brunner
The following parameters are relevant to IKEv2 Mediation Extension operation only.
445 42 Tobias Brunner
446 42 Tobias Brunner
_mediation = yes | *no*_
447 42 Tobias Brunner
448 42 Tobias Brunner
p((. whether this connection is a mediation connection,  ie.  whether this connection is used to mediate other
449 42 Tobias Brunner
     connections.  Mediation connections create no child SA. Acceptable values  are  no (the default) and yes.
450 42 Tobias Brunner
451 42 Tobias Brunner
_mediated_by = <name>_
452 42 Tobias Brunner
453 42 Tobias Brunner
p((. the  name  of the connection to mediate this connection through. If given, the connection will  be  mediated
454 42 Tobias Brunner
     through  the  named mediation  connection.  The mediation connection must set *mediation=yes*.
455 42 Tobias Brunner
456 42 Tobias Brunner
_me_peerid = <id>_
457 42 Tobias Brunner
458 42 Tobias Brunner
p((. ID as which the peer is known to the mediation server, ie. which the  other end of this connection uses as
459 42 Tobias Brunner
     its leftid on its connection to the mediation server.  This is the ID we request  the mediation server to
460 42 Tobias Brunner
     mediate us with.  If me_peerid is not given, the rightid of this connection will be used as peer ID.