/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-09-08 18:54:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908185447-dm2ertwxa20qbckf
* INSTALL: Even 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 "2018-02-08">
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>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
 
      <year>2018</year>
45
34
      <holder>Teddy Hogeborn</holder>
46
35
      <holder>Björn Påhlsson</holder>
47
36
    </copyright>
48
37
    <xi:include href="legalnotice.xml"/>
49
38
  </refentryinfo>
50
 
  
 
39
 
51
40
  <refmeta>
52
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
53
42
    <manvolnum>8</manvolnum>
59
48
      Generate key and password for Mandos client and server.
60
49
    </refpurpose>
61
50
  </refnamediv>
62
 
  
 
51
 
63
52
  <refsynopsisdiv>
64
53
    <cmdsynopsis>
65
54
      <command>&COMMANDNAME;</command>
126
115
        <replaceable>TIME</replaceable></option></arg>
127
116
      </group>
128
117
      <sbr/>
129
 
      <group>
130
 
        <arg choice="plain"><option>--force</option></arg>
131
 
        <arg choice="plain"><option>-f</option></arg>
132
 
      </group>
 
118
      <arg><option>--force</option></arg>
133
119
    </cmdsynopsis>
134
120
    <cmdsynopsis>
135
121
      <command>&COMMANDNAME;</command>
136
122
      <group choice="req">
137
123
        <arg choice="plain"><option>--password</option></arg>
138
124
        <arg choice="plain"><option>-p</option></arg>
139
 
        <arg choice="plain"><option>--passfile
140
 
        <replaceable>FILE</replaceable></option></arg>
141
 
        <arg choice="plain"><option>-F</option>
142
 
        <replaceable>FILE</replaceable></arg>
143
125
      </group>
144
126
      <sbr/>
145
127
      <group>
155
137
        <arg choice="plain"><option>-n
156
138
        <replaceable>NAME</replaceable></option></arg>
157
139
      </group>
158
 
      <group>
159
 
        <arg choice="plain"><option>--no-ssh</option></arg>
160
 
        <arg choice="plain"><option>-S</option></arg>
161
 
      </group>
162
140
    </cmdsynopsis>
163
141
    <cmdsynopsis>
164
142
      <command>&COMMANDNAME;</command>
189
167
    </para>
190
168
    <para>
191
169
      This program can also be used with the
192
 
      <option>--password</option> or <option>--passfile</option>
193
 
      options to generate a ready-made section for
194
 
      <filename>clients.conf</filename> (see
 
170
      <option>--password</option> option to generate a ready-made
 
171
      section for <filename>clients.conf</filename> (see
195
172
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
196
173
      <manvolnum>5</manvolnum></citerefentry>).
197
174
    </para>
220
197
          </para>
221
198
        </listitem>
222
199
      </varlistentry>
223
 
      
 
200
 
224
201
      <varlistentry>
225
202
        <term><option>--dir
226
203
        <replaceable>DIRECTORY</replaceable></option></term>
229
206
        <listitem>
230
207
          <para>
231
208
            Target directory for key files.  Default is
232
 
            <filename class="directory">/etc/mandos</filename>.
 
209
            <filename>/etc/mandos</filename>.
233
210
          </para>
234
211
        </listitem>
235
212
      </varlistentry>
236
 
      
 
213
 
237
214
      <varlistentry>
238
215
        <term><option>--type
239
216
        <replaceable>TYPE</replaceable></option></term>
241
218
        <replaceable>TYPE</replaceable></option></term>
242
219
        <listitem>
243
220
          <para>
244
 
            Key type.  Default is <quote>RSA</quote>.
 
221
            Key type.  Default is <quote>DSA</quote>.
245
222
          </para>
246
223
        </listitem>
247
224
      </varlistentry>
248
 
      
 
225
 
249
226
      <varlistentry>
250
227
        <term><option>--length
251
228
        <replaceable>BITS</replaceable></option></term>
253
230
        <replaceable>BITS</replaceable></option></term>
254
231
        <listitem>
255
232
          <para>
256
 
            Key length in bits.  Default is 4096.
 
233
            Key length in bits.  Default is 2048.
257
234
          </para>
258
235
        </listitem>
259
236
      </varlistentry>
260
 
      
 
237
 
261
238
      <varlistentry>
262
239
        <term><option>--subtype
263
240
        <replaceable>KEYTYPE</replaceable></option></term>
265
242
        <replaceable>KEYTYPE</replaceable></option></term>
266
243
        <listitem>
267
244
          <para>
268
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
245
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
269
246
            encryption-only).
270
247
          </para>
271
248
        </listitem>
272
249
      </varlistentry>
273
 
      
 
250
 
274
251
      <varlistentry>
275
252
        <term><option>--sublength
276
253
        <replaceable>BITS</replaceable></option></term>
278
255
        <replaceable>BITS</replaceable></option></term>
279
256
        <listitem>
280
257
          <para>
281
 
            Subkey length in bits.  Default is 4096.
 
258
            Subkey length in bits.  Default is 2048.
282
259
          </para>
283
260
        </listitem>
284
261
      </varlistentry>
285
 
      
 
262
 
286
263
      <varlistentry>
287
264
        <term><option>--email
288
265
        <replaceable>ADDRESS</replaceable></option></term>
294
271
          </para>
295
272
        </listitem>
296
273
      </varlistentry>
