/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-02 13:04:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902130442-ytnjsmllaph18e20
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
  (BUGS): Commented out.  There are no bugs.
  (EXAMPLE): Added lots of examples.
  (SECURITY): Added text.
  (SEE ALSO): Added "crypttab(5)" and "execve(2)".

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