userapps/opensource/ipsec-tools/src/racoon/racoonctl.8

   1 .\" $Id: racoonctl.8,v 1.2 2004/11/21 16:46:53 manubsd Exp $
   2 .\"
   3 .\" Copyright (C) 2004 Emmanuel Dreyfus
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the project nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .Dd November 16, 2004
  31 .Dt RACOONCTL 8
  32 .\"
  33 .Sh NAME
  34 .Nm racoonctl
  35 .Nd racoon administrative control tool
  36 .\"
  37 .Sh SYNOPSIS
  38 .Nm
  39 reload-config
  40 .Nm
  41 show-schedule
  42 .Nm
  43 .Op Fl l Op Fl l
  44 show-sa
  45 .Op isakmp|esp|ah|ipsec
  46 .Nm
  47 flush-sa
  48 .Op isakmp|esp|ah|ipsec
  49 .Nm
  50 delete-sa
  51 .Ar saopts
  52 .Nm
  53 establish-sa
  54 .Op Fl u Ar identity
  55 .Ar saopts
  56 .Nm
  57 vpn-connect
  58 .Op Fl u identity
  59 .Ar vpn_gateway
  60 .Nm
  61 vpn-disconnect
  62 .Ar vpn_gateway
  63 .Nm
  64 show-event
  65 .Op Fl l
  66 .\"
  67 .Sh DESCRIPTION
  68 .Nm
  69 is used to control
  70 .Xr racoon 8
  71 operation, if ipsec-tools was configured with adminport support.
  72 Communication between
  73 .Nm
  74 and
  75 .Xr racoon 8
  76 is done through a UNIX socket. By changing the default mode and ownership
  77 of the socket, you can allow non root users to alter
  78 .Xr racoon 8
  79 behavior, so do that with caution.
  80 .Pp
  81 The following commands are available:
  82 .Bl -tag -width Ds
  83 .It reload-config
  84 This should cause
  85 .Xr racoon 8
  86 to reload its configuration file. This seems completely broken at the time
  87 this man page is written.
  88 .It show-schedule
  89 Unknown command.
  90 .It show-sa Op isakmp|esp|ah|ipsec
  91 Dump the SA: All the SA if no SA class is provided, or either ISAKMP SA,
  92 IPsec ESP SA, or IPsec AH SA, or all IPsec SA.
  93 Use
  94 .Fl l
  95 to increase verbosity.
  96 .It flush-sa Op isakmp|esp|ah|ipsec
  97 is used to flush all SA if no SA class is provided, or a class of SA,
  98 either ISAKMP SA, IPsec ESP SA, or IPsec AH SA, or all IPsec SA.
  99 .It establish-sa Oo Fl u Ar username Oc Ar saopts
 100 Establish a SA, either a ISAKMP SA, IPsec ESP SA, or IPsec AH SA. The
 101 optionnal
 102 .Fl u Ar username
 103 can be used when establishing an ISAKMP SA while hybrid auth is in use.
 104 .Nm
 105 will prompt you for the password associated with
 106 .Ar username
 107 and theses credentials will be used in the Xauth exchange.
 108 .Pp
 109 .Ar saopts
 110 can have the following formats:
 111 .Bl -tag -width Bl
 112 .It isakmp {inet|inet6} Ar src Ar dst
 113 .It {esp|ah} {inet|inet6} Ar src/prefixlen/port Ar dst/prefixlen/port
 114 {icmp|tcp|udp|any}
 115 .El
 116 .It vpn-connect Oo Fl u Ar username Oc Ar vpn_gateway
 117 This is a particular case of the previous command. It will establish an ISAKMP
 118 SA with
 119 .Ar vpn_gateway .
 120 .It delete-sa Ar saopts
 121 Delete a SA, either a ISAKMP SA, IPsec ESP SA, or IPsec AH SA.
 122 .It vpn-disconnect Ar vpn_gateway
 123 This is a particular case of the previous command. It will kill all SA
 124 associated with
 125 .Ar vpn_gateway .
 126 .It show-event Op Fl l
 127 Dump all events reported by
 128 .Xr racoon 8 ,
 129 then quit.
 130 The
 131 .Fl l
 132 causes
 133 .Nm
 134 to not stop once all the events have been readen, but rather to loop
 135 awaiting and reporting new events.
 136 .El
 137 .Pp
 138 Command shortcuts are available:
 139 .Bl -tag
 140 .It rc
 141 reload-config
 142 .It ss
 143 show-sa
 144 .It sc
 145 show-schedule
 146 .It fs
 147 flush-sa
 148 .It ds
 149 delete-sa
 150 .It es
 151 establish-sa
 152 .It vc
 153 vpn-connect
 154 .It vd
 155 vpn-disconnect
 156 .It se
 157 show-event
 158 .El
 159 .\"
 160 .Sh RETURN VALUES
 161 The command should exit with 0 on success, and non-zero on errors.
 162 .\"
 163 .Sh FILES
 164 .Bl -tag
 165 .It Pa /var/racoon/racoon.sock
 166 .Xr racoon 8
 167 control socket.
 168 .El
 169 .\"
 170 .Sh SEE ALSO
 171 .Xr ipsec 4 ,
 172 .Xr racoon 8 .
 173 .Sh HISTORY
 174 Once was
 175 .Xr kmpstat 8
 176 in the KAME project. It turned into
 177 .Xr racoonctl 8 but remained undocumented for a while.
 178 .An Emmanuel Dreyfus Aq manu@netbsd.org
 179 wrote this man page.