/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: 2012-06-17 02:30:59 UTC
  • mto: (301.1.1 release) (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 302.
  • Revision ID: teddy@recompile.se-20120617023059-em4nfnxg1tsn64xj
* plugins.d/mandos-client (start_mandos_communication): Bug fix; skip
                                                        non-specified
                                                        interfaces.
  (main): Use lower_privileges() consistently.  Bug fix: Don't remove
          "none" from list of interfaces.  Make --interface=none work
          again by not bringing up interfaces specified after "none".
* plugins.d/mandos-client.xml (OPTIONS): Document new meaning of
                                         specifying --interface=none
                                         together with other
                                         interface names,

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">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-09-03">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
 
37
      <year>2012</year>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </copyright>
37
41
    <xi:include href="legalnotice.xml"/>
38
42
  </refentryinfo>
39
 
 
 
43
  
40
44
  <refmeta>
41
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
46
    <manvolnum>8</manvolnum>
48
52
      Generate key and password for Mandos client and server.
49
53
    </refpurpose>
50
54
  </refnamediv>
51
 
 
 
55
  
52
56
  <refsynopsisdiv>
53
57
    <cmdsynopsis>
54
58
      <command>&COMMANDNAME;</command>
122
126
      <group choice="req">
123
127
        <arg choice="plain"><option>--password</option></arg>
124
128
        <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>
125
133
      </group>
126
134
      <sbr/>
127
135
      <group>
159
167
    <para>
160
168
      <command>&COMMANDNAME;</command> is a program to generate the
161
169
      OpenPGP key used by
162
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
170
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
163
171
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
164
172
      normally written to /etc/mandos for later installation into the
165
173
      initrd image, but this, and most other things, can be changed
167
175
    </para>
168
176
    <para>
169
177
      This program can also be used with the
170
 
      <option>--password</option> option to generate a ready-made
171
 
      section for <filename>clients.conf</filename> (see
 
178
      <option>--password</option> or <option>--passfile</option>
 
179
      options to generate a ready-made section for
 
180
      <filename>clients.conf</filename> (see
172
181
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
173
182
      <manvolnum>5</manvolnum></citerefentry>).
174
183
    </para>
197
206
          </para>
198
207
        </listitem>
199
208
      </varlistentry>
200
 
 
 
209
      
201
210
      <varlistentry>
202
211
        <term><option>--dir
203
212
        <replaceable>DIRECTORY</replaceable></option></term>
206
215
        <listitem>
207
216
          <para>
208
217
            Target directory for key files.  Default is
209
 
            <filename>/etc/mandos</filename>.
 
218
            <filename class="directory">/etc/mandos</filename>.
210
219
          </para>
211
220
        </listitem>
212
221
      </varlistentry>
213
 
 
 
222
      
214
223
      <varlistentry>
215
224
        <term><option>--type
216
225
        <replaceable>TYPE</replaceable></option></term>
222
231
          </para>
223
232
        </listitem>
224
233
      </varlistentry>
225
 
 
 
234
      
226
235
      <varlistentry>
227
236
        <term><option>--length
228
237
        <replaceable>BITS</replaceable></option></term>
234
243
          </para>
235
244
        </listitem>
236
245
      </varlistentry>
237
 
 
 
246
      
238
247
      <varlistentry>
239
248
        <term><option>--subtype
240
249
        <replaceable>KEYTYPE</replaceable></option></term>
247
256
          </para>
248
257
        </listitem>
249
258
      </varlistentry>
250
 
 
 
259
      
251
260
      <varlistentry>
252
261
        <term><option>--sublength
253
262
        <replaceable>BITS</replaceable></option></term>
259
268
          </para>
260
269
        </listitem>
261
270
      </varlistentry>
262
 
 
 
271
      
263
272
      <varlistentry>
264
273
        <term><option>--email
265
274
        <replaceable>ADDRESS</replaceable></option></term>
271
280
          </para>
272
281
        </listitem>
273
282
      </varlistentry>
274
 
 
 
283
      
275
284
      <varlistentry>
276
285
        <term><option>--comment
277
286
        <replaceable>TEXT</replaceable></option></term>
284
293
          </para>
285
294
        </listitem>
286
295
      </varlistentry>
287
 
 
 
296
      
288
297
      <varlistentry>
289
298
        <term><option>--expire
290
299
        <replaceable>TIME</replaceable></option></term>
298
307
          </para>
299
308
        </listitem>
300
309
      </varlistentry>
301
 
 
 
310
      
302
311
      <varlistentry>
303
312
        <term><option>--force</option></term>
304
313
        <term><option>-f</option></term>
326
335
          </para>
327
336
        </listitem>
328
337
      </varlistentry>
 
338
      <varlistentry>
 
339
        <term><option>--passfile
 
340
        <replaceable>FILE</replaceable></option></term>
 
341
        <term><option>-F
 
342
        <replaceable>FILE</replaceable></option></term>
 
343
        <listitem>
 
344
          <para>
 
345
            The same as <option>--password</option>, but read from
 
346
            <replaceable>FILE</replaceable>, not the terminal.
 
347
          </para>
 
348
        </listitem>
 
349
      </varlistentry>
329
350
    </variablelist>
330
351
  </refsect1>
331
 
 
 
352
  
332
353
  <refsect1 id="overview">
333
354
    <title>OVERVIEW</title>
334
355
    <xi:include href="overview.xml"/>
338
359
      <filename>clients.conf</filename> on the server.
339
360
    </para>
340
361
  </refsect1>
341
 
 
 
362
  
342
363
  <refsect1 id="exit_status">
343
364
    <title>EXIT STATUS</title>
344
365
    <para>
364
385
    </variablelist>
365
386
  </refsect1>
366
387
  
367
 
  <refsect1 id="file">
 
388
  <refsect1 id="files">
368
389
    <title>FILES</title>
369
390
    <para>
370
391
      Use the <option>--dir</option> option to change where
391
412
        </listitem>
392
413
      </varlistentry>
393
414
      <varlistentry>
394
 
        <term><filename>/tmp</filename></term>
 
415
        <term><filename class="directory">/tmp</filename></term>
395
416
        <listitem>
396
417
          <para>
397
418
            Temporary files will be written here if
401
422
      </varlistentry>
402
423
    </variablelist>
403
424
  </refsect1>
404
 
 
 
425
  
405
426
<!--   <refsect1 id="bugs"> -->
406
427
<!--     <title>BUGS</title> -->
407
428
<!--     <para> -->
408
429
<!--     </para> -->
409
430
<!--   </refsect1> -->
410
 
 
 
431
  
411
432
  <refsect1 id="example">
412
433
    <title>EXAMPLE</title>
413
434
    <informalexample>
432
453
    </informalexample>
433
454
    <informalexample>
434
455
      <para>
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>.
 
456
        Prompt for a password, encrypt it with the key in <filename
 
457
        class="directory">/etc/mandos</filename> and output a section
 
458
        suitable for <filename>clients.conf</filename>.
438
459
      </para>
439
460
      <para>
440
461
        <userinput>&COMMANDNAME; --password</userinput>
454
475
      </para>
455
476
    </informalexample>
456
477
  </refsect1>
457
 
 
 
478
  
458
479
  <refsect1 id="security">
459
480
    <title>SECURITY</title>
460
481
    <para>
469
490
      <manvolnum>8</manvolnum></citerefentry>.
470
491
    </para>
471
492
  </refsect1>
472
 
 
 
493
  
473
494
  <refsect1 id="see_also">
474
495
    <title>SEE ALSO</title>
475
496
    <para>
 
497
      <citerefentry><refentrytitle>intro</refentrytitle>
 
498
      <manvolnum>8mandos</manvolnum></citerefentry>,
476
499
      <citerefentry><refentrytitle>gpg</refentrytitle>
477
500
      <manvolnum>1</manvolnum></citerefentry>,
478
501
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
479
502
      <manvolnum>5</manvolnum></citerefentry>,
480
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
481
504
      <manvolnum>8</manvolnum></citerefentry>,
482
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
505
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
483
506
      <manvolnum>8mandos</manvolnum></citerefentry>
484
507
    </para>
485
508
  </refsect1>