/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

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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2011-11-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-01">
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>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
37
    <xi:include href="legalnotice.xml"/>
42
38
  </refentryinfo>
43
 
  
 
39
 
44
40
  <refmeta>
45
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
42
    <manvolnum>8</manvolnum>
52
48
      Gives encrypted passwords to authenticated Mandos clients
53
49
    </refpurpose>
54
50
  </refnamediv>
55
 
  
 
51
 
56
52
  <refsynopsisdiv>
57
53
    <cmdsynopsis>
58
54
      <command>&COMMANDNAME;</command>
87
83
      <replaceable>DIRECTORY</replaceable></option></arg>
88
84
      <sbr/>
89
85
      <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>
97
 
      <sbr/>
98
 
      <arg><option>--no-restore</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--statedir
101
 
      <replaceable>DIRECTORY</replaceable></option></arg>
102
86
    </cmdsynopsis>
103
87
    <cmdsynopsis>
104
88
      <command>&COMMANDNAME;</command>
116
100
      <arg choice="plain"><option>--check</option></arg>
117
101
    </cmdsynopsis>
118
102
  </refsynopsisdiv>
119
 
  
 
103
 
120
104
  <refsect1 id="description">
121
105
    <title>DESCRIPTION</title>
122
106
    <para>
123
107
      <command>&COMMANDNAME;</command> is a server daemon which
124
108
      handles incoming request for passwords for a pre-defined list of
125
 
      client host computers. For an introduction, see
126
 
      <citerefentry><refentrytitle>intro</refentrytitle>
127
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
128
 
      uses Zeroconf to announce itself on the local network, and uses
129
 
      TLS to communicate securely with and to authenticate the
130
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
131
 
      use IPv6 link-local addresses, since the clients will probably
132
 
      not have any other addresses configured (see <xref
133
 
      linkend="overview"/>).  Any authenticated client is then given
134
 
      the stored pre-encrypted password for that specific client.
 
109
      client host computers.  The Mandos server uses Zeroconf to
 
110
      announce itself on the local network, and uses TLS to
 
111
      communicate securely with and to authenticate the clients.  The
 
112
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
113
      link-local addresses, since the clients will probably not have
 
114
      any other addresses configured (see <xref linkend="overview"/>).
 
115
      Any authenticated client is then given the stored pre-encrypted
 
116
      password for that specific client.
135
117
    </para>
 
118
 
136
119
  </refsect1>
137
120
  
138
121
  <refsect1 id="purpose">
139
122
    <title>PURPOSE</title>
 
123
 
140
124
    <para>
141
125
      The purpose of this is to enable <emphasis>remote and unattended
142
126
      rebooting</emphasis> of client host computer with an
143
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
144
128
      linkend="overview"/> for details.
145
129
    </para>
 
130
    
146
131
  </refsect1>
147
132
  
148
133
  <refsect1 id="options">
149
134
    <title>OPTIONS</title>
 
135
    
150
136
    <variablelist>
151
137
      <varlistentry>
152
138
        <term><option>--help</option></term>
204
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
205
191
        </listitem>
206
192
      </varlistentry>
207
 
      
208
 
      <varlistentry>
209
 
        <term><option>--debuglevel
210
 
        <replaceable>LEVEL</replaceable></option></term>
211
 
        <listitem>
212
 
          <para>
213
 
            Set the debugging log level.
214
 
            <replaceable>LEVEL</replaceable> is a string, one of
215
 
            <quote><literal>CRITICAL</literal></quote>,
216
 
            <quote><literal>ERROR</literal></quote>,
217
 
            <quote><literal>WARNING</literal></quote>,
218
 
            <quote><literal>INFO</literal></quote>, or
219
 
            <quote><literal>DEBUG</literal></quote>, in order of
220
 
            increasing verbosity.  The default level is
221
 
            <quote><literal>WARNING</literal></quote>.
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
      
 
193
 
226
194
      <varlistentry>
227
195
        <term><option>--priority <replaceable>
228
196
        PRIORITY</replaceable></option></term>
230
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
231
199
        </listitem>
232
200
      </varlistentry>
233
 
      
 
201
 
234
202
      <varlistentry>
235
203
        <term><option>--servicename
236
204
        <replaceable>NAME</replaceable></option></term>
239
207
                      xpointer="servicename"/>
240
208
        </listitem>
241
209
      </varlistentry>
242
 
      
 
210
 
243
211
      <varlistentry>
244
212
        <term><option>--configdir
245
213
        <replaceable>DIRECTORY</replaceable></option></term>
