/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-01 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

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-12-28">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-01">
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>
84
83
      <replaceable>DIRECTORY</replaceable></option></arg>
85
84
      <sbr/>
86
85
      <arg><option>--debug</option></arg>
87
 
      <sbr/>
88
 
      <arg><option>--no-dbus</option></arg>
89
86
    </cmdsynopsis>
90
87
    <cmdsynopsis>
91
88
      <command>&COMMANDNAME;</command>
103
100
      <arg choice="plain"><option>--check</option></arg>
104
101
    </cmdsynopsis>
105
102
  </refsynopsisdiv>
106
 
  
 
103
 
107
104
  <refsect1 id="description">
108
105
    <title>DESCRIPTION</title>
109
106
    <para>
118
115
      Any authenticated client is then given the stored pre-encrypted
119
116
      password for that specific client.
120
117
    </para>
 
118
 
121
119
  </refsect1>
122
120
  
123
121
  <refsect1 id="purpose">
124
122
    <title>PURPOSE</title>
 
123
 
125
124
    <para>
126
125
      The purpose of this is to enable <emphasis>remote and unattended
127
126
      rebooting</emphasis> of client host computer with an
128
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
129
128
      linkend="overview"/> for details.
130
129
    </para>
 
130
    
131
131
  </refsect1>
132
132
  
133
133
  <refsect1 id="options">
134
134
    <title>OPTIONS</title>
 
135
    
135
136
    <variablelist>
136
137
      <varlistentry>
137
138
        <term><option>--help</option></term>
189
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
191
        </listitem>
191
192
      </varlistentry>
192
 
      
 
193
 
193
194
      <varlistentry>
194
195
        <term><option>--priority <replaceable>
195
196
        PRIORITY</replaceable></option></term>
197
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
199
        </listitem>
199
200
      </varlistentry>
200
 
      
 
201
 
201
202
      <varlistentry>
202
203
        <term><option>--servicename
203
204
        <replaceable>NAME</replaceable></option></term>
206
207
                      xpointer="servicename"/>
207
208
        </listitem>
208
209
      </varlistentry>
209
 
      
 
210
 
210
211
      <varlistentry>
211
212
        <term><option>--configdir
212
213
        <replaceable>DIRECTORY</replaceable></option></term>
221
222
          </para>
222
223
        </listitem>
223
224
      </varlistentry>
224
 
      
 
225
 
225
226
      <varlistentry>
226
227
        <term><option>--version</option></term>
227
228
        <listitem>
230
231
          </para>
231
232
        </listitem>
232
233
      </varlistentry>
233
 
      
234
 
      <varlistentry>
235
 
        <term><option>--no-dbus</option></term>
236
 
        <listitem>
237
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
238
 
          <para>
239
 
            See also <xref linkend="dbus"/>.
240
 
        </listitem>
241
 
      </varlistentry>
242
234
    </variablelist>
243
235
  </refsect1>
244
 
  
 
236
 
245
237
  <refsect1 id="overview">
246
238
    <title>OVERVIEW</title>
247
239
    <xi:include href="overview.xml"/>
251
243
      <acronym>RAM</acronym> disk environment.
252
244
    </para>
253
245
  </refsect1>
254
 
  
 
246
 
255
247
  <refsect1 id="protocol">
256
248
    <title>NETWORK PROTOCOL</title>
257
249
    <para>
309
301
      </row>
310
302
    </tbody></tgroup></table>
311
303
  </refsect1>
312
 
  
 
304
 
313
305
  <refsect1 id="checking">
314
306
    <title>CHECKING</title>
315
307
    <para>
323
315
      <manvolnum>5</manvolnum></citerefentry>.
324
316
    </para>
325
317
  </refsect1>
326
 
  
 
318
 
327
319
  <refsect1 id="logging">
328
320
    <title>LOGGING</title>
329
321
    <para>
333
325
      and also show them on the console.
334
326
    </para>
335
327
  </refsect1>
336
 
  
337
 
  <refsect1 id="dbus">
338
 
    <title>D-BUS INTERFACE</title>
339
 
    <para>
340
 
      The server will by default provide a D-Bus system bus interface.
341
 
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
344
 
    </para>
345
 
  </refsect1>
346
328
 
347
329
  <refsect1 id="exit_status">
348
330
    <title>EXIT STATUS</title>
351
333
      critical error is encountered.
352
334
    </para>
353
335
  </refsect1>
354
 
  
 
336
 
355
337
  <refsect1 id="environment">
356
338
    <title>ENVIRONMENT</title>
357
339
    <variablelist>
371
353
      </varlistentry>
372
354
    </variablelist>
373
355
  </refsect1>
374
 
  
375
 
  <refsect1 id="files">
 
356
 
 
357
  <refsect1 id="file">
376
358
    <title>FILES</title>
377
359
    <para>
378
360
      Use the <option>--configdir</option> option to change where
401
383
        </listitem>
402
384
      </varlistentry>
403
385
      <varlistentry>
404
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
386
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
405
387
        <listitem>
406
388
          <para>
407
389
            The file containing the process id of
442
424
      Currently, if a client is declared <quote>invalid</quote> due to
443
425
      having timed out, the server does not record this fact onto
444
426
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="clients"/>.
 
427
      <xref linkend="CLIENTS"/>.
446
428
    </para>
447
429
    <para>
448
430
      There is currently no way of querying the server of the current
456
438
      Debug mode is conflated with running in the foreground.
457
439
    </para>
458
440
    <para>
459
 
      The console log messages does not show a time stamp.
460
 
    </para>
461
 
    <para>
462
 
      This server does not check the expire time of clients’ OpenPGP
463
 
      keys.
 
441
      The console log messages does not show a timestamp.
464
442
    </para>
465
443
  </refsect1>
466
444
  
501
479
      </para>
502
480
    </informalexample>
503
481
  </refsect1>
504
 
  
 
482
 
505
483
  <refsect1 id="security">
506
484
    <title>SECURITY</title>
507
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
508
486
      <title>SERVER</title>
509
487
      <para>
510
488
        Running this <command>&COMMANDNAME;</command> server program
511
489
        should not in itself present any security risk to the host
512
 
        computer running it.  The program switches to a non-root user
513
 
        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.
514
492
      </para>
515
493
    </refsect2>
516
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
517
495
      <title>CLIENTS</title>
518
496
      <para>
519
497
        The server only gives out its stored data to clients which
526
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
505
        <manvolnum>5</manvolnum></citerefentry>)
528
506
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
530
508
      </para>
531
509
      <para>
532
510
        As detailed in <xref linkend="checking"/>, the status of all
551
529
      </para>
552
530
      <para>
553
531
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
555
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
534
      </para>
557
535
    </refsect2>
558
536
  </refsect1>
559
 
  
 
537
 
560
538
  <refsect1 id="see_also">
561
539
    <title>SEE ALSO</title>
562
540
    <para>
565
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
544
        <refentrytitle>mandos.conf</refentrytitle>
567
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>mandos-client</refentrytitle>
 
546
        <refentrytitle>password-request</refentrytitle>
569
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
549
      </citerefentry>