/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

First version of a somewhat complete D-Bus server interface.  Also
change user/group name to "_mandos".

* debian/mandos.postinst: Rename old "mandos" user and group to
                          "_mandos"; create "_mandos" user and group
                          if none exist.
* debian/mandos-client.postinst: - '' -

* initramfs-tools-hook: Try "_mandos" before "mandos" as user and
                        group name.

* mandos (_datetime_to_dbus_struct): New; was previously local.
  (Client.started): Renamed to "last_started".  All users changed.
  (Client.started): New; boolean.
  (Client.dbus_object_path): New.
  (Client.check_command): Renamed to "checker_command".  All users
                          changed.
  (Client.__init__): Set and use "self.dbus_object_path".  Set
                     "self.started".
  (Client.start): Update "self.started".  Emit "self.PropertyChanged"
                  signals for both "started" and "last_started".
  (Client.stop): Update "self.started".  Emit "self.PropertyChanged"
                 signal for "started".
  (Client.checker_callback): Take additional "command" argument.  All
                             callers changed. Emit
                             "self.PropertyChanged" signal.
  (Client.bump_timeout): Emit "self.PropertyChanged" signal for
                         "last_checked_ok".
  (Client.start_checker): Emit "self.PropertyChanged" signal for
                          "checker_running".
  (Client.stop_checker): Emit "self.PropertyChanged" signal for
                         "checker_running".
  (Client.still_valid): Bug fix: use "getattr(self, started, False)"
                        instead of "self.started" in case this client
                        object is so new that the "started" attribute
                        has not been created yet.
  (Client.IntervalChanged, Client.CheckerIsRunning, Client.GetChecker,
  Client.GetCreated, Client.GetFingerprint, Client.GetHost,
  Client.GetInterval, Client.GetName, Client.GetStarted,
  Client.GetTimeout, Client.StateChanged, Client.TimeoutChanged):
  Removed; all callers changed.
  (Client.CheckerCompleted): Add "condition" and "command" arguments.
                             All callers changed.
  (Client.GetAllProperties, Client.PropertyChanged): New.
  (Client.StillValid): Renamed to "IsStillValid".
  (Client.StartChecker): Changed to its own function to avoid the
                         return value from "Client.start_checker()".
  (Client.Stop): Changed to its own function to avoid the return value
                 from "Client.stop()".
  (main): Try "_mandos" before "mandos" as user and group name.
          Removed inner function "remove_from_clients".  New inner
          class "MandosServer".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2008-10-03">
 
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>
36
37
    </copyright>
37
38
    <xi:include href="legalnotice.xml"/>
38
39
  </refentryinfo>
39
 
 
 
40
  
40
41
  <refmeta>
41
42
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
43
    <manvolnum>8</manvolnum>
48
49
      Generate key and password for Mandos client and server.
49
50
    </refpurpose>
50
51
  </refnamediv>
51
 
 
 
52
  
52
53
  <refsynopsisdiv>
53
54
    <cmdsynopsis>
54
55
      <command>&COMMANDNAME;</command>
122
123
      <group choice="req">
123
124
        <arg choice="plain"><option>--password</option></arg>
124
125
        <arg choice="plain"><option>-p</option></arg>
 
126
        <arg choice="plain"><option>--passfile
 
127
        <replaceable>FILE</replaceable></option></arg>
 
128
        <arg choice="plain"><option>-F</option>
 
129
        <replaceable>FILE</replaceable></arg>
125
130
      </group>
126
131
      <sbr/>
127
132
      <group>
159
164
    <para>
160
165
      <command>&COMMANDNAME;</command> is a program to generate the
161
166
      OpenPGP key used by
162
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
167
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
163
168
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
164
169
      normally written to /etc/mandos for later installation into the
165
170
      initrd image, but this, and most other things, can be changed
167
172
    </para>
168
173
    <para>
169
174
      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
 
175
      <option>--password</option> or <option>--passfile</option>
 
176
      options to generate a ready-made section for
 
177
      <filename>clients.conf</filename> (see
172
178
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
173
179
      <manvolnum>5</manvolnum></citerefentry>).
174
180
    </para>
197
203
          </para>
198
204
        </listitem>
199
205
      </varlistentry>
200
 
 
 
206
      
201
207
      <varlistentry>
202
208
        <term><option>--dir
203
209
        <replaceable>DIRECTORY</replaceable></option></term>
210
216
          </para>
211
217
        </listitem>
212
218
      </varlistentry>
213
 
 
 
219
      
214
220
      <varlistentry>
