/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-03 19:13:50 UTC
  • mfrom: (24.1.83 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080903191350-la2y2wuxt67xjslb
* mandos-keygen.xml (BUGS): Commented out.

* mandos.xml (BUGS): Note non-checking of expire time of OpenPGP keys.

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-09-03">
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
37
    <xi:include href="legalnotice.xml"/>
48
38
  </refentryinfo>
49
 
  
 
39
 
50
40
  <refmeta>
51
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
52
42
    <manvolnum>8</manvolnum>
58
48
      Generate key and password for Mandos client and server.
59
49
    </refpurpose>
60
50
  </refnamediv>
61
 
  
 
51
 
62
52
  <refsynopsisdiv>
63
53
    <cmdsynopsis>
64
54
      <command>&COMMANDNAME;</command>
125
115
        <replaceable>TIME</replaceable></option></arg>
126
116
      </group>
127
117
      <sbr/>
128
 
      <group>
129
 
        <arg choice="plain"><option>--force</option></arg>
130
 
        <arg choice="plain"><option>-f</option></arg>
131
 
      </group>
 
118
      <arg><option>--force</option></arg>
132
119
    </cmdsynopsis>
133
120
    <cmdsynopsis>
134
121
      <command>&COMMANDNAME;</command>
135
122
      <group choice="req">
136
123
        <arg choice="plain"><option>--password</option></arg>
137
124
        <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
125
      </group>
143
126
      <sbr/>
144
127
      <group>
154
137
        <arg choice="plain"><option>-n
155
138
        <replaceable>NAME</replaceable></option></arg>
156
139
      </group>
157
 
      <group>
158
 
        <arg choice="plain"><option>--no-ssh</option></arg>
159
 
        <arg choice="plain"><option>-S</option></arg>
160
 
      </group>
161
140
    </cmdsynopsis>
162
141
    <cmdsynopsis>
163
142
      <command>&COMMANDNAME;</command>
180
159
    <para>
181
160
      <command>&COMMANDNAME;</command> is a program to generate the
182
161
      OpenPGP key used by
183
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
162
      <citerefentry><refentrytitle>password-request</refentrytitle>
184
163
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
185
164
      normally written to /etc/mandos for later installation into the
186
165
      initrd image, but this, and most other things, can be changed
188
167
    </para>
189
168
    <para>
190
169
      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
 
170
      <option>--password</option> option to generate a ready-made
 
171
      section for <filename>clients.conf</filename> (see
194
172
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
195
173
      <manvolnum>5</manvolnum></citerefentry>).
196
174
    </para>
219
197
          </para>
220
198
        </listitem>
221
199
      </varlistentry>
222
 
      
 
200
 
223
201
      <varlistentry>
224
202
        <term><option>--dir
225
203
        <replaceable>DIRECTORY</replaceable></option></term>
228
206
        <listitem>
229
207
          <para>
230
208
            Target directory for key files.  Default is
231
 
            <filename class="directory">/etc/mandos</filename>.
 
209
            <filename>/etc/mandos</filename>.
232
210
          </para>
233
211
        </listitem>
234
212
      </varlistentry>
235
 
      
 
213
 
236
214
      <varlistentry>
237
215
        <term><option>--type
238
216
        <replaceable>TYPE</replaceable></option></term>
240
218
        <replaceable>TYPE</replaceable></option></term>
241
219
        <listitem>
242
220
          <para>
243
 
            Key type.  Default is <quote>RSA</quote>.
 
221
            Key type.  Default is <quote>DSA</quote>.
244
222
          </para>
245
223
        </listitem>
246
224
      </varlistentry>
247
 
      
 
225
 
248
226
      <varlistentry>
249
227
        <term><option>--length
250
228
        <replaceable>BITS</replaceable></option></term>
252
230
        <replaceable>BITS</replaceable></option></term>
253
231
        <listitem>
254
232
          <para>
255
 
            Key length in bits.  Default is 4096.
 
233
            Key length in bits.  Default is 2048.
256
234
          </para>
257
235
        </listitem>
258
236
      </varlistentry>
259
 
      
 
237
 
260
238
      <varlistentry>
261
239
        <term><option>--subtype
262
240
        <replaceable>KEYTYPE</replaceable></option></term>
264
242
        <replaceable>KEYTYPE</replaceable></option></term>
265
243
        <listitem>
266
244
          <para>
267
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
245
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
268
246
            encryption-only).
269
247
          </para>
270
248
        </listitem>
271
249
      </varlistentry>
272
 
      
 
250
 
273
251
      <varlistentry>
274
252
        <term><option>--sublength
