/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 12:23:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831122333-qgppahxb4d4b0coc
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
                                            the ones in the SYNOPSIS.
                                            Split <term> tags into one
                                            for each option.  Use
                                            <option> tags instead of
                                            <literal>.  Moved long
                                            options before short.

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">
4
5
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2017-02-23">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <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>
44
34
      <holder>Teddy Hogeborn</holder>
45
35
      <holder>Björn Påhlsson</holder>
46
36
    </copyright>
47
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
48
60
  </refentryinfo>
49
 
  
 
61
 
50
62
  <refmeta>
51
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
52
64
    <manvolnum>8</manvolnum>
58
70
      Generate key and password for Mandos client and server.
59
71
    </refpurpose>
60
72
  </refnamediv>
61
 
  
 
73
 
62
74
  <refsynopsisdiv>
63
75
    <cmdsynopsis>
64
76
      <command>&COMMANDNAME;</command>
125
137
        <replaceable>TIME</replaceable></option></arg>
126
138
      </group>
127
139
      <sbr/>
128
 
      <group>
129
 
        <arg choice="plain"><option>--force</option></arg>
130
 
        <arg choice="plain"><option>-f</option></arg>
131
 
      </group>
 
140
      <arg><option>--force</option></arg>
132
141
    </cmdsynopsis>
133
142
    <cmdsynopsis>
134
143
      <command>&COMMANDNAME;</command>
135
144
      <group choice="req">
136
145
        <arg choice="plain"><option>--password</option></arg>
137
146
        <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>
142
147
      </group>
143
148
      <sbr/>
144
149
      <group>
154
159
        <arg choice="plain"><option>-n
155
160
        <replaceable>NAME</replaceable></option></arg>
156
161
      </group>
157
 
      <group>
158
 
        <arg choice="plain"><option>--no-ssh</option></arg>
159
 
        <arg choice="plain"><option>-S</option></arg>
160
 
      </group>
161
162
    </cmdsynopsis>
162
163
    <cmdsynopsis>
163
164
      <command>&COMMANDNAME;</command>
180
181
    <para>
181
182
      <command>&COMMANDNAME;</command> is a program to generate the
182
183
      OpenPGP key used by
183
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
184
      <citerefentry><refentrytitle>password-request</refentrytitle>
184
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
185
186
      normally written to /etc/mandos for later installation into the
186
187
      initrd image, but this, and most other things, can be changed
188
189
    </para>
189
190
    <para>
190
191
      This program can also be used with the
191
 
      <option>--password</option> or <option>--passfile</option>
192
 
      options to generate a ready-made section for
193
 
      <filename>clients.conf</filename> (see
 
192
      <option>--password</option> option to generate a ready-made
 
193
      section for <filename>clients.conf</filename> (see
194
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
195
195
      <manvolnum>5</manvolnum></citerefentry>).
196
196
    </para>
219
219
          </para>
220
220
        </listitem>
221
221
      </varlistentry>
222
 
      
 
222
 
223
223
      <varlistentry>
224
224
        <term><option>--dir
225
225
        <replaceable>DIRECTORY</replaceable></option></term>
228
228
        <listitem>
229
229
          <para>
230
230
            Target directory for key files.  Default is
231
 
            <filename class="directory">/etc/mandos</filename>.
 
231
            <filename>/etc/mandos</filename>.
232
232
          </para>
233
233
        </listitem>
234
234
      </varlistentry>
235
 
      
 
235
 
236
236
      <varlistentry>
237
237
        <term><option>--type
238
238
        <replaceable>TYPE</replaceable></option></term>
240
240
        <replaceable>TYPE</replaceable></option></term>
241
241
        <listitem>
242
242
          <para>
243
 
            Key type.  Default is <quote>RSA</quote>.
 
243
            Key type.  Default is <quote>DSA</quote>.
244
244
          </para>
245
245
        </listitem>
246
246
      </varlistentry>
247
 
      
 
247
 
248
248
      <varlistentry>
249
249
        <term><option>--length
250
250
        <replaceable>BITS</replaceable></option></term>
252
252
        <replaceable>BITS</replaceable></option></term>
253
253
        <listitem>
254
254
          <para>
255
 
            Key length in bits.  Default is 4096.
 
255
            Key length in bits.  Default is 2048.
256
256
          </para>
257
257
        </listitem>
258
258
      </varlistentry>
259
 
      
 
259
 
260
260
      <varlistentry>
261
261
        <term><option>--subtype
262
262
        <replaceable>KEYTYPE</replaceable></option></term>
264
264
        <replaceable>KEYTYPE</replaceable></option></term>
265
265
        <listitem>
266
266
          <para>
267
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
267
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
268
268
            encryption-only).
269
269
          </para>
270
270
        </listitem>
271
271
      </varlistentry>
272
 
      
 