254
222
          </para>
255
223
        </listitem>
256
224
      </varlistentry>
257
 
      
 
225
 
258
226
      <varlistentry>
259
227
        <term><option>--version</option></term>
260
228
        <listitem>
263
231
          </para>
264
232
        </listitem>
265
233
      </varlistentry>
266
 
      
267
 
      <varlistentry>
268
 
        <term><option>--no-dbus</option></term>
269
 
        <listitem>
270
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
271
 
          <para>
272
 
            See also <xref linkend="dbus_interface"/>.
273
 
          </para>
274
 
        </listitem>
275
 
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--no-ipv6</option></term>
279
 
        <listitem>
280
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
281
 
        </listitem>
282
 
      </varlistentry>
283
 
      
284
 
      <varlistentry>
285
 
        <term><option>--no-restore</option></term>
286
 
        <listitem>
287
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
288
 
        </listitem>
289
 
      </varlistentry>
290
 
      
291
 
      <varlistentry>
292
 
        <term><option>--statedir
293
 
        <replaceable>DIRECTORY</replaceable></option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
 
        </listitem>
297
 
      </varlistentry>
298
234
    </variablelist>
299
235
  </refsect1>
300
 
  
 
236
 
301
237
  <refsect1 id="overview">
302
238
    <title>OVERVIEW</title>
303
239
    <xi:include href="overview.xml"/>
307
243
      <acronym>RAM</acronym> disk environment.
308
244
    </para>
309
245
  </refsect1>
310
 
  
 
246
 
311
247
  <refsect1 id="protocol">
312
248
    <title>NETWORK PROTOCOL</title>
313
249
    <para>
365
301
      </row>
366
302
    </tbody></tgroup></table>
367
303
  </refsect1>
368
 
  
 
304
 
369
305
  <refsect1 id="checking">
370
306
    <title>CHECKING</title>
371
307
    <para>
372
308
      The server will, by default, continually check that the clients
373
309
      are still up.  If a client has not been confirmed as being up
374
310
      for some time, the client is assumed to be compromised and is no
375
 
      longer eligible to receive the encrypted password.  (Manual
376
 
      intervention is required to re-enable a client.)  The timeout,
377
 
      extended timeout, checker program, and interval between checks
378
 
      can be configured both globally and per client; see
379
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
383
 
    </para>
384
 
  </refsect1>
385
 
  
386
 
  <refsect1 id="approval">
387
 
    <title>APPROVAL</title>
388
 
    <para>
389
 
      The server can be configured to require manual approval for a
390
 
      client before it is sent its secret.  The delay to wait for such
391
 
      approval and the default action (approve or deny) can be
392
 
      configured both globally and per client; see <citerefentry>
 
311
      longer eligible to receive the encrypted password.  The timeout,
 
312
      checker program, and interval between checks can be configured
 
313
      both globally and per client; see <citerefentry>
393
314
      <refentrytitle>mandos-clients.conf</refentrytitle>
394
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
395
 
      will be approved immediately without delay.
396
 
    </para>
397
 
    <para>
398
 
      This can be used to deny a client its secret if not manually
399
 
      approved within a specified time.  It can also be used to make
400
 
      the server delay before giving a client its secret, allowing
401
 
      optional manual denying of this specific client.
402
 
    </para>
403
 
    
 
315
      <manvolnum>5</manvolnum></citerefentry>.
 
316
    </para>
404
317
  </refsect1>
405
 
  
 
318
 
406
319
  <refsect1 id="logging">
407
320
    <title>LOGGING</title>
408
321
    <para>
412
325
      and also show them on the console.
413
326
    </para>
414
327
  </refsect1>
415
 
  
416
 
  <refsect1 id="dbus_interface">
417
 
    <title>D-BUS INTERFACE</title>
418
 
    <para>
419
 
      The server will by default provide a D-Bus system bus interface.
420
 
      This interface will only be accessible by the root user or a
421
 
      Mandos-specific user, if such a user exists.  For documentation
422
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
423
 
    </para>
424
 
  </refsect1>
425
 
  
 
328
 
426
329
  <refsect1 id="exit_status">
427
330
    <title>EXIT STATUS</title>
428
331
    <para>
430
333
      critical error is encountered.
431
334
    </para>
432
335
  </refsect1>
433
 
  
 
336
 
434
337
  <refsect1 id="environment">
435
338
    <title>ENVIRONMENT</title>
436
339
    <variablelist>
450
353
      </varlistentry>
451
354
    </variablelist>
452
355
  </refsect1>
