/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-09-05 08:38:30 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080905083830-6y9v2rb2us0m45kn
* Makefile (PIDDIR, USER, GROUP): New variables.
  (install-server): Create $(PIDDIR).  Copy "init.d-mandos" and
                    "default-mandos" into place.  Install init script
                    using "update-rc.d".
  (uninstall-server): Remove links to init script using "update-rc.d".
  (purge-server): Remove /etc/init.d/mandos and /etc/default/mandos.

* default-mandos: New file.  Will install as "/etc/default/mandos".
* init.d-mandos:            - '' -           "/etc/init.d/mandos".

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 "2014-06-22">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-03">
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
37
    <xi:include href="legalnotice.xml"/>
42
38
  </refentryinfo>
43
 
  
 
39
 
44
40
  <refmeta>
45
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
42
    <manvolnum>8</manvolnum>
52
48
      Generate key and password for Mandos client and server.
53
49
    </refpurpose>
54
50
  </refnamediv>
55
 
  
 
51
 
56
52
  <refsynopsisdiv>
57
53
    <cmdsynopsis>
58
54
      <command>&COMMANDNAME;</command>
119
115
        <replaceable>TIME</replaceable></option></arg>
120
116
      </group>
121
117
      <sbr/>
122
 
      <group>
123
 
        <arg choice="plain"><option>--force</option></arg>
124
 
        <arg choice="plain"><option>-f</option></arg>
125
 
      </group>
 
118
      <arg><option>--force</option></arg>
126
119
    </cmdsynopsis>
127
120
    <cmdsynopsis>
128
121
      <command>&COMMANDNAME;</command>
129
122
      <group choice="req">
130
123
        <arg choice="plain"><option>--password</option></arg>
131
124
        <arg choice="plain"><option>-p</option></arg>
132
 
        <arg choice="plain"><option>--passfile
133
 
        <replaceable>FILE</replaceable></option></arg>
134
 
        <arg choice="plain"><option>-F</option>
135
 
        <replaceable>FILE</replaceable></arg>
136
125
      </group>
137
126
      <sbr/>
138
127
      <group>
148
137
        <arg choice="plain"><option>-n
149
138
        <replaceable>NAME</replaceable></option></arg>
150
139
      </group>
151
 
      <group>
152
 
        <arg choice="plain"><option>--no-ssh</option></arg>
153
 
        <arg choice="plain"><option>-S</option></arg>
154
 
      </group>
155
140
    </cmdsynopsis>
156
141
    <cmdsynopsis>
157
142
      <command>&COMMANDNAME;</command>
174
159
    <para>
175
160
      <command>&COMMANDNAME;</command> is a program to generate the
176
161
      OpenPGP key used by
177
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
162
      <citerefentry><refentrytitle>password-request</refentrytitle>
178
163
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
179
164
      normally written to /etc/mandos for later installation into the
180
165
      initrd image, but this, and most other things, can be changed
182
167
    </para>
183
168
    <para>
184
169
      This program can also be used with the
185
 
      <option>--password</option> or <option>--passfile</option>
186
 
      options to generate a ready-made section for
187
 
      <filename>clients.conf</filename> (see
 
170
      <option>--password</option> option to generate a ready-made
 
171
      section for <filename>clients.conf</filename> (see
188
172
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
189
173
      <manvolnum>5</manvolnum></citerefentry>).
190
174
    </para>
213
197
          </para>
214
198
        </listitem>
215
199
      </varlistentry>
216
 
      
 
200
 
217
201
      <varlistentry>
218
202
        <term><option>--dir
219
203
        <replaceable>DIRECTORY</replaceable></option></term>
222
206
        <listitem>
223
207
          <para>
224
208
            Target directory for key files.  Default is
225
 
            <filename class="directory">/etc/mandos</filename>.
 
209
            <filename>/etc/mandos</filename>.
226
210
          </para>
227
211
        </listitem>
228
212
      </varlistentry>
229
 
      
 
213
 
230
214
      <varlistentry>
231
215
        <term><option>--type
232
216
        <replaceable>TYPE</replaceable></option></term>
234
218
        <replaceable>TYPE</replaceable></option></term>
235
219
        <listitem>
236
220
          <para>
237
 
            Key type.  Default is <quote>RSA</quote>.
 
221
            Key type.  Default is <quote>DSA</quote>.
238
222
          </para>
239
223
        </listitem>
240
224
      </varlistentry>
241
 
      
 
225
 
242
226
      <varlistentry>
243
227
        <term><option>--length
244
228
        <replaceable>BITS</replaceable></option></term>
246
230
        <replaceable>BITS</replaceable></option></term>
247
231
        <listitem>
248
232
          <para>
249
 
            Key length in bits.  Default is 4096.
 
233
            Key length in bits.  Default is 2048.
250
234
          </para>
251
235
        </listitem>
252
236
      </varlistentry>
253
 
      
 
237
 
254
238
      <varlistentry>
255
239
        <term><option>--subtype
256
240
        <replaceable>KEYTYPE</replaceable></option></term>
258
242
        <replaceable>KEYTYPE</replaceable></option></term>
259
243
        <listitem>
260
244
          <para>
261
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
245
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
262
246
            encryption-only).
263
247
          </para>
264
248
        </listitem>
265
249
      </varlistentry>
266
 
      
 
250
 
267
251
      <varlistentry>
268
252
        <term><option>--sublength
269
253
        <replaceable>BITS</replaceable></option></term>
271
255
        <replaceable>BITS</replaceable></option></term>
272
256
        <listitem>
273
257
          <para>
274
 
            Subkey length in bits.  Default is 4096.
 
