/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-08-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY COMMANDNAME "mandos-keygen">
 
6
<!ENTITY TIMESTAMP "2008-08-29">
8
7
]>
9
8
 
10
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
15
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
16
16
    <authorgroup>
17
17
      <author>
18
18
        <firstname>Björn</firstname>
31
31
    </authorgroup>
32
32
    <copyright>
33
33
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
35
36
    </copyright>
36
37
    <legalnotice>
37
38
      <para>
87
88
        <replaceable>bits</replaceable></arg>
88
89
      </group>
89
90
      <group choice="opt">
 
91
        <arg choice="plain"><option>--subtype</option>
 
92
        <replaceable>type</replaceable></arg>
 
93
      </group>
 
94
      <group choice="opt">
 
95
        <arg choice="plain"><option>--sublength</option>
 
96
        <replaceable>bits</replaceable></arg>
 
97
      </group>
 
98
      <group choice="opt">
90
99
        <arg choice="plain"><option>--name</option>
91
100
        <replaceable>NAME</replaceable></arg>
92
101
      </group>
121
130
        <replaceable>bits</replaceable></arg>
122
131
      </group>
123
132
      <group choice="opt">
 
133
        <arg choice="plain"><option>-s</option>
 
134
        <replaceable>type</replaceable></arg>
 
135
      </group>
 
136
      <group choice="opt">
 
137
        <arg choice="plain"><option>-L</option>
 
138
        <replaceable>bits</replaceable></arg>
 
139
      </group>
 
140
      <group choice="opt">
124
141
        <arg choice="plain"><option>-n</option>
125
142
        <replaceable>NAME</replaceable></arg>
126
143
      </group>
143
160
    <cmdsynopsis>
144
161
      <command>&COMMANDNAME;</command>
145
162
      <group choice="req">
146
 
        <arg choice='plain'><option>-h</option></arg>
147
 
        <arg choice='plain'><option>--help</option></arg>
148
 
      </group>
149
 
    </cmdsynopsis>
150
 
    <cmdsynopsis>
151
 
      <command>&COMMANDNAME;</command>
152
 
      <group choice="req">
153
 
        <arg choice='plain'><option>-v</option></arg>
154
 
        <arg choice='plain'><option>--version</option></arg>
 
163
        <arg choice="plain"><option>-p</option></arg>
 
164
        <arg choice="plain"><option>--password</option></arg>
 
165
      </group>
 
166
      <group choice="opt">
 
167
        <arg choice="plain"><option>--dir</option>
 
168
        <replaceable>directory</replaceable></arg>
 
169
      </group>
 
170
      <group choice="opt">
 
171
        <arg choice="plain"><option>--name</option>
 
172
        <replaceable>NAME</replaceable></arg>
 
173
      </group>
 
174
    </cmdsynopsis>
 
175
    <cmdsynopsis>
 
176
      <command>&COMMANDNAME;</command>
 
177
      <group choice="req">
 
178
        <arg choice="plain"><option>-h</option></arg>
 
179
        <arg choice="plain"><option>--help</option></arg>
 
180
      </group>
 
181
    </cmdsynopsis>
 
182
    <cmdsynopsis>
 
183
      <command>&COMMANDNAME;</command>
 
184
      <group choice="req">
 
185
        <arg choice="plain"><option>-v</option></arg>
 
186
        <arg choice="plain"><option>--version</option></arg>
155
187
      </group>
156
188
    </cmdsynopsis>
157
189
  </refsynopsisdiv>
167
199
      initrd image, but this, like most things, can be changed with
168
200
      command line options.
169
201
    </para>
 
202
    <para>
 
203
      It can also be used to generate ready-made sections for
 
204
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
205
      <manvolnum>5</manvolnum></citerefentry> using the
 
206
      <option>--password</option> option.
 
207
    </para>
 
208
  </refsect1>
 
209
  
 
210
  <refsect1 id="purpose">
 
211
    <title>PURPOSE</title>
 
212
 
 
213
    <para>
 
214
      The purpose of this is to enable <emphasis>remote and unattended
 