297
 
      
 
274
 
298
275
      <varlistentry>
299
276
        <term><option>--comment
300
277
        <replaceable>TEXT</replaceable></option></term>
302
279
        <replaceable>TEXT</replaceable></option></term>
303
280
        <listitem>
304
281
          <para>
305
 
            Comment field for key.  Default is empty.
 
282
            Comment field for key.  The default value is
 
283
            <quote><literal>Mandos client key</literal></quote>.
306
284
          </para>
307
285
        </listitem>
308
286
      </varlistentry>
309
 
      
 
287
 
310
288
      <varlistentry>
311
289
        <term><option>--expire
312
290
        <replaceable>TIME</replaceable></option></term>
320
298
          </para>
321
299
        </listitem>
322
300
      </varlistentry>
323
 
      
 
301
 
324
302
      <varlistentry>
325
303
        <term><option>--force</option></term>
326
304
        <term><option>-f</option></term>
348
326
          </para>
349
327
        </listitem>
350
328
      </varlistentry>
351
 
      <varlistentry>
352
 
        <term><option>--passfile
353
 
        <replaceable>FILE</replaceable></option></term>
354
 
        <term><option>-F
355
 
        <replaceable>FILE</replaceable></option></term>
356
 
        <listitem>
357
 
          <para>
358
 
            The same as <option>--password</option>, but read from
359
 
            <replaceable>FILE</replaceable>, not the terminal.
360
 
          </para>
361
 
        </listitem>
362
 
      </varlistentry>
363
 
      <varlistentry>
364
 
        <term><option>--no-ssh</option></term>
365
 
        <term><option>-S</option></term>
366
 
        <listitem>
367
 
          <para>
368
 
            When <option>--password</option> or
369
 
            <option>--passfile</option> is given, this option will
370
 
            prevent <command>&COMMANDNAME;</command> from calling
371
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
372
 
            for this host and, if successful, output suitable config
373
 
            options to use this fingerprint as a
374
 
            <option>checker</option> option in the output.  This is
375
 
            otherwise the default behavior.
376
 
          </para>
377
 
        </listitem>
378
 
      </varlistentry>
379
329
    </variablelist>
380
330
  </refsect1>
381
 
  
 
331
 
382
332
  <refsect1 id="overview">
383
333
    <title>OVERVIEW</title>
384
334
    <xi:include href="overview.xml"/>
388
338
      <filename>clients.conf</filename> on the server.
389
339
    </para>
390
340
  </refsect1>
391
 
  
 
341
 
392
342
  <refsect1 id="exit_status">
393
343
    <title>EXIT STATUS</title>
394
344
    <para>
414
364
    </variablelist>
415
365
  </refsect1>
416
366
  
417
 
  <refsect1 id="files">
 
367
  <refsect1 id="file">
418
368
    <title>FILES</title>
419
369
    <para>
420
370
      Use the <option>--dir</option> option to change where
441
391
        </listitem>
442
392
      </varlistentry>
443
393
      <varlistentry>
444
 
        <term><filename class="directory">/tmp</filename></term>
 
394
        <term><filename>/tmp</filename></term>
445
395
        <listitem>
446
396
          <para>
447
397
            Temporary files will be written here if
451
401
      </varlistentry>
452
402
    </variablelist>
453
403
  </refsect1>
454
 
  
455
 
  <refsect1 id="bugs">
456
 
    <title>BUGS</title>
457
 
    <xi:include href="bugs.xml"/>
458
 
  </refsect1>
459
 
  
 
404
 
 
405
<!--   <refsect1 id="bugs"> -->
 
406
<!--     <title>BUGS</title> -->
 
407
<!--     <para> -->
 
408
<!--     </para> -->
 
409
<!--   </refsect1> -->
 
410
 
460
411
  <refsect1 id="example">
461
412
    <title>EXAMPLE</title>
462
413
    <informalexample>
481
432
    </informalexample>
482
433
    <informalexample>
483
434
      <para>
484
 
        Prompt for a password, encrypt it with the key in <filename
485
 
        class="directory">/etc/mandos</filename> and output a section
486
 
        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>.
487
438
      </para>
488
439
      <para>
489
440
        <userinput>&COMMANDNAME; --password</userinput>
503
454
      </para>
504
455
    </informalexample>
505
456
  </refsect1>
506
 
  
 
457
 
507
458
  <refsect1 id="security">
508
459
    <title>SECURITY</title>
509
460
    <para>
518
469
      <manvolnum>8</manvolnum></citerefentry>.
519
470
    </para>
520
471
  </refsect1>
521
 
  
 
472
 
522
473
  <refsect1 id="see_also">
523
474
    <title>SEE ALSO</title>
524
475
    <para>
525
 
      <citerefentry><refentrytitle>intro</refentrytitle>
526
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
527
476
      <citerefentry><refentrytitle>gpg</refentrytitle>
528
477
      <manvolnum>1</manvolnum></citerefentry>,
529
478
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
531
480
      <citerefentry><refentrytitle>mandos</refentrytitle>
532
481
      <manvolnum>8</manvolnum></citerefentry>,
533
482
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
535
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
536
 
      <manvolnum>1</manvolnum></citerefentry>
 
483
      <manvolnum>8mandos</manvolnum></citerefentry>
537
484
    </para>
538
485
  </refsect1>
539
486