/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: 2008-09-04 13:36:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904133659-0omre4j6luosb20q
* mandos-clients.conf.xml (OPTIONS): Improved spelling.

* mandos.conf.xml (BUGS): - '' -

* mandos.xml (BUGS): - '' -

* plugin-runner.xml (NAME): Fix spelling by changing wording.
  (OPTIONS): Improved spelling.
  (EXAMPLE): Do not use obsolete "--keydir" option.  Improved wording.

* plugins.d/password-prompt.xml (DESCRIPTION): Improved spelling.
  (EXAMPLE): Add <acronym> tag.
  (SECURITY): Improved spelling.

* plugins.d/password-request.xml (SYNOPSIS): Changed replaceable to
                                             match OPTIONS section.
  (DESCRIPTION, OVERVIEW): Improved spelling.

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