/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2018-02-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-09-03">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
34
44
      <holder>Teddy Hogeborn</holder>
35
45
      <holder>Björn Påhlsson</holder>
36
46
    </copyright>
37
47
    <xi:include href="legalnotice.xml"/>
38
48
  </refentryinfo>
39
 
 
 
49
  
40
50
  <refmeta>
41
51
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
52
    <manvolnum>8</manvolnum>
48
58
      Generate key and password for Mandos client and server.
49
59
    </refpurpose>
50
60
  </refnamediv>
51
 
 
 
61
  
52
62
  <refsynopsisdiv>
53
63
    <cmdsynopsis>
54
64
      <command>&COMMANDNAME;</command>
115
125
        <replaceable>TIME</replaceable></option></arg>
116
126
      </group>
117
127
      <sbr/>
118
 
      <arg><option>--force</option></arg>
 
128
      <group>
 
129
        <arg choice="plain"><option>--force</option></arg>
 
130
        <arg choice="plain"><option>-f</option></arg>
 
131
      </group>
119
132
    </cmdsynopsis>
120
133
    <cmdsynopsis>
121
134
      <command>&COMMANDNAME;</command>
122
135
      <group choice="req">
123
136
        <arg choice="plain"><option>--password</option></arg>
124
137
        <arg choice="plain"><option>-p</option></arg>
 
138
        <arg choice="plain"><option>--passfile
 
139
        <replaceable>FILE</replaceable></option></arg>
 
140
        <arg choice="plain"><option>-F</option>
 
141
        <replaceable>FILE</replaceable></arg>
125
142
      </group>
126
143
      <sbr/>
127
144
      <group>
137
154
        <arg choice="plain"><option>-n
138
155
        <replaceable>NAME</replaceable></option></arg>
139
156
      </group>
 
157
      <group>
 
158
        <arg choice="plain"><option>--no-ssh</option></arg>
 
159
        <arg choice="plain"><option>-S</option></arg>
 
160
      </group>
140
161
    </cmdsynopsis>
141
162
    <cmdsynopsis>
142
163
      <command>&COMMANDNAME;</command>
159
180
    <para>
160
181
      <command>&COMMANDNAME;</command> is a program to generate the
161
182
      OpenPGP key used by
162
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
183
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
163
184
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
164
185
      normally written to /etc/mandos for later installation into the
165
186
      initrd image, but this, and most other things, can be changed
167
188
    </para>
168
189
    <para>
169
190
      This program can also be used with the
170
 
      <option>--password</option> option to generate a ready-made
171
 
      section for <filename>clients.conf</filename> (see
 
191
      <option>--password</option> or <option>--passfile</option>
 
192
      options to generate a ready-made section for
 
193
      <filename>clients.conf</filename> (see
172
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
173
195
      <manvolnum>5</manvolnum></citerefentry>).
174
196
    </para>
197
219
          </para>
198
220
        </listitem>
199
221
      </varlistentry>
200
 
 
 
222
      
201
223
      <varlistentry>
202
224
        <term><option>--dir
203
225
        <replaceable>DIRECTORY</replaceable></option></term>
206
228
        <listitem>
207
229
          <para>
208
230
            Target directory for key files.  Default is
209
 
            <filename>/etc/mandos</filename>.
 
231
            <filename class="directory">/etc/mandos</filename>.
210
232
          </para>
211
233
        </listitem>
212
234
      </varlistentry>
213
 
 
 
235
      
214
236
      <varlistentry>
215
237
        <term><option>--type
216
238
        <replaceable>TYPE</replaceable></option></term>
218
240
        <replaceable>TYPE</replaceable></option></term>
219
241
        <listitem>
220
242
          <para>
221
 
            Key type.  Default is <quote>DSA</quote>.
 
243
            Key type.  Default is <quote>RSA</quote>.
222
244
          </para>
223
245
        </listitem>
224
246
      </varlistentry>
225
 
 
 
247
      
226
248
      <varlistentry>
227
249
        <term><option>--length
228
250
        <replaceable>BITS</replaceable></option></term>
230
252
        <replaceable>BITS</replaceable></option></term>
231
253
        <listitem>
232
254
          <para>
233
 
            Key length in bits.  Default is 2048.
 
255
            Key length in bits.  Default is 4096.
234
256
          </para>
235
257
        </listitem>
236
258
      </varlistentry>
237
 
 
 
259
      
238
260
      <varlistentry>
239
261
        <term><option>--subtype
240
262
        <replaceable>KEYTYPE</replaceable></option></term>
242
264
        <replaceable>KEYTYPE</replaceable></option></term>
243
265
        <listitem>
244
266
          <para>
245
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
267
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
246
268
            encryption-only).
247
269
          </para>
248
270
        </listitem>
249
271
      </varlistentry>
250
 
 
 
272
      
251
273
      <varlistentry>
252
274
        <term><option>--sublength
253
275
        <replaceable>BITS</replaceable></option></term>
255
277
        <replaceable>BITS</replaceable></option></term>
256
278
        <listitem>
257
279
          <para>
258
 
            Subkey length in bits.  Default is 2048.
 
280
            Subkey length in bits.  Default is 4096.
259
281
          </para>
260
282
        </listitem>
261
283
      </varlistentry>
262
 
 
 
284
      
263
285
      <varlistentry>
264
286
        <term><option>--email
265
287
        <replaceable>ADDRESS</replaceable></option></term>
271
293
          </para>
272
294
        </listitem>
273
295
      </varlistentry>
274
 
 
 
296
      
275
297
      <varlistentry>
276
298
        <term><option>--comment
