/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-09-08 18:18:49 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908181849-ogydhr0m4axi3dnu
* INSTALL: More text.  Better text.

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 "2013-10-22">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-06">
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
37
    <xi:include href="legalnotice.xml"/>
42
38
  </refentryinfo>
43
 
  
 
39
 
44
40
  <refmeta>
45
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
42
    <manvolnum>8</manvolnum>
52
48
      Generate key and password for Mandos client and server.
53
49
    </refpurpose>
54
50
  </refnamediv>
55
 
  
 
51
 
56
52
  <refsynopsisdiv>
57
53
    <cmdsynopsis>
58
54
      <command>&COMMANDNAME;</command>
126
122
      <group choice="req">
127
123
        <arg choice="plain"><option>--password</option></arg>
128
124
        <arg choice="plain"><option>-p</option></arg>
129
 
        <arg choice="plain"><option>--passfile
130
 
        <replaceable>FILE</replaceable></option></arg>
131
 
        <arg choice="plain"><option>-F</option>
132
 
        <replaceable>FILE</replaceable></arg>
133
125
      </group>
134
126
      <sbr/>
135
127
      <group>
175
167
    </para>
176
168
    <para>
177
169
      This program can also be used with the
178
 
      <option>--password</option> or <option>--passfile</option>
179
 
      options to generate a ready-made section for
180
 
      <filename>clients.conf</filename> (see
 
170
      <option>--password</option> option to generate a ready-made
 
171
      section for <filename>clients.conf</filename> (see
181
172
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
182
173
      <manvolnum>5</manvolnum></citerefentry>).
183
174
    </para>
206
197
          </para>
207
198
        </listitem>
208
199
      </varlistentry>
209
 
      
 
200
 
210
201
      <varlistentry>
211
202
        <term><option>--dir
212
203
        <replaceable>DIRECTORY</replaceable></option></term>
215
206
        <listitem>
216
207
          <para>
217
208
            Target directory for key files.  Default is
218
 
            <filename class="directory">/etc/mandos</filename>.
 
209
            <filename>/etc/mandos</filename>.
219
210
          </para>
220
211
        </listitem>
221
212
      </varlistentry>
222
 
      
 
213
 
223
214
      <varlistentry>
224
215
        <term><option>--type
225
216
        <replaceable>TYPE</replaceable></option></term>
227
218
        <replaceable>TYPE</replaceable></option></term>
228
219
        <listitem>
229
220
          <para>
230
 
            Key type.  Default is <quote>RSA</quote>.
 
221
            Key type.  Default is <quote>DSA</quote>.
231
222
          </para>
232
223
        </listitem>
233
224
      </varlistentry>
234
 
      
 
225
 
235
226
      <varlistentry>
236
227
        <term><option>--length
237
228
        <replaceable>BITS</replaceable></option></term>
239
230
        <replaceable>BITS</replaceable></option></term>
240
231
        <listitem>
241
232
          <para>
242
 
            Key length in bits.  Default is 4096.
 
233
            Key length in bits.  Default is 2048.
243
234
          </para>
244
235
        </listitem>
245
236
      </varlistentry>
246
 
      
 
237
 
247
238
      <varlistentry>
248
239
        <term><option>--subtype
249
240
        <replaceable>KEYTYPE</replaceable></option></term>
251
242
        <replaceable>KEYTYPE</replaceable></option></term>
252
243
        <listitem>
253
244
          <para>
254
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
245
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
255
246
            encryption-only).
256
247
          </para>
257
248
        </listitem>
258
249
      </varlistentry>
259
 
      
 
250
 
260
251
      <varlistentry>
261
252
        <term><option>--sublength
262
253
        <replaceable>BITS</replaceable></option></term>
264
255
        <replaceable>BITS</replaceable></option></term>
265
256
        <listitem>
266
257
          <para>
267
 
            Subkey length in bits.  Default is 4096.
 
258
            Subkey length in bits.  Default is 2048.
268
259
          </para>
269
260
        </listitem>
270
261
      </varlistentry>
271
 
      
 
262
 
272
263
      <varlistentry>
273
264
        <term><option>--email
274
265
        <replaceable>ADDRESS</replaceable></option></term>
280
271
          </para>
281
272
        </listitem>