453
 
  
454
 
  <refsect1 id="files">
 
356
 
 
357
  <refsect1 id="file">
455
358
    <title>FILES</title>
456
359
    <para>
457
360
      Use the <option>--configdir</option> option to change where
480
383
        </listitem>
481
384
      </varlistentry>
482
385
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
484
 
        <listitem>
485
 
          <para>
486
 
            The file containing the process id of the
487
 
            <command>&COMMANDNAME;</command> process started last.
488
 
          </para>
489
 
        </listitem>
490
 
      </varlistentry>
491
 
      <varlistentry>
492
 
        <term><filename
493
 
        class="directory">/var/lib/mandos</filename></term>
494
 
        <listitem>
495
 
          <para>
496
 
            Directory where persistent state will be saved.  Change
497
 
            this with the <option>--statedir</option> option.  See
498
 
            also the <option>--no-restore</option> option.
 
386
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
387
        <listitem>
 
388
          <para>
 
389
            The file containing the process id of
 
390
            <command>&COMMANDNAME;</command>.
499
391
          </para>
500
392
        </listitem>
501
393
      </varlistentry>
529
421
      backtrace.  This could be considered a feature.
530
422
    </para>
531
423
    <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.
 
433
    </para>
 
434
    <para>
532
435
      There is no fine-grained control over logging and debug output.
533
436
    </para>
534
437
    <para>
535
438
      Debug mode is conflated with running in the foreground.
536
439
    </para>
537
440
    <para>
538
 
      This server does not check the expire time of clients’ OpenPGP
539
 
      keys.
 
441
      The console log messages does not show a timestamp.
540
442
    </para>
541
443
  </refsect1>
542
444
  
553
455
    <informalexample>
554
456
      <para>
555
457
        Run the server in debug mode, read configuration files from
556
 
        the <filename class="directory">~/mandos</filename> directory,
557
 
        and use the Zeroconf service name <quote>Test</quote> to not
558
 
        collide with any other official Mandos server on this host:
 
458
        the <filename>~/mandos</filename> directory, and use the
 
459
        Zeroconf service name <quote>Test</quote> to not collide with
 
460
        any other official Mandos server on this host:
559
461
      </para>
560
462
      <para>
561
463
 
577
479
      </para>
578
480
    </informalexample>
579
481
  </refsect1>
580
 
  
 
482
 
581
483
  <refsect1 id="security">
582
484
    <title>SECURITY</title>
583
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
584
486
      <title>SERVER</title>
585
487
      <para>
586
488
        Running this <command>&COMMANDNAME;</command> server program
587
489
        should not in itself present any security risk to the host
588
 
        computer running it.  The program switches to a non-root user
589
 
        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.
590
492
      </para>
591
493
    </refsect2>
592
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
593
495
      <title>CLIENTS</title>
594
496
      <para>
595
497
        The server only gives out its stored data to clients which
602
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
603
505
        <manvolnum>5</manvolnum></citerefentry>)
604
506
        <emphasis>must</emphasis> be made non-readable by anyone
605
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
606
508
      </para>
607
509
      <para>
608
510
        As detailed in <xref linkend="checking"/>, the status of all
610
512
        compromised if they are gone for too long.
611
513
      </para>
612
514
      <para>
 
515
        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 <acronym>RAM</acronym> image of the client host.  What
 
525
        should be done in that case (if restarting the server program
 
526
        really is necessary) is to stop the server program, edit the
 
527
        configuration file to omit any suspect clients, and restart
 
528
        the server program.
 
529
      </para>
 
530
      <para>
613
531
        For more details on client-side security, see
614
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
615
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
616
534
      </para>
617
535
    </refsect2>
618
536
  </refsect1>
619
 
  
 
537
 
620
538
  <refsect1 id="see_also">
621
539
    <title>SEE ALSO</title>
622
540
    <para>
623
 
      <citerefentry><refentrytitle>intro</refentrytitle>
624
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
625
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
626
 
      <manvolnum>5</manvolnum></citerefentry>,
627
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
628
 
      <manvolnum>5</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
630
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
631
 
      <citerefentry><refentrytitle>sh</refentrytitle>
632
 
      <manvolnum>1</manvolnum></citerefentry>
 
541
      <citerefentry>
 
542
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
544
        <refentrytitle>mandos.conf</refentrytitle>
 
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
546
        <refentrytitle>password-request</refentrytitle>
 
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
549
      </citerefentry>
633
550
    </para>
634
551
    <variablelist>
635
552
      <varlistentry>