258
            Subkey length in bits.  Default is 2048.
275
259
          </para>
276
260
        </listitem>
277
261
      </varlistentry>
278
 
      
 
262
 
279
263
      <varlistentry>
280
264
        <term><option>--email
281
265
        <replaceable>ADDRESS</replaceable></option></term>
287
271
          </para>
288
272
        </listitem>
289
273
      </varlistentry>
290
 
      
 
274
 
291
275
      <varlistentry>
292
276
        <term><option>--comment
293
277
        <replaceable>TEXT</replaceable></option></term>
295
279
        <replaceable>TEXT</replaceable></option></term>
296
280
        <listitem>
297
281
          <para>
298
 
            Comment field for key.  Default is empty.
 
282
            Comment field for key.  The default value is
 
283
            <quote><literal>Mandos client key</literal></quote>.
299
284
          </para>
300
285
        </listitem>
301
286
      </varlistentry>
302
 
      
 
287
 
303
288
      <varlistentry>
304
289
        <term><option>--expire
305
290
        <replaceable>TIME</replaceable></option></term>
313
298
          </para>
314
299
        </listitem>
315
300
      </varlistentry>
316
 
      
 
301
 
317
302
      <varlistentry>
318
303
        <term><option>--force</option></term>
319
304
        <term><option>-f</option></term>
341
326
          </para>
342
327
        </listitem>
343
328
      </varlistentry>
344
 
      <varlistentry>
345
 
        <term><option>--passfile
346
 
        <replaceable>FILE</replaceable></option></term>
347
 
        <term><option>-F
348
 
        <replaceable>FILE</replaceable></option></term>
349
 
        <listitem>
350
 
          <para>
351
 
            The same as <option>--password</option>, but read from
352
 
            <replaceable>FILE</replaceable>, not the terminal.
353
 
          </para>
354
 
        </listitem>
355
 
      </varlistentry>
356
 
      <varlistentry>
357
 
        <term><option>--no-ssh</option></term>
358
 
        <term><option>-S</option></term>
359
 
        <listitem>
360
 
          <para>
361
 
            When <option>--password</option> or
362
 
            <option>--passfile</option> is given, this option will
363
 
            prevent <command>&COMMANDNAME;</command> from calling
364
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
365
 
            for this host and, if successful, output suitable config
366
 
            options to use this fingerprint as a
367
 
            <option>checker</option> option in the output.  This is
368
 
            otherwise the default behavior.
369
 
          </para>
370
 
        </listitem>
371
 
      </varlistentry>
372
329
    </variablelist>
373
330
  </refsect1>
374
 
  
 
331
 
375
332
  <refsect1 id="overview">
376
333
    <title>OVERVIEW</title>
377
334
    <xi:include href="overview.xml"/>
381
338
      <filename>clients.conf</filename> on the server.
382
339
    </para>
383
340
  </refsect1>
384
 
  
 
341
 
385
342
  <refsect1 id="exit_status">
386
343
    <title>EXIT STATUS</title>
387
344
    <para>
407
364
    </variablelist>
408
365
  </refsect1>
409
366
  
410
 
  <refsect1 id="files">
 
367
  <refsect1 id="file">
411
368
    <title>FILES</title>
412
369
    <para>
413
370
      Use the <option>--dir</option> option to change where
434
391
        </listitem>
435
392
      </varlistentry>
436
393
      <varlistentry>
437
 
        <term><filename class="directory">/tmp</filename></term>
 
394
        <term><filename>/tmp</filename></term>
438
395
        <listitem>
439
396
          <para>
440
397
            Temporary files will be written here if
444
401
      </varlistentry>
445
402
    </variablelist>
446
403
  </refsect1>
447
 
  
 
404
 
448
405
<!--   <refsect1 id="bugs"> -->
449
406
<!--     <title>BUGS</title> -->
450
407
<!--     <para> -->
451
408
<!--     </para> -->
452
409
<!--   </refsect1> -->
453
 
  
 
410
 
454
411
  <refsect1 id="example">
455
412
    <title>EXAMPLE</title>
456
413
    <informalexample>
475
432
    </informalexample>
476
433
    <informalexample>
477
434
      <para>
478
 
        Prompt for a password, encrypt it with the key in <filename
479
 
        class="directory">/etc/mandos</filename> and output a section
480
 
        suitable for <filename>clients.conf</filename>.
 
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>.
481
438
      </para>
482
439
      <para>
483
440
        <userinput>&COMMANDNAME; --password</userinput>
497
454
      </para>
498
455
    </informalexample>
499
456
  </refsect1>
500
 
  
 
457
 
501
458
  <refsect1 id="security">
502
459
    <title>SECURITY</title>
503
460
    <para>
512
469
      <manvolnum>8</manvolnum></citerefentry>.
513
470
    </para>
514
471
  </refsect1>
515
 
  
 
472
 
516
473
  <refsect1 id="see_also">
517
474
    <title>SEE ALSO</title>
518
475
    <para>
519
 
      <citerefentry><refentrytitle>intro</refentrytitle>
520
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
521
476
      <citerefentry><refentrytitle>gpg</refentrytitle>
522
477
      <manvolnum>1</manvolnum></citerefentry>,
523
478
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
524
479
      <manvolnum>5</manvolnum></citerefentry>,
525
480
      <citerefentry><refentrytitle>mandos</refentrytitle>
526
481
      <manvolnum>8</manvolnum></citerefentry>,
527
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
528
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
529
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
530
 
      <manvolnum>1</manvolnum></citerefentry>
 
482
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
483
      <manvolnum>8mandos</manvolnum></citerefentry>
531
484
    </para>
532
485
  </refsect1>
533
486