/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 Hogeborn
  • Date: 2009-02-23 11:52:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090223115242-5930ewin7m4o6zpr
* README (The Plugin System): Improve wording.

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-02">
 
5
<!ENTITY TIMESTAMP "2009-02-15">
 
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-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
86
92
    </cmdsynopsis>
87
93
    <cmdsynopsis>
88
94
      <command>&COMMANDNAME;</command>
100
106
      <arg choice="plain"><option>--check</option></arg>
101
107
    </cmdsynopsis>
102
108
  </refsynopsisdiv>
103
 
 
 
109
  
104
110
  <refsect1 id="description">
105
111
    <title>DESCRIPTION</title>
106
112
    <para>
186
192
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
193
        </listitem>
188
194
      </varlistentry>
189
 
 
 
195
      
190
196
      <varlistentry>
191
197
        <term><option>--priority <replaceable>
192
198
        PRIORITY</replaceable></option></term>
194
200
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
201
        </listitem>
196
202
      </varlistentry>
197
 
 
 
203
      
198
204
      <varlistentry>
199
205
        <term><option>--servicename
200
206
        <replaceable>NAME</replaceable></option></term>
203
209
                      xpointer="servicename"/>
204
210
        </listitem>
205
211
      </varlistentry>
206
 
 
 
212
      
207
213
      <varlistentry>
208
214
        <term><option>--configdir
209
215
        <replaceable>DIRECTORY</replaceable></option></term>
218
224
          </para>
219
225
        </listitem>
220
226
      </varlistentry>
221
 
 
 
227
      
222
228
      <varlistentry>
223
229
        <term><option>--version</option></term>
224
230
        <listitem>
227
233
          </para>
228
234
        </listitem>
229
235
      </varlistentry>
 
236
      
 
237
      <varlistentry>
 
238
        <term><option>--no-dbus</option></term>
 
239
        <listitem>
 
240
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
241
          <para>
 
242
            See also <xref linkend="dbus_interface"/>.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
 
248
        <term><option>--no-ipv6</option></term>
 
249
        <listitem>
 
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
251
        </listitem>
 
252
      </varlistentry>
230
253
    </variablelist>
231
254
  </refsect1>
232
 
 
 
255
  
233
256
  <refsect1 id="overview">
234
257
    <title>OVERVIEW</title>
235
258
    <xi:include href="overview.xml"/>
239
262
      <acronym>RAM</acronym> disk environment.
240
263
    </para>
241
264
  </refsect1>
242
 
 
 
265
  
243
266
  <refsect1 id="protocol">
244
267
    <title>NETWORK PROTOCOL</title>
245
268
    <para>
297
320
      </row>
298
321
    </tbody></tgroup></table>
299
322
  </refsect1>
300
 
 
 
323
  
301
324
  <refsect1 id="checking">
302
325
    <title>CHECKING</title>
303
326
    <para>
311
334
      <manvolnum>5</manvolnum></citerefentry>.
312
335
    </para>
313
336
  </refsect1>
314
 
 
 
337
  
315
338
  <refsect1 id="logging">
316
339
    <title>LOGGING</title>
317
340
    <para>
321
344
      and also show them on the console.
322
345
    </para>
323
346
  </refsect1>
324
 
 
 
347
  
 
348
  <refsect1 id="dbus_interface">
 
349
    <title>D-BUS INTERFACE</title>
 
350
    <para>
 
351
      The server will by default provide a D-Bus system bus interface.
 
352
      This interface will only be accessible by the root user or a
 
353
      Mandos-specific user, if such a user exists.
 
354
      <!-- XXX -->
 
355
    </para>
 
356
  </refsect1>
 
357
  
325
358
  <refsect1 id="exit_status">
326
359
    <title>EXIT STATUS</title>
327
360
    <para>
329
362
      critical error is encountered.
330
363
    </para>
331
364
  </refsect1>
332
 
 
 
365
  
333
366
  <refsect1 id="environment">
334
367
    <title>ENVIRONMENT</title>
335
368
    <variablelist>
349
382
      </varlistentry>
350
383
    </variablelist>
351
384
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
385
  
 
386
  <refsect1 id="files">
354
387
    <title>FILES</title>
355
388
    <para>
356
389
      Use the <option>--configdir</option> option to change where
379
412
        </listitem>
380
413
      </varlistentry>
381
414
      <varlistentry>
382
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
415
        <term><filename>/var/run/mandos.pid</filename></term>
383
416
        <listitem>
384
417
          <para>
385
418
            The file containing the process id of
420
453
      Currently, if a client is declared <quote>invalid</quote> due to
421
454
      having timed out, the server does not record this fact onto
422
455
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
 
456
      <xref linkend="clients"/>.
424
457
    </para>
425
458
    <para>
426
459
      There is currently no way of querying the server of the current
434
467
      Debug mode is conflated with running in the foreground.
435
468
    </para>
436
469
    <para>
437
 
      The console log messages does not show a timestamp.
 
470
      The console log messages do not show a time stamp.
 
471
    </para>
 
472
    <para>
 
473
      This server does not check the expire time of clients’ OpenPGP
 
474
      keys.
438
475
    </para>
439
476
  </refsect1>
440
477
  
475
512
      </para>
476
513
    </informalexample>
477
514
  </refsect1>
478
 
 
 
515
  
479
516
  <refsect1 id="security">
480
517
    <title>SECURITY</title>
481
 
    <refsect2 id="SERVER">
 
518
    <refsect2 id="server">
482
519
      <title>SERVER</title>
483
520
      <para>
484
521
        Running this <command>&COMMANDNAME;</command> server program
485
522
        should not in itself present any security risk to the host
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.
 
523
        computer running it.  The program switches to a non-root user
 
524
        soon after startup.
488
525
      </para>
489
526
    </refsect2>
490
 
    <refsect2 id="CLIENTS">
 
527
    <refsect2 id="clients">
491
528
      <title>CLIENTS</title>
492
529
      <para>
493
530
        The server only gives out its stored data to clients which
500
537
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
501
538
        <manvolnum>5</manvolnum></citerefentry>)
502
539
        <emphasis>must</emphasis> be made non-readable by anyone
503
 
        except the user running the server.
 
540
        except the user starting the server (usually root).
504
541
      </para>
505
542
      <para>
506
543
        As detailed in <xref linkend="checking"/>, the status of all
525
562
      </para>
526
563
      <para>
527
564
        For more details on client-side security, see
528
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
565
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
529
566
        <manvolnum>8mandos</manvolnum></citerefentry>.
530
567
      </para>
531
568
    </refsect2>
532
569
  </refsect1>
533
 
 
 
570
  
534
571
  <refsect1 id="see_also">
535
572
    <title>SEE ALSO</title>
536
573
    <para>
539
576
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
540
577
        <refentrytitle>mandos.conf</refentrytitle>
541
578
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
542
 
        <refentrytitle>password-request</refentrytitle>
 
579
        <refentrytitle>mandos-client</refentrytitle>
543
580
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
544
581
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
545
582
      </citerefentry>