/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

  • Committer: teddy at bsnet
  • Date: 2010-08-10 19:08:24 UTC
  • mto: (237.2.182 mandos-local)
  • mto: This revision was merged to the branch mainline in revision 270.
  • Revision ID: teddy@fukt.bsnet.se-20100810190824-5yquozxy4kh6py3f
* plugins.d/mandos-client.c: An empty interface name now means to
                             autodetect an interface; to specify no
                             particular interface, use "none".
  (sys_class_net): New global variable for the "/sys/class/net" path.
  (good_interface): New function to determine the suitability of an
                    interface.  Used by a scandir() call in main().
  (main): Changed default value for "interface" to the empty string.
          Moved "connect_to" to be a global variable.  Only take down
          and up interface if its name is not "none".
* plugins.d/mandos-client.xml (OPTIONS): Update documentation for the
                                         "--interface" option.

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-12">
 
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>
83
85
      <replaceable>DIRECTORY</replaceable></option></arg>
84
86
      <sbr/>
85
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-ipv6</option></arg>
86
90
    </cmdsynopsis>
87
91
    <cmdsynopsis>
88
92
      <command>&COMMANDNAME;</command>
227
231
          </para>
228
232
        </listitem>
229
233
      </varlistentry>
 
234
      
 
235
      <varlistentry>
 
236
        <term><option>--no-ipv6</option></term>
 
237
        <listitem>
 
238
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
239
        </listitem>
 
240
      </varlistentry>
230
241
    </variablelist>
231
242
  </refsect1>
232
243
  
304
315
      The server will, by default, continually check that the clients
305
316
      are still up.  If a client has not been confirmed as being up
306
317
      for some time, the client is assumed to be compromised and is no
307
 
      longer eligible to receive the encrypted password.  The timeout,
 
318
      longer eligible to receive the encrypted password.  (Manual
 
319
      intervention is required to re-enable a client.)  The timeout,
308
320
      checker program, and interval between checks can be configured
309
321
      both globally and per client; see <citerefentry>
310
322
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
 
323
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
324
      receiving its password will also be treated as a successful
 
325
      checker run.
312
326
    </para>
313
327
  </refsect1>
314
328
  
350
364
    </variablelist>
351
365
  </refsect1>
352
366
  
353
 
  <refsect1 id="file">
 
367
  <refsect1 id="files">
354
368
    <title>FILES</title>
355
369
    <para>
356
370
      Use the <option>--configdir</option> option to change where
420
434
      Currently, if a client is declared <quote>invalid</quote> due to
421
435
      having timed out, the server does not record this fact onto
422
436
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
 
437
      <xref linkend="clients"/>.
424
438
    </para>
425
439
    <para>
426
440
      There is currently no way of querying the server of the current
434
448
      Debug mode is conflated with running in the foreground.
435
449
    </para>
436
450
    <para>
437
 
      The console log messages does not show a time stamp.
 
451
      The console log messages do not show a time stamp.
438
452
    </para>
439
453
    <para>
440
454
      This server does not check the expire time of clients’ OpenPGP
482
496
  
483
497
  <refsect1 id="security">
484
498
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
499
    <refsect2 id="server">
486
500
      <title>SERVER</title>
487
501
      <para>
488
502
        Running this <command>&COMMANDNAME;</command> server program
491
505
        soon after startup.
492
506
      </para>
493
507
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
508
    <refsect2 id="clients">
495
509
      <title>CLIENTS</title>
496
510
      <para>
497
511
        The server only gives out its stored data to clients which
504
518
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
519
        <manvolnum>5</manvolnum></citerefentry>)
506
520
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
521
        except the user starting the server (usually root).
508
522
      </para>
509
523
      <para>
510
524
        As detailed in <xref linkend="checking"/>, the status of all