network_cmds-115.2.tar.gz

[apple/network_cmds.git] / racoon.tproj / racoon.8

.\"	$KAME: racoon.8,v 1.28 2001/10/19 05:04:32 sakane Exp $
.\"
.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the project nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd November 20, 2000
.Dt RACOON 8
.Os KAME
.\"
.Sh NAME
.Nm racoon
.Nd IKE (ISAKMP/Oakley) key management daemon
.\"
.Sh SYNOPSIS
.Nm racoon
.Bk -words
.Op Fl BdFv46
.Ek
.Bk -words
.Op Fl f Ar configfile
.Ek
.Bk -words
.Op Fl l Ar logfile
.Ek
.Bk -words
.Op Fl p Ar isakmp-port
.Ek
.\"
.Sh DESCRIPTION
.Nm
speaks IKE
.Pq ISAKMP/Oakley
key management protocol,
to establish security association with other hosts.
SPD
.Pq Security Policy Database
in the kernel usually triggers to start
.Nm racoon .
.Nm racoon
usually sends all of informational messages, warnings and error messages to
.Xr syslogd 8
with the facility LOG_DAEMON, the priority LOG_INFO.
Debugging messages are sent with the priority LOG_DEBUG.
You should configure
.Xr syslog.conf 5
appropriately to see these messages.
.Bl -tag -width Ds
.It Fl B
Install SA(s) from the file which is specified in
.Xr racoon.conf 5 .
.It Fl d
Increase the debug level.
Multiple
.Fl d
will increase the debug level even more.
.It Fl F
Run
.Nm racoon
in the foreground.
.It Fl f Ar configfile
Use
.Ar configfile
as the configuration file instead of the default.
.It Fl l Ar logfile
Use
.Ar logfile
as the logging file instead of
.Xr syslogd 8 .
.It Fl p Ar isakmp-port
Listen to ISAKMP key exchange on port
.Ar isakmp-port
instead of the default port number, 500.
.It Fl v
The flag causes the packet dump be more verbose, with higher debugging level.
.It Fl 4
.It Fl 6
Specifies the default address family for the sockets.
.El
.Pp
.Nm
assumes the presence of kernel random number device
.Xr rnd 4
at
.Pa /dev/urandom .
Informational messages are labeled
.Em info ,
and debugging messages are labeled
.Em debug .
You have to configure
.Xr syslog.conf 5
if you want to see them in a logging file.
.\"
.Sh FILES
.Bl -tag -width /usr/local/v6/etc/racoon.conf -compact
.It Pa /usr/local/v6/etc/racoon.conf
default configuration file.
.El
.\"
.Sh RETURN VALUES
The command exits with 0 on success, and non-zero on errors.
.\"
.Sh SEE ALSO
.Xr ipsec 4 ,
.Xr racoon.conf 5 ,
.Xr setkey 8 ,
.Xr syslogd 8
.Xr syslog.conf 5
.\"
.Sh HISTORY
The
.Nm
command first appeared in
.Dq YIPS
Yokogawa IPsec implementation.
.\"
.\".Sh BUGS