/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-03 05:04:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050440-7cwzxestx6pvdy1i
* Makefile (mandos.8): Add dependency on "overview.xml" and
                       "legalnotice.xml".
  (mandos-keygen.8): New target.
  (mandos-conf.5): Added dependency on "legalnotice.xml".
  (plugin-runner.8mandos): New target
  (plugins.d/password-request.8mandos): - '' -

* mandos-options.xml (priority): Make wording server/client neutral.

* plugins.d/password-request.c (main): Changed .arg fields of the argp
                                       options struct to be more
                                       consistent with the manual.

* plugins.d/password-request.xml (OVERVIEW): Moved to after "OPTIONS".
  (OPTIONS): Improved wording and names of replaceables.

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