215
221
        <term><option>--type
216
222
        <replaceable>TYPE</replaceable></option></term>
222
228
          </para>
223
229
        </listitem>
224
230
      </varlistentry>
225
 
 
 
231
      
226
232
      <varlistentry>
227
233
        <term><option>--length
228
234
        <replaceable>BITS</replaceable></option></term>
234
240
          </para>
235
241
        </listitem>
236
242
      </varlistentry>
237
 
 
 
243
      
238
244
      <varlistentry>
239
245
        <term><option>--subtype
240
246
        <replaceable>KEYTYPE</replaceable></option></term>
247
253
          </para>
248
254
        </listitem>
249
255
      </varlistentry>
250
 
 
 
256
      
251
257
      <varlistentry>
252
258
        <term><option>--sublength
253
259
        <replaceable>BITS</replaceable></option></term>
259
265
          </para>
260
266
        </listitem>
261
267
      </varlistentry>
262
 
 
 
268
      
263
269
      <varlistentry>
264
270
        <term><option>--email
265
271
        <replaceable>ADDRESS</replaceable></option></term>
271
277
          </para>
272
278
        </listitem>
273
279
      </varlistentry>
274
 
 
 
280
      
275
281
      <varlistentry>
276
282
        <term><option>--comment
277
283
        <replaceable>TEXT</replaceable></option></term>
284
290
          </para>
285
291
        </listitem>
286
292
      </varlistentry>
287
 
 
 
293
      
288
294
      <varlistentry>
289
295
        <term><option>--expire
290
296
        <replaceable>TIME</replaceable></option></term>
298
304
          </para>
299
305
        </listitem>
300
306
      </varlistentry>
301
 
 
 
307
      
302
308
      <varlistentry>
303
309
        <term><option>--force</option></term>
304
310
        <term><option>-f</option></term>
326
332
          </para>
327
333
        </listitem>
328
334
      </varlistentry>
 
335
      <varlistentry>
 
336
        <term><option>--passfile
 
337
        <replaceable>FILE</replaceable></option></term>
 
338
        <term><option>-F
 
339
        <replaceable>FILE</replaceable></option></term>
 
340
        <listitem>
 
341
          <para>
 
342
            The same as <option>--password</option>, but read from
 
343
            <replaceable>FILE</replaceable>, not the terminal.
 
344
          </para>
 
345
        </listitem>
 
346
      </varlistentry>
329
347
    </variablelist>
330
348
  </refsect1>
331
 
 
 
349
  
332
350
  <refsect1 id="overview">
333
351
    <title>OVERVIEW</title>
334
352
    <xi:include href="overview.xml"/>
338
356
      <filename>clients.conf</filename> on the server.
339
357
    </para>
340
358
  </refsect1>
341
 
 
 
359
  
342
360
  <refsect1 id="exit_status">
343
361
    <title>EXIT STATUS</title>
344
362
    <para>
364
382
    </variablelist>
365
383
  </refsect1>
366
384
  
367
 
  <refsect1 id="file">
 
385
  <refsect1 id="files">
368
386
    <title>FILES</title>
369
387
    <para>
370
388
      Use the <option>--dir</option> option to change where
401
419
      </varlistentry>
402
420
    </variablelist>
403
421
  </refsect1>
404
 
 
 
422
  
405
423
<!--   <refsect1 id="bugs"> -->
406
424
<!--     <title>BUGS</title> -->
407
425
<!--     <para> -->
408
426
<!--     </para> -->
409
427
<!--   </refsect1> -->
410
 
 
 
428
  
411
429
  <refsect1 id="example">
412
430
    <title>EXAMPLE</title>
413
431
    <informalexample>
454
472
      </para>
455
473
    </informalexample>
456
474
  </refsect1>
457
 
 
 
475
  
458
476
  <refsect1 id="security">
459
477
    <title>SECURITY</title>
460
478
    <para>
469
487
      <manvolnum>8</manvolnum></citerefentry>.
470
488
    </para>
471
489
  </refsect1>
472
 
 
 
490
  
473
491
  <refsect1 id="see_also">
474
492
    <title>SEE ALSO</title>
475
493
    <para>
479
497
      <manvolnum>5</manvolnum></citerefentry>,
480
498
      <citerefentry><refentrytitle>mandos</refentrytitle>
481
499
      <manvolnum>8</manvolnum></citerefentry>,
482
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
500
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
483
501
      <manvolnum>8mandos</manvolnum></citerefentry>
484
502
    </para>
485
503
  </refsect1>