/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 05:08:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050824-x38ghzu01vkfrpb4
* plugins.d/password-request.xml (OVERVIEW): Improved wording.
  (EXIT STATUS): Fixed typos.

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-09-30">
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>
101
100
      <arg choice="plain"><option>--check</option></arg>
102
101
    </cmdsynopsis>
103
102
  </refsynopsisdiv>
104
 
  
 
103
 
105
104
  <refsect1 id="description">
106
105
    <title>DESCRIPTION</title>
107
106
    <para>
187
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
188
187
        </listitem>
189
188
      </varlistentry>
190
 
      
 
189
 
191
190
      <varlistentry>
192
191
        <term><option>--priority <replaceable>
193
192
        PRIORITY</replaceable></option></term>
195
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
196
195
        </listitem>
197
196
      </varlistentry>
198
 
      
 
197
 
199
198
      <varlistentry>
200
199
        <term><option>--servicename
201
200
        <replaceable>NAME</replaceable></option></term>
204
203
                      xpointer="servicename"/>
205
204
        </listitem>
206
205
      </varlistentry>
207
 
      
 
206
 
208
207
      <varlistentry>
209
208
        <term><option>--configdir
210
209
        <replaceable>DIRECTORY</replaceable></option></term>
219
218
          </para>
220
219
        </listitem>
221
220
      </varlistentry>
222
 
      
 
221
 
223
222
      <varlistentry>
224
223
        <term><option>--version</option></term>
225
224
        <listitem>
230
229
      </varlistentry>
231
230
    </variablelist>
232
231
  </refsect1>
233
 
  
 
232
 
234
233
  <refsect1 id="overview">
235
234
    <title>OVERVIEW</title>
236
235
    <xi:include href="overview.xml"/>
240
239
      <acronym>RAM</acronym> disk environment.
241
240
    </para>
242
241
  </refsect1>
243
 
  
 
242
 
244
243
  <refsect1 id="protocol">
245
244
    <title>NETWORK PROTOCOL</title>
246
245
    <para>
298
297
      </row>
299
298
    </tbody></tgroup></table>
300
299
  </refsect1>
301
 
  
 
300
 
302
301
  <refsect1 id="checking">
303
302
    <title>CHECKING</title>
304
303
    <para>
312
311
      <manvolnum>5</manvolnum></citerefentry>.
313
312
    </para>
314
313
  </refsect1>
315
 
  
 
314
 
316
315
  <refsect1 id="logging">
317
316
    <title>LOGGING</title>
318
317
    <para>
322
321
      and also show them on the console.
323
322
    </para>
324
323
  </refsect1>
325
 
  
 
324
 
326
325
  <refsect1 id="exit_status">
327
326
    <title>EXIT STATUS</title>
328
327
    <para>
330
329
      critical error is encountered.
331
330
    </para>
332
331
  </refsect1>
333
 
  
 
332
 
334
333
  <refsect1 id="environment">
335
334
    <title>ENVIRONMENT</title>
336
335
    <variablelist>
350
349
      </varlistentry>
351
350
    </variablelist>
352
351
  </refsect1>
353
 
  
 
352
 
354
353
  <refsect1 id="file">
355
354
    <title>FILES</title>
356
355
    <para>
380
379
        </listitem>
381
380
      </varlistentry>
382
381
      <varlistentry>
383
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
382
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
384
383
        <listitem>
385
384
          <para>
386
385
            The file containing the process id of
435
434
      Debug mode is conflated with running in the foreground.
436
435
    </para>
437
436
    <para>
438
 
      The console log messages does not show a time stamp.
439
 
    </para>
440
 
    <para>
441
 
      This server does not check the expire time of clients’ OpenPGP
442
 
      keys.
 
437
      The console log messages does not show a timestamp.
443
438
    </para>
444
439
  </refsect1>
445
440
  
480
475
      </para>
481
476
    </informalexample>
482
477
  </refsect1>
483
 
  
 
478
 
484
479
  <refsect1 id="security">
485
480
    <title>SECURITY</title>
486
481
    <refsect2 id="SERVER">
488
483
      <para>
489
484
        Running this <command>&COMMANDNAME;</command> server program
490
485
        should not in itself present any security risk to the host
491
 
        computer running it.  The program switches to a non-root user
492
 
        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.
493
488
      </para>
494
489
    </refsect2>
495
490
    <refsect2 id="CLIENTS">
505
500
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
501
        <manvolnum>5</manvolnum></citerefentry>)
507
502
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user starting the server (usually root).
 
503
        except the user running the server.
509
504
      </para>
510
505
      <para>
511
506
        As detailed in <xref linkend="checking"/>, the status of all
530
525
      </para>
531
526
      <para>
532
527
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
528
        <citerefentry><refentrytitle>password-request</refentrytitle>
534
529
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
530
      </para>
536
531
    </refsect2>
537
532
  </refsect1>
538
 
  
 
533
 
539
534
  <refsect1 id="see_also">
540
535
    <title>SEE ALSO</title>
541
536
    <para>
544
539
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
540
        <refentrytitle>mandos.conf</refentrytitle>
546
541
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>mandos-client</refentrytitle>
 
542
        <refentrytitle>password-request</refentrytitle>
548
543
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
544
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
545
      </citerefentry>