/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-10-05 17:38:31 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081005173831-fysrfayl4yvhlo6x
* INSTALL: Add instructions on how to set the correct network
           interface on the cient, and also how to test the server and
           verify the password.

* TODO: Clean up old stuff.

* debian/mandos-client.README.Debian: Separate into sections with
                                      headlines.  Add instructions on
                                      how to test the server and
                                      verify the password.

* plugin-runner.conf: Add reminder to update initrd image.

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-08-31">
 
5
<!ENTITY TIMESTAMP "2008-10-03">
 
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>
34
35
      <holder>Teddy Hogeborn</holder>
35
36
      <holder>Björn Påhlsson</holder>
36
37
    </copyright>
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>
 
38
    <xi:include href="legalnotice.xml"/>
60
39
  </refentryinfo>
61
 
 
 
40
  
62
41
  <refmeta>
63
42
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
43
    <manvolnum>8</manvolnum>
70
49
      Generate key and password for Mandos client and server.
71
50
    </refpurpose>
72
51
  </refnamediv>
73
 
 
 
52
  
74
53
  <refsynopsisdiv>
75
54
    <cmdsynopsis>
76
55
      <command>&COMMANDNAME;</command>
144
123
      <group choice="req">
145
124
        <arg choice="plain"><option>--password</option></arg>
146
125
        <arg choice="plain"><option>-p</option></arg>
 
126
        <arg choice="plain"><option>--passfile
 
127
        <replaceable>FILE</replaceable></option></arg>
 
128
        <arg choice="plain"><option>-F</option>
 
129
        <replaceable>FILE</replaceable></arg>
147
130
      </group>
148
131
      <sbr/>
149
132
      <group>
181
164
    <para>
182
165
      <command>&COMMANDNAME;</command> is a program to generate the
183
166
      OpenPGP key used by
184
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
167
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
185
168
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
186
169
      normally written to /etc/mandos for later installation into the
187
170
      initrd image, but this, and most other things, can be changed
189
172
    </para>
190
173
    <para>
191
174
      This program can also be used with the
192
 
      <option>--password</option> option to generate a ready-made
193
 
      section for <filename>clients.conf</filename> (see
 
175
      <option>--password</option> or <option>--passfile</option>
 
176
      options to generate a ready-made section for
 
177
      <filename>clients.conf</filename> (see
194
178
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
195
179
      <manvolnum>5</manvolnum></citerefentry>).
196
180
    </para>
219
203
          </para>
220
204
        </listitem>
221
205
      </varlistentry>
222
 
 
 
206
      
223
207
      <varlistentry>
224
208
        <term><option>--dir
225
209
        <replaceable>DIRECTORY</replaceable></option></term>
232
216
          </para>
233
217
        </listitem>
234
218
      </varlistentry>
235
 
 
 
219
      
236
220
      <varlistentry>
237
221
        <term><option>--type
238
222
        <replaceable>TYPE</replaceable></option></term>
244
228
          </para>
245
229
        </listitem>
246
230
      </varlistentry>
247
 
 
 
231
      
248
232
      <varlistentry>
249
233
        <term><option>--length
250
234
        <replaceable>BITS</replaceable></option></term>
256
240
          </para>
257
241
        </listitem>
258
242
      </varlistentry>
259
 
 
 
243
      
260
244
      <varlistentry>
261
245
        <term><option>--subtype
262
246
        <replaceable>KEYTYPE</replaceable></option></term>
269
253
          </para>
270
254
        </listitem>
271
255
      </varlistentry>
272
 
 
 
256
      
273
257
      <varlistentry>
274
258
        <term><option>--sublength
275
259
        <replaceable>BITS</replaceable></option></term>
281
265
          </para>
282
266
        </listitem>
283
267
      </varlistentry>
284
 
 
 
268
      
285
269
      <varlistentry>
286
270
        <term><option>--email
287
271
        <replaceable>ADDRESS</replaceable></option></term>
293
277
          </para>
294
278
        </listitem>
295
279
      </varlistentry>
296
 
 
 
280
      
297
281
      <varlistentry>
298
282
        <term><option>--comment
299
283
        <replaceable>TEXT</replaceable></option></term>
306
290
          </para>
307
291
        </listitem>
308
292
      </varlistentry>
309
 
 
 
293
      
310
294
      <varlistentry>
311
295
        <term><option>--expire
312
296
        <replaceable>TIME</replaceable></option></term>
320
304
          </para>
321
305
        </listitem>
322
306
      </varlistentry>
323
 
 
 
307
      
324
308
      <varlistentry>
325
309
        <term><option>--force</option></term>
326
310
        <term><option>-f</option></term>
348
332
          </para>
349
333
        </listitem>
350
334
      </varlistentry>
 
335
      <varlistentry>
 
336
        <term><option>--passfile
 
337
        <replaceable>FILE</replaceable></option></term>
 
338
        <term><option>-F
 
339
        <replaceable>FILE</replaceable></option></term>
 
340
        <listitem>
 
341
          <para>
 
342
            The same as <option>--password</option>, but read from
 
343
            <replaceable>FILE</replaceable>, not the terminal.
 
344
          </para>
 
345
        </listitem>
 
346
      </varlistentry>
351
347
    </variablelist>
352
348
  </refsect1>
353
 
 
 
349
  
354
350
  <refsect1 id="overview">
355
351
    <title>OVERVIEW</title>
356
352
    <xi:include href="overview.xml"/>
360
356
      <filename>clients.conf</filename> on the server.
361
357
    </para>
362
358
  </refsect1>
363
 
 
 
359
  
364
360
  <refsect1 id="exit_status">
365
361
    <title>EXIT STATUS</title>
366
362
    <para>
386
382
    </variablelist>
387
383
  </refsect1>
388
384
  
389
 
  <refsect1 id="file">
 
385
  <refsect1 id="files">
390
386
    <title>FILES</title>
391
387
    <para>
392
388
      Use the <option>--dir</option> option to change where
423
419
      </varlistentry>
424
420
    </variablelist>
425
421
  </refsect1>
426
 
 
427
 
  <refsect1 id="bugs">
428
 
    <title>BUGS</title>
429
 
    <para>
430
 
      None are known at this time.
431
 
    </para>
432
 
  </refsect1>
433
 
 
 
422
  
 
423
<!--   <refsect1 id="bugs"> -->
 
424
<!--     <title>BUGS</title> -->
 
425
<!--     <para> -->
 
426
<!--     </para> -->
 
427
<!--   </refsect1> -->
 
428
  
434
429
  <refsect1 id="example">
435
430
    <title>EXAMPLE</title>
436
431
    <informalexample>
477
472
      </para>
478
473
    </informalexample>
479
474
  </refsect1>
480
 
 
 
475
  
481
476
  <refsect1 id="security">
482
477
    <title>SECURITY</title>
483
478
    <para>
492
487
      <manvolnum>8</manvolnum></citerefentry>.
493
488
    </para>
494
489
  </refsect1>
495
 
 
 
490
  
496
491
  <refsect1 id="see_also">
497
492
    <title>SEE ALSO</title>
498
493
    <para>
502
497
      <manvolnum>5</manvolnum></citerefentry>,
503
498
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
499
      <manvolnum>8</manvolnum></citerefentry>,
505
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
500
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
506
501
      <manvolnum>8mandos</manvolnum></citerefentry>
507
502
    </para>
508
503
  </refsect1>