/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: 2018-02-12 14:54:58 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 364.
  • Revision ID: teddy@recompile.se-20180212145458-mkcjkw4cd9s18izm
Client bug fix: Revert change to plugin-runner

* plugin-runner.c (free_plugin): Bug fix: Don't free() plugin name.

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 "2018-02-08">
 
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>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
34
45
      <holder>Teddy Hogeborn</holder>
35
46
      <holder>Björn Påhlsson</holder>
36
47
    </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>
 
48
    <xi:include href="legalnotice.xml"/>
60
49
  </refentryinfo>
61
 
 
 
50
  
62
51
  <refmeta>
63
52
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
53
    <manvolnum>8</manvolnum>
70
59
      Generate key and password for Mandos client and server.
71
60
    </refpurpose>
72
61
  </refnamediv>
73
 
 
 
62
  
74
63
  <refsynopsisdiv>
75
64
    <cmdsynopsis>
76
65
      <command>&COMMANDNAME;</command>
137
126
        <replaceable>TIME</replaceable></option></arg>
138
127
      </group>
139
128
      <sbr/>
140
 
      <arg><option>--force</option></arg>
 
129
      <group>
 
130
        <arg choice="plain"><option>--force</option></arg>
 
131
        <arg choice="plain"><option>-f</option></arg>
 
132
      </group>
141
133
    </cmdsynopsis>
142
134
    <cmdsynopsis>
143
135
      <command>&COMMANDNAME;</command>
144
136
      <group choice="req">
145
137
        <arg choice="plain"><option>--password</option></arg>
146
138
        <arg choice="plain"><option>-p</option></arg>
 
139
        <arg choice="plain"><option>--passfile
 
140
        <replaceable>FILE</replaceable></option></arg>
 
141
        <arg choice="plain"><option>-F</option>
 
142
        <replaceable>FILE</replaceable></arg>
147
143
      </group>
148
144
      <sbr/>
149
145
      <group>
159
155
        <arg choice="plain"><option>-n
160
156
        <replaceable>NAME</replaceable></option></arg>
161
157
      </group>
 
158
      <group>
 
159
        <arg choice="plain"><option>--no-ssh</option></arg>
 
160
        <arg choice="plain"><option>-S</option></arg>
 
161
      </group>
162
162
    </cmdsynopsis>
163
163
    <cmdsynopsis>
164
164
      <command>&COMMANDNAME;</command>
181
181
    <para>
182
182
      <command>&COMMANDNAME;</command> is a program to generate the
183
183
      OpenPGP key used by
184
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
184
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
185
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
186
186
      normally written to /etc/mandos for later installation into the
187
187
      initrd image, but this, and most other things, can be changed
189
189
    </para>
190
190
    <para>
191
191
      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
 
192
      <option>--password</option> or <option>--passfile</option>
 
193
      options to generate a ready-made section for
 
194
      <filename>clients.conf</filename> (see
194
195
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
195
196
      <manvolnum>5</manvolnum></citerefentry>).
196
197
    </para>
219
220
          </para>
220
221
        </listitem>
221
222
      </varlistentry>
222
 
 
 
223
      
223
224
      <varlistentry>
224
225
        <term><option>--dir
225
226
        <replaceable>DIRECTORY</replaceable></option></term>
228
229
        <listitem>
229
230
          <para>
230
231
            Target directory for key files.  Default is
231
 
            <filename>/etc/mandos</filename>.
 
232
            <filename class="directory">/etc/mandos</filename>.
232
233
          </para>
233
234
        </listitem>
234
235
      </varlistentry>
235
 
 
 
236
      
236
237
      <varlistentry>
237
238
        <term><option>--type
238
239
        <replaceable>TYPE</replaceable></option></term>
240
241
        <replaceable>TYPE</replaceable></option></term>
241
242
        <listitem>
242
243
          <para>
243
 
            Key type.  Default is <quote>DSA</quote>.
 
244
            Key type.  Default is <quote>RSA</quote>.
244
245
          </para>
245
246
        </listitem>
246
247
      </varlistentry>
247
 
 
 
248
      
248
249
      <varlistentry>
249
250
        <term><option>--length
250
251
        <replaceable>BITS</replaceable></option></term>
252
253
        <replaceable>BITS</replaceable></option></term>
253
254
        <listitem>
254
255
          <para>
255
 
            Key length in bits.  Default is 2048.
 
256
            Key length in bits.  Default is 4096.
256
257
          </para>
257
258
        </listitem>
258
259
      </varlistentry>
259
 
 
 
260
      
260
261
      <varlistentry>
261
262
        <term><option>--subtype
262
263
        <replaceable>KEYTYPE</replaceable></option></term>
264
265
        <replaceable>KEYTYPE</replaceable></option></term>
265
266
        <listitem>
266
267
          <para>
267
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
268
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
268
269
            encryption-only).
269
270
          </para>
270
271
        </listitem>
271
272
      </varlistentry>
272
 
 
 
273
      
273
274
      <varlistentry>
274
275
        <term><option>--sublength
275
276
        <replaceable>BITS</replaceable></option></term>
277
278
        <replaceable>BITS</replaceable></option></term>
278
279
        <listitem>
279
280
          <para>
280
 
            Subkey length in bits.  Default is 2048.
 
281
            Subkey length in bits.  Default is 4096.
281
282
          </para>
282
283
        </listitem>
283
284
      </varlistentry>
284
 
 
 
285
      
285
286
      <varlistentry>
