freeswan/utils/setup.8

   1 .TH IPSEC_SETUP 8 "23 July 2001"
   2 .\" RCSID $Id: setup.8,v 1.32 2001/07/24 00:17:20 henry Exp $
   3 .SH NAME
   4 ipsec setup \- control IPsec subsystem
   5 .SH SYNOPSIS
   6 .B ipsec
   7 .B setup
   8 command
   9 .SH DESCRIPTION
  10 .I Setup
  11 controls the FreeS/WAN IPsec subsystem,
  12 including both the Klips kernel code and the Pluto key-negotiation daemon.
  13 (It is a synonym for the ``rc'' script for the subsystem;
  14 the system runs the equivalent of
  15 .B "ipsec setup start"
  16 at boot time,
  17 and
  18 .B "ipsec setup stop"
  19 at shutdown time, more or less.)
  20 .PP
  21 The action taken depends on the specific
  22 .IR command ,
  23 and on the contents of the
  24 .B config
  25 .B setup
  26 section of the
  27 IPsec configuration file (\c
  28 .IR /etc/ipsec.conf ,
  29 see
  30 .IR ipsec.conf (5)).
  31 Current
  32 .IR command s
  33 are:
  34 .TP 10
  35 .B start
  36 start Klips and Pluto,
  37 including setting up Klips to do crypto operations on the
  38 interface(s) specified in the configuration file,
  39 and (if the configuration file so specifies)
  40 setting up manually-keyed connections and/or
  41 asking Pluto to negotiate automatically-keyed connections
  42 to other security gateways
  43 .TP
  44 .B stop
  45 shut down Klips and Pluto,
  46 including tearing down all existing crypto connections
  47 .TP
  48 .B restart
  49 equivalent to
  50 .B stop
  51 followed by
  52 .B start
  53 .TP
  54 .B status
  55 report the status of the subsystem;
  56 normally just reports
  57 .B "IPsec running"
  58 and
  59 .BR "pluto pid \fInnn\fP" ,
  60 or
  61 .BR "IPsec stopped" ,
  62 and exits with status 0,
  63 but will go into more detail (and exit with status 1)
  64 if something strange is found.
  65 (An ``illicit'' Pluto is one that does not match the process ID in
  66 Pluto's lock file;
  67 an ``orphaned'' Pluto is one with no lock file.)
  68 .PP
  69 The
  70 .B stop
  71 operation tries to clean up properly even if assorted accidents
  72 have occurred,
  73 e.g. Pluto having died without removing its lock file.
  74 If
  75 .B stop
  76 discovers that the subsystem is (supposedly) not running,
  77 it will complain,
  78 but will do its cleanup anyway before exiting with status 1.
  79 .PP
  80 Although a number of configuration-file parameters influence
  81 .IR setup 's
  82 operations, the key one is the
  83 .B interfaces
  84 parameter, which must be right or chaos will ensue.
  85 .SH FILES
  86 .ta \w'/proc/sys/net/ipv4/ip_forward'u+2n
  87 /etc/rc.d/init.d/ipsec  the script itself
  88 .br
  89 /etc/init.d/ipsec       alternate location for the script
  90 .br
  91 /etc/ipsec.conf IPsec configuration file
  92 .br
  93 /proc/sys/net/ipv4/ip_forward   forwarding control
  94 .br
  95 /var/run/ipsec.info     saved information
  96 .br
  97 /var/run/pluto.pid      Pluto lock file
  98 .br
  99 /var/run/ipsec_setup.pid        IPsec lock file
 100 .SH SEE ALSO
 101 ipsec.conf(5), ipsec(8), ipsec_manual(8), ipsec_auto(8), route(8)
 102 .SH DIAGNOSTICS
 103 All output from the commands
 104 .B start
 105 and
 106 .B stop
 107 goes both to standard
 108 output and to
 109 .IR syslogd (8),
 110 via
 111 .IR logger (1).
 112 Selected additional information is logged only to
 113 .IR syslogd (8).
 114 .SH HISTORY
 115 Written for the FreeS/WAN project
 116 <http://www.freeswan.org>
 117 by Henry Spencer.
 118 .SH BUGS
 119 Old versions of
 120 .IR logger (1)
 121 inject spurious extra newlines onto standard output.