/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

Merge from Björn.

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 "2011-02-27">
 
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>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </copyright>
37
41
    <xi:include href="legalnotice.xml"/>
38
42
  </refentryinfo>
39
 
 
 
43
  
40
44
  <refmeta>
41
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
46
    <manvolnum>8</manvolnum>
48
52
      Gives encrypted passwords to authenticated Mandos clients
49
53
    </refpurpose>
50
54
  </refnamediv>
51
 
 
 
55
  
52
56
  <refsynopsisdiv>
53
57
    <cmdsynopsis>
54
58
      <command>&COMMANDNAME;</command>
83
87
      <replaceable>DIRECTORY</replaceable></option></arg>
84
88
      <sbr/>
85
89
      <arg><option>--debug</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--debuglevel
 
92
      <replaceable>LEVEL</replaceable></option></arg>
 
93
      <sbr/>
 
94
      <arg><option>--no-dbus</option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-ipv6</option></arg>
86
97
    </cmdsynopsis>
87
98
    <cmdsynopsis>
88
99
      <command>&COMMANDNAME;</command>
100
111
      <arg choice="plain"><option>--check</option></arg>
101
112
    </cmdsynopsis>
102
113
  </refsynopsisdiv>
103
 
 
 
114
  
104
115
  <refsect1 id="description">
105
116
    <title>DESCRIPTION</title>
106
117
    <para>
115
126
      Any authenticated client is then given the stored pre-encrypted
116
127
      password for that specific client.
117
128
    </para>
118
 
 
119
129
  </refsect1>
120
130
  
121
131
  <refsect1 id="purpose">
122
132
    <title>PURPOSE</title>
123
 
 
124
133
    <para>
125
134
      The purpose of this is to enable <emphasis>remote and unattended
126
135
      rebooting</emphasis> of client host computer with an
127
136
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
137
      linkend="overview"/> for details.
129
138
    </para>
130
 
    
131
139
  </refsect1>
132
140
  
133
141
  <refsect1 id="options">
134
142
    <title>OPTIONS</title>
135
 
    
136
143
    <variablelist>
137
144
      <varlistentry>
138
145
        <term><option>--help</option></term>
190
197
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
198
        </listitem>
192
199
      </varlistentry>
193
 
 
 
200
      
 
201
      <varlistentry>
 
202
        <term><option>--debuglevel
 
203
        <replaceable>LEVEL</replaceable></option></term>
 
204
        <listitem>
 
205
          <para>
 
206
            Set the debugging log level.
 
207
            <replaceable>LEVEL</replaceable> is a string, one of
 
208
            <quote><literal>CRITICAL</literal></quote>,
 
209
            <quote><literal>ERROR</literal></quote>,
 
210
            <quote><literal>WARNING</literal></quote>,
 
211
            <quote><literal>INFO</literal></quote>, or
 
212
            <quote><literal>DEBUG</literal></quote>, in order of
 
213
            increasing verbosity.  The default level is
 
214
            <quote><literal>WARNING</literal></quote>.
 
215
          </para>
 
216
        </listitem>
 
217
      </varlistentry>
 
218
      
194
219
      <varlistentry>
195
220
        <term><option>--priority <replaceable>
196
221
        PRIORITY</replaceable></option></term>
198
223
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
224
        </listitem>
200
225
      </varlistentry>
201
 
 
 
226
      
202
227
      <varlistentry>
203
228
        <term><option>--servicename
204
229
        <replaceable>NAME</replaceable></option></term>
207
232
                      xpointer="servicename"/>
208
233
        </listitem>
209
234
      </varlistentry>
210
 
 
 
235
      
211
236
      <varlistentry>
212
237
        <term><option>--configdir
213
238
        <replaceable>DIRECTORY</replaceable></option></term>
222
247
          </para>
223
248
        </listitem>
224
249
      </varlistentry>
225
 
 
 
250
      
226
251
      <varlistentry>
227
252
        <term><option>--version</option></term>
228
253
        <listitem>
231
256
          </para>
232
257
        </listitem>
233
258
      </varlistentry>
 
259
      
 
260
      <varlistentry>
 
261
        <term><option>--no-dbus</option></term>
 
262
        <listitem>
 
263
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
264
          <para>
 
