/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: 2008-08-31 10:27:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831102733-2u083dacxul80ynp
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
                               <literal>.  Split <term> tags into one
                               for each option.  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 "2014-06-22">
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>2011</year>
37
 
      <year>2012</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
 
    <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>
42
60
  </refentryinfo>
43
 
  
 
61
 
44
62
  <refmeta>
45
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
64
    <manvolnum>8</manvolnum>
52
70
      Generate key and password for Mandos client and server.
53
71
    </refpurpose>
54
72
  </refnamediv>
55
 
  
 
73
 
56
74
  <refsynopsisdiv>
57
75
    <cmdsynopsis>
58
76
      <command>&COMMANDNAME;</command>
119
137
        <replaceable>TIME</replaceable></option></arg>
120
138
      </group>
121
139
      <sbr/>
122
 
      <group>
123
 
        <arg choice="plain"><option>--force</option></arg>
124
 
        <arg choice="plain"><option>-f</option></arg>
125
 
      </group>
 
140
      <arg><option>--force</option></arg>
126
141
    </cmdsynopsis>
127
142
    <cmdsynopsis>
128
143
      <command>&COMMANDNAME;</command>
129
144
      <group choice="req">
130
145
        <arg choice="plain"><option>--password</option></arg>
131
146
        <arg choice="plain"><option>-p</option></arg>
132
 
        <arg choice="plain"><option>--passfile
133
 
        <replaceable>FILE</replaceable></option></arg>
134
 
        <arg choice="plain"><option>-F</option>
135
 
        <replaceable>FILE</replaceable></arg>
136
147
      </group>
137
148
      <sbr/>
138
149
      <group>
148
159
        <arg choice="plain"><option>-n
149
160
        <replaceable>NAME</replaceable></option></arg>
150
161
      </group>
151
 
      <group>
152
 
        <arg choice="plain"><option>--no-ssh</option></arg>
153
 
        <arg choice="plain"><option>-S</option></arg>
154
 
      </group>
155
162
    </cmdsynopsis>
156
163
    <cmdsynopsis>
157
164
      <command>&COMMANDNAME;</command>
174
181
    <para>
175
182
      <command>&COMMANDNAME;</command> is a program to generate the
176
183
      OpenPGP key used by
177
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
184
      <citerefentry><refentrytitle>password-request</refentrytitle>
178
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
179
186
      normally written to /etc/mandos for later installation into the
180
187
      initrd image, but this, and most other things, can be changed
182
189
    </para>
183
190
    <para>
184
191
      This program can also be used with the
185
 
      <option>--password</option> or <option>--passfile</option>
186
 
      options to generate a ready-made section for
187
 
      <filename>clients.conf</filename> (see
 
192
      <option>--password</option> option to generate a ready-made
 
193
      section for <filename>clients.conf</filename> (see
188
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
189
195
      <manvolnum>5</manvolnum></citerefentry>).
190
196
    </para>
213
219
          </para>
214
220
        </listitem>
215
221
      </varlistentry>
216
 
      
 
222
 
217
223
      <varlistentry>
218
224
        <term><option>--dir
219
225
        <replaceable>DIRECTORY</replaceable></option></term>
222
228
        <listitem>
223
229
          <para>
224
230
            Target directory for key files.  Default is
225
 
            <filename class="directory">/etc/mandos</filename>.
 
231
            <filename>/etc/mandos</filename>.
226
232
          </para>
227
233
        </listitem>
228
234
      </varlistentry>
229
 
      
 
235
 
230
236
      <varlistentry>
231
237
        <term><option>--type
232
238
        <replaceable>TYPE</replaceable></option></term>
234
240
        <replaceable>TYPE</replaceable></option></term>
235
241
        <listitem>
236
242
          <para>
237
 
            Key type.  Default is <quote>RSA</quote>.
 
243
            Key type.  Default is <quote>DSA</quote>.
238
244
          </para>
239
245
        </listitem>
240
246
      </varlistentry>
241
 
      
 
247
 
242
248
      <varlistentry>
243
249
        <term><option>--length
244
250
        <replaceable>BITS</replaceable></option></term>
246
252
        <replaceable>BITS</replaceable></option></term>
247
253
        <listitem>
248
254
          <para>
249
 
            Key length in bits.  Default is 4096.
 
255
            Key length in bits.  Default is 2048.
250
256
          </para>
251
257
        </listitem>
252
258
      </varlistentry>
253
 
      
 
259
 
254
260
      <varlistentry>
255
261
        <term><option>--subtype
256
262
        <replaceable>KEYTYPE</replaceable></option></term>
258
264
        <replaceable>KEYTYPE</replaceable></option></term>
259
265
        <listitem>
260
266
          <para>
261
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
267
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
262
268
            encryption-only).
263
269
          </para>
264
270
        </listitem>
265
271
      </varlistentry>
266
 
      
 
272
 
267
273
      <varlistentry>
268
274
        <term><option>--sublength
269
275
        <replaceable>BITS</replaceable></option></term>
271
277
        <replaceable>BITS</replaceable></option></term>
272
278
        <listitem>
273
279
          <para>
274
 
            Subkey length in bits.  Default is 4096.
 
280
            Subkey length in bits.  Default is 2048.
275
281
          </para>
276
282
        </listitem>
277
283
      </varlistentry>
278
 
      
 
284
 
279
285
      <varlistentry>
280
286
        <term><option>--email
281
287
        <replaceable>ADDRESS</replaceable></option></term>
