]> git.saurik.com Git - apple/ipsec.git/blame_incremental - ipsec-tools/racoon/racoon.8
ipsec-332.100.1.tar.gz
[apple/ipsec.git] / ipsec-tools / racoon / racoon.8
... / ...
CommitLineData
1.\" $Id: racoon.8,v 1.3.10.1 2005/04/18 11:10:55 manubsd 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
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 46BdFLv
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.\"
50.Sh DESCRIPTION
51.Nm
52is used to setup and maintain an IPSec tunnel or transport channel,
53between two devices, over which network traffic is conveyed securely.
54This security is made possible by cryptographic keys and operations
55on both devices.
56.\"
57.Nm
58relies on a standardized network protocol (IKE) to automatically
59negotiate and manage the cryptographic keys (e.g. security
60associations) that are necessary for the
61IPSec tunnel or transport channel to function.
62.\"
63.Nm
64speaks the IKE
65.Pq ISAKMP/Oakley
66key management protocol,
67to establish security associations with other hosts.
68The SPD
69.Pq Security Policy Database
70in the kernel usually triggers
71.Nm .
72.Nm
73usually sends all informational messages, warnings and error messages to
74.Xr syslogd 8
75with the facility
76.Dv LOG_DAEMON
77and the priority
78.Dv LOG_INFO .
79Debugging messages are sent with the priority
80.Dv LOG_DEBUG .
81You should configure
82.Xr syslog.conf 5
83appropriately to see these messages.
84.Bl -tag -width Ds
85.It Fl 4
86.It Fl 6
87Specify the default address family for the sockets.
88.It Fl B
89Install SA(s) from the file which is specified in
90.Xr racoon.conf 5 .
91.It Fl d
92Increase the debug level.
93Multiple
94.Fl d
95arguments will increase the debug level even more.
96.It Fl F
97Run
98.Nm
99in the foreground.
100.It Fl f Ar configfile
101Use
102.Ar configfile
103as the configuration file instead of the default.
104.It Fl L
105Include
106.Ar file_name:line_number:function_name
107in all messages.
108.It Fl l Ar logfile
109Use
110.Ar logfile
111as the logging file instead of
112.Xr syslogd 8 .
113.It Fl v
114This flag causes the packet dump be more verbose, with higher
115debugging level.
116.El
117.Pp
118.Nm
119assumes the presence of the kernel random number device
120.Xr rnd 4
121at
122.Pa /dev/urandom .
123.\"
124.Sh RETURN VALUES
125The command exits with 0 on success, and non-zero on errors.
126.\"
127.Sh FILES
128.Bl -tag -width /private/etc/racoon/remote/anonymous -compact
129.It Pa /private/etc/racoon/racoon.conf
130default configuration file.
131.It Pa /private/etc/racoon/psk.txt
132default pre-shared key file.
133.El
134.\"
135.Sh SEE ALSO
136.Xr ipsec 4 ,
137.Xr racoon.conf 5 ,
138.Xr syslog.conf 5 ,
139.Xr setkey 8 ,
140.Xr syslogd 8
141.\"
142.Sh HISTORY
143The
144.Nm
145command first appeared in the
146.Dq YIPS
147Yokogawa IPsec implementation.
148.\"
149.Sh SECURITY CONSIDERATIONS
150The use of IKE phase 1 aggressive mode is not recommended,
151as described in
152.Pa http://www.kb.cert.org/vuls/id/886601 .