/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: 2015-08-02 09:36:40 UTC
  • Revision ID: teddy@recompile.se-20150802093640-nc0n17rbmqlbaxuf
Add D-Bus annotations on a few properties on the Client object.

The D-Bus property "Secret" on the interface
"se.recompile.Mandos.Client" should have the annotation
"org.freedesktop.DBus.Property.EmitsChangedSignal" set to
"invalidates".  Also, the properties "Created", "Fingerprint", "Name",
and "ObjectPath" should have the same annotation set to "const".

* mandos (ClientDBus.Name_dbus_property): Set annotation
                    "org.freedesktop.DBus.Property.EmitsChangedSignal"
                    to "const".
  (ClientDBus.Fingerprint_dbus_property): - '' -
  (ClientDBus.Created_dbus_property): - '' -
  (ClientDBus.ObjectPath_dbus_property): - '' -
  (ClientDBus.Secret_dbus_property): Set annotation
                    "org.freedesktop.DBus.Property.EmitsChangedSignal"
                    to "invalidates".

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-03">
 
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>
37
45
    <xi:include href="legalnotice.xml"/>
38
46
  </refentryinfo>
39
 
 
 
47
  
40
48
  <refmeta>
41
49
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
50
    <manvolnum>8</manvolnum>
48
56
      Generate key and password for Mandos client and server.
49
57
    </refpurpose>
50
58
  </refnamediv>
51
 
 
 
59
  
52
60
  <refsynopsisdiv>
53
61
    <cmdsynopsis>
54
62
      <command>&COMMANDNAME;</command>
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>
159
178
    <para>
160
179
      <command>&COMMANDNAME;</command> is a program to generate the
161
180
      OpenPGP key used by
162
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
181
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
163
182
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
164
183
      normally written to /etc/mandos for later installation into the
165
184
      initrd image, but this, and most other things, can be changed
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>
197
217
          </para>
198
218
        </listitem>
199
219
      </varlistentry>
200
 
 
 
220
      
201
221
      <varlistentry>
202
222
        <term><option>--dir
203
223
        <replaceable>DIRECTORY</replaceable></option></term>
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>
213
 
 
 
233
      
214
234
      <varlistentry>
215
235
        <term><option>--type
216
236
        <replaceable>TYPE</replaceable></option></term>
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>
225
 
 
 
245
      
226
246
      <varlistentry>
227
247
        <term><option>--length
228
248
        <replaceable>BITS</replaceable></option></term>
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>
237
 
 
 
257
      
238
258
      <varlistentry>
239
259
        <term><option>--subtype
240
260
        <replaceable>KEYTYPE</replaceable></option></term>
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>
249
269
      </varlistentry>
250
 
 
 
270
      
251
271
      <varlistentry>
252
272
        <term><option>--sublength
253
273
        <replaceable>BITS</replaceable></option></term>
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>
262
 
 
 
282
      
263
283
      <varlistentry>
264
284
        <term><option>--email
265
285
        <replaceable>ADDRESS</replaceable></option></term>
271
291
          </para>
272
292
        </listitem>
273
293
      </varlistentry>
274
 
 
 
294
      
275
295
      <varlistentry>
276
296
        <term><option>--comment
277
297
        <replaceable>TEXT</replaceable></option></term>
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>
287
 
 
 
306
      
288
307
      <varlistentry>
289
308
        <term><option>--expire
290
309
        <replaceable>TIME</replaceable></option></term>
298
317
          </para>
299
318
        </listitem>
300
319
      </varlistentry>
301
 
 
 
320
      
302
321
      <varlistentry>
303
322
        <term><option>--force</option></term>
304
323
        <term><option>-f</option></term>
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
  
332
379
  <refsect1 id="overview">
333
380
    <title>OVERVIEW</title>
334
381
    <xi:include href="overview.xml"/>
338
385
      <filename>clients.conf</filename> on the server.
339
386
    </para>
340
387
  </refsect1>
341
 
 
 
388
  
342
389
  <refsect1 id="exit_status">
343
390
    <title>EXIT STATUS</title>
344
391
    <para>
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
401
448
      </varlistentry>
402
449
    </variablelist>
403
450
  </refsect1>
404
 
 
 
451
  
405
452
<!--   <refsect1 id="bugs"> -->
406
453
<!--     <title>BUGS</title> -->
407
454
<!--     <para> -->
408
455
<!--     </para> -->
409
456
<!--   </refsect1> -->
410
 
 
 
457
  
411
458
  <refsect1 id="example">
412
459
    <title>EXAMPLE</title>
413
460
    <informalexample>
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>
454
501
      </para>
455
502
    </informalexample>
456
503
  </refsect1>
457
 
 
 
504
  
458
505
  <refsect1 id="security">
459
506
    <title>SECURITY</title>
460
507
    <para>
469
516
      <manvolnum>8</manvolnum></citerefentry>.
470
517
    </para>
471
518
  </refsect1>
472
 
 
 
519
  
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>
479
528
      <manvolnum>5</manvolnum></citerefentry>,
480
529
      <citerefentry><refentrytitle>mandos</refentrytitle>
481
530
      <manvolnum>8</manvolnum></citerefentry>,
482
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
483
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
531
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
533
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
534
      <manvolnum>1</manvolnum></citerefentry>
484
535
    </para>
485
536
  </refsect1>
486
537