/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

* plugins.d/mandos-client.c (init_gnutls_session): Retry interrupted
                                                   GnuTLS functions.
  (main): Drop privileges early, and raise them only where needed and
          lower them whenever possible.

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-21">
 
5
<!ENTITY TIMESTAMP "2009-09-10">
 
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>
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>
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
  
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>
322
346
    </para>
323
347
  </refsect1>
324
348
  
 
349
  <refsect1 id="dbus_interface">
 
350
    <title>D-BUS INTERFACE</title>
 
351
    <para>
 
352
      The server will by default provide a D-Bus system bus interface.
 
353
      This interface will only be accessible by the root user or a
 
354
      Mandos-specific user, if such a user exists.
 
355
      <!-- XXX -->
 
356
    </para>
 
357
  </refsect1>
 
358
  
325
359
  <refsect1 id="exit_status">
326
360
    <title>EXIT STATUS</title>
327
361
    <para>
350
384
    </variablelist>
351
385
  </refsect1>
352
386
  
353
 
  <refsect1 id="file">
 
387
  <refsect1 id="files">
354
388
    <title>FILES</title>
355
389
    <para>
356
390
      Use the <option>--configdir</option> option to change where
420
454
      Currently, if a client is declared <quote>invalid</quote> due to
421
455
      having timed out, the server does not record this fact onto
422
456
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
 
457
      <xref linkend="clients"/>.
424
458
    </para>
425
459
    <para>
426
460
      There is currently no way of querying the server of the current
434
468
      Debug mode is conflated with running in the foreground.
435
469
    </para>
436
470
    <para>
437
 
      The console log messages does not show a time stamp.
 
471
      The console log messages do not show a time stamp.
438
472
    </para>
439
473
    <para>
440
474
      This server does not check the expire time of clients’ OpenPGP
482
516
  
483
517
  <refsect1 id="security">
484
518
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
519
    <refsect2 id="server">
486
520
      <title>SERVER</title>
487
521
      <para>
488
522
        Running this <command>&COMMANDNAME;</command> server program
491
525
        soon after startup.
492
526
      </para>
493
527
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
528
    <refsect2 id="clients">
495
529
      <title>CLIENTS</title>
496
530
      <para>
497
531
        The server only gives out its stored data to clients which