286
287
        <term><option>--email
287
288
        <replaceable>ADDRESS</replaceable></option></term>
293
294
          </para>
294
295
        </listitem>
295
296
      </varlistentry>
296
 
 
 
297
      
297
298
      <varlistentry>
298
299
        <term><option>--comment
299
300
        <replaceable>TEXT</replaceable></option></term>
301
302
        <replaceable>TEXT</replaceable></option></term>
302
303
        <listitem>
303
304
          <para>
304
 
            Comment field for key.  The default value is
305
 
            <quote><literal>Mandos client key</literal></quote>.
 
305
            Comment field for key.  Default is empty.
306
306
          </para>
307
307
        </listitem>
308
308
      </varlistentry>
309
 
 
 
309
      
310
310
      <varlistentry>
311
311
        <term><option>--expire
312
312
        <replaceable>TIME</replaceable></option></term>
320
320
          </para>
321
321
        </listitem>
322
322
      </varlistentry>
323
 
 
 
323
      
324
324
      <varlistentry>
325
325
        <term><option>--force</option></term>
326
326
        <term><option>-f</option></term>
348
348
          </para>
349
349
        </listitem>
350
350
      </varlistentry>
 
351
      <varlistentry>
 
352
        <term><option>--passfile
 
353
        <replaceable>FILE</replaceable></option></term>
 
354
        <term><option>-F
 
355
        <replaceable>FILE</replaceable></option></term>
 
356
        <listitem>
 
357
          <para>
 
358
            The same as <option>--password</option>, but read from
 
359
            <replaceable>FILE</replaceable>, not the terminal.
 
360
          </para>
 
361
        </listitem>
 
362
      </varlistentry>
 
363
      <varlistentry>
 
364
        <term><option>--no-ssh</option></term>
 
365
        <term><option>-S</option></term>
 
366
        <listitem>
 
367
          <para>
 
368
            When <option>--password</option> or
 
369
            <option>--passfile</option> is given, this option will
 
370
            prevent <command>&COMMANDNAME;</command> from calling
 
371
            <command>ssh-keyscan</command> to get an SSH fingerprint
 
372
            for this host and, if successful, output suitable config
 
373
            options to use this fingerprint as a
 
374
            <option>checker</option> option in the output.  This is
 
375
            otherwise the default behavior.
 
376
          </para>
 
377
        </listitem>
 
378
      </varlistentry>
351
379
    </variablelist>
352
380
  </refsect1>
353
 
 
 
381
  
354
382
  <refsect1 id="overview">
355
383
    <title>OVERVIEW</title>
356
384
    <xi:include href="overview.xml"/>
360
388
      <filename>clients.conf</filename> on the server.
361
389
    </para>
362
390
  </refsect1>
363
 
 
 
391
  
364
392
  <refsect1 id="exit_status">
365
393
    <title>EXIT STATUS</title>
366
394
    <para>
386
414
    </variablelist>
387
415
  </refsect1>
388
416
  
389
 
  <refsect1 id="file">
 
417
  <refsect1 id="files">
390
418
    <title>FILES</title>
391
419
    <para>
392
420
      Use the <option>--dir</option> option to change where
413
441
        </listitem>
414
442
      </varlistentry>
415
443
      <varlistentry>
416
 
        <term><filename>/tmp</filename></term>
 
444
        <term><filename class="directory">/tmp</filename></term>
417
445
        <listitem>
418
446
          <para>
419
447
            Temporary files will be written here if
423
451
      </varlistentry>
424
452
    </variablelist>
425
453
  </refsect1>
426
 
 
 
454
  
427
455
  <refsect1 id="bugs">
428
456
    <title>BUGS</title>
429
 
    <para>
430
 
      None are known at this time.
431
 
    </para>
 
457
    <xi:include href="bugs.xml"/>
432
458
  </refsect1>
433
 
 
 
459
  
434
460
  <refsect1 id="example">
435
461
    <title>EXAMPLE</title>
436
462
    <informalexample>
455
481
    </informalexample>
456
482
    <informalexample>
457
483
      <para>
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>.
 
484
        Prompt for a password, encrypt it with the key in <filename
 
485
        class="directory">/etc/mandos</filename> and output a section
 
486
        suitable for <filename>clients.conf</filename>.
461
487
      </para>
462
488
      <para>
463
489
        <userinput>&COMMANDNAME; --password</userinput>
477
503
      </para>
478
504
    </informalexample>
479
505
  </refsect1>
480
 
 
 
506
  
481
507
  <refsect1 id="security">
482
508
    <title>SECURITY</title>
483
509
    <para>
492
518
      <manvolnum>8</manvolnum></citerefentry>.
493
519
    </para>
494
520
  </refsect1>
495
 
 
 
521
  
496
522
  <refsect1 id="see_also">
497
523
    <title>SEE ALSO</title>
498
524
    <para>
 
525
      <citerefentry><refentrytitle>intro</refentrytitle>
 
526
      <manvolnum>8mandos</manvolnum></citerefentry>,
499
527
      <citerefentry><refentrytitle>gpg</refentrytitle>
500
528
      <manvolnum>1</manvolnum></citerefentry>,
501
529
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
502
530
      <manvolnum>5</manvolnum></citerefentry>,
503
531
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
532
      <manvolnum>8</manvolnum></citerefentry>,
505
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
506
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
533
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
534
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
535
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
536
      <manvolnum>1</manvolnum></citerefentry>
507
537
    </para>
508
538
  </refsect1>
509
539