/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: 2009-02-25 01:21:37 UTC
  • mfrom: (237.2.86 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20090225012137-2pgnggykq7zhy2i0
Merge from trunk.  Bug fix for initramfs-tools-hook.

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-08-31">
 
5
<!ENTITY TIMESTAMP "2009-02-24">
 
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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
37
39
    <xi:include href="legalnotice.xml"/>
38
40
  </refentryinfo>
39
 
 
 
41
  
40
42
  <refmeta>
41
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
44
    <manvolnum>8</manvolnum>
48
50
      Gives encrypted passwords to authenticated Mandos clients
49
51
    </refpurpose>
50
52
  </refnamediv>
51
 
 
 
53
  
52
54
  <refsynopsisdiv>
53
55
    <cmdsynopsis>
54
56
      <command>&COMMANDNAME;</command>
83
85
      <replaceable>DIRECTORY</replaceable></option></arg>
84
86
      <sbr/>
85
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-ipv6</option></arg>
86
90
    </cmdsynopsis>
87
91
    <cmdsynopsis>
88
92
      <command>&COMMANDNAME;</command>
100
104
      <arg choice="plain"><option>--check</option></arg>
101
105
    </cmdsynopsis>
102
106
  </refsynopsisdiv>
103
 
 
 
107
  
104
108
  <refsect1 id="description">
105
109
    <title>DESCRIPTION</title>
106
110
    <para>
115
119
      Any authenticated client is then given the stored pre-encrypted
116
120
      password for that specific client.
117
121
    </para>
118
 
 
119
122
  </refsect1>
120
123
  
121
124
  <refsect1 id="purpose">
122
125
    <title>PURPOSE</title>
123
 
 
124
126
    <para>
125
127
      The purpose of this is to enable <emphasis>remote and unattended
126
128
      rebooting</emphasis> of client host computer with an
127
129
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
130
      linkend="overview"/> for details.
129
131
    </para>
130
 
    
131
132
  </refsect1>
132
133
  
133
134
  <refsect1 id="options">
134
135
    <title>OPTIONS</title>
135
 
    
136
136
    <variablelist>
137
137
      <varlistentry>
138
138
        <term><option>--help</option></term>
190
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
191
        </listitem>
192
192
      </varlistentry>
193
 
 
 
193
      
194
194
      <varlistentry>
195
195
        <term><option>--priority <replaceable>
196
196
        PRIORITY</replaceable></option></term>
198
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
199
        </listitem>
200
200
      </varlistentry>
201
 
 
 
201
      
202
202
      <varlistentry>
203
203
        <term><option>--servicename
204
204
        <replaceable>NAME</replaceable></option></term>
207
207
                      xpointer="servicename"/>
208
208
        </listitem>
209
209
      </varlistentry>
210
 
 
 
210
      
211
211
      <varlistentry>
212
212
        <term><option>--configdir
213
213
        <replaceable>DIRECTORY</replaceable></option></term>
222
222
          </para>
223
223
        </listitem>
224
224
      </varlistentry>
225
 
 
 
225
      
226
226
      <varlistentry>
227
227
        <term><option>--version</option></term>
228
228
        <listitem>
231
231
          </para>
232
232
        </listitem>
233
233
      </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>
234
241
    </variablelist>
235
242
  </refsect1>
236
 
 
 
243
  
237
244
  <refsect1 id="overview">
238
245
    <title>OVERVIEW</title>
239
246
    <xi:include href="overview.xml"/>
240
247
    <para>
241
248
      This program is the server part.  It is a normal server program
242
249
      and will run in a normal system environment, not in an initial
243
 
      RAM disk environment.
 
250
      <acronym>RAM</acronym> disk environment.
244
251
    </para>
245
252
  </refsect1>
246
 
 
 
253
  
247
254
  <refsect1 id="protocol">
248
255
    <title>NETWORK PROTOCOL</title>
249
256
    <para>
301
308
      </row>
302
309
    </tbody></tgroup></table>
303
310
  </refsect1>
304
 
 
 
311
  
305
312
  <refsect1 id="checking">
306
313
    <title>CHECKING</title>
307
314
    <para>
315
322
      <manvolnum>5</manvolnum></citerefentry>.
316
323
    </para>
317
324
  </refsect1>
318
 
 
 
325
  
319
326
  <refsect1 id="logging">
320
327
    <title>LOGGING</title>
321
328
    <para>
325
332
      and also show them on the console.
326
333
    </para>
327
334
  </refsect1>
328
 
 
 
335
  
329
336
  <refsect1 id="exit_status">
330
337
    <title>EXIT STATUS</title>
331
338
    <para>
333
340
      critical error is encountered.
334
341
    </para>
335
342
  </refsect1>
336
 
 
 
343
  
337
344
  <refsect1 id="environment">
338
345
    <title>ENVIRONMENT</title>
339
346
    <variablelist>
353
360
      </varlistentry>
354
361
    </variablelist>
355
362
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
363
  
 
364
  <refsect1 id="files">
358
365
    <title>FILES</title>
359
366
    <para>
360
367
      Use the <option>--configdir</option> option to change where
383
390
        </listitem>
384
391
      </varlistentry>
385
392
      <varlistentry>
386
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
393
        <term><filename>/var/run/mandos.pid</filename></term>
387
394
        <listitem>
388
395
          <para>
389
396
            The file containing the process id of
424
431
      Currently, if a client is declared <quote>invalid</quote> due to
425
432
      having timed out, the server does not record this fact onto
426
433
      permanent storage.  This has some security implications, see
427
 
      <xref linkend="CLIENTS"/>.
 
434
      <xref linkend="clients"/>.
428
435
    </para>
429
436
    <para>
430
437
      There is currently no way of querying the server of the current
438
445
      Debug mode is conflated with running in the foreground.
439
446
    </para>
440
447
    <para>
441
 
      The console log messages does not show a timestamp.
 
448
      The console log messages do not show a time stamp.
 
449
    </para>
 
450
    <para>
 
451
      This server does not check the expire time of clients’ OpenPGP
 
452
      keys.
442
453
    </para>
443
454
  </refsect1>
444
455
  
479
490
      </para>
480
491
    </informalexample>
481
492
  </refsect1>
482
 
 
 
493
  
483
494
  <refsect1 id="security">
484
495
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
496
    <refsect2 id="server">
486
497
      <title>SERVER</title>
487
498
      <para>
488
499
        Running this <command>&COMMANDNAME;</command> server program
489
500
        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.
 
501
        computer running it.  The program switches to a non-root user
 
502
        soon after startup.
492
503
      </para>
493
504
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
505
    <refsect2 id="clients">
495
506
      <title>CLIENTS</title>
496
507
      <para>
497
508
        The server only gives out its stored data to clients which
504
515
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
516
        <manvolnum>5</manvolnum></citerefentry>)
506
517
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
518
        except the user starting the server (usually root).
508
519
      </para>
509
520
      <para>
510
521
        As detailed in <xref linkend="checking"/>, the status of all
521
532
        restarting servers if it is suspected that a client has, in
522
533
        fact, been compromised by parties who may now be running a
523
534
        fake Mandos client with the keys from the non-encrypted
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
 
535
        initial <acronym>RAM</acronym> image of the client host.  What
 
536
        should be done in that case (if restarting the server program
 
537
        really is necessary) is to stop the server program, edit the
527
538
        configuration file to omit any suspect clients, and restart
528
539
        the server program.
529
540
      </para>
530
541
      <para>
531
542
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
543
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
544
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
545
      </para>
535
546
    </refsect2>
536
547
  </refsect1>
537
 
 
 
548
  
538
549
  <refsect1 id="see_also">
539
550
    <title>SEE ALSO</title>
540
551
    <para>
543
554
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
555
        <refentrytitle>mandos.conf</refentrytitle>
545
556
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
 
557
        <refentrytitle>mandos-client</refentrytitle>
547
558
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
559
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
560
      </citerefentry>