/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.xml

Restore some poor D-Bus methods who got a bit hastily deleted.  Enable
writing to the "last_checked_ok" property.

* mandos (ClientDBus.CheckedOK, ClientDBus.Enable,
          ClientDBus.StartChecker, ClientDBus.Disable,
          ClientDBus.StopChecker): Restored.
  (ClientDBus.last_checked_ok_dbus_property): Make writing to this
                                              property do
                                              "self.checked_ok()".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.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">
6
 
<!ENTITY TIMESTAMP "2008-09-06">
 
5
<!ENTITY TIMESTAMP "2009-09-17">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
37
39
    <xi:include href="legalnotice.xml"/>
38
40
  </refentryinfo>
39
 
 
 
41
  
40
42
  <refmeta>
41
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
44
    <manvolnum>8</manvolnum>
48
50
      Gives encrypted passwords to authenticated Mandos clients
49
51
    </refpurpose>
50
52
  </refnamediv>
51
 
 
 
53
  
52
54
  <refsynopsisdiv>
53
55
    <cmdsynopsis>
54
56
      <command>&COMMANDNAME;</command>
83
85
      <replaceable>DIRECTORY</replaceable></option></arg>
84
86
      <sbr/>
85
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
86
92
    </cmdsynopsis>
87
93
    <cmdsynopsis>
88
94
      <command>&COMMANDNAME;</command>
100
106
      <arg choice="plain"><option>--check</option></arg>
101
107
    </cmdsynopsis>
102
108
  </refsynopsisdiv>
103
 
 
 
109
  
104
110
  <refsect1 id="description">
105
111
    <title>DESCRIPTION</title>
106
112
    <para>
186
192
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
193
        </listitem>
188
194
      </varlistentry>
189
 
 
 
195
      
190
196
      <varlistentry>
191
197
        <term><option>--priority <replaceable>
192
198
        PRIORITY</replaceable></option></term>
194
200
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
201
        </listitem>
196
202
      </varlistentry>
197
 
 
 
203
      
198
204
      <varlistentry>
199
205
        <term><option>--servicename
200
206
        <replaceable>NAME</replaceable></option></term>
203
209
                      xpointer="servicename"/>
204
210
        </listitem>
205
211
      </varlistentry>
206
 
 
 
212
      
207
213
      <varlistentry>
208
214
        <term><option>--configdir
209
215
        <replaceable>DIRECTORY</replaceable></option></term>
218
224
          </para>
219
225
        </listitem>
220
226
      </varlistentry>
221
 
 
 
227
      
222
228
      <varlistentry>
223
229
        <term><option>--version</option></term>
224
230
        <listitem>
227
233
          </para>
228
234
        </listitem>
229
235
      </varlistentry>
 
236
      
 
237
      <varlistentry>
 
238
        <term><option>--no-dbus</option></term>
 
239
        <listitem>
 
240
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
241
          <para>
 
242
            See also <xref linkend="dbus_interface"/>.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
 
248
        <term><option>--no-ipv6</option></term>
 
249
        <listitem>
 
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
251
        </listitem>
 
252
      </varlistentry>
230
253
    </variablelist>
231
254
  </refsect1>
232
 
 
 
255
  
233
256
  <refsect1 id="overview">
234
257
    <title>OVERVIEW</title>
235
258
    <xi:include href="overview.xml"/>
239
262
      <acronym>RAM</acronym> disk environment.
240
263
    </para>
241
264
  </refsect1>
242
 
 
 
265
  
243
266
  <refsect1 id="protocol">
244
267
    <title>NETWORK PROTOCOL</title>
245
268
    <para>
297
320
      </row>
298
321
    </tbody></tgroup></table>
299
322
  </refsect1>
300
 
 
 
323
  
301
324
  <refsect1 id="checking">
302
325
    <title>CHECKING</title>
303
326
    <para>
304
327
      The server will, by default, continually check that the clients
305
328
      are still up.  If a client has not been confirmed as being up
306
329
      for some time, the client is assumed to be compromised and is no
307
 
      longer eligible to receive the encrypted password.  The timeout,
 
330
      longer eligible to receive the encrypted password.  (Manual
 
331
      intervention is required to re-enable a client.)  The timeout,
308
332
      checker program, and interval between checks can be configured
309
333
      both globally and per client; see <citerefentry>
310
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
312
338
    </para>
313
339
  </refsect1>
314
 
 
 
340
  
315
341
  <refsect1 id="logging">
316
342
    <title>LOGGING</title>
317
343
    <para>
321
347
      and also show them on the console.
322
348
    </para>
323
349
  </refsect1>
324
 
 
 
350
  
 
351
  <refsect1 id="dbus_interface">
 
352
    <title>D-BUS INTERFACE</title>
 
353
    <para>
 
354
      The server will by default provide a D-Bus system bus interface.
 
355
      This interface will only be accessible by the root user or a
 
356
      Mandos-specific user, if such a user exists.
 
357
      <!-- XXX -->
 
358
    </para>
 
359
  </refsect1>
 
360
  
325
361
  <refsect1 id="exit_status">
326
362
    <title>EXIT STATUS</title>
327
363
    <para>
329
365
      critical error is encountered.
330
366
    </para>
331
367
  </refsect1>
332
 
 
 
368
  
333
369
  <refsect1 id="environment">
334
370
    <title>ENVIRONMENT</title>
335
371
    <variablelist>
349
385
      </varlistentry>
350
386
    </variablelist>
351
387
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
388
  
 
389
  <refsect1 id="files">
354
390
    <title>FILES</title>
355
391
    <para>
356
392
      Use the <option>--configdir</option> option to change where
420
456
      Currently, if a client is declared <quote>invalid</quote> due to
421
457
      having timed out, the server does not record this fact onto
422
458
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
 
459
      <xref linkend="clients"/>.
424
460
    </para>
425
461
    <para>
426
462
      There is currently no way of querying the server of the current
434
470
      Debug mode is conflated with running in the foreground.
435
471
    </para>
436
472
    <para>
437
 
      The console log messages does not show a time stamp.
 
473
      The console log messages do not show a time stamp.
438
474
    </para>
439
475
    <para>
440
476
      This server does not check the expire time of clients’ OpenPGP
479
515
      </para>
480
516
    </informalexample>
481
517
  </refsect1>
482
 
 
 
518
  
483
519
  <refsect1 id="security">
484
520
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
521
    <refsect2 id="server">
486
522
      <title>SERVER</title>
487
523
      <para>
488
524
        Running this <command>&COMMANDNAME;</command> server program
491
527
        soon after startup.
492
528
      </para>
493
529
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
530
    <refsect2 id="clients">
495
531
      <title>CLIENTS</title>
496
532
      <para>
497
533
        The server only gives out its stored data to clients which
504
540
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
541
        <manvolnum>5</manvolnum></citerefentry>)
506
542
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
543
        except the user starting the server (usually root).
508
544
      </para>
509
545
      <para>
510
546
        As detailed in <xref linkend="checking"/>, the status of all
534
570
      </para>
535
571
    </refsect2>
536
572
  </refsect1>
537
 
 
 
573
  
538
574
  <refsect1 id="see_also">
539
575
    <title>SEE ALSO</title>
540
576
    <para>