/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-31 14:02:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140237-oz9knd88esz8cj4y
* plugin-runner.xml: Removed <?xml-stylesheet>.
* plugins.d/password-request.xml: - '' -

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-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>2011</year>
37
 
      <year>2012</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
42
60
  </refentryinfo>
43
 
  
 
61
 
44
62
  <refmeta>
45
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
64
    <manvolnum>8</manvolnum>
52
70
      Generate key and password for Mandos client and server.
53
71
    </refpurpose>
54
72
  </refnamediv>
55
 
  
 
73
 
56
74
  <refsynopsisdiv>
57
75
    <cmdsynopsis>
58
76
      <command>&COMMANDNAME;</command>
126
144
      <group choice="req">
127
145
        <arg choice="plain"><option>--password</option></arg>
128
146
        <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
147
      </group>
134
148
      <sbr/>
135
149
      <group>
167
181
    <para>
168
182
      <command>&COMMANDNAME;</command> is a program to generate the
169
183
      OpenPGP key used by
170
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
184
      <citerefentry><refentrytitle>password-request</refentrytitle>
171
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
172
186
      normally written to /etc/mandos for later installation into the
173
187
      initrd image, but this, and most other things, can be changed
175
189
    </para>
176
190
    <para>
177
191
      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
 
192
      <option>--password</option> option to generate a ready-made
 
193
      section for <filename>clients.conf</filename> (see
181
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
182
195
      <manvolnum>5</manvolnum></citerefentry>).
183
196
    </para>
206
219
          </para>
207
220
        </listitem>
208
221
      </varlistentry>
209
 
      
 
222
 
210
223
      <varlistentry>
211
224
        <term><option>--dir
212
225
        <replaceable>DIRECTORY</replaceable></option></term>
215
228
        <listitem>
216
229
          <para>
217
230
            Target directory for key files.  Default is
218
 
            <filename class="directory">/etc/mandos</filename>.
 
231
            <filename>/etc/mandos</filename>.
219
232
          </para>
220
233
        </listitem>
221
234
      </varlistentry>
222
 
      
 
235
 
223
236
      <varlistentry>
224
237
        <term><option>--type
225
238
        <replaceable>TYPE</replaceable></option></term>
227
240
        <replaceable>TYPE</replaceable></option></term>
228
241
        <listitem>
229
242
          <para>
230
 
            Key type.  Default is <quote>RSA</quote>.
 
243
            Key type.  Default is <quote>DSA</quote>.
231
244
          </para>
232
245
        </listitem>
233
246
      </varlistentry>
234
 
      
 
247
 
235
248
      <varlistentry>
236
249
        <term><option>--length
237
250
        <replaceable>BITS</replaceable></option></term>
239
252
        <replaceable>BITS</replaceable></option></term>
240
253
        <listitem>
241
254
          <para>
242
 
            Key length in bits.  Default is 4096.
 
255
            Key length in bits.  Default is 2048.
243
256
          </para>
244
257
        </listitem>
245
258
      </varlistentry>
246
 
      
 
259
 
247
260
      <varlistentry>
248
261
        <term><option>--subtype
249
262
        <replaceable>KEYTYPE</replaceable></option></term>
251
264
        <replaceable>KEYTYPE</replaceable></option></term>
252
265
        <listitem>
253
266
          <para>
254
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
267
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
255
268
            encryption-only).
256
269
          </para>
257
270
        </listitem>
258
271
      </varlistentry>
259
 
      
 
272
 
260
273
      <varlistentry>
261
274
        <term><option>--sublength
262
275
        <replaceable>BITS</replaceable></option></term>
264
277
        <replaceable>BITS</replaceable></option></term>
265
278
        <listitem>
266
279
          <para>
267
 
            Subkey length in bits.  Default is 4096.
 
280
            Subkey length in bits.  Default is 2048.
268
281
          </para>
269
282
        </listitem>
270
283
      </varlistentry>
271
 
      
 
284
 
272
285
      <varlistentry>
273
286
        <term><option>--email
274
287
        <replaceable>ADDRESS</replaceable></option></term>
280
293
          </para>
281
294
        </listitem>
282
295
      </varlistentry>
283
 
      
 
296
 