275
253
        <replaceable>BITS</replaceable></option></term>
277
255
        <replaceable>BITS</replaceable></option></term>
278
256
        <listitem>
279
257
          <para>
280
 
            Subkey length in bits.  Default is 4096.
 
258
            Subkey length in bits.  Default is 2048.
281
259
          </para>
282
260
        </listitem>
283
261
      </varlistentry>
284
 
      
 
262
 
285
263
      <varlistentry>
286
264
        <term><option>--email
287
265
        <replaceable>ADDRESS</replaceable></option></term>
293
271
          </para>
294
272
        </listitem>
295
273
      </varlistentry>
296
 
      
 
274
 
297
275
      <varlistentry>
298
276
        <term><option>--comment
299
277
        <replaceable>TEXT</replaceable></option></term>
301
279
        <replaceable>TEXT</replaceable></option></term>
302
280
        <listitem>
303
281
          <para>
304
 
            Comment field for key.  Default is empty.
 
282
            Comment field for key.  The default value is
 
283
            <quote><literal>Mandos client key</literal></quote>.
305
284
          </para>
306
285
        </listitem>
307
286
      </varlistentry>
308
 
      
 
287
 
309
288
      <varlistentry>
310
289
        <term><option>--expire
311
290
        <replaceable>TIME</replaceable></option></term>
319
298
          </para>
320
299
        </listitem>
321
300
      </varlistentry>
322
 
      
 
301
 
323
302
      <varlistentry>
324
303
        <term><option>--force</option></term>
325
304
        <term><option>-f</option></term>
347
326
          </para>
348
327
        </listitem>
349
328
      </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
329
    </variablelist>
379
330
  </refsect1>
380
 
  
 
331
 
381
332
  <refsect1 id="overview">
382
333
    <title>OVERVIEW</title>
383
334
    <xi:include href="overview.xml"/>
387
338
      <filename>clients.conf</filename> on the server.
388
339
    </para>
389
340
  </refsect1>
390
 
  
 
341
 
391
342
  <refsect1 id="exit_status">
392
343
    <title>EXIT STATUS</title>
393
344
    <para>
413
364
    </variablelist>
414
365
  </refsect1>
415
366
  
416
 
  <refsect1 id="files">
 
367
  <refsect1 id="file">
417
368
    <title>FILES</title>
418
369
    <para>
419
370
      Use the <option>--dir</option> option to change where
440
391
        </listitem>
441
392
      </varlistentry>
442
393
      <varlistentry>
443
 
        <term><filename class="directory">/tmp</filename></term>
 
394
        <term><filename>/tmp</filename></term>
444
395
        <listitem>
445
396
          <para>
446
397
            Temporary files will be written here if
450
401
      </varlistentry>
451
402
    </variablelist>
452
403
  </refsect1>
453
 
  
454
 
  <refsect1 id="bugs">
455
 
    <title>BUGS</title>
456
 
    <xi:include href="bugs.xml"/>
457
 
  </refsect1>
458
 
  
 
404
 
 
405
<!--   <refsect1 id="bugs"> -->
 
406
<!--     <title>BUGS</title> -->
 
407
<!--     <para> -->
 
408
<!--     </para> -->
 
409
<!--   </refsect1> -->
 
410
 
459
411
  <refsect1 id="example">
460
412
    <title>EXAMPLE</title>
461
413
    <informalexample>
480
432
    </informalexample>
481
433
    <informalexample>
482
434
      <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>.
 
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>.
486
438
      </para>
487
439
      <para>
488
440
        <userinput>&COMMANDNAME; --password</userinput>
502
454
      </para>
503
455
    </informalexample>
504
456
  </refsect1>
505
 
  
 
457
 
506
458
  <refsect1 id="security">
507
459
    <title>SECURITY</title>
508
460
    <para>
517
469
      <manvolnum>8</manvolnum></citerefentry>.
518
470
    </para>
519
471
  </refsect1>
520
 
  
 
472
 
521
473
  <refsect1 id="see_also">
522
474
    <title>SEE ALSO</title>
523
475
    <para>
524
 
      <citerefentry><refentrytitle>intro</refentrytitle>
525
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
526
476
      <citerefentry><refentrytitle>gpg</refentrytitle>
527
477
      <manvolnum>1</manvolnum></citerefentry>,
528
478
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
479
      <manvolnum>5</manvolnum></citerefentry>,
530
480
      <citerefentry><refentrytitle>mandos</refentrytitle>
531
481
      <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>
 
482
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
483
      <manvolnum>8mandos</manvolnum></citerefentry>
536
484
    </para>
537
485
  </refsect1>
538
486