265
            See also <xref linkend="dbus_interface"/>.
 
266
          </para>
 
267
        </listitem>
 
268
      </varlistentry>
 
269
      
 
270
      <varlistentry>
 
271
        <term><option>--no-ipv6</option></term>
 
272
        <listitem>
 
273
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
274
        </listitem>
 
275
      </varlistentry>
234
276
    </variablelist>
235
277
  </refsect1>
236
 
 
 
278
  
237
279
  <refsect1 id="overview">
238
280
    <title>OVERVIEW</title>
239
281
    <xi:include href="overview.xml"/>
240
282
    <para>
241
283
      This program is the server part.  It is a normal server program
242
284
      and will run in a normal system environment, not in an initial
243
 
      RAM disk environment.
 
285
      <acronym>RAM</acronym> disk environment.
244
286
    </para>
245
287
  </refsect1>
246
 
 
 
288
  
247
289
  <refsect1 id="protocol">
248
290
    <title>NETWORK PROTOCOL</title>
249
291
    <para>
301
343
      </row>
302
344
    </tbody></tgroup></table>
303
345
  </refsect1>
304
 
 
 
346
  
305
347
  <refsect1 id="checking">
306
348
    <title>CHECKING</title>
307
349
    <para>
308
350
      The server will, by default, continually check that the clients
309
351
      are still up.  If a client has not been confirmed as being up
310
352
      for some time, the client is assumed to be compromised and is no
311
 
      longer eligible to receive the encrypted password.  The timeout,
 
353
      longer eligible to receive the encrypted password.  (Manual
 
354
      intervention is required to re-enable a client.)  The timeout,
312
355
      checker program, and interval between checks can be configured
313
356
      both globally and per client; see <citerefentry>
314
357
      <refentrytitle>mandos-clients.conf</refentrytitle>
315
 
      <manvolnum>5</manvolnum></citerefentry>.
316
 
    </para>
317
 
  </refsect1>
318
 
 
 
358
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
359
      receiving its password will also be treated as a successful
 
360
      checker run.
 
361
    </para>
 
362
  </refsect1>
 
363
  
 
364
  <refsect1 id="approval">
 
365
    <title>APPROVAL</title>
 
366
    <para>
 
367
      The server can be configured to require manual approval for a
 
368
      client before it is sent its secret.  The delay to wait for such
 
369
      approval and the default action (approve or deny) can be
 
370
      configured both globally and per client; see <citerefentry>
 
371
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
372
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
373
      will be approved immediately without delay.
 
374
    </para>
 
375
    <para>
 
376
      This can be used to deny a client its secret if not manually
 
377
      approved within a specified time.  It can also be used to make
 
378
      the server delay before giving a client its secret, allowing
 
379
      optional manual denying of this specific client.
 
380
    </para>
 
381
    
 
382
  </refsect1>
 
383
  
319
384
  <refsect1 id="logging">
320
385
    <title>LOGGING</title>
321
386
    <para>
325
390
      and also show them on the console.
326
391
    </para>
327
392
  </refsect1>
328
 
 
 
393
  
 
394
  <refsect1 id="dbus_interface">
 
395
    <title>D-BUS INTERFACE</title>
 
396
    <para>
 
397
      The server will by default provide a D-Bus system bus interface.
 
398
      This interface will only be accessible by the root user or a
 
399
      Mandos-specific user, if such a user exists.  For documentation
 
400
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
401
    </para>
 
402
  </refsect1>
 
403
  
329
404
  <refsect1 id="exit_status">
330
405
    <title>EXIT STATUS</title>
331
406
    <para>
333
408
      critical error is encountered.
334
409
    </para>
335
410
  </refsect1>
336
 
 
 
411
  
337
412
  <refsect1 id="environment">
338
413
    <title>ENVIRONMENT</title>
339
414
    <variablelist>
353
428
      </varlistentry>
354
429
    </variablelist>
355
430
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
431
  
 
432
  <refsect1 id="files">
358
433
    <title>FILES</title>
359
434
    <para>
360
435
      Use the <option>--configdir</option> option to change where
383
458
        </listitem>
384
459
      </varlistentry>
385
460
      <varlistentry>
386
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
461
        <term><filename>/var/run/mandos.pid</filename></term>
