/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: 2016-02-06 14:54:50 UTC
  • Revision ID: teddy@recompile.se-20160206145450-617bg20ezzt8a5mp
On cleanup, Signal ClientRemoved only if using D-Bus.

* mandos (main/cleanup): Bug fix: only send D-Bus signal ClientRemoved
                         if actually using D-Bus.

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-12">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
 
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>
34
42
      <holder>Teddy Hogeborn</holder>
35
43
      <holder>Björn Påhlsson</holder>
36
44
    </copyright>
115
123
        <replaceable>TIME</replaceable></option></arg>
116
124
      </group>
117
125
      <sbr/>
118
 
      <arg><option>--force</option></arg>
 
126
      <group>
 
127
        <arg choice="plain"><option>--force</option></arg>
 
128
        <arg choice="plain"><option>-f</option></arg>
 
129
      </group>
119
130
    </cmdsynopsis>
120
131
    <cmdsynopsis>
121
132
      <command>&COMMANDNAME;</command>
122
133
      <group choice="req">
123
134
        <arg choice="plain"><option>--password</option></arg>
124
135
        <arg choice="plain"><option>-p</option></arg>
 
136
        <arg choice="plain"><option>--passfile
 
137
        <replaceable>FILE</replaceable></option></arg>
 
138
        <arg choice="plain"><option>-F</option>
 
139
        <replaceable>FILE</replaceable></arg>
125
140
      </group>
126
141
      <sbr/>
127
142
      <group>
137
152
        <arg choice="plain"><option>-n
138
153
        <replaceable>NAME</replaceable></option></arg>
139
154
      </group>
 
155
      <group>
 
156
        <arg choice="plain"><option>--no-ssh</option></arg>
 
157
        <arg choice="plain"><option>-S</option></arg>
 
158
      </group>
140
159
    </cmdsynopsis>
141
160
    <cmdsynopsis>
142
161
      <command>&COMMANDNAME;</command>
167
186
    </para>
168
187
    <para>
169
188
      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
 
189
      <option>--password</option> or <option>--passfile</option>
 
190
      options to generate a ready-made section for
 
191
      <filename>clients.conf</filename> (see
172
192
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
173
193
      <manvolnum>5</manvolnum></citerefentry>).
174
194
    </para>
206
226
        <listitem>
207
227
          <para>
208
228
            Target directory for key files.  Default is
209
 
            <filename>/etc/mandos</filename>.
 
229
            <filename class="directory">/etc/mandos</filename>.
210
230
          </para>
211
231
        </listitem>
212
232
      </varlistentry>
218
238
        <replaceable>TYPE</replaceable></option></term>
219
239
        <listitem>
220
240
          <para>
221
 
            Key type.  Default is <quote>DSA</quote>.
 
241
            Key type.  Default is <quote>RSA</quote>.
222
242
          </para>
223
243
        </listitem>
224
244
      </varlistentry>
230
250
        <replaceable>BITS</replaceable></option></term>
231
251
        <listitem>
232
252
          <para>
233
 
            Key length in bits.  Default is 2048.
 
253
            Key length in bits.  Default is 4096.
234
254
          </para>
235
255
        </listitem>
236
256
      </varlistentry>
242
262
        <replaceable>KEYTYPE</replaceable></option></term>
243
263
        <listitem>
244
264
          <para>
245
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
265
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
246
266
            encryption-only).
247
267
          </para>
248
268
        </listitem>
255
275
        <replaceable>BITS</replaceable></option></term>
256
276
        <listitem>
257
277
          <para>
258
 
            Subkey length in bits.  Default is 2048.
 
278
            Subkey length in bits.  Default is 4096.
259
279
          </para>
260
280
        </listitem>
261
281
      </varlistentry>
279
299
        <replaceable>TEXT</replaceable></option></term>
280
300
        <listitem>
281
301
          <para>
282
 
            Comment field for key.  The default value is
283
 
            <quote><literal>Mandos client key</literal></quote>.
 
302
            Comment field for key.  Default is empty.
284
303
          </para>
285
304
        </listitem>
286
305
      </varlistentry>
326
345
          </para>
327
346
        </listitem>
328
347
      </varlistentry>
 
348
      <varlistentry>
 
349
        <term><option>--passfile
 
350
        <replaceable>FILE</replaceable></option></term>
 
351
        <term><option>-F
 
352
        <replaceable>FILE</replaceable></option></term>
 
353
        <listitem>
 
354
          <para>
 
355
            The same as <option>--password</option>, but read from
 
356
            <replaceable>FILE</replaceable>, not the terminal.
 
357
          </para>
 
358
        </listitem>
 
359
      </varlistentry>
 
360
      <varlistentry>
 
361
        <term><option>--no-ssh</option></term>
 
362
        <term><option>-S</option></term>
 
363
        <listitem>
 
364
          <para>
 
365
            When <option>--password</option> or
 
366
            <option>--passfile</option> is given, this option will
 
367
            prevent <command>&COMMANDNAME;</command> from calling
 
368
            <command>ssh-keyscan</command> to get an SSH fingerprint
 
369
            for this host and, if successful, output suitable config
 
370
            options to use this fingerprint as a
 
371
            <option>checker</option> option in the output.  This is
 
372
            otherwise the default behavior.
 
373
          </para>
 
374
        </listitem>
 
375
      </varlistentry>
329
376
    </variablelist>
330
377
  </refsect1>
331
378
  
364
411
    </variablelist>
365
412
  </refsect1>
366
413
  
367
 
  <refsect1 id="file">
 
414
  <refsect1 id="files">
368
415
    <title>FILES</title>
369
416
    <para>
370
417
      Use the <option>--dir</option> option to change where
391
438
        </listitem>
392
439
      </varlistentry>
393
440
      <varlistentry>
394
 
        <term><filename>/tmp</filename></term>
 
441
        <term><filename class="directory">/tmp</filename></term>
395
442
        <listitem>
396
443
          <para>
397
444
            Temporary files will be written here if
432
479
    </informalexample>
433
480
    <informalexample>
434
481
      <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>.
 
482
        Prompt for a password, encrypt it with the key in <filename
 
483
        class="directory">/etc/mandos</filename> and output a section
 
484
        suitable for <filename>clients.conf</filename>.
438
485
      </para>
439
486
      <para>
440
487
        <userinput>&COMMANDNAME; --password</userinput>
473
520
  <refsect1 id="see_also">
474
521
    <title>SEE ALSO</title>
475
522
    <para>
 
523
      <citerefentry><refentrytitle>intro</refentrytitle>
 
524
      <manvolnum>8mandos</manvolnum></citerefentry>,
476
525
      <citerefentry><refentrytitle>gpg</refentrytitle>
477
526
      <manvolnum>1</manvolnum></citerefentry>,
478
527
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
480
529
      <citerefentry><refentrytitle>mandos</refentrytitle>
481
530
      <manvolnum>8</manvolnum></citerefentry>,
482
531
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
483
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
532
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
533
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
534
      <manvolnum>1</manvolnum></citerefentry>
484
535
    </para>
485
536
  </refsect1>
486
537