277
299
        <replaceable>TEXT</replaceable></option></term>
279
301
        <replaceable>TEXT</replaceable></option></term>
280
302
        <listitem>
281
303
          <para>
282
 
            Comment field for key.  The default value is
283
 
            <quote><literal>Mandos client key</literal></quote>.
 
304
            Comment field for key.  Default is empty.
284
305
          </para>
285
306
        </listitem>
286
307
      </varlistentry>
287
 
 
 
308
      
288
309
      <varlistentry>
289
310
        <term><option>--expire
290
311
        <replaceable>TIME</replaceable></option></term>
298
319
          </para>
299
320
        </listitem>
300
321
      </varlistentry>
301
 
 
 
322
      
302
323
      <varlistentry>
303
324
        <term><option>--force</option></term>
304
325
        <term><option>-f</option></term>
326
347
          </para>
327
348
        </listitem>
328
349
      </varlistentry>
 
350
      <varlistentry>
 
351
        <term><option>--passfile
 
352
        <replaceable>FILE</replaceable></option></term>
 
353
        <term><option>-F
 
354
        <replaceable>FILE</replaceable></option></term>
 
355
        <listitem>
 
356
          <para>
 
357
            The same as <option>--password</option>, but read from
 
358
            <replaceable>FILE</replaceable>, not the terminal.
 
359
          </para>
 
360
        </listitem>
 
361
      </varlistentry>
 
362
      <varlistentry>
 
363
        <term><option>--no-ssh</option></term>
 
364
        <term><option>-S</option></term>
 
365
        <listitem>
 
366
          <para>
 
367
            When <option>--password</option> or
 
368
            <option>--passfile</option> is given, this option will
 
369
            prevent <command>&COMMANDNAME;</command> from calling
 
370
            <command>ssh-keyscan</command> to get an SSH fingerprint
 
371
            for this host and, if successful, output suitable config
 
372
            options to use this fingerprint as a
 
373
            <option>checker</option> option in the output.  This is
 
374
            otherwise the default behavior.
 
375
          </para>
 
376
        </listitem>
 
377
      </varlistentry>
329
378
    </variablelist>
330
379
  </refsect1>
331
 
 
 
380
  
332
381
  <refsect1 id="overview">
333
382
    <title>OVERVIEW</title>
334
383
    <xi:include href="overview.xml"/>
338
387
      <filename>clients.conf</filename> on the server.
339
388
    </para>
340
389
  </refsect1>
341
 
 
 
390
  
342
391
  <refsect1 id="exit_status">
343
392
    <title>EXIT STATUS</title>
344
393
    <para>
364
413
    </variablelist>
365
414
  </refsect1>
366
415
  
367
 
  <refsect1 id="file">
 
416
  <refsect1 id="files">
368
417
    <title>FILES</title>
369
418
    <para>
370
419
      Use the <option>--dir</option> option to change where
391
440
        </listitem>
392
441
      </varlistentry>
393
442
      <varlistentry>
394
 
        <term><filename>/tmp</filename></term>
 
443
        <term><filename class="directory">/tmp</filename></term>
395
444
        <listitem>
396
445
          <para>
397
446
            Temporary files will be written here if
401
450
      </varlistentry>
402
451
    </variablelist>
403
452
  </refsect1>
404
 
 
405
 
<!--   <refsect1 id="bugs"> -->
406
 
<!--     <title>BUGS</title> -->
407
 
<!--     <para> -->
408
 
<!--     </para> -->
409
 
<!--   </refsect1> -->
410
 
 
 
453
  
 
454
  <refsect1 id="bugs">
 
455
    <title>BUGS</title>
 
456
    <xi:include href="bugs.xml"/>
 
457
  </refsect1>
 
458
  
411
459
  <refsect1 id="example">
412
460
    <title>EXAMPLE</title>
413
461
    <informalexample>
432
480
    </informalexample>
433
481
    <informalexample>
434
482
      <para>
435
 
        Prompt for a password, encrypt it with the key in
436
 
        <filename>/etc/mandos</filename> and output a section suitable
437
 
        for <filename>clients.conf</filename>.
 
483
        Prompt for a password, encrypt it with the key in <filename
 
484
        class="directory">/etc/mandos</filename> and output a section
 
485
        suitable for <filename>clients.conf</filename>.
438
486
      </para>
439
487
      <para>
440
488
        <userinput>&COMMANDNAME; --password</userinput>
454
502
      </para>
455
503
    </informalexample>
456
504
  </refsect1>
457
 
 
 
505
  
458
506
  <refsect1 id="security">
459
507
    <title>SECURITY</title>
460
508
    <para>
469
517
      <manvolnum>8</manvolnum></citerefentry>.
470
518
    </para>
471
519
  </refsect1>
472
 
 
 
520
  
473
521
  <refsect1 id="see_also">
474
522
    <title>SEE ALSO</title>
475
523
    <para>
 
524
      <citerefentry><refentrytitle>intro</refentrytitle>
 
525
      <manvolnum>8mandos</manvolnum></citerefentry>,
476
526
      <citerefentry><refentrytitle>gpg</refentrytitle>
477
527
      <manvolnum>1</manvolnum></citerefentry>,
478
528
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
479
529
      <manvolnum>5</manvolnum></citerefentry>,
480
530
      <citerefentry><refentrytitle>mandos</refentrytitle>
481
531
      <manvolnum>8</manvolnum></citerefentry>,
482
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
483
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
532
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
534
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
535
      <manvolnum>1</manvolnum></citerefentry>
484
536
    </para>
485
537
  </refsect1>
486
538