/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-06 15:41:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906154127-oxfrwsrbu0inhljv
* plugin-runner.c (main): Bug fix: use built-in default value if
                          "--plugin-dir" was not used.

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-02-24">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-05">
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-ipv6</option></arg>
90
86
    </cmdsynopsis>
91
87
    <cmdsynopsis>
92
88
      <command>&COMMANDNAME;</command>
104
100
      <arg choice="plain"><option>--check</option></arg>
105
101
    </cmdsynopsis>
106
102
  </refsynopsisdiv>
107
 
  
 
103
 
108
104
  <refsect1 id="description">
109
105
    <title>DESCRIPTION</title>
110
106
    <para>
190
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
187
        </listitem>
192
188
      </varlistentry>
193
 
      
 
189
 
194
190
      <varlistentry>
195
191
        <term><option>--priority <replaceable>
196
192
        PRIORITY</replaceable></option></term>
198
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
195
        </listitem>
200
196
      </varlistentry>
201
 
      
 
197
 
202
198
      <varlistentry>
203
199
        <term><option>--servicename
204
200
        <replaceable>NAME</replaceable></option></term>
207
203
                      xpointer="servicename"/>
208
204
        </listitem>
209
205
      </varlistentry>
210
 
      
 
206
 
211
207
      <varlistentry>
212
208
        <term><option>--configdir
213
209
        <replaceable>DIRECTORY</replaceable></option></term>
222
218
          </para>
223
219
        </listitem>
224
220
      </varlistentry>
225
 
      
 
221
 
226
222
      <varlistentry>
227
223
        <term><option>--version</option></term>
228
224
        <listitem>
231
227
          </para>
232
228
        </listitem>
233
229
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
 
        <term><option>--no-ipv6</option></term>
237
 
        <listitem>
238
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
239
 
        </listitem>
240
 
      </varlistentry>
241
230
    </variablelist>
242
231
  </refsect1>
243
 
  
 
232
 
244
233
  <refsect1 id="overview">
245
234
    <title>OVERVIEW</title>
246
235
    <xi:include href="overview.xml"/>
250
239
      <acronym>RAM</acronym> disk environment.
251
240
    </para>
252
241
  </refsect1>
253
 
  
 
242
 
254
243
  <refsect1 id="protocol">
255
244
    <title>NETWORK PROTOCOL</title>
256
245
    <para>
308
297
      </row>
309
298
    </tbody></tgroup></table>
310
299
  </refsect1>
311
 
  
 
300
 
312
301
  <refsect1 id="checking">
313
302
    <title>CHECKING</title>
314
303
    <para>
322
311
      <manvolnum>5</manvolnum></citerefentry>.
323
312
    </para>
324
313
  </refsect1>
325
 
  
 
314
 
326
315
  <refsect1 id="logging">
327
316
    <title>LOGGING</title>
328
317
    <para>
332
321
      and also show them on the console.
333
322
    </para>
334
323
  </refsect1>
335
 
  
 
324
 
336
325
  <refsect1 id="exit_status">
337
326
    <title>EXIT STATUS</title>
338
327
    <para>
340
329
      critical error is encountered.
341
330
    </para>
342
331
  </refsect1>
343
 
  
 
332
 
344
333
  <refsect1 id="environment">
345
334
    <title>ENVIRONMENT</title>
346
335
    <variablelist>
360
349
      </varlistentry>
361
350
    </variablelist>
362
351
  </refsect1>
363
 
  
364
 
  <refsect1 id="files">
 
352
 
 
353
  <refsect1 id="file">
365
354
    <title>FILES</title>
366
355
    <para>
367
356
      Use the <option>--configdir</option> option to change where
431
420
      Currently, if a client is declared <quote>invalid</quote> due to
432
421
      having timed out, the server does not record this fact onto
433
422
      permanent storage.  This has some security implications, see
434
 
      <xref linkend="clients"/>.
 
423
      <xref linkend="CLIENTS"/>.
435
424
    </para>
436
425
    <para>
437
426
      There is currently no way of querying the server of the current
445
434
      Debug mode is conflated with running in the foreground.
446
435
    </para>
447
436
    <para>
448
 
      The console log messages do not show a time stamp.
 
437
      The console log messages does not show a time stamp.
449
438
    </para>
450
439
    <para>
451
440
      This server does not check the expire time of clients’ OpenPGP
490
479
      </para>
491
480
    </informalexample>
492
481
  </refsect1>
493
 
  
 
482
 
494
483
  <refsect1 id="security">
495
484
    <title>SECURITY</title>
496
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
497
486
      <title>SERVER</title>
498
487
      <para>
499
488
        Running this <command>&COMMANDNAME;</command> server program
502
491
        soon after startup.
503
492
      </para>
504
493
    </refsect2>
505
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
506
495
      <title>CLIENTS</title>
507
496
      <para>
508
497
        The server only gives out its stored data to clients which
515
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
516
505
        <manvolnum>5</manvolnum></citerefentry>)
517
506
        <emphasis>must</emphasis> be made non-readable by anyone
518
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
519
508
      </para>
520
509
      <para>
521
510
        As detailed in <xref linkend="checking"/>, the status of all
540
529
      </para>
541
530
      <para>
542
531
        For more details on client-side security, see
543
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
544
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
545
534
      </para>
546
535
    </refsect2>
547
536
  </refsect1>
548
 
  
 
537
 
549
538
  <refsect1 id="see_also">
550
539
    <title>SEE ALSO</title>
551
540
    <para>
554
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
555
544
        <refentrytitle>mandos.conf</refentrytitle>
556
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
557
 
        <refentrytitle>mandos-client</refentrytitle>
 
546
        <refentrytitle>password-request</refentrytitle>
558
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
559
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
560
549
      </citerefentry>