aboutsummaryrefslogtreecommitdiffstats
path: root/doc/manpage.d/ipsec_setup.8.html
blob: 7197e2b18850b28ddfac626a94b39ee49a46fbb1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
Content-type: text/html

<HTML><HEAD><TITLE>Manpage of IPSEC_SETUP</TITLE>
</HEAD><BODY>
<H1>IPSEC_SETUP</H1>
Section: Maintenance Commands (8)<BR>Updated: 23 July 2001<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>


<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

ipsec setup - control IPsec subsystem
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>ipsec</B>

<B>setup</B>

[
<B>--show</B>

|
<B>--showonly</B>

]
command
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

<I>Setup</I>

controls the FreeS/WAN IPsec subsystem,
including both the Klips kernel code and the Pluto key-negotiation daemon.
(It is a synonym for the ``rc'' script for the subsystem;
the system runs the equivalent of
<B>ipsec setup start</B>

at boot time,
and
<B>ipsec setup stop</B>

at shutdown time, more or less.)
<P>

The action taken depends on the specific
<I>command</I>,

and on the contents of the
<B>config</B>

<B>setup</B>

section of the
IPsec configuration file (<I>/etc/ipsec.conf</I>,

see
<I><A HREF="ipsec.conf.5.html">ipsec.conf</A></I>(5)).

Current
<I>command</I>s

are:
<DL COMPACT>
<DT><B>start</B>

<DD>
start Klips and Pluto,
including setting up Klips to do crypto operations on the 
interface(s) specified in the configuration file,
and (if the configuration file so specifies)
setting up manually-keyed connections and/or
asking Pluto to negotiate automatically-keyed connections
to other security gateways
<DT><B>stop</B>

<DD>
shut down Klips and Pluto,
including tearing down all existing crypto connections
<DT><B>restart</B>

<DD>
equivalent to
<B>stop</B>

followed by
<B>start</B>

<DT><B>status</B>

<DD>
report the status of the subsystem;
normally just reports
<B>IPsec running</B>

and
<B>pluto pid </B><I>nnn</I>,

or
<B>IPsec stopped</B>,

and exits with status 0,
but will go into more detail (and exit with status 1)
if something strange is found.
(An ``illicit'' Pluto is one that does not match the process ID in
Pluto's lock file;
an ``orphaned'' Pluto is one with no lock file.)
</DL>
<P>

The
<B>stop</B>

operation tries to clean up properly even if assorted accidents
have occurred,
e.g. Pluto having died without removing its lock file.
If
<B>stop</B>

discovers that the subsystem is (supposedly) not running,
it will complain,
but will do its cleanup anyway before exiting with status 1.
<P>

Although a number of configuration-file parameters influence
<I>setup</I>'s

operations, the key one is the
<B>interfaces</B>

parameter, which must be right or chaos will ensue.
<P>

The
<B>--show</B>

and
<B>--showonly</B>

options cause
<I>setup</I>

to display the shell commands that it would execute.
<B>--showonly</B>

suppresses their execution.
Only
<B>start</B>,

<B>stop</B>,

and
<B>restart</B>

commands recognize these flags.
<A NAME="lbAE">&nbsp;</A>
<H2>FILES</H2>



/etc/rc.d/init.d/ipsec<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>the script itself<BR>
<BR>

/etc/init.d/ipsec<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>alternate location for the script<BR>
<BR>

/etc/ipsec.conf<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>IPsec configuration file<BR>
<BR>

/proc/sys/net/ipv4/ip_forward<TT>&nbsp;</TT>forwarding control<BR>
<BR>

/var/run/ipsec.info<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>saved information<BR>
<BR>

/var/run/pluto.pid<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>Pluto lock file<BR>
<BR>

/var/run/ipsec_setup.pid<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>IPsec lock file<BR>
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>

<A HREF="ipsec.conf.5.html">ipsec.conf</A>(5), <A HREF="ipsec.8.html">ipsec</A>(8), <A HREF="ipsec_manual.8.html">ipsec_manual</A>(8), <A HREF="ipsec_auto.8.html">ipsec_auto</A>(8), <A HREF="route.8.html">route</A>(8)
<A NAME="lbAG">&nbsp;</A>
<H2>DIAGNOSTICS</H2>

All output from the commands
<B>start</B>

and
<B>stop</B>

goes both to standard
output and to
<I><A HREF="syslogd.8.html">syslogd</A></I>(8),

via
<I><A HREF="logger.1.html">logger</A></I>(1).

Selected additional information is logged only to
<I><A HREF="syslogd.8.html">syslogd</A></I>(8).

<A NAME="lbAH">&nbsp;</A>
<H2>HISTORY</H2>

Written for the FreeS/WAN project
&lt;<A HREF="http://www.freeswan.org">http://www.freeswan.org</A>&gt;
by Henry Spencer.
<A NAME="lbAI">&nbsp;</A>
<H2>BUGS</H2>

Old versions of
<I><A HREF="logger.1.html">logger</A></I>(1)

inject spurious extra newlines onto standard output.
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">FILES</A><DD>
<DT><A HREF="#lbAF">SEE ALSO</A><DD>
<DT><A HREF="#lbAG">DIAGNOSTICS</A><DD>
<DT><A HREF="#lbAH">HISTORY</A><DD>
<DT><A HREF="#lbAI">BUGS</A><DD>
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 21:40:18 GMT, November 11, 2003
</BODY>
</HTML>