/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

* initramfs-tools-hook: Only copy needed file; avoid copying Mandos
                        server config files.

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 "2009-09-17">
 
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"/>
243
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>
308
315
      The server will, by default, continually check that the clients
309
316
      are still up.  If a client has not been confirmed as being up
310
317
      for some time, the client is assumed to be compromised and is no
311
 
      longer eligible to receive the encrypted password.  The timeout,
 
318
      longer eligible to receive the encrypted password.  (Manual
 
319
      intervention is required to re-enable a client.)  The timeout,
312
320
      checker program, and interval between checks can be configured
313
321
      both globally and per client; see <citerefentry>
314
322
      <refentrytitle>mandos-clients.conf</refentrytitle>
315
 
      <manvolnum>5</manvolnum></citerefentry>.
 
323
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
324
      receiving its password will also be treated as a successful
 
325
      checker run.
316
326
    </para>
317
327
  </refsect1>
318
 
 
 
328
  
319
329
  <refsect1 id="logging">
320
330
    <title>LOGGING</title>
321
331
    <para>
325
335
      and also show them on the console.
326
336
    </para>
327
337
  </refsect1>
328
 
 
 
338
  
329
339
  <refsect1 id="exit_status">
330
340
    <title>EXIT STATUS</title>
331
341
    <para>
333
343
      critical error is encountered.
334
344
    </para>
335
345
  </refsect1>
336
 
 
 
346
  
337
347
  <refsect1 id="environment">
338
348
    <title>ENVIRONMENT</title>
339
349
    <variablelist>
353
363
      </varlistentry>
354
364
    </variablelist>
355
365
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
366
  
 
367
  <refsect1 id="files">
358
368
    <title>FILES</title>
359
369
    <para>
360
370
      Use the <option>--configdir</option> option to change where
383
393
        </listitem>
384
394
      </varlistentry>
385
395
      <varlistentry>
386
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
396
        <term><filename>/var/run/mandos.pid</filename></term>
387
397
        <listitem>
388
398
          <para>
389
399
            The file containing the process id of
424
434
      Currently, if a client is declared <quote>invalid</quote> due to
425
435
      having timed out, the server does not record this fact onto
426
436
      permanent storage.  This has some security implications, see
427
 
      <xref linkend="CLIENTS"/>.
 
437
      <xref linkend="clients"/>.
428
438
    </para>
429
439
    <para>
430
440
      There is currently no way of querying the server of the current
438
448
      Debug mode is conflated with running in the foreground.
439
449
    </para>
440
450
    <para>
441
 
      The console log messages does not show a timestamp.
 
451
      The console log messages do not show a time stamp.
 
452
    </para>
 
453
    <para>
 
454
      This server does not check the expire time of clients’ OpenPGP
 
455
      keys.
442
456
    </para>
443
457
  </refsect1>
444
458
  
479
493
      </para>
480
494
    </informalexample>
481
495
  </refsect1>
482
 
 
 
496
  
483
497
  <refsect1 id="security">
484
498
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
499
    <refsect2 id="server">
486
500
      <title>SERVER</title>
487
501
      <para>
488
502
        Running this <command>&COMMANDNAME;</command> server program
489
503
        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.
 
504
        computer running it.  The program switches to a non-root user
 
505
        soon after startup.
492
506
      </para>
493
507
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
508
    <refsect2 id="clients">
495
509
      <title>CLIENTS</title>
496
510
      <para>
497
511
        The server only gives out its stored data to clients which
504
518
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
519
        <manvolnum>5</manvolnum></citerefentry>)
506
520
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
521
        except the user starting the server (usually root).
508
522
      </para>
509
523
      <para>
510
524
        As detailed in <xref linkend="checking"/>, the status of all
529
543
      </para>
530
544
      <para>
531
545
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
546
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
547
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
548
      </para>
535
549
    </refsect2>
536
550
  </refsect1>
537
 
 
 
551
  
538
552
  <refsect1 id="see_also">
539
553
    <title>SEE ALSO</title>
540
554
    <para>
543
557
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
558
        <refentrytitle>mandos.conf</refentrytitle>
545
559
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
 
560
        <refentrytitle>mandos-client</refentrytitle>
547
561
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
562
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
563
      </citerefentry>