272
 
273
273
      <varlistentry>
274
274
        <term><option>--sublength
275
275
        <replaceable>BITS</replaceable></option></term>
277
277
        <replaceable>BITS</replaceable></option></term>
278
278
        <listitem>
279
279
          <para>
280
 
            Subkey length in bits.  Default is 4096.
 
280
            Subkey length in bits.  Default is 2048.
281
281
          </para>
282
282
        </listitem>
283
283
      </varlistentry>
284
 
      
 
284
 
285
285
      <varlistentry>
286
286
        <term><option>--email
287
287
        <replaceable>ADDRESS</replaceable></option></term>
293
293
          </para>
294
294
        </listitem>
295
295
      </varlistentry>
296
 
      
 
296
 
297
297
      <varlistentry>
298
298
        <term><option>--comment
299
299
        <replaceable>TEXT</replaceable></option></term>
301
301
        <replaceable>TEXT</replaceable></option></term>
302
302
        <listitem>
303
303
          <para>
304
 
            Comment field for key.  Default is empty.
 
304
            Comment field for key.  The default value is
 
305
            <quote><literal>Mandos client key</literal></quote>.
305
306
          </para>
306
307
        </listitem>
307
308
      </varlistentry>
308
 
      
 
309
 
309
310
      <varlistentry>
310
311
        <term><option>--expire
311
312
        <replaceable>TIME</replaceable></option></term>
319
320
          </para>
320
321
        </listitem>
321
322
      </varlistentry>
322
 
      
 
323
 
323
324
      <varlistentry>
324
325
        <term><option>--force</option></term>
325
326
        <term><option>-f</option></term>
347
348
          </para>
348
349
        </listitem>
349
350
      </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>
378
351
    </variablelist>
379
352
  </refsect1>
380
 
  
 
353
 
381
354
  <refsect1 id="overview">
382
355
    <title>OVERVIEW</title>
383
356
    <xi:include href="overview.xml"/>
387
360
      <filename>clients.conf</filename> on the server.
388
361
    </para>
389
362
  </refsect1>
390
 
  
 
363
 
391
364
  <refsect1 id="exit_status">
392
365
    <title>EXIT STATUS</title>
393
366
    <para>
413
386
    </variablelist>
414
387
  </refsect1>
415
388
  
416
 
  <refsect1 id="files">
 
389
  <refsect1 id="file">
417
390
    <title>FILES</title>
418
391
    <para>
419
392
      Use the <option>--dir</option> option to change where
440
413
        </listitem>
441
414
      </varlistentry>
442
415
      <varlistentry>
443
 
        <term><filename class="directory">/tmp</filename></term>
 
416
        <term><filename>/tmp</filename></term>
444
417
        <listitem>
445
418
          <para>
446
419
            Temporary files will be written here if
450
423
      </varlistentry>
451
424
    </variablelist>
452
425
  </refsect1>
453
 
  
 
426
 
454
427
  <refsect1 id="bugs">
455
428
    <title>BUGS</title>
456
 
    <xi:include href="bugs.xml"/>
 
429
    <para>
 
430
      None are known at this time.
 
431
    </para>
457
432
  </refsect1>
458
 
  
 
433
 
459
434
  <refsect1 id="example">
460
435
    <title>EXAMPLE</title>
461
436
    <informalexample>
480
455
    </informalexample>
481
456
    <informalexample>
482
457
      <para>
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>.
 
458
        Prompt for a password, encrypt it with the key in
 
459
        <filename>/etc/mandos</filename> and output a section suitable
 
460
        for <filename>clients.conf</filename>.
486
461
      </para>
487
462
      <para>
488
463
        <userinput>&COMMANDNAME; --password</userinput>
502
477
      </para>
503
478
    </informalexample>
504
479
  </refsect1>
505
 
  
 
480
 
506
481
  <refsect1 id="security">
507
482
    <title>SECURITY</title>
508
483
    <para>
517
492
      <manvolnum>8</manvolnum></citerefentry>.
518
493
    </para>
519
494
  </refsect1>
520
 
  
 
495
 
521
496
  <refsect1 id="see_also">
522
497
    <title>SEE ALSO</title>
523
498
    <para>
524
 
      <citerefentry><refentrytitle>intro</refentrytitle>
525
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
526
499
      <citerefentry><refentrytitle>gpg</refentrytitle>
527
500
      <manvolnum>1</manvolnum></citerefentry>,
528
501
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
502
      <manvolnum>5</manvolnum></citerefentry>,
530
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
531
504
      <manvolnum>8</manvolnum></citerefentry>,
532
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
534
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
535
 
      <manvolnum>1</manvolnum></citerefentry>
 
505
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
506
      <manvolnum>8mandos</manvolnum></citerefentry>
536
507
    </para>
537
508
  </refsect1>
538
509