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