/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-10-05 17:38:31 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081005173831-fysrfayl4yvhlo6x
* INSTALL: Add instructions on how to set the correct network
           interface on the cient, and also how to test the server and
           verify the password.

* TODO: Clean up old stuff.

* debian/mandos-client.README.Debian: Separate into sections with
                                      headlines.  Add instructions on
                                      how to test the server and
                                      verify the password.

* plugin-runner.conf: Add reminder to update initrd image.

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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-09-01">
 
5
<!ENTITY TIMESTAMP "2008-10-03">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
36
37
    </copyright>
37
38
    <xi:include href="legalnotice.xml"/>
38
39
  </refentryinfo>
39
 
 
 
40
  
40
41
  <refmeta>
41
42
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
43
    <manvolnum>8</manvolnum>
48
49
      Gives encrypted passwords to authenticated Mandos clients
49
50
    </refpurpose>
50
51
  </refnamediv>
51
 
 
 
52
  
52
53
  <refsynopsisdiv>
53
54
    <cmdsynopsis>
54
55
      <command>&COMMANDNAME;</command>
100
101
      <arg choice="plain"><option>--check</option></arg>
101
102
    </cmdsynopsis>
102
103
  </refsynopsisdiv>
103
 
 
 
104
  
104
105
  <refsect1 id="description">
105
106
    <title>DESCRIPTION</title>
106
107
    <para>
115
116
      Any authenticated client is then given the stored pre-encrypted
116
117
      password for that specific client.
117
118
    </para>
118
 
 
119
119
  </refsect1>
120
120
  
121
121
  <refsect1 id="purpose">
122
122
    <title>PURPOSE</title>
123
 
 
124
123
    <para>
125
124
      The purpose of this is to enable <emphasis>remote and unattended
126
125
      rebooting</emphasis> of client host computer with an
127
126
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
127
      linkend="overview"/> for details.
129
128
    </para>
130
 
    
131
129
  </refsect1>
132
130
  
133
131
  <refsect1 id="options">
134
132
    <title>OPTIONS</title>
135
 
    
136
133
    <variablelist>
137
134
      <varlistentry>
138
135
        <term><option>--help</option></term>
190
187
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
188
        </listitem>
192
189
      </varlistentry>
193
 
 
 
190
      
194
191
      <varlistentry>
195
192
        <term><option>--priority <replaceable>
196
193
        PRIORITY</replaceable></option></term>
198
195
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
196
        </listitem>
200
197
      </varlistentry>
201
 
 
 
198
      
202
199
      <varlistentry>
203
200
        <term><option>--servicename
204
201
        <replaceable>NAME</replaceable></option></term>
207
204
                      xpointer="servicename"/>
208
205
        </listitem>
209
206
      </varlistentry>
210
 
 
 
207
      
211
208
      <varlistentry>
212
209
        <term><option>--configdir
213
210
        <replaceable>DIRECTORY</replaceable></option></term>
222
219
          </para>
223
220
        </listitem>
224
221
      </varlistentry>
225
 
 
 
222
      
226
223
      <varlistentry>
227
224
        <term><option>--version</option></term>
228
225
        <listitem>
233
230
      </varlistentry>
234
231
    </variablelist>
235
232
  </refsect1>
236
 
 
 
233
  
237
234
  <refsect1 id="overview">
238
235
    <title>OVERVIEW</title>
239
236
    <xi:include href="overview.xml"/>
243
240
      <acronym>RAM</acronym> disk environment.
244
241
    </para>
245
242
  </refsect1>
246
 
 
 
243
  
247
244
  <refsect1 id="protocol">
248
245
    <title>NETWORK PROTOCOL</title>
249
246
    <para>
301
298
      </row>
302
299
    </tbody></tgroup></table>
303
300
  </refsect1>
304
 
 
 
301
  
305
302
  <refsect1 id="checking">
306
303
    <title>CHECKING</title>
307
304
    <para>
315
312
      <manvolnum>5</manvolnum></citerefentry>.
316
313
    </para>
317
314
  </refsect1>
318
 
 
 
315
  
319
316
  <refsect1 id="logging">
320
317
    <title>LOGGING</title>
321
318
    <para>
325
322
      and also show them on the console.
326
323
    </para>
327
324
  </refsect1>
328
 
 
 
325
  
329
326
  <refsect1 id="exit_status">
330
327
    <title>EXIT STATUS</title>
331
328
    <para>
333
330
      critical error is encountered.
334
331
    </para>
335
332
  </refsect1>
336
 
 
 
333
  
337
334
  <refsect1 id="environment">
338
335
    <title>ENVIRONMENT</title>
339
336
    <variablelist>
353
350
      </varlistentry>
354
351
    </variablelist>
355
352
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
353
  
 
354
  <refsect1 id="files">
358
355
    <title>FILES</title>
359
356
    <para>
360
357
      Use the <option>--configdir</option> option to change where
383
380
        </listitem>
384
381
      </varlistentry>
385
382
      <varlistentry>
386
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
383
        <term><filename>/var/run/mandos.pid</filename></term>
387
384
        <listitem>
388
385
          <para>
389
386
            The file containing the process id of
424
421
      Currently, if a client is declared <quote>invalid</quote> due to
425
422
      having timed out, the server does not record this fact onto
426
423
      permanent storage.  This has some security implications, see
427
 
      <xref linkend="CLIENTS"/>.
 
424
      <xref linkend="clients"/>.
428
425
    </para>
429
426
    <para>
430
427
      There is currently no way of querying the server of the current
438
435
      Debug mode is conflated with running in the foreground.
439
436
    </para>
440
437
    <para>
441
 
      The console log messages does not show a timestamp.
 
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.
442
443
    </para>
443
444
  </refsect1>
444
445
  
479
480
      </para>
480
481
    </informalexample>
481
482
  </refsect1>
482
 
 
 
483
  
483
484
  <refsect1 id="security">
484
485
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
486
    <refsect2 id="server">
486
487
      <title>SERVER</title>
487
488
      <para>
488
489
        Running this <command>&COMMANDNAME;</command> server program
489
490
        should not in itself present any security risk to the host
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.
 
491
        computer running it.  The program switches to a non-root user
 
492
        soon after startup.
492
493
      </para>
493
494
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
495
    <refsect2 id="clients">
495
496
      <title>CLIENTS</title>
496
497
      <para>
497
498
        The server only gives out its stored data to clients which
504
505
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
506
        <manvolnum>5</manvolnum></citerefentry>)
506
507
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
508
        except the user starting the server (usually root).
508
509
      </para>
509
510
      <para>
510
511
        As detailed in <xref linkend="checking"/>, the status of all
529
530
      </para>
530
531
      <para>
531
532
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
533
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
535
      </para>
535
536
    </refsect2>
536
537
  </refsect1>
537
 
 
 
538
  
538
539
  <refsect1 id="see_also">
539
540
    <title>SEE ALSO</title>
540
541
    <para>
543
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
545
        <refentrytitle>mandos.conf</refentrytitle>
545
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
 
547
        <refentrytitle>mandos-client</refentrytitle>
547
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
550
      </citerefentry>