387
462
        <listitem>
388
463
          <para>
389
 
            The file containing the process id of
390
 
            <command>&COMMANDNAME;</command>.
 
464
            The file containing the process id of the
 
465
            <command>&COMMANDNAME;</command> process started last.
391
466
          </para>
392
467
        </listitem>
393
468
      </varlistentry>
421
496
      backtrace.  This could be considered a feature.
422
497
    </para>
423
498
    <para>
424
 
      Currently, if a client is declared <quote>invalid</quote> due to
425
 
      having timed out, the server does not record this fact onto
426
 
      permanent storage.  This has some security implications, see
427
 
      <xref linkend="CLIENTS"/>.
428
 
    </para>
429
 
    <para>
430
 
      There is currently no way of querying the server of the current
431
 
      status of clients, other than analyzing its <systemitem
432
 
      class="service">syslog</systemitem> output.
 
499
      Currently, if a client is disabled due to having timed out, the
 
500
      server does not record this fact onto permanent storage.  This
 
501
      has some security implications, see <xref linkend="clients"/>.
433
502
    </para>
434
503
    <para>
435
504
      There is no fine-grained control over logging and debug output.
438
507
      Debug mode is conflated with running in the foreground.
439
508
    </para>
440
509
    <para>
441
 
      The console log messages does not show a timestamp.
 
510
      The console log messages do not show a time stamp.
 
511
    </para>
 
512
    <para>
 
513
      This server does not check the expire time of clients’ OpenPGP
 
514
      keys.
442
515
    </para>
443
516
  </refsect1>
444
517
  
479
552
      </para>
480
553
    </informalexample>
481
554
  </refsect1>
482
 
 
 
555
  
483
556
  <refsect1 id="security">
484
557
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
558
    <refsect2 id="server">
486
559
      <title>SERVER</title>
487
560
      <para>
488
561
        Running this <command>&COMMANDNAME;</command> server program
489
562
        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.
 
563
        computer running it.  The program switches to a non-root user
 
564
        soon after startup.
492
565
      </para>
493
566
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
567
    <refsect2 id="clients">
495
568
      <title>CLIENTS</title>
496
569
      <para>
497
570
        The server only gives out its stored data to clients which
504
577
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
578
        <manvolnum>5</manvolnum></citerefentry>)
506
579
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
580
        except the user starting the server (usually root).
508
581
      </para>
509
582
      <para>
510
583
        As detailed in <xref linkend="checking"/>, the status of all
513
586
      </para>
514
587
      <para>
515
588
        If a client is compromised, its downtime should be duly noted
516
 
        by the server which would therefore declare the client
517
 
        invalid.  But if the server was ever restarted, it would
518
 
        re-read its client list from its configuration file and again
519
 
        regard all clients therein as valid, and hence eligible to
520
 
        receive their passwords.  Therefore, be careful when
521
 
        restarting servers if it is suspected that a client has, in
522
 
        fact, been compromised by parties who may now be running a
523
 
        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
527
 
        configuration file to omit any suspect clients, and restart
528
 
        the server program.
 
589
        by the server which would therefore disable the client.  But
 
590
        if the server was ever restarted, it would re-read its client
 
591
        list from its configuration file and again regard all clients
 
592
        therein as enabled, and hence eligible to receive their
 
593
        passwords.  Therefore, be careful when restarting servers if
 
594
        it is suspected that a client has, in fact, been compromised
 
595
        by parties who may now be running a fake Mandos client with
 
596
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
597
        image of the client host.  What should be done in that case
 
598
        (if restarting the server program really is necessary) is to
 
599
        stop the server program, edit the configuration file to omit
 
600
        any suspect clients, and restart the server program.
529
601
      </para>
530
602
      <para>
531
603
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
604
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
605
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
606
      </para>
535
607
    </refsect2>
536
608
  </refsect1>
537
 
 
 
609
  
538
610
  <refsect1 id="see_also">
539
611
    <title>SEE ALSO</title>
540
612
    <para>
543
615
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
616
        <refentrytitle>mandos.conf</refentrytitle>
545
617
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
 
618
        <refentrytitle>mandos-client</refentrytitle>
547
619
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
620
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
621
      </citerefentry>