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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry>
<refmeta>
<refentrytitle>IPSEC</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='date'>16 April 2023</refmiscinfo>
<refmiscinfo class="source">Libreswan</refmiscinfo>
<refmiscinfo class="version">@@IPSECVERSION@@</refmiscinfo>
<refmiscinfo class="manual">Executable programs</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>ipsec</refname>
<refpurpose>invoke IPsec utilities</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>ipsec</command>
<arg choice='plain'><replaceable>command</replaceable></arg>
<arg choice='opt' rep='repeat'><replaceable>argument</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ipsec help</command>
</cmdsynopsis>
<cmdsynopsis>
<command>ipsec version</command>
</cmdsynopsis>
<cmdsynopsis>
<command>ipsec directory</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
<command>ipsec</command> invokes any of several utilities
involved in controlling the IPsec encryption/authentication
system, running the specified <replaceable>command</replaceable>
with the specified <replaceable>argument</replaceable> as if it
had been invoked directly. This largely eliminates possible
name collisions with other software, and also permits some
centralized services.
</para>
<para>
<command>ipsec help</command> lists the available commands.
Most have their own manual pages.
</para>
<para>
<command>ipsec version</command> outputs the software version.
</para>
<para>
<command>ipsec directory</command> reports where the
<command>ipsec</command> sub-commands are stored.
</para>
</refsect1>
<refsect1 id='commands'>
<title>COMMANDS</title>
<para>
To get a list of supported commands, use the command
<command>ipsec --help</command>. The full set of commands are
listed below:
</para>
<variablelist>
<varlistentry>
<term><command>ipsec start</command></term>
<term><command>ipsec stop</command></term>
<term><command>ipsec restart</command></term>
<term><command>ipsec listen</command></term>
<listitem>
<para>
Used to control the <command>pluto</command> daemon using
the host init system. Supported init systems are sysv,
systemd, upstart and openrc.
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-start</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-stop</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listen</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
and
<citerefentry><refentrytitle>ipsec-restart</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec add</command></term>
<term><command>ipsec up</command></term>
<term><command>ipsec start</command></term>
<term><command>ipsec route</command></term>
<term><command>ipsec unroute</command></term>
<term><command>ipsec ondemand</command></term>
<term><command>ipsec down</command></term>
<term><command>ipsec delete</command></term>
<term><command>ipsec redirect</command></term>
<term><command>ipsec replace</command></term>
<listitem>
<para>
Used to manually add, remove and manipulate connections.
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-add</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-redirect</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-up</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-start</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-route</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-unroute</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-ondemand</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-down</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-replace</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
and
<citerefentry><refentrytitle>ipsec-delete</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec status</command></term>
<term><command>ipsec briefstatus</command></term>
<term><command>ipsec connectionstatus</command></term>
<term><command>ipsec briefconnectionstatus</command></term>
<term><command>ipsec trafficstatus</command></term>
<term><command>ipsec shuntstatus</command></term>
<listitem>
<para>
Used to display information about connections and their current status.
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-status</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-briefstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-trafficstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-connectionstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-shuntstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
and
<citerefentry><refentrytitle>ipsec-briefconnectionstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec initnss</command></term>
<term><command>ipsec checknss</command></term>
<term><command>ipsec import</command></term>
<term><command>ipsec listall</command></term>
<term><command>ipsec listcerts</command></term>
<term><command>ipsec rereadsecrets</command></term>
<term><command>ipsec listpubkeys</command></term>
<term><command>ipsec rereadcerts</command></term>
<term><command>ipsec listcacerts</command></term>
<term><command>ipsec rereadall</command></term>
<term><command>ipsec rereadsecrets</command></term>
<listitem>
<para>
Used to initialise, verify, and manipulate the NSS
database that contains all the X.509 certificate
information and private RSA keys.
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-initnss</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-rereadall</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-rereadsecrets</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listall</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-checknss</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-import</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-rereadcerts</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listcerts</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listcacerts</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-fips</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-rereadsecrets</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listpubkeys</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
and
<citerefentry><refentrytitle>ipsec-pk12status</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec fetchcrls</command></term>
<term><command>ipsec listcrls</command></term>
<listitem>
<para>
Update and display the Certificate Revocation List.
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-fetchcrls</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
and
<citerefentry><refentrytitle>ipsec-listcrls</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec certutil</command></term>
<term><command>ipsec crlutil</command></term>
<term><command>ipsec modutil</command></term>
<term><command>ipsec pk12util</command></term>
<term><command>ipsec vfychain</command></term>
<listitem>
<para>
Wrappers around the <application>NSS</application>
<command>pk12util</command>, <command>modutil</command>,
<command>certutil</command>, and
<command>crlutil</command> that can be used to directly
manipulate <application>Libreswan's</application>
<application>NSS</application> database.
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-certutil</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-crlutil</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
<citerefentry><refentrytitle>ipsec-modutil</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-pk12util</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
and
<citerefentry><refentrytitle>ipsec-vfychain</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec checkconfig</command></term>
<term><command>ipsec readwriteconf</command></term>
<listitem>
<para>
Used to validate and dump the ipsec file (default
<filename>@@IPSEC_CONF@@</filename>).
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-checkconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
and
<citerefentry><refentrytitle>ipsec-readwriteconf</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec checknflog</command></term>
<term><command>ipsec stopnflog</command></term>
<listitem>
<para>
Used to initialise and delete iptable rules for the nflog
devices when specified via the nflog= or nflog-all=
configuration options.
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-checknflog</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
and
<citerefentry><refentrytitle>ipsec-stopnflog</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec whack</command></term>
<listitem>
<para>
Low-level utility for manipulating
<application>Libreswan's</application> daemon
<command>pluto</command>.
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-whack</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec pluto</command></term>
<listitem>
<para>
<application>Libreswan's</application> daemon that
implements the Internet Key Exchange protocols.
</para>
<para>
See
<citerefentry><refentrytitle>ipsec-pluto</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec showhostkey</command></term>
<term><command>ipsec newhostkey</command></term>
<term><command>ipsec ecdsasigkey</command></term>
<term><command>ipsec rsasigkey</command></term>
<listitem>
<para>
Generate and display raw host keys stored in the
<application>NSS</application> database.
</para>
<para>
See:
<citerefentry><refentrytitle>ipsec-showhostkey</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-newhostkey</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-ecdsasigkey</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-rsasigkey</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec algparse</command></term>
<listitem>
<para>
Utility for displaying and verifying cryptographic proposals.
</para>
<para>
See:
<citerefentry><refentrytitle>ipsec-algparse</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec showroute</command></term>
<listitem>
<para>
Utility for displaying the routing information.
</para>
<para>
See:
<citerefentry><refentrytitle>ipsec-showroute</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec letsencrypt</command></term>
<listitem>
<para>
Utility for generating
<application>letsencrypt</application> keys.
</para>
<para>
See:
<citerefentry><refentrytitle>ipsec-letsencrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ipsec fipsstatus</command></term>
<term><command>ipsec cavp</command></term>
<listitem>
<para>
Display FIPS status and run FIPS crypto tests for CAVP
complance.
</para>
<para>
See:
<citerefentry><refentrytitle>ipsec-fipsstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-cavp</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='returncode'><title>RETURN CODE</title>
<para>
The ipsec command passes the return code of the sub-command back
to the caller. The only exception is when <command>ipsec
pluto</command> is used without <option>--nofork</option>, as it
will fork into the background and the ipsec command returns
success while the pluto daemon may in fact exit with an error code
after the fork.
</para>
</refsect1>
<refsect1 id='files'>
<title>FILES</title>
<para>
<filename>@@LIBEXECDIR@@</filename> usual utilities directory
</para>
</refsect1>
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>ipsec.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-add</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-algparse</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-briefconnectionstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-briefstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-certutil</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-checkconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-checknflog</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-checknss</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-connectionstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-crlutil</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-delete</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-down</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-ecdsasigkey</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-fetchcrls</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-fipsstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-globalstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-import</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-initnss</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-letsencrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listall</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listcacerts</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listcerts</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listcrls</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listen</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-listpubkeys</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-modutil</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-newhostkey</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-ondemand</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-pk12util</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-pluto</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-purgeocsp</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-redirect</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-replace</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-rereadall</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-rereadcerts</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-rereadsecrets</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-restart</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-route</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-rsasigkey</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-setup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-showhostkey</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-showroute</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-showstates</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-shuntstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-start</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-status</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-stop</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-trafficstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-unroute</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-up</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-vfychain</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-whack</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id='author'>
<title>AUTHOR</title>
<para>
<author><personname><firstname>Tuomo</firstname><surname>Soini</surname></personname></author>
<author><personname><firstname>Andrew</firstname><surname>Cagney</surname></personname></author>
</para>
</refsect1>
</refentry>
|
