/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: 2013-10-27 00:59:22 UTC
  • Revision ID: teddy@recompile.se-20131027005922-3q2161l63mtxii9u
Add systemd service support for Mandos server.

* Makefile (SYSTEMD): New; systemd system unit directory.
  (install-server): Install mandos.service.
  (purge-server): Remove mandos.service.
* debian/control (Build-Depends): Added "systemd".
* init.d-mandos (Description): Updated.
* mandos.service: New.

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-06">
 
5
<!ENTITY TIMESTAMP "2013-10-22">
 
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>
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>
218
227
        <replaceable>TYPE</replaceable></option></term>
219
228
        <listitem>
220
229
          <para>
221
 
            Key type.  Default is <quote>DSA</quote>.
 
230
            Key type.  Default is <quote>RSA</quote>.
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>
230
239
        <replaceable>BITS</replaceable></option></term>
231
240
        <listitem>
232
241
          <para>
233
 
            Key length in bits.  Default is 2048.
 
242
            Key length in bits.  Default is 4096.
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>
242
251
        <replaceable>KEYTYPE</replaceable></option></term>
243
252
        <listitem>
244
253
          <para>
245
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
254
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
246
255
            encryption-only).
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>
255
264
        <replaceable>BITS</replaceable></option></term>
256
265
        <listitem>
257
266
          <para>
258
 
            Subkey length in bits.  Default is 2048.
 
267
            Subkey length in bits.  Default is 4096.
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>
279
288
        <replaceable>TEXT</replaceable></option></term>
280
289
        <listitem>
281
290
          <para>
282
 
            Comment field for key.  The default value is
283
 
            <quote><literal>Mandos client key</literal></quote>.
 
291
            Comment field for key.  Default is empty.
284
292
          </para>
285
293
        </listitem>
286
294
      </varlistentry>
287
 
 
 
295
      
288
296
      <varlistentry>
289
297
        <term><option>--expire
290
298
        <replaceable>TIME</replaceable></option></term>
298
306
          </para>
299
307
        </listitem>
300
308
      </varlistentry>
301
 
 
 
309
      
302
310
      <varlistentry>
303
311
        <term><option>--force</option></term>
304
312
        <term><option>-f</option></term>
326
334
          </para>
327
335
        </listitem>
328
336
      </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>
329
349
    </variablelist>
330
350
  </refsect1>
331
 
 
 
351
  
332
352
  <refsect1 id="overview">
333
353
    <title>OVERVIEW</title>
334
354
    <xi:include href="overview.xml"/>
338
358
      <filename>clients.conf</filename> on the server.
339
359
    </para>
340
360
  </refsect1>
341
 
 
 
361
  
342
362
  <refsect1 id="exit_status">
343
363
    <title>EXIT STATUS</title>
344
364
    <para>
364
384
    </variablelist>
365
385
  </refsect1>
366
386
  
367
 
  <refsect1 id="file">
 
387
  <refsect1 id="files">
368
388
    <title>FILES</title>
369
389
    <para>
370
390
      Use the <option>--dir</option> option to change where
391
411
        </listitem>
392
412
      </varlistentry>
393
413
      <varlistentry>
394
 
        <term><filename>/tmp</filename></term>
 
414
        <term><filename class="directory">/tmp</filename></term>
395
415
        <listitem>
396
416
          <para>
397
417
            Temporary files will be written here if
401
421
      </varlistentry>
402
422
    </variablelist>
403
423
  </refsect1>
404
 
 
 
424
  
405
425
<!--   <refsect1 id="bugs"> -->
406
426
<!--     <title>BUGS</title> -->
407
427
<!--     <para> -->
408
428
<!--     </para> -->
409
429
<!--   </refsect1> -->
410
 
 
 
430
  
411
431
  <refsect1 id="example">
412
432
    <title>EXAMPLE</title>
413
433
    <informalexample>
432
452
    </informalexample>
433
453
    <informalexample>
434
454
      <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>.
 
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>.
438
458
      </para>
439
459
      <para>
440
460
        <userinput>&COMMANDNAME; --password</userinput>
454
474
      </para>
455
475
    </informalexample>
456
476
  </refsect1>
457
 
 
 
477
  
458
478
  <refsect1 id="security">
459
479
    <title>SECURITY</title>
460
480
    <para>
469
489
      <manvolnum>8</manvolnum></citerefentry>.
470
490
    </para>
471
491
  </refsect1>
472
 
 
 
492
  
473
493
  <refsect1 id="see_also">
474
494
    <title>SEE ALSO</title>
475
495
    <para>
 
496
      <citerefentry><refentrytitle>intro</refentrytitle>
 
497
      <manvolnum>8mandos</manvolnum></citerefentry>,
476
498
      <citerefentry><refentrytitle>gpg</refentrytitle>
477
499
      <manvolnum>1</manvolnum></citerefentry>,
478
500
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>