215
      rebooting</emphasis> of client host computer with an
 
216
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
217
      linkend="overview"/> for details.
 
218
    </para>
 
219
 
170
220
  </refsect1>
171
221
  
172
222
  <refsect1 id="options">
187
237
        <replaceable>directory</replaceable></literal></term>
188
238
        <listitem>
189
239
          <para>
190
 
            Target directory for key files.
 
240
            Target directory for key files.  Default is
 
241
            <filename>/etc/mandos</filename>.
191
242
          </para>
192
243
        </listitem>
193
244
      </varlistentry>
197
248
        <replaceable>type</replaceable></literal></term>
198
249
        <listitem>
199
250
          <para>
200
 
            Key type.  Default is DSA.
 
251
            Key type.  Default is <quote>DSA</quote>.
201
252
          </para>
202
253
        </listitem>
203
254
      </varlistentry>
207
258
        <replaceable>bits</replaceable></literal></term>
208
259
        <listitem>
209
260
          <para>
210
 
            Key length in bits.  Default is 1024.
 
261
            Key length in bits.  Default is 2048.
 
262
          </para>
 
263
        </listitem>
 
264
      </varlistentry>
 
265
 
 
266
      <varlistentry>
 
267
        <term><literal>-s</literal>, <literal>--subtype
 
268
        <replaceable>type</replaceable></literal></term>
 
269
        <listitem>
 
270
          <para>
 
271
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
272
            encryption-only).
 
273
          </para>
 
274
        </listitem>
 
275
      </varlistentry>
 
276
 
 
277
      <varlistentry>
 
278
        <term><literal>-L</literal>, <literal>--sublength
 
279
        <replaceable>bits</replaceable></literal></term>
 
280
        <listitem>
 
281
          <para>
 
282
            Subkey length in bits.  Default is 2048.
211
283
          </para>
212
284
        </listitem>
213
285
      </varlistentry>
228
300
        <listitem>
229
301
          <para>
230
302
            Comment field for key.  The default value is
231
 
            "<literal>Mandos client key</literal>".
 
303
            <quote><literal>Mandos client key</literal></quote>.
232
304
          </para>
233
305
        </listitem>
234
306
      </varlistentry>
253
325
          </para>
254
326
        </listitem>
255
327
      </varlistentry>
 
328
      <varlistentry>
 
329
        <term><literal>-p</literal>, <literal>--password</literal
 
330
        ></term>
 
331
        <listitem>
 
332
          <para>
 
333
            Prompt for a password and encrypt it with the key already
 
334
            present in either <filename>/etc/mandos</filename> or the
 
335
            directory specified with the <option>--dir</option>
 
336
            option.  Outputs, on standard output, a section suitable
 
337
            for inclusion in <citerefentry><refentrytitle
 
338
            >mandos-clients.conf</refentrytitle><manvolnum
 
339
            >8</manvolnum></citerefentry>.  The host name or the name
 
340
            specified with the <option>--name</option> option is used
 
341
            for the section header.  All other options are ignored,
 
342
            and no keys are created.
 
343
          </para>
 
344
        </listitem>
 
345
      </varlistentry>
256
346
    </variablelist>
257
347
  </refsect1>
258
348
 
 
349
  <refsect1 id="overview">
 
350
    <title>OVERVIEW</title>
 
351
    <xi:include href="overview.xml"/>
 
352
    <para>
 
353
      This program is a small utility to generate new OpenPGP keys for
 
354
      new Mandos clients.
 
355
    </para>
 
356
  </refsect1>
 
357
 
259
358
  <refsect1 id="exit_status">
260
359
    <title>EXIT STATUS</title>
261
360
    <para>
 
361
      The exit status will be 0 if new keys were successfully created,
 
362
      otherwise not.
262
363
    </para>
263
364
  </refsect1>
264
365
  
 
366
  <refsect1 id="environment">
 
367
    <title>ENVIRONMENT</title>
 
368
    <variablelist>
 
369
      <varlistentry>
 
370
        <term><varname>TMPDIR</varname></term>
 
371
        <listitem>
 
372
          <para>
 
