/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: 2018-02-22 09:20:19 UTC
  • Revision ID: teddy@recompile.se-20180222092019-ehyz79hzti9dnk2g
Client bug fix: Don't use leak sanitizer with leaking libraries

* Makefile (plugin-helpers/mandos-client): Remove "-fsanitize=leak"
  from CFLAGS.

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-20">
 
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>
115
126
        <replaceable>TIME</replaceable></option></arg>
116
127
      </group>
117
128
      <sbr/>
118
 
      <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>
119
133
    </cmdsynopsis>
120
134
    <cmdsynopsis>
121
135
      <command>&COMMANDNAME;</command>
141
155
        <arg choice="plain"><option>-n
142
156
        <replaceable>NAME</replaceable></option></arg>
143
157
      </group>
 
158
      <group>
 
159
        <arg choice="plain"><option>--no-ssh</option></arg>
 
160
        <arg choice="plain"><option>-S</option></arg>
 
161
      </group>
144
162
    </cmdsynopsis>
145
163
    <cmdsynopsis>
146
164
      <command>&COMMANDNAME;</command>
211
229
        <listitem>
212
230
          <para>
213
231
            Target directory for key files.  Default is
214
 
            <filename>/etc/mandos</filename>.
 
232
            <filename class="directory">/etc/mandos</filename>.
215
233
          </para>
216
234
        </listitem>
217
235
      </varlistentry>
223
241
        <replaceable>TYPE</replaceable></option></term>
224
242
        <listitem>
225
243
          <para>
226
 
            Key type.  Default is <quote>DSA</quote>.
 
244
            Key type.  Default is <quote>RSA</quote>.
227
245
          </para>
228
246
        </listitem>
229
247
      </varlistentry>
235
253
        <replaceable>BITS</replaceable></option></term>
236
254
        <listitem>
237
255
          <para>
238
 
            Key length in bits.  Default is 2048.
 
256
            Key length in bits.  Default is 4096.
239
257
          </para>
240
258
        </listitem>
241
259
      </varlistentry>
247
265
        <replaceable>KEYTYPE</replaceable></option></term>
248
266
        <listitem>
249
267
          <para>
250
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
268
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
251
269
            encryption-only).
252
270
          </para>
253
271
        </listitem>
260
278
        <replaceable>BITS</replaceable></option></term>
261
279
        <listitem>
262
280
          <para>
263
 
            Subkey length in bits.  Default is 2048.
 
281
            Subkey length in bits.  Default is 4096.
264
282
          </para>
265
283
        </listitem>
266
284
      </varlistentry>
284
302
        <replaceable>TEXT</replaceable></option></term>
285
303
        <listitem>
286
304
          <para>
287
 
            Comment field for key.  The default value is
288
 
            <quote><literal>Mandos client key</literal></quote>.
 
305
            Comment field for key.  Default is empty.
289
306
          </para>
290
307
        </listitem>
291
308
      </varlistentry>
343
360
          </para>
344
361
        </listitem>
345
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>
346
379
    </variablelist>
347
380
  </refsect1>
348
381
  
381
414
    </variablelist>
382
415
  </refsect1>
383
416
  
384
 
  <refsect1 id="file">
 
417
  <refsect1 id="files">
385
418
    <title>FILES</title>
386
419
    <para>
387
420
      Use the <option>--dir</option> option to change where
408
441
        </listitem>
409
442
      </varlistentry>
410
443
      <varlistentry>
411
 
        <term><filename>/tmp</filename></term>
 
444
        <term><filename class="directory">/tmp</filename></term>
412
445
        <listitem>
413
446
          <para>
414
447
            Temporary files will be written here if
419
452
    </variablelist>
420
453
  </refsect1>
421
454
  
422
 
<!--   <refsect1 id="bugs"> -->
423
 
<!--     <title>BUGS</title> -->
424
 
<!--     <para> -->
425
 
<!--     </para> -->
426
 
<!--   </refsect1> -->
 
455
  <refsect1 id="bugs">
 
456
    <title>BUGS</title>
 
457
    <xi:include href="bugs.xml"/>
 
458
  </refsect1>
427
459
  
428
460
  <refsect1 id="example">
429
461
    <title>EXAMPLE</title>
449
481
    </informalexample>
450
482
    <informalexample>
451
483
      <para>
452
 
        Prompt for a password, encrypt it with the key in
453
 
        <filename>/etc/mandos</filename> and output a section suitable
454
 
        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>.
455
487
      </para>
456
488
      <para>
457
489
        <userinput>&COMMANDNAME; --password</userinput>
490
522
  <refsect1 id="see_also">
491
523
    <title>SEE ALSO</title>
492
524
    <para>
 
525
      <citerefentry><refentrytitle>intro</refentrytitle>
 
526
      <manvolnum>8mandos</manvolnum></citerefentry>,
493
527
      <citerefentry><refentrytitle>gpg</refentrytitle>
494
528
      <manvolnum>1</manvolnum></citerefentry>,
495
529
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
497
531
      <citerefentry><refentrytitle>mandos</refentrytitle>
498
532
      <manvolnum>8</manvolnum></citerefentry>,
499
533
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
500
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
534
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
535
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
536
      <manvolnum>1</manvolnum></citerefentry>
501
537
    </para>
502
538
  </refsect1>
503
539