File: ipsec-algparse.8.xml

package info (click to toggle)
libreswan 5.2-2.3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 81,644 kB
  • sloc: ansic: 129,988; sh: 32,018; xml: 20,646; python: 10,303; makefile: 3,022; javascript: 1,506; sed: 574; yacc: 511; perl: 264; awk: 52
file content (298 lines) | stat: -rw-r--r-- 6,783 bytes parent folder | download | duplicates (2)
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
<?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 id='algparse8'>

  <refmeta>
    <refentrytitle>IPSEC-ALGPARSE</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class='date'>30 November 2023</refmiscinfo>
    <refmiscinfo class="source">Libreswan</refmiscinfo>
    <refmiscinfo class="version">@@IPSECVERSION@@</refmiscinfo>
    <refmiscinfo class="manual">Executable programs</refmiscinfo>
  </refmeta>

  <refnamediv id='name'>
    <refname>ipsec-algparse</refname>
    <refpurpose>
      utility for verifying IKE and IPsec cryptographic proposal syntax
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>ipsec algparse</command>
      <group>
	<arg choice="plain">-v1</arg>
	<arg choice="plain">-v2</arg>
	<arg choice="plain">-v</arg>
	<arg choice="plain">-verbose</arg>
	<arg choice="plain">-debug</arg>
	<arg choice="plain">-p1</arg>
	<arg choice="plain">-p2</arg>
	<arg choice="plain">
	  -pfs
	  <group choice="req">
	    <arg choice="plain">yes</arg>
	    <arg choice="plain">no</arg>
	  </group>
	</arg>
	<arg choice="plain">
	  -fips
	  <group choice="req">
	    <arg choice="plain">yes</arg>
	    <arg choice="plain">no</arg>
	  </group>
	</arg>
	<arg choice="plain">-ignore</arg>
	<arg choice="plain">-impair</arg>
	<arg choice="plain">
	  -nsspw
	  <replaceable>password</replaceable>
	</arg>
      </group>
      <sbr/>
      <group choice="req">
	<arg choice="plain">-tp</arg>
	<arg choice="plain">-ta</arg>
	<arg choice="plain">ike=<replaceable>proposals</replaceable></arg>
	<arg choice="plain">esp=<replaceable>proposals</replaceable></arg>
	<arg choice="plain">ah=<replaceable>proposals</replaceable></arg>
	<arg choice="plain"><replaceable>proposals</replaceable></arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>
      DESCRIPTION
    </title>

    <para>
      <command>ipsec algparse</command> is a utility that parses and
      expands and Internet Key Exchange cryptographic proposals using
      the same syntax as used in the file
      <filename>ipsec.conf</filename> (see the description of
      <command>ike=</command> and <command>esp=</command> in
      <citerefentry><refentrytitle><filename>ipsec.conf</filename></refentrytitle>
      <manvolnum>5</manvolnum></citerefentry> for details).  In
      addition, <command>ipsec algparse</command> can be used to run
      the proposal parser or the cryptographic algorithm testsuites.
    </para>

    <para>
      The following options control what <command>ipsec
      algparse</command> will parse:
    </para>

    <variablelist>

      <varlistentry>
	<term>
	  <option>ike=<optional><replaceable>proposals</replaceable></optional></option>
	</term>
	<term>
	  <option>esp=<optional><replaceable>proposals</replaceable></optional></option>
	</term>
	<term>
	  <option>ah=<optional><replaceable>proposals</replaceable></optional></option>
	</term>
	<listitem>
	  <para>
	    Parse the <replaceable>proposals</replaceable> using the
	    IKE, ESP, or AH proposal parser.  When
	    <replaceable>proposals</replaceable> is omitted, display
	    the default IKE, ESP, or AH proposals.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>proposal</option>
	</term>
	<listitem>
	  <para>
	    Try to parse the proposal using all three of the IKE, ESP,
	    and AH proposal parsers.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-tp</option>
	</term>
	<listitem>
	  <para>
	    run the proposal testsuite
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-ta</option>
	</term>
	<listitem>
	  <para>
	    run the algorithm testsuite
	  </para>
	</listitem>
      </varlistentry>

    </variablelist>

    <para>
      The following options alter the parser behaviour:
    </para>

    <variablelist>

      <varlistentry>
	<term>
	  <option>-v1</option>
	</term>
	<term>
	  <option>-v2</option>
	</term>
	<listitem>
	  <para>
	    Parse the <replaceable>proposals</replaceable> using
	    either the IKEv1 or IKEv2 proposal syntax.
	  </para>
	  <para>
	    The default is IKEv2.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-pfs=yes|no</option>
	</term>
	<listitem>
	  <para>
	    Specify PFS (Perfect Forward Privicy).  When
	    <command>yes</command> Diffi-Helman algorithms will be
	    included in the proposal.
	  </para>
	  <para>
	    The default is <command>--pfs=no</command>.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-fips=yes|no</option>
	</term>
	<listitem>
	  <para>
	    Force NSS into FIPS mode.
	  </para>
	  <para>
	    The default is determined by the system environment.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-p1</option>
	</term>
	<term>
	  <option>-p2</option>
	</term>
	<listitem>
	  <para>
	    Specify the parser to use.
	  </para>
	  <para>
	    By default, IKEv1 uses the simple (p1) parser, and IKEv2
	    uses the more complex (p2) parser.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-nsspw</option>
	</term>
	<listitem>
	  <para>
	    Specify the NSS database password.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-impair</option>
	</term>
	<listitem>
	  <para>
	    Impair the parser, disabling all algorithm checks.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-ignore</option>
	</term>
	<listitem>
	  <para>
	    Ignore parser errors.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-v</option>
	</term>
	<term>
	  <option>-verbose</option>
	</term>
	<listitem>
	  <para>
	    Be more verbose when invoking proposal parser.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-d</option>
	</term>
	<term>
	  <option>-debug</option>
	</term>
	<listitem>
	  <para>
	    Enable full debug-logging when invoking the proposal parser.
	  </para>
	</listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1 id='history'>
    <title>HISTORY</title>
    <para>
      Written for the <application>Libreswan</application> project by
      <author><personname><firstname>Andrew</firstname><surname>Cagney</surname></personname></author>.
    </para>
  </refsect1>

  <refsect1 id='author'>
    <title>AUTHOR</title>
    <para>
      <author><personname><firstname>Andrew</firstname><surname>Cagney</surname></personname></author>
    </para>
  </refsect1>
</refentry>