freeswan/doc/manpage.d/ipsec_auto.8.html

   1 Content-type: text/html
   2
   3 <HTML><HEAD><TITLE>Manpage of IPSEC_AUTO</TITLE>
   4 </HEAD><BODY>
   5 <H1>IPSEC_AUTO</H1>
   6 Section: Maintenance Commands (8)<BR>Updated: 31 May 2001<BR><A HREF="#index">Index</A>
   7 <A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
   8
   9
  10 <A NAME="lbAB">&nbsp;</A>
  11 <H2>NAME</H2>
  12
  13 ipsec auto - control automatically-keyed IPsec connections
  14 <A NAME="lbAC">&nbsp;</A>
  15 <H2>SYNOPSIS</H2>
  16
  17 <B>ipsec</B>
  18
  19 <B>auto</B>
  20
  21 [
  22 <B>--show</B>
  23
  24 ] [
  25 <B>--showonly</B>
  26
  27 ] [
  28 <B>--asynchronous</B>
  29
  30 ]
  31 <BR>
  32
  33 &nbsp;&nbsp;&nbsp;[
  34 <B>--config</B>
  35
  36 configfile
  37 ] [
  38 <B>--verbose</B>
  39
  40 ]
  41 <BR>
  42
  43 &nbsp;&nbsp;&nbsp;operation
  44 connection
  45 <P>
  46 <B>ipsec</B>
  47
  48 <B>auto</B>
  49
  50 [
  51 <B>--show</B>
  52
  53 ] [
  54 <B>--showonly</B>
  55
  56 ] operation
  57 <A NAME="lbAD">&nbsp;</A>
  58 <H2>DESCRIPTION</H2>
  59
  60 <I>Auto</I>
  61
  62 manipulates automatically-keyed FreeS/WAN IPsec connections,
  63 setting them up and shutting them down
  64 based on the information in the IPsec configuration file.
  65 In the normal usage,
  66 <I>connection</I>
  67
  68 is the name of a connection specification in the configuration file;
  69 <I>operation</I>
  70
  71 is
  72 <B>--add</B>,
  73
  74 <B>--delete</B>,
  75
  76 <B>--replace</B>,
  77
  78 <B>--up</B>,
  79
  80 <B>--down</B>,
  81
  82 <B>--route</B>,
  83
  84 or
  85 <B>--unroute</B>.
  86
  87 The
  88 <B>--ready</B>,
  89
  90 <B>--rereadsecrets</B>,
  91
  92 and
  93 <B>--status</B>
  94
  95 <I>operations</I>
  96
  97 do not take a connection name.
  98 <I>Auto</I>
  99
 100 generates suitable
 101 commands and feeds them to a shell for execution.
 102 <P>
 103
 104 The
 105 <B>--add</B>
 106
 107 operation adds a connection specification to the internal database
 108 within
 109 <I>pluto</I>;
 110
 111 it will fail if
 112 <I>pluto</I>
 113
 114 already has a specification by that name.
 115 The
 116 <B>--delete</B>
 117
 118 operation deletes a connection specification from
 119 <I>pluto</I>'s
 120
 121 internal database (also tearing down any connections based on it);
 122 it will fail if the specification does not exist.
 123 The
 124 <B>--replace</B>
 125
 126 operation is equivalent to
 127 <B>--delete</B>
 128
 129 (if there is already a specification by the given name)
 130 followed by
 131 <B>--add</B>,
 132
 133 and is a convenience for updating
 134 <I>pluto</I>'s
 135
 136 internal specification to match an external one.
 137 (Note that a
 138 <B>--rereadsecrets</B>
 139
 140 may also be needed.)
 141 None of the other operations alters the internal database.
 142 <P>
 143
 144 The
 145 <B>--up</B>
 146
 147 operation asks
 148 <I>pluto</I>
 149
 150 to establish a connection based on an entry in its internal database.
 151 The
 152 <B>--down</B>
 153
 154 operation tells
 155 <I>pluto</I>
 156
 157 to tear down such a connection.
 158 <P>
 159
 160 Normally,
 161 <I>pluto</I>
 162
 163 establishes a route to the destination specified for a connection as
 164 part of the
 165 <B>--up</B>
 166
 167 operation.
 168 However, the route and only the route can be established with the
 169 <B>--route</B>
 170
 171 operation.
 172 Until and unless an actual connection is established,
 173 this discards any packets sent there,
 174 which may be preferable to having them sent elsewhere based on a more
 175 general route (e.g., a default route).
 176 <P>
 177
 178 Normally,
 179 <I>pluto</I>'s
 180
 181 route to a destination remains in place when a
 182 <B>--down</B>
 183
 184 operation is used to take the connection down
 185 (or if connection setup, or later automatic rekeying, fails).
 186 This permits establishing a new connection (perhaps using a
 187 different specification; the route is altered as necessary)
 188 without having a ``window'' in which packets might go elsewhere
 189 based on a more general route.
 190 Such a route can be removed using the
 191 <B>--unroute</B>
 192
 193 operation
 194 (and is implicitly removed by
 195 <B>--delete</B>).
 196
 197 <P>
 198
 199 The
 200 <B>--ready</B>
 201
 202 operation tells
 203 <I>pluto</I>
 204
 205 to listen for connection-setup requests from other hosts.
 206 Doing an
 207 <B>--up</B>
 208
 209 operation before doing
 210 <B>--ready</B>
 211
 212 on both ends is futile and will not work,
 213 although this is now automated as part of IPsec startup and
 214 should not normally be an issue.
 215 <P>
 216
 217 The
 218 <B>--status</B>
 219
 220 operation asks
 221 <I>pluto</I>
 222
 223 for current connection status.
 224 The output format is ad-hoc and likely to change.
 225 <P>
 226
 227 The
 228 <B>--rereadsecrets</B>
 229
 230 operation tells
 231 <I>pluto</I>
 232
 233 to re-read the
 234 <I>/etc/ipsec.secrets</I>
 235
 236 secret-keys file,
 237 which it normally reads only at startup time.
 238 (This is currently a synonym for
 239 <B>--ready</B>,
 240
 241 but that may change.)
 242 <P>
 243
 244 The
 245 <B>--show</B>
 246
 247 option turns on the
 248 <B>-x</B>
 249
 250 option of the shell used to execute the commands,
 251 so each command is shown as it is executed.
 252 <P>
 253
 254 The
 255 <B>--showonly</B>
 256
 257 option causes
 258 <I>auto</I>
 259
 260 to show the commands it would run, on standard output,
 261 and not run them.
 262 <P>
 263
 264 The
 265 <B>--asynchronous</B>
 266
 267 option, applicable only to the
 268 <B>up</B>
 269
 270 operation,
 271 tells
 272 <I>pluto</I>
 273
 274 to attempt to establish the connection,
 275 but does not delay to report results.
 276 This is especially useful to start multiple connections in parallel
 277 when network links are slow.
 278 <P>
 279
 280 The
 281 <B>--verbose</B>
 282
 283 option instructs
 284 <I>auto</I>
 285
 286 to pass through all output from
 287 <I><A HREF="ipsec_whack.8.html">ipsec_whack</A></I>(8),
 288
 289 including log output that is normally filtered out as uninteresting.
 290 <P>
 291
 292 The
 293 <B>--config</B>
 294
 295 option specifies a non-standard location for the IPsec
 296 configuration file (default
 297 <I>/etc/ipsec.conf</I>).
 298
 299 <P>
 300
 301 See
 302 <I><A HREF="ipsec.conf.5.html">ipsec.conf</A></I>(5)
 303
 304 for details of the configuration file.
 305 Apart from the basic parameters which specify the endpoints and routing
 306 of a connection (<B>left</B>
 307 and
 308 <B>right</B>,
 309
 310 plus possibly
 311 <B>leftsubnet</B>,
 312
 313 <B>leftnexthop</B>,
 314
 315 <B>leftfirewall</B>,
 316
 317 their
 318 <B>right</B>
 319
 320 equivalents,
 321 and perhaps
 322 <B>type</B>),
 323
 324 an
 325 <I>auto</I>
 326
 327 connection almost certainly needs a
 328 <B>keyingtries</B>
 329
 330 parameter (since the
 331 <B>keyingtries</B>
 332
 333 default is poorly chosen).
 334 <A NAME="lbAE">&nbsp;</A>
 335 <H2>FILES</H2>
 336
 337
 338
 339 /etc/ipsec.conf<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>default IPSEC configuration file<BR>
 340 <BR>
 341
 342 /var/run/ipsec.info<TT>&nbsp;&nbsp;&nbsp;</TT><B>%defaultroute</B> information<BR>
 343 <A NAME="lbAF">&nbsp;</A>
 344 <H2>SEE ALSO</H2>
 345
 346 <A HREF="ipsec.conf.5.html">ipsec.conf</A>(5), <A HREF="ipsec.8.html">ipsec</A>(8), <A HREF="ipsec_pluto.8.html">ipsec_pluto</A>(8), <A HREF="ipsec_whack.8.html">ipsec_whack</A>(8), <A HREF="ipsec_manual.8.html">ipsec_manual</A>(8)
 347 <A NAME="lbAG">&nbsp;</A>
 348 <H2>HISTORY</H2>
 349
 350 Written for the FreeS/WAN project
 351 &lt;<A HREF="http://www.freeswan.org">http://www.freeswan.org</A>&gt;
 352 by Henry Spencer.
 353 <A NAME="lbAH">&nbsp;</A>
 354 <H2>BUGS</H2>
 355
 356 Although an
 357 <B>--up</B>
 358
 359 operation does connection setup on both ends,
 360 <B>--down</B>
 361
 362 tears only one end of the connection down
 363 (although the orphaned end will eventually time out).
 364 <P>
 365
 366 There is no support for
 367 <B>passthrough</B>
 368
 369 connections.
 370 <P>
 371
 372 A connection description which uses
 373 <B>%defaultroute</B>
 374
 375 for one of its
 376 <B>nexthop</B>
 377
 378 parameters but not the other may be falsely
 379 rejected as erroneous in some circumstances.
 380 <P>
 381
 382 <HR>
 383 <A NAME="index">&nbsp;</A><H2>Index</H2>
 384 <DL>
 385 <DT><A HREF="#lbAB">NAME</A><DD>
 386 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 387 <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
 388 <DT><A HREF="#lbAE">FILES</A><DD>
 389 <DT><A HREF="#lbAF">SEE ALSO</A><DD>
 390 <DT><A HREF="#lbAG">HISTORY</A><DD>
 391 <DT><A HREF="#lbAH">BUGS</A><DD>
 392 </DL>
 393 <HR>
 394 This document was created by
 395 <A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
 396 using the manual pages.<BR>
 397 Time: 05:09:31 GMT, June 19, 2001
 398 </BODY>
 399 </HTML>