282
273
      </varlistentry>
283
 
      
 
274
 
284
275
      <varlistentry>
285
276
        <term><option>--comment
286
277
        <replaceable>TEXT</replaceable></option></term>
288
279
        <replaceable>TEXT</replaceable></option></term>
289
280
        <listitem>
290
281
          <para>
291
 
            Comment field for key.  Default is empty.
 
282
            Comment field for key.  The default value is
 
283
            <quote><literal>Mandos client key</literal></quote>.
292
284
          </para>
293
285
        </listitem>
294
286
      </varlistentry>
295
 
      
 
287
 
296
288
      <varlistentry>
297
289
        <term><option>--expire
298
290
        <replaceable>TIME</replaceable></option></term>
306
298
          </para>
307
299
        </listitem>
308
300
      </varlistentry>
309
 
      
 
301
 
310
302
      <varlistentry>
311
303
        <term><option>--force</option></term>
312
304
        <term><option>-f</option></term>
334
326
          </para>
335
327
        </listitem>
336
328
      </varlistentry>
337
 
      <varlistentry>
338
 
        <term><option>--passfile
339
 
        <replaceable>FILE</replaceable></option></term>
340
 
        <term><option>-F
341
 
        <replaceable>FILE</replaceable></option></term>
342
 
        <listitem>
343
 
          <para>
344
 
            The same as <option>--password</option>, but read from
345
 
            <replaceable>FILE</replaceable>, not the terminal.
346
 
          </para>
347
 
        </listitem>
348
 
      </varlistentry>
349
329
    </variablelist>
350
330
  </refsect1>
351
 
  
 
331
 
352
332
  <refsect1 id="overview">
353
333
    <title>OVERVIEW</title>
354
334
    <xi:include href="overview.xml"/>
358
338
      <filename>clients.conf</filename> on the server.
359
339
    </para>
360
340
  </refsect1>
361
 
  
 
341
 
362
342
  <refsect1 id="exit_status">
363
343
    <title>EXIT STATUS</title>
364
344
    <para>
384
364
    </variablelist>
385
365
  </refsect1>
386
366
  
387
 
  <refsect1 id="files">
 
367
  <refsect1 id="file">
388
368
    <title>FILES</title>
389
369
    <para>
390
370
      Use the <option>--dir</option> option to change where
411
391
        </listitem>
412
392
      </varlistentry>
413
393
      <varlistentry>
414
 
        <term><filename class="directory">/tmp</filename></term>
 
394
        <term><filename>/tmp</filename></term>
415
395
        <listitem>
416
396
          <para>
417
397
            Temporary files will be written here if
421
401
      </varlistentry>
422
402
    </variablelist>
423
403
  </refsect1>
424
 
  
 
404
 
425
405
<!--   <refsect1 id="bugs"> -->
426
406
<!--     <title>BUGS</title> -->
427
407
<!--     <para> -->
428
408
<!--     </para> -->
429
409
<!--   </refsect1> -->
430
 
  
 
410
 
431
411
  <refsect1 id="example">
432
412
    <title>EXAMPLE</title>
433
413
    <informalexample>
452
432
    </informalexample>
453
433
    <informalexample>
454
434
      <para>
455
 
        Prompt for a password, encrypt it with the key in <filename
456
 
        class="directory">/etc/mandos</filename> and output a section
457
 
        suitable for <filename>clients.conf</filename>.
 
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>.
458
438
      </para>
459
439
      <para>
460
440
        <userinput>&COMMANDNAME; --password</userinput>
474
454
      </para>
475
455
    </informalexample>
476
456
  </refsect1>
477
 
  
 
457
 
478
458
  <refsect1 id="security">
479
459
    <title>SECURITY</title>
480
460
    <para>
489
469
      <manvolnum>8</manvolnum></citerefentry>.
490
470
    </para>
491
471
  </refsect1>
492
 
  
 
472
 
493
473
  <refsect1 id="see_also">
494
474
    <title>SEE ALSO</title>
495
475
    <para>
496
 
      <citerefentry><refentrytitle>intro</refentrytitle>
497
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
498
476
      <citerefentry><refentrytitle>gpg</refentrytitle>
499
477
      <manvolnum>1</manvolnum></citerefentry>,
500
478
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>