/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

merge

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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2009-01-04">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-04">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
37
36
    </copyright>
38
37
    <xi:include href="legalnotice.xml"/>
39
38
  </refentryinfo>
40
 
  
 
39
 
41
40
  <refmeta>
42
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
42
    <manvolnum>8</manvolnum>
49
48
      Gives encrypted passwords to authenticated Mandos clients
50
49
    </refpurpose>
51
50
  </refnamediv>
52
 
  
 
51
 
53
52
  <refsynopsisdiv>
54
53
    <cmdsynopsis>
55
54
      <command>&COMMANDNAME;</command>
84
83
      <replaceable>DIRECTORY</replaceable></option></arg>
85
84
      <sbr/>
86
85
      <arg><option>--debug</option></arg>
87
 
      <sbr/>
88
 
      <arg><option>--no-dbus</option></arg>
89
86
    </cmdsynopsis>
90
87
    <cmdsynopsis>
91
88
      <command>&COMMANDNAME;</command>
103
100
      <arg choice="plain"><option>--check</option></arg>
104
101
    </cmdsynopsis>
105
102
  </refsynopsisdiv>
106
 
  
 
103
 
107
104
  <refsect1 id="description">
108
105
    <title>DESCRIPTION</title>
109
106
    <para>
189
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
187
        </listitem>
191
188
      </varlistentry>
192
 
      
 
189
 
193
190
      <varlistentry>
194
191
        <term><option>--priority <replaceable>
195
192
        PRIORITY</replaceable></option></term>
197
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
195
        </listitem>
199
196
      </varlistentry>
200
 
      
 
197
 
201
198
      <varlistentry>
202
199
        <term><option>--servicename
203
200
        <replaceable>NAME</replaceable></option></term>
206
203
                      xpointer="servicename"/>
207
204
        </listitem>
208
205
      </varlistentry>
209
 
      
 
206
 
210
207
      <varlistentry>
211
208
        <term><option>--configdir
212
209
        <replaceable>DIRECTORY</replaceable></option></term>
221
218
          </para>
222
219
        </listitem>
223
220
      </varlistentry>
224
 
      
 
221
 
225
222
      <varlistentry>
226
223
        <term><option>--version</option></term>
227
224
        <listitem>
230
227
          </para>
231
228
        </listitem>
232
229
      </varlistentry>
233
 
      
234
 
      <varlistentry>
235
 
        <term><option>--no-dbus</option></term>
236
 
        <listitem>
237
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
238
 
          <para>
239
 
            See also <xref linkend="dbus_interface"/>.
240
 
          </para>
241
 
        </listitem>
242
 
      </varlistentry>
243
230
    </variablelist>
244
231
  </refsect1>
245
 
  
 
232
 
246
233
  <refsect1 id="overview">
247
234
    <title>OVERVIEW</title>
248
235
    <xi:include href="overview.xml"/>
252
239
      <acronym>RAM</acronym> disk environment.
253
240
    </para>
254
241
  </refsect1>
255
 
  
 
242
 
256
243
  <refsect1 id="protocol">
257
244
    <title>NETWORK PROTOCOL</title>
258
245
    <para>
310
297
      </row>
311
298
    </tbody></tgroup></table>
312
299
  </refsect1>
313
 
  
 
300
 
314
301
  <refsect1 id="checking">
315
302
    <title>CHECKING</title>
316
303
    <para>
324
311
      <manvolnum>5</manvolnum></citerefentry>.
325
312
    </para>
326
313
  </refsect1>
327
 
  
 
314
 
328
315
  <refsect1 id="logging">
329
316
    <title>LOGGING</title>
330
317
    <para>
334
321
      and also show them on the console.
335
322
    </para>
336
323
  </refsect1>
337
 
  
338
 
  <refsect1 id="dbus_interface">
339
 
    <title>D-BUS INTERFACE</title>
340
 
    <para>
341
 
      The server will by default provide a D-Bus system bus interface.
342
 
      This interface will only be accessible by the root user or a
343
 
      Mandos-specific user, if such a user exists.
344
 
      <!-- XXX -->
345
 
    </para>
346
 
  </refsect1>
347
324
 
348
325
  <refsect1 id="exit_status">
349
326
    <title>EXIT STATUS</title>
352
329
      critical error is encountered.
353
330
    </para>
354
331
  </refsect1>
355
 
  
 
332
 
356
333
  <refsect1 id="environment">
357
334
    <title>ENVIRONMENT</title>
358
335
    <variablelist>
372
349
      </varlistentry>
373
350
    </variablelist>
374
351
  </refsect1>
375
 
  
376
 
  <refsect1 id="files">
 
352
 
 
353
  <refsect1 id="file">
377
354
    <title>FILES</title>
378
355
    <para>
379
356
      Use the <option>--configdir</option> option to change where
402
379
        </listitem>
403
380
      </varlistentry>
404
381
      <varlistentry>
405
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
382
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
406
383
        <listitem>
407
384
          <para>
408
385
            The file containing the process id of
443
420
      Currently, if a client is declared <quote>invalid</quote> due to
444
421
      having timed out, the server does not record this fact onto
445
422
      permanent storage.  This has some security implications, see
446
 
      <xref linkend="clients"/>.
 
423
      <xref linkend="CLIENTS"/>.
447
424
    </para>
448
425
    <para>
449
426
      There is currently no way of querying the server of the current
502
479
      </para>
503
480
    </informalexample>
504
481
  </refsect1>
505
 
  
 
482
 
506
483
  <refsect1 id="security">
507
484
    <title>SECURITY</title>
508
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
509
486
      <title>SERVER</title>
510
487
      <para>
511
488
        Running this <command>&COMMANDNAME;</command> server program
512
489
        should not in itself present any security risk to the host
513
 
        computer running it.  The program switches to a non-root user
514
 
        soon after startup.
 
490
        computer running it.  The program does not need any special
 
491
        privileges to run, and is designed to run as a non-root user.
515
492
      </para>
516
493
    </refsect2>
517
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
518
495
      <title>CLIENTS</title>
519
496
      <para>
520
497
        The server only gives out its stored data to clients which
527
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
528
505
        <manvolnum>5</manvolnum></citerefentry>)
529
506
        <emphasis>must</emphasis> be made non-readable by anyone
530
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
531
508
      </para>
532
509
      <para>
533
510
        As detailed in <xref linkend="checking"/>, the status of all
552
529
      </para>
553
530
      <para>
554
531
        For more details on client-side security, see
555
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
556
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
557
534
      </para>
558
535
    </refsect2>
559
536
  </refsect1>
560
 
  
 
537
 
561
538
  <refsect1 id="see_also">
562
539
    <title>SEE ALSO</title>
563
540
    <para>
566
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
567
544
        <refentrytitle>mandos.conf</refentrytitle>
568
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
569
 
        <refentrytitle>mandos-client</refentrytitle>
 
546
        <refentrytitle>password-request</refentrytitle>
570
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
571
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
572
549
      </citerefentry>