373
            If set, temporary files will be created here. See
 
374
            <citerefentry><refentrytitle>mktemp</refentrytitle>
 
375
            <manvolnum>1</manvolnum></citerefentry>.
 
376
          </para>
 
377
        </listitem>
 
378
      </varlistentry>
 
379
    </variablelist>
 
380
  </refsect1>
 
381
  
265
382
  <refsect1 id="file">
266
383
    <title>FILES</title>
267
384
    <para>
 
385
      Use the <option>--dir</option> option to change where
 
386
      <command>&COMMANDNAME;</command> will write the key files.  The
 
387
      default file names are shown here.
268
388
    </para>
 
389
    <variablelist>
 
390
      <varlistentry>
 
391
        <term><filename>/etc/mandos/seckey.txt</filename></term>
 
392
        <listitem>
 
393
          <para>
 
394
            OpenPGP secret key file which will be created or
 
395
            overwritten.
 
396
          </para>
 
397
        </listitem>
 
398
      </varlistentry>
 
399
      <varlistentry>
 
400
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
 
401
        <listitem>
 
402
          <para>
 
403
            OpenPGP public key file which will be created or
 
404
            overwritten.
 
405
          </para>
 
406
        </listitem>
 
407
      </varlistentry>
 
408
      <varlistentry>
 
409
        <term><filename>/tmp</filename></term>
 
410
        <listitem>
 
411
          <para>
 
412
            Temporary files will be written here if
 
413
            <varname>TMPDIR</varname> is not set.
 
414
          </para>
 
415
        </listitem>
 
416
      </varlistentry>
 
417
    </variablelist>
269
418
  </refsect1>
270
419
 
271
420
  <refsect1 id="bugs">
272
421
    <title>BUGS</title>
273
422
    <para>
 
423
      None are known at this time.
274
424
    </para>
275
425
  </refsect1>
276
426
 
277
 
  <refsect1 id="examples">
278
 
    <title>EXAMPLES</title>
279
 
    <para>
280
 
    </para>
 
427
  <refsect1 id="example">
 
428
    <title>EXAMPLE</title>
 
429
    <informalexample>
 
430
      <para>
 
431
        Normal invocation needs no options:
 
432
      </para>
 
433
      <para>
 
434
        <userinput>&COMMANDNAME;</userinput>
 
435
      </para>
 
436
    </informalexample>
 
437
    <informalexample>
 
438
      <para>
 
439
        Create keys in another directory and of another type.  Force
 
440
        overwriting old key files:
 
441
      </para>
 
442
      <para>
 
443
 
 
444
<!-- do not wrap this line -->
 
445
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
 
446
 
 
447
      </para>
 
448
    </informalexample>
281
449
  </refsect1>
282
450
 
283
451
  <refsect1 id="security">
284
452
    <title>SECURITY</title>
285
453
    <para>
 
454
      The <option>--type</option>, <option>--length</option>,
 
455
      <option>--subtype</option>, and <option>--sublength</option>
 
456
      options can be used to create keys of insufficient security.  If
 
457
      in doubt, leave them to the default values.
 
458
    </para>
 
459
    <para>
 
460
      The key expire time is not guaranteed to be honored by
 
461
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
462
      <manvolnum>8</manvolnum></citerefentry>.
286
463
    </para>
287
464
  </refsect1>
288
465
 
292
469
      <citerefentry><refentrytitle>password-request</refentrytitle>
293
470
      <manvolnum>8mandos</manvolnum></citerefentry>,
294
471
      <citerefentry><refentrytitle>mandos</refentrytitle>
295
 
      <manvolnum>8</manvolnum></citerefentry>, and
 
472
      <manvolnum>8</manvolnum></citerefentry>,
296
473
      <citerefentry><refentrytitle>gpg</refentrytitle>
297
474
      <manvolnum>1</manvolnum></citerefentry>
298
475
    </para>
299
476
  </refsect1>
300
477
  
301
478
</refentry>
 
479
<!-- Local Variables: -->
 
480
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
481
<!-- time-stamp-end: "[\"']>" -->
 
482
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
483
<!-- End: -->