284
297
      <varlistentry>
285
298
        <term><option>--comment
286
299
        <replaceable>TEXT</replaceable></option></term>
288
301
        <replaceable>TEXT</replaceable></option></term>
289
302
        <listitem>
290
303
          <para>
291
 
            Comment field for key.  Default is empty.
 
304
            Comment field for key.  The default value is
 
305
            <quote><literal>Mandos client key</literal></quote>.
292
306
          </para>
293
307
        </listitem>
294
308
      </varlistentry>
295
 
      
 
309
 
296
310
      <varlistentry>
297
311
        <term><option>--expire
298
312
        <replaceable>TIME</replaceable></option></term>
306
320
          </para>
307
321
        </listitem>
308
322
      </varlistentry>
309
 
      
 
323
 
310
324
      <varlistentry>
311
325
        <term><option>--force</option></term>
312
326
        <term><option>-f</option></term>
334
348
          </para>
335
349
        </listitem>
336
350
      </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
351
    </variablelist>
350
352
  </refsect1>
351
 
  
 
353
 
352
354
  <refsect1 id="overview">
353
355
    <title>OVERVIEW</title>
354
356
    <xi:include href="overview.xml"/>
358
360
      <filename>clients.conf</filename> on the server.
359
361
    </para>
360
362
  </refsect1>
361
 
  
 
363
 
362
364
  <refsect1 id="exit_status">
363
365
    <title>EXIT STATUS</title>
364
366
    <para>
384
386
    </variablelist>
385
387
  </refsect1>
386
388
  
387
 
  <refsect1 id="files">
 
389
  <refsect1 id="file">
388
390
    <title>FILES</title>
389
391
    <para>
390
392
      Use the <option>--dir</option> option to change where
411
413
        </listitem>
412
414
      </varlistentry>
413
415
      <varlistentry>
414
 
        <term><filename class="directory">/tmp</filename></term>
 
416
        <term><filename>/tmp</filename></term>
415
417
        <listitem>
416
418
          <para>
417
419
            Temporary files will be written here if
421
423
      </varlistentry>
422
424
    </variablelist>
423
425
  </refsect1>
424
 
  
425
 
<!--   <refsect1 id="bugs"> -->
426
 
<!--     <title>BUGS</title> -->
427
 
<!--     <para> -->
428
 
<!--     </para> -->
429
 
<!--   </refsect1> -->
430
 
  
 
426
 
 
427
  <refsect1 id="bugs">
 
428
    <title>BUGS</title>
 
429
    <para>
 
430
      None are known at this time.
 
431
    </para>
 
432
  </refsect1>
 
433
 
431
434
  <refsect1 id="example">
432
435
    <title>EXAMPLE</title>
433
436
    <informalexample>
452
455
    </informalexample>
453
456
    <informalexample>
454
457
      <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>.
 
458
        Prompt for a password, encrypt it with the key in
 
459
        <filename>/etc/mandos</filename> and output a section suitable
 
460
        for <filename>clients.conf</filename>.
458
461
      </para>
459
462
      <para>
460
463
        <userinput>&COMMANDNAME; --password</userinput>
474
477
      </para>
475
478
    </informalexample>
476
479
  </refsect1>
477
 
  
 
480
 
478
481
  <refsect1 id="security">
479
482
    <title>SECURITY</title>
480
483
    <para>
489
492
      <manvolnum>8</manvolnum></citerefentry>.
490
493
    </para>
491
494
  </refsect1>
492
 
  
 
495
 
493
496
  <refsect1 id="see_also">
494
497
    <title>SEE ALSO</title>
495
498
    <para>
496
 
      <citerefentry><refentrytitle>intro</refentrytitle>
497
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
498
499
      <citerefentry><refentrytitle>gpg</refentrytitle>
499
500
      <manvolnum>1</manvolnum></citerefentry>,
500
501
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
501
502
      <manvolnum>5</manvolnum></citerefentry>,
502
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
503
504
      <manvolnum>8</manvolnum></citerefentry>,
504
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
505
      <citerefentry><refentrytitle>password-request</refentrytitle>
505
506
      <manvolnum>8mandos</manvolnum></citerefentry>
506
507
    </para>
507
508
  </refsect1>