/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 Hogeborn
  • Date: 2009-09-17 11:47:22 UTC
  • mfrom: (237.2.138 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20090917114722-azcwe7sdowxc95ba
Merge from trunk.  Lots of bug fixes, including Debian bug #546928.

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-05">
 
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-ipv6</option></arg>
86
90
    </cmdsynopsis>
87
91
    <cmdsynopsis>
88
92
      <command>&COMMANDNAME;</command>
100
104
      <arg choice="plain"><option>--check</option></arg>
101
105
    </cmdsynopsis>
102
106
  </refsynopsisdiv>
103
 
 
 
107
  
104
108
  <refsect1 id="description">
105
109
    <title>DESCRIPTION</title>
106
110
    <para>
186
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
191
        </listitem>
188
192
      </varlistentry>
189
 
 
 
193
      
190
194
      <varlistentry>
191
195
        <term><option>--priority <replaceable>
192
196
        PRIORITY</replaceable></option></term>
194
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
199
        </listitem>
196
200
      </varlistentry>
197
 
 
 
201
      
198
202
      <varlistentry>
199
203
        <term><option>--servicename
200
204
        <replaceable>NAME</replaceable></option></term>
203
207
                      xpointer="servicename"/>
204
208
        </listitem>
205
209
      </varlistentry>
206
 
 
 
210
      
207
211
      <varlistentry>
208
212
        <term><option>--configdir
209
213
        <replaceable>DIRECTORY</replaceable></option></term>
218
222
          </para>
219
223
        </listitem>
220
224
      </varlistentry>
221
 
 
 
225
      
222
226
      <varlistentry>
223
227
        <term><option>--version</option></term>
224
228
        <listitem>
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
  
233
244
  <refsect1 id="overview">
234
245
    <title>OVERVIEW</title>
235
246
    <xi:include href="overview.xml"/>
239
250
      <acronym>RAM</acronym> disk environment.
240
251
    </para>
241
252
  </refsect1>
242
 
 
 
253
  
243
254
  <refsect1 id="protocol">
244
255
    <title>NETWORK PROTOCOL</title>
245
256
    <para>
297
308
      </row>
298
309
    </tbody></tgroup></table>
299
310
  </refsect1>
300
 
 
 
311
  
301
312
  <refsect1 id="checking">
302
313
    <title>CHECKING</title>
303
314
    <para>
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
  
315
329
  <refsect1 id="logging">
316
330
    <title>LOGGING</title>
317
331
    <para>
321
335
      and also show them on the console.
322
336
    </para>
323
337
  </refsect1>
324
 
 
 
338
  
325
339
  <refsect1 id="exit_status">
326
340
    <title>EXIT STATUS</title>
327
341
    <para>
329
343
      critical error is encountered.
330
344
    </para>
331
345
  </refsect1>
332
 
 
 
346
  
333
347
  <refsect1 id="environment">
334
348
    <title>ENVIRONMENT</title>
335
349
    <variablelist>
349
363
      </varlistentry>
350
364
    </variablelist>
351
365
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
366
  
 
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
479
493
      </para>
480
494
    </informalexample>
481
495
  </refsect1>
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
529
543
      </para>
530
544
      <para>
531
545
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
546
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
547
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
548
      </para>
535
549
    </refsect2>
536
550
  </refsect1>
537
 
 
 
551
  
538
552
  <refsect1 id="see_also">
539
553
    <title>SEE ALSO</title>
540
554
    <para>
543
557
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
558
        <refentrytitle>mandos.conf</refentrytitle>
545
559
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
 
560
        <refentrytitle>mandos-client</refentrytitle>
547
561
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
562
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
563
      </citerefentry>