/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-08-31 15:06:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831150639-tqdkyea3b9p3rou7
* Makefile: Make all DocBook rules include legalnotice.xml as a
            dependency.

* legalnotice.xml: New file with just the <legalnotice> tag in it.

* mandos-clients.conf.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".
* mandos-keygen.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos-conf.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos.xml (/refentry/refentryinfo/legalnotice): - '' -

* overview.xml: Changed root node tag name in DOCTYPE declaration.

* plugin-runner.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-prompt.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-request.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-08-31">
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>
116
115
      Any authenticated client is then given the stored pre-encrypted
117
116
      password for that specific client.
118
117
    </para>
 
118
 
119
119
  </refsect1>
120
120
  
121
121
  <refsect1 id="purpose">
122
122
    <title>PURPOSE</title>
 
123
 
123
124
    <para>
124
125
      The purpose of this is to enable <emphasis>remote and unattended
125
126
      rebooting</emphasis> of client host computer with an
126
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
127
128
      linkend="overview"/> for details.
128
129
    </para>
 
130
    
129
131
  </refsect1>
130
132
  
131
133
  <refsect1 id="options">
132
134
    <title>OPTIONS</title>
 
135
    
133
136
    <variablelist>
134
137
      <varlistentry>
135
138
        <term><option>--help</option></term>
187
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
188
191
        </listitem>
189
192
      </varlistentry>
190
 
      
 
193
 
191
194
      <varlistentry>
192
195
        <term><option>--priority <replaceable>
193
196
        PRIORITY</replaceable></option></term>
195
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
196
199
        </listitem>
197
200
      </varlistentry>
198
 
      
 
201
 
199
202
      <varlistentry>
200
203
        <term><option>--servicename
201
204
        <replaceable>NAME</replaceable></option></term>
204
207
                      xpointer="servicename"/>
205
208
        </listitem>
206
209
      </varlistentry>
207
 
      
 
210
 
208
211
      <varlistentry>
209
212
        <term><option>--configdir
210
213
        <replaceable>DIRECTORY</replaceable></option></term>
219
222
          </para>
220
223
        </listitem>
221
224
      </varlistentry>
222
 
      
 
225
 
223
226
      <varlistentry>
224
227
        <term><option>--version</option></term>
225
228
        <listitem>
230
233
      </varlistentry>
231
234
    </variablelist>
232
235
  </refsect1>
233
 
  
 
236
 
234
237
  <refsect1 id="overview">
235
238
    <title>OVERVIEW</title>
236
239
    <xi:include href="overview.xml"/>
237
240
    <para>
238
241
      This program is the server part.  It is a normal server program
239
242
      and will run in a normal system environment, not in an initial
240
 
      <acronym>RAM</acronym> disk environment.
 
243
      RAM disk environment.
241
244
    </para>
242
245
  </refsect1>
243
 
  
 
246
 
244
247
  <refsect1 id="protocol">
245
248
    <title>NETWORK PROTOCOL</title>
246
249
    <para>
298
301
      </row>
299
302
    </tbody></tgroup></table>
300
303
  </refsect1>
301
 
  
 
304
 
302
305
  <refsect1 id="checking">
303
306
    <title>CHECKING</title>
304
307
    <para>
312
315
      <manvolnum>5</manvolnum></citerefentry>.
313
316
    </para>
314
317
  </refsect1>
315
 
  
 
318
 
316
319
  <refsect1 id="logging">
317
320
    <title>LOGGING</title>
318
321
    <para>
322
325
      and also show them on the console.
323
326
    </para>
324
327
  </refsect1>
325
 
  
 
328
 
326
329
  <refsect1 id="exit_status">
327
330
    <title>EXIT STATUS</title>
328
331
    <para>
330
333
      critical error is encountered.
331
334
    </para>
332
335
  </refsect1>
333
 
  
 
336
 
334
337
  <refsect1 id="environment">
335
338
    <title>ENVIRONMENT</title>
336
339
    <variablelist>
350
353
      </varlistentry>
351
354
    </variablelist>
352
355
  </refsect1>
353
 
  
 
356
 
354
357
  <refsect1 id="file">
355
358
    <title>FILES</title>
356
359
    <para>
380
383
        </listitem>
381
384
      </varlistentry>
382
385
      <varlistentry>
383
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
386
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
384
387
        <listitem>
385
388
          <para>
386
389
            The file containing the process id of
435
438
      Debug mode is conflated with running in the foreground.
436
439
    </para>
437
440
    <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.
 
441
      The console log messages does not show a timestamp.
443
442
    </para>
444
443
  </refsect1>
445
444
  
480
479
      </para>
481
480
    </informalexample>
482
481
  </refsect1>
483
 
  
 
482
 
484
483
  <refsect1 id="security">
485
484
    <title>SECURITY</title>
486
485
    <refsect2 id="SERVER">
488
487
      <para>
489
488
        Running this <command>&COMMANDNAME;</command> server program
490
489
        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.
 
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.
493
492
      </para>
494
493
    </refsect2>
495
494
    <refsect2 id="CLIENTS">
505
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
505
        <manvolnum>5</manvolnum></citerefentry>)
507
506
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
509
508
      </para>
510
509
      <para>
511
510
        As detailed in <xref linkend="checking"/>, the status of all
522
521
        restarting servers if it is suspected that a client has, in
523
522
        fact, been compromised by parties who may now be running a
524
523
        fake Mandos client with the keys from the non-encrypted
525
 
        initial <acronym>RAM</acronym> image of the client host.  What
526
 
        should be done in that case (if restarting the server program
527
 
        really is necessary) is to stop the server program, edit the
 
524
        initial RAM image of the client host.  What should be done in
 
525
        that case (if restarting the server program really is
 
526
        necessary) is to stop the server program, edit the
528
527
        configuration file to omit any suspect clients, and restart
529
528
        the server program.
530
529
      </para>
531
530
      <para>
532
531
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
534
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
534
      </para>
536
535
    </refsect2>
537
536
  </refsect1>
538
 
  
 
537
 
539
538
  <refsect1 id="see_also">
540
539
    <title>SEE ALSO</title>
541
540
    <para>
544
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
544
        <refentrytitle>mandos.conf</refentrytitle>
546
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>mandos-client</refentrytitle>
 
546
        <refentrytitle>password-request</refentrytitle>
548
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
549
      </citerefentry>