/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 from trunk; fix small memory leak in plugin-runner.

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-04">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
 
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>
100
102
      <arg choice="plain"><option>--check</option></arg>
101
103
    </cmdsynopsis>
102
104
  </refsynopsisdiv>
103
 
 
 
105
  
104
106
  <refsect1 id="description">
105
107
    <title>DESCRIPTION</title>
106
108
    <para>
186
188
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
189
        </listitem>
188
190
      </varlistentry>
189
 
 
 
191
      
190
192
      <varlistentry>
191
193
        <term><option>--priority <replaceable>
192
194
        PRIORITY</replaceable></option></term>
194
196
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
197
        </listitem>
196
198
      </varlistentry>
197
 
 
 
199
      
198
200
      <varlistentry>
199
201
        <term><option>--servicename
200
202
        <replaceable>NAME</replaceable></option></term>
203
205
                      xpointer="servicename"/>
204
206
        </listitem>
205
207
      </varlistentry>
206
 
 
 
208
      
207
209
      <varlistentry>
208
210
        <term><option>--configdir
209
211
        <replaceable>DIRECTORY</replaceable></option></term>
218
220
          </para>
219
221
        </listitem>
220
222
      </varlistentry>
221
 
 
 
223
      
222
224
      <varlistentry>
223
225
        <term><option>--version</option></term>
224
226
        <listitem>
229
231
      </varlistentry>
230
232
    </variablelist>
231
233
  </refsect1>
232
 
 
 
234
  
233
235
  <refsect1 id="overview">
234
236
    <title>OVERVIEW</title>
235
237
    <xi:include href="overview.xml"/>
239
241
      <acronym>RAM</acronym> disk environment.
240
242
    </para>
241
243
  </refsect1>
242
 
 
 
244
  
243
245
  <refsect1 id="protocol">
244
246
    <title>NETWORK PROTOCOL</title>
245
247
    <para>
297
299
      </row>
298
300
    </tbody></tgroup></table>
299
301
  </refsect1>
300
 
 
 
302
  
301
303
  <refsect1 id="checking">
302
304
    <title>CHECKING</title>
303
305
    <para>
311
313
      <manvolnum>5</manvolnum></citerefentry>.
312
314
    </para>
313
315
  </refsect1>
314
 
 
 
316
  
315
317
  <refsect1 id="logging">
316
318
    <title>LOGGING</title>
317
319
    <para>
321
323
      and also show them on the console.
322
324
    </para>
323
325
  </refsect1>
324
 
 
 
326
  
325
327
  <refsect1 id="exit_status">
326
328
    <title>EXIT STATUS</title>
327
329
    <para>
329
331
      critical error is encountered.
330
332
    </para>
331
333
  </refsect1>
332
 
 
 
334
  
333
335
  <refsect1 id="environment">
334
336
    <title>ENVIRONMENT</title>
335
337
    <variablelist>
349
351
      </varlistentry>
350
352
    </variablelist>
351
353
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
354
  
 
355
  <refsect1 id="files">
354
356
    <title>FILES</title>
355
357
    <para>
356
358
      Use the <option>--configdir</option> option to change where
379
381
        </listitem>
380
382
      </varlistentry>
381
383
      <varlistentry>
382
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
384
        <term><filename>/var/run/mandos.pid</filename></term>
383
385
        <listitem>
384
386
          <para>
385
387
            The file containing the process id of
420
422
      Currently, if a client is declared <quote>invalid</quote> due to
421
423
      having timed out, the server does not record this fact onto
422
424
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
 
425
      <xref linkend="clients"/>.
424
426
    </para>
425
427
    <para>
426
428
      There is currently no way of querying the server of the current
479
481
      </para>
480
482
    </informalexample>
481
483
  </refsect1>
482
 
 
 
484
  
483
485
  <refsect1 id="security">
484
486
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
487
    <refsect2 id="server">
486
488
      <title>SERVER</title>
487
489
      <para>
488
490
        Running this <command>&COMMANDNAME;</command> server program
489
491
        should not in itself present any security risk to the host
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.
 
492
        computer running it.  The program switches to a non-root user
 
493
        soon after startup.
492
494
      </para>
493
495
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
496
    <refsect2 id="clients">
495
497
      <title>CLIENTS</title>
496
498
      <para>
497
499
        The server only gives out its stored data to clients which
504
506
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
507
        <manvolnum>5</manvolnum></citerefentry>)
506
508
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
509
        except the user starting the server (usually root).
508
510
      </para>
509
511
      <para>
510
512
        As detailed in <xref linkend="checking"/>, the status of all
529
531
      </para>
530
532
      <para>
531
533
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
534
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
535
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
536
      </para>
535
537
    </refsect2>
536
538
  </refsect1>
537
 
 
 
539
  
538
540
  <refsect1 id="see_also">
539
541
    <title>SEE ALSO</title>
540
542
    <para>
543
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
546
        <refentrytitle>mandos.conf</refentrytitle>
545
547
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
 
548
        <refentrytitle>mandos-client</refentrytitle>
547
549
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
550
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
551
      </citerefentry>