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

  • Committer: teddy at bsnet
  • Date: 2011-11-12 18:15:29 UTC
  • mfrom: (521.1.1 doc-filename-class)
  • Revision ID: teddy@fukt.bsnet.se-20111112181529-v4emlw0v5fugv2tk
Merge doc markup fixes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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
4
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2011-10-22">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
 
37
      <year>2011</year>
37
38
      <holder>Teddy Hogeborn</holder>
38
39
      <holder>Björn Påhlsson</holder>
39
40
    </copyright>
93
94
      <arg><option>--no-dbus</option></arg>
94
95
      <sbr/>
95
96
      <arg><option>--no-ipv6</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-restore</option></arg>
96
99
    </cmdsynopsis>
97
100
    <cmdsynopsis>
98
101
      <command>&COMMANDNAME;</command>
116
119
    <para>
117
120
      <command>&COMMANDNAME;</command> is a server daemon which
118
121
      handles incoming request for passwords for a pre-defined list of
119
 
      client host computers.  The Mandos server uses Zeroconf to
120
 
      announce itself on the local network, and uses TLS to
121
 
      communicate securely with and to authenticate the clients.  The
122
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
123
 
      link-local addresses, since the clients will probably not have
124
 
      any other addresses configured (see <xref linkend="overview"/>).
125
 
      Any authenticated client is then given the stored pre-encrypted
126
 
      password for that specific client.
 
122
      client host computers. For an introduction, see
 
123
      <citerefentry><refentrytitle>intro</refentrytitle>
 
124
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
125
      uses Zeroconf to announce itself on the local network, and uses
 
126
      TLS to communicate securely with and to authenticate the
 
127
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
128
      use IPv6 link-local addresses, since the clients will probably
 
129
      not have any other addresses configured (see <xref
 
130
      linkend="overview"/>).  Any authenticated client is then given
 
131
      the stored pre-encrypted password for that specific client.
127
132
    </para>
128
133
  </refsect1>
129
134
  
272
277
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
273
278
        </listitem>
274
279
      </varlistentry>
 
280
      
 
281
      <varlistentry>
 
282
        <term><option>--no-restore</option></term>
 
283
        <listitem>
 
284
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
285
        </listitem>
 
286
      </varlistentry>
275
287
    </variablelist>
276
288
  </refsect1>
277
289
  
351
363
      for some time, the client is assumed to be compromised and is no
352
364
      longer eligible to receive the encrypted password.  (Manual
353
365
      intervention is required to re-enable a client.)  The timeout,
354
 
      checker program, and interval between checks can be configured
355
 
      both globally and per client; see <citerefentry>
356
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
366
      extended timeout, checker program, and interval between checks
 
367
      can be configured both globally and per client; see
 
368
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
357
369
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
358
370
      receiving its password will also be treated as a successful
359
371
      checker run.
384
396
    <title>LOGGING</title>
385
397
    <para>
386
398
      The server will send log message with various severity levels to
387
 
      <filename>/dev/log</filename>.  With the
 
399
      <filename class="devicefile">/dev/log</filename>.  With the
388
400
      <option>--debug</option> option, it will log even more messages,
389
401
      and also show them on the console.
390
402
    </para>
466
478
        </listitem>
467
479
      </varlistentry>
468
480
      <varlistentry>
469
 
        <term><filename>/dev/log</filename></term>
 
481
        <term><filename class="devicefile">/dev/log</filename></term>
470
482
        <listitem>
471
483
          <para>
472
484
            The Unix domain socket to where local syslog messages are
506
518
      Debug mode is conflated with running in the foreground.
507
519
    </para>
508
520
    <para>
509
 
      The console log messages do not show a time stamp.
510
 
    </para>
511
 
    <para>
512
521
      This server does not check the expire time of clients’ OpenPGP
513
522
      keys.
514
523
    </para>
609
618
  <refsect1 id="see_also">
610
619
    <title>SEE ALSO</title>
611
620
    <para>
612
 
      <citerefentry>
613
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
614
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
 
        <refentrytitle>mandos.conf</refentrytitle>
616
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
 
        <refentrytitle>mandos-client</refentrytitle>
618
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
620
 
      </citerefentry>
 
621
      <citerefentry><refentrytitle>intro</refentrytitle>
 
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
623
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
624
      <manvolnum>5</manvolnum></citerefentry>,
 
625
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
626
      <manvolnum>5</manvolnum></citerefentry>,
 
627
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
628
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
629
      <citerefentry><refentrytitle>sh</refentrytitle>
 
630
      <manvolnum>1</manvolnum></citerefentry>
621
631
    </para>
622
632
    <variablelist>
623
633
      <varlistentry>