/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

removed old/unspecified todo's

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 "2008-12-28">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-02">
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"/>.
240
 
        </listitem>
241
 
      </varlistentry>
242
230
    </variablelist>
243
231
  </refsect1>
244
 
  
 
232
 
245
233
  <refsect1 id="overview">
246
234
    <title>OVERVIEW</title>
247
235
    <xi:include href="overview.xml"/>
251
239
      <acronym>RAM</acronym> disk environment.
252
240
    </para>
253
241
  </refsect1>
254
 
  
 
242
 
255
243
  <refsect1 id="protocol">
256
244
    <title>NETWORK PROTOCOL</title>
257
245
    <para>
309
297
      </row>
310
298
    </tbody></tgroup></table>
311
299
  </refsect1>
312
 
  
 
300
 
313
301
  <refsect1 id="checking">
314
302
    <title>CHECKING</title>
315
303
    <para>
323
311
      <manvolnum>5</manvolnum></citerefentry>.
324
312
    </para>
325
313
  </refsect1>
326
 
  
 
314
 
327
315
  <refsect1 id="logging">
328
316
    <title>LOGGING</title>
329
317
    <para>
333
321
      and also show them on the console.
334
322
    </para>
335
323
  </refsect1>
336
 
  
337
 
  <refsect1 id="dbus">
338
 
    <title>D-BUS INTERFACE</title>
339
 
    <para>
340
 
      The server will by default provide a D-Bus system bus interface.
341
 
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
344
 
    </para>
345
 
  </refsect1>
346
324
 
347
325
  <refsect1 id="exit_status">
348
326
    <title>EXIT STATUS</title>
351
329
      critical error is encountered.
352
330
    </para>
353
331
  </refsect1>
354
 
  
 
332
 
355
333
  <refsect1 id="environment">
356
334
    <title>ENVIRONMENT</title>
357
335
    <variablelist>
371
349
      </varlistentry>
372
350
    </variablelist>
373
351
  </refsect1>
374
 
  
375
 
  <refsect1 id="files">
 
352
 
 
353
  <refsect1 id="file">
376
354
    <title>FILES</title>
377
355
    <para>
378
356
      Use the <option>--configdir</option> option to change where
401
379
        </listitem>
402
380
      </varlistentry>
403
381
      <varlistentry>
404
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
382
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
405
383
        <listitem>
406
384
          <para>
407
385
            The file containing the process id of
442
420
      Currently, if a client is declared <quote>invalid</quote> due to
443
421
      having timed out, the server does not record this fact onto
444
422
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="clients"/>.
 
423
      <xref linkend="CLIENTS"/>.
446
424
    </para>
447
425
    <para>
448
426
      There is currently no way of querying the server of the current
456
434
      Debug mode is conflated with running in the foreground.
457
435
    </para>
458
436
    <para>
459
 
      The console log messages does not show a time stamp.
460
 
    </para>
461
 
    <para>
462
 
      This server does not check the expire time of clients’ OpenPGP
463
 
      keys.
 
437
      The console log messages does not show a timestamp.
464
438
    </para>
465
439
  </refsect1>
466
440
  
501
475
      </para>
502
476
    </informalexample>
503
477
  </refsect1>
504
 
  
 
478
 
505
479
  <refsect1 id="security">
506
480
    <title>SECURITY</title>
507
 
    <refsect2 id="server">
 
481
    <refsect2 id="SERVER">
508
482
      <title>SERVER</title>
509
483
      <para>
510
484
        Running this <command>&COMMANDNAME;</command> server program
511
485
        should not in itself present any security risk to the host
512
 
        computer running it.  The program switches to a non-root user
513
 
        soon after startup.
 
486
        computer running it.  The program does not need any special
 
487
        privileges to run, and is designed to run as a non-root user.
514
488
      </para>
515
489
    </refsect2>
516
 
    <refsect2 id="clients">
 
490
    <refsect2 id="CLIENTS">
517
491
      <title>CLIENTS</title>
518
492
      <para>
519
493
        The server only gives out its stored data to clients which
526
500
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
501
        <manvolnum>5</manvolnum></citerefentry>)
528
502
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user starting the server (usually root).
 
503
        except the user running the server.
530
504
      </para>
531
505
      <para>
532
506
        As detailed in <xref linkend="checking"/>, the status of all
551
525
      </para>
552
526
      <para>
553
527
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
528
        <citerefentry><refentrytitle>password-request</refentrytitle>
555
529
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
530
      </para>
557
531
    </refsect2>
558
532
  </refsect1>
559
 
  
 
533
 
560
534
  <refsect1 id="see_also">
561
535
    <title>SEE ALSO</title>
562
536
    <para>
565
539
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
540
        <refentrytitle>mandos.conf</refentrytitle>
567
541
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>mandos-client</refentrytitle>
 
542
        <refentrytitle>password-request</refentrytitle>
569
543
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
544
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
545
      </citerefentry>