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

   1 .\" $Id: racoon.8,v 1.3 2004/07/12 20:35:58 ludvigm Exp $
   2 .\"
   3 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   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 20, 2000
  31 .Dt RACOON 8
  32 .Os KAME
  33 .\"
  34 .Sh NAME
  35 .Nm racoon
  36 .Nd IKE (ISAKMP/Oakley) key management daemon
  37 .\"
  38 .Sh SYNOPSIS
  39 .Nm racoon
  40 .Bk -words
  41 .Op Fl BFvdL46
  42 .Ek
  43 .Bk -words
  44 .Op Fl f Ar configfile
  45 .Ek
  46 .Bk -words
  47 .Op Fl l Ar logfile
  48 .Ek
  49 .Bk -words
  50 .Op Fl p Ar isakmp-port
  51 .Ek
  52 .Bk -words
  53 .Op Fl P Ar isakmp-natt-port
  54 .Ek
  55 .\"
  56 .Sh DESCRIPTION
  57 .Nm
  58 speaks IKE
  59 .Pq ISAKMP/Oakley
  60 key management protocol,
  61 to establish security association with other hosts.
  62 SPD
  63 .Pq Security Policy Database
  64 in the kernel usually triggers to start
  65 .Nm racoon .
  66 .Nm racoon
  67 usually sends all of informational messages, warnings and error messages to
  68 .Xr syslogd 8
  69 with the facility LOG_DAEMON, the priority LOG_INFO.
  70 Debugging messages are sent with the priority LOG_DEBUG.
  71 You should configure
  72 .Xr syslog.conf 5
  73 appropriately to see these messages.
  74 .Bl -tag -width Ds
  75 .It Fl B
  76 Install SA(s) from the file which is specified in
  77 .Xr racoon.conf 5 .
  78 .It Fl F
  79 Run
  80 .Nm racoon
  81 in the foreground.
  82 .It Fl f Ar configfile
  83 Use
  84 .Ar configfile
  85 as the configuration file instead of the default.
  86 .It Fl l Ar logfile
  87 Use
  88 .Ar logfile
  89 as the logging file instead of
  90 .Xr syslogd 8 .
  91 .It Fl p Ar isakmp-port
  92 Listen to ISAKMP key exchange on port
  93 .Ar isakmp-port
  94 instead of the default port number, 500.
  95 .It Fl P Ar isakmp-natt-port
  96 Use
  97 .Ar isakmp-natt-port
  98 for NAT-Traversal port-floating. The default is 4500.
  99 .It Fl v
 100 The flag causes the packet dump be more verbose, with higher debugging level.
 101 .It Fl d
 102 Increase the debug level.
 103 Multiple
 104 .Fl d
 105 will increase the debug level even more.
 106 .It Fl L
 107 Include
 108 .Ar file_name:line_number:fuction_name
 109 location in all messages.
 110 .It Fl 4
 111 .It Fl 6
 112 Specifies the default address family for the sockets.
 113 .El
 114 .Pp
 115 .Nm
 116 assumes the presence of kernel random number device
 117 .Xr rnd 4
 118 at
 119 .Pa /dev/urandom .
 120 Informational messages are labeled
 121 .Em info ,
 122 and debugging messages are labeled
 123 .Em debug .
 124 You have to configure
 125 .Xr syslog.conf 5
 126 if you want to see them in a logging file.
 127 .\"
 128 .Sh RETURN VALUES
 129 The command exits with 0 on success, and non-zero on errors.
 130 .\"
 131 .Sh FILES
 132 .Bl -tag -width /usr/local/v6/etc/racoon.conf -compact
 133 .It Pa /usr/local/v6/etc/racoon.conf
 134 default configuration file.
 135 .El
 136 .\"
 137 .Sh SEE ALSO
 138 .Xr ipsec 4 ,
 139 .Xr racoon.conf 5 ,
 140 .Xr syslog.conf 5 ,
 141 .Xr setkey 8 ,
 142 .Xr syslogd 8
 143 .\"
 144 .Sh HISTORY
 145 The
 146 .Nm
 147 command first appeared in
 148 .Dq YIPS
 149 Yokogawa IPsec implementation.
 150 .\"
 151 .Sh SECURITY CONSIDERATIONS
 152 The use of IKE phase 1 aggressive mode is not recommended,
 153 as describved in
 154 .Li http://www.kb.cert.org/vuls/id/886601 .