287
293
          </para>
288
294
        </listitem>
289
295
      </varlistentry>
290
 
      
 
296
 
291
297
      <varlistentry>
292
298
        <term><option>--comment
293
299
        <replaceable>TEXT</replaceable></option></term>
295
301
        <replaceable>TEXT</replaceable></option></term>
296
302
        <listitem>
297
303
          <para>
298
 
            Comment field for key.  Default is empty.
 
304
            Comment field for key.  The default value is
 
305
            <quote><literal>Mandos client key</literal></quote>.
299
306
          </para>
300
307
        </listitem>
301
308
      </varlistentry>
302
 
      
 
309
 
303
310
      <varlistentry>
304
311
        <term><option>--expire
305
312
        <replaceable>TIME</replaceable></option></term>
313
320
          </para>
314
321
        </listitem>
315
322
      </varlistentry>
316
 
      
 
323
 
317
324
      <varlistentry>
318
325
        <term><option>--force</option></term>
319
326
        <term><option>-f</option></term>
341
348
          </para>
342
349
        </listitem>
343
350
      </varlistentry>
344
 
      <varlistentry>
345
 
        <term><option>--passfile
346
 
        <replaceable>FILE</replaceable></option></term>
347
 
        <term><option>-F
348
 
        <replaceable>FILE</replaceable></option></term>
349
 
        <listitem>
350
 
          <para>
351
 
            The same as <option>--password</option>, but read from
352
 
            <replaceable>FILE</replaceable>, not the terminal.
353
 
          </para>
354
 
        </listitem>
355
 
      </varlistentry>
356
 
      <varlistentry>
357
 
        <term><option>--no-ssh</option></term>
358
 
        <term><option>-S</option></term>
359
 
        <listitem>
360
 
          <para>
361
 
            When <option>--password</option> or
362
 
            <option>--passfile</option> is given, this option will
363
 
            prevent <command>&COMMANDNAME;</command> from calling
364
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
365
 
            for this host and, if successful, output suitable config
366
 
            options to use this fingerprint as a
367
 
            <option>checker</option> option in the output.  This is
368
 
            otherwise the default behavior.
369
 
          </para>
370
 
        </listitem>
371
 
      </varlistentry>
372
351
    </variablelist>
373
352
  </refsect1>
374
 
  
 
353
 
375
354
  <refsect1 id="overview">
376
355
    <title>OVERVIEW</title>
377
356
    <xi:include href="overview.xml"/>
381
360
      <filename>clients.conf</filename> on the server.
382
361
    </para>
383
362
  </refsect1>
384
 
  
 
363
 
385
364
  <refsect1 id="exit_status">
386
365
    <title>EXIT STATUS</title>
387
366
    <para>
407
386
    </variablelist>
408
387
  </refsect1>
409
388
  
410
 
  <refsect1 id="files">
 
389
  <refsect1 id="file">
411
390
    <title>FILES</title>
412
391
    <para>
413
392
      Use the <option>--dir</option> option to change where
434
413
        </listitem>
435
414
      </varlistentry>
436
415
      <varlistentry>
437
 
        <term><filename class="directory">/tmp</filename></term>
 
416
        <term><filename>/tmp</filename></term>
438
417
        <listitem>
439
418
          <para>
440
419
            Temporary files will be written here if
444
423
      </varlistentry>
445
424
    </variablelist>
446
425
  </refsect1>
447
 
  
448
 
<!--   <refsect1 id="bugs"> -->
449
 
<!--     <title>BUGS</title> -->
450
 
<!--     <para> -->
451
 
<!--     </para> -->
452
 
<!--   </refsect1> -->
453
 
  
 
426
 
 
427
  <refsect1 id="bugs">
 
428
    <title>BUGS</title>
 
429
    <para>
 
430
      None are known at this time.
 
431
    </para>
 
432
  </refsect1>
 
433
 
454
434
  <refsect1 id="example">
455
435
    <title>EXAMPLE</title>
456
436
    <informalexample>
475
455
    </informalexample>
476
456
    <informalexample>
477
457
      <para>
478
 
        Prompt for a password, encrypt it with the key in <filename
479
 
        class="directory">/etc/mandos</filename> and output a section
480
 
        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>.
481
461
      </para>
482
462
      <para>
483
463
        <userinput>&COMMANDNAME; --password</userinput>
497
477
      </para>
498
478
    </informalexample>
499
479
  </refsect1>
500
 
  
 
480
 
501
481
  <refsect1 id="security">
502
482
    <title>SECURITY</title>
503
483
    <para>
512
492
      <manvolnum>8</manvolnum></citerefentry>.
513
493
    </para>
514
494
  </refsect1>
515
 
  
 
495
 
516
496
  <refsect1 id="see_also">
517
497
    <title>SEE ALSO</title>
518
498
    <para>
519
 
      <citerefentry><refentrytitle>intro</refentrytitle>
520
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
521
499
      <citerefentry><refentrytitle>gpg</refentrytitle>
522
500
      <manvolnum>1</manvolnum></citerefentry>,
523
501
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
524
502
      <manvolnum>5</manvolnum></citerefentry>,
525
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
526
504
      <manvolnum>8</manvolnum></citerefentry>,
527
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
528
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
529
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
530
 
      <manvolnum>1</manvolnum></citerefentry>
 
505
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
506
      <manvolnum>8mandos</manvolnum></citerefentry>
531
507
    </para>
532
508
  </refsect1>
533
509