/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: 2011-12-21 17:17:32 UTC
  • mto: (237.7.75 trunk)
  • mto: This revision was merged to the branch mainline in revision 290.
  • Revision ID: teddy@recompile.se-20111221171732-j1yfbekvztjk205a
* mandos-ctl (main): Correct "except:" syntax.

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 "2011-11-26">
 
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>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </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>
 
97
      <sbr/>
 
98
      <arg><option>--no-restore</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--statedir
 
101
      <replaceable>DIRECTORY</replaceable></option></arg>
86
102
    </cmdsynopsis>
87
103
    <cmdsynopsis>
88
104
      <command>&COMMANDNAME;</command>
100
116
      <arg choice="plain"><option>--check</option></arg>
101
117
    </cmdsynopsis>
102
118
  </refsynopsisdiv>
103
 
 
 
119
  
104
120
  <refsect1 id="description">
105
121
    <title>DESCRIPTION</title>
106
122
    <para>
107
123
      <command>&COMMANDNAME;</command> is a server daemon which
108
124
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
117
135
    </para>
118
 
 
119
136
  </refsect1>
120
137
  
121
138
  <refsect1 id="purpose">
122
139
    <title>PURPOSE</title>
123
 
 
124
140
    <para>
125
141
      The purpose of this is to enable <emphasis>remote and unattended
126
142
      rebooting</emphasis> of client host computer with an
127
143
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
144
      linkend="overview"/> for details.
129
145
    </para>
130
 
    
131
146
  </refsect1>
132
147
  
133
148
  <refsect1 id="options">
134
149
    <title>OPTIONS</title>
135
 
    
136
150
    <variablelist>
137
151
      <varlistentry>
138
152
        <term><option>--help</option></term>
190
204
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
205
        </listitem>
192
206
      </varlistentry>
193
 
 
 
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
      
194
226
      <varlistentry>
195
227
        <term><option>--priority <replaceable>
196
228
        PRIORITY</replaceable></option></term>
198
230
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
231
        </listitem>
200
232
      </varlistentry>
201
 
 
 
233
      
202
234
      <varlistentry>
203
235
        <term><option>--servicename
204
236
        <replaceable>NAME</replaceable></option></term>
207
239
                      xpointer="servicename"/>
208
240
        </listitem>
209
241
      </varlistentry>
210
 
 
 
242
      
211
243
      <varlistentry>
212
244
        <term><option>--configdir
213
245
        <replaceable>DIRECTORY</replaceable></option></term>
222
254
          </para>
223
255
        </listitem>
224
256
      </varlistentry>
225
 
 
 
257
      
226
258
      <varlistentry>
227
259
        <term><option>--version</option></term>
228
260
        <listitem>
231
263
          </para>
232
264
        </listitem>
233
265
      </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>
234
298
    </variablelist>
235
299
  </refsect1>
236
 
 
 
300
  
237
301
  <refsect1 id="overview">
238
302
    <title>OVERVIEW</title>
239
303
    <xi:include href="overview.xml"/>
243
307
      <acronym>RAM</acronym> disk environment.
244
308
    </para>
245
309
  </refsect1>
246
 
 
 
310
  
247
311
  <refsect1 id="protocol">
248
312
    <title>NETWORK PROTOCOL</title>
249
313
    <para>
301
365
      </row>
302
366
    </tbody></tgroup></table>
303
367
  </refsect1>
304
 
 
 
368
  
305
369
  <refsect1 id="checking">
306
370
    <title>CHECKING</title>
307
371
    <para>
308
372
      The server will, by default, continually check that the clients
309
373
      are still up.  If a client has not been confirmed as being up
310
374
      for some time, the client is assumed to be compromised and is no
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>
 
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>
314
393
      <refentrytitle>mandos-clients.conf</refentrytitle>
315
 
      <manvolnum>5</manvolnum></citerefentry>.
316
 
    </para>
 
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
    
317
404
  </refsect1>
318
 
 
 
405
  
319
406
  <refsect1 id="logging">
320
407
    <title>LOGGING</title>
321
408
    <para>
322
409
      The server will send log message with various severity levels to
323
 
      <filename>/dev/log</filename>.  With the
 
410
      <filename class="devicefile">/dev/log</filename>.  With the
324
411
      <option>--debug</option> option, it will log even more messages,
325
412
      and also show them on the console.
326
413
    </para>
327
414
  </refsect1>
328
 
 
 
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
  
329
426
  <refsect1 id="exit_status">
330
427
    <title>EXIT STATUS</title>
331
428
    <para>
333
430
      critical error is encountered.
334
431
    </para>
335
432
  </refsect1>
336
 
 
 
433
  
337
434
  <refsect1 id="environment">
338
435
    <title>ENVIRONMENT</title>
339
436
    <variablelist>
353
450
      </varlistentry>
354
451
    </variablelist>
355
452
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
453
  
 
454
  <refsect1 id="files">
358
455
    <title>FILES</title>
359
456
    <para>
360
457
      Use the <option>--configdir</option> option to change where
383
480
        </listitem>
384
481
      </varlistentry>
385
482
      <varlistentry>
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>.
 
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 class="devicefile">/dev/log</filename></term>
 
493
      </varlistentry>
 
494
      <varlistentry>
 
495
        <term><filename
 
496
        class="directory">/var/lib/mandos</filename></term>
 
497
        <listitem>
 
498
          <para>
 
499
            Directory where persistent state will be saved.  Change
 
500
            this with the <option>--statedir</option> option.  See
 
501
            also the <option>--no-restore</option> option.
391
502
          </para>
392
503
        </listitem>
393
504
      </varlistentry>
421
532
      backtrace.  This could be considered a feature.
422
533
    </para>
423
534
    <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>
435
535
      There is no fine-grained control over logging and debug output.
436
536
    </para>
437
537
    <para>
438
538
      Debug mode is conflated with running in the foreground.
439
539
    </para>
440
540
    <para>
441
 
      The console log messages does not show a timestamp.
 
541
      This server does not check the expire time of clients’ OpenPGP
 
542
      keys.
442
543
    </para>
443
544
  </refsect1>
444
545
  
455
556
    <informalexample>
456
557
      <para>
457
558
        Run the server in debug mode, read configuration files from
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
        the <filename class="directory">~/mandos</filename> directory,
 
560
        and use the Zeroconf service name <quote>Test</quote> to not
 
561
        collide with any other official Mandos server on this host:
461
562
      </para>
462
563
      <para>
463
564
 
479
580
      </para>
480
581
    </informalexample>
481
582
  </refsect1>
482
 
 
 
583
  
483
584
  <refsect1 id="security">
484
585
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
586
    <refsect2 id="server">
486
587
      <title>SERVER</title>
487
588
      <para>
488
589
        Running this <command>&COMMANDNAME;</command> server program
489
590
        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.
 
591
        computer running it.  The program switches to a non-root user
 
592
        soon after startup.
492
593
      </para>
493
594
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
595
    <refsect2 id="clients">
495
596
      <title>CLIENTS</title>
496
597
      <para>
497
598
        The server only gives out its stored data to clients which
504
605
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
606
        <manvolnum>5</manvolnum></citerefentry>)
506
607
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
608
        except the user starting the server (usually root).
508
609
      </para>
509
610
      <para>
510
611
        As detailed in <xref linkend="checking"/>, the status of all
512
613
        compromised if they are gone for too long.
513
614
      </para>
514
615
      <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>
531
616
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
617
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
618
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
619
      </para>
535
620
    </refsect2>
536
621
  </refsect1>
537
 
 
 
622
  
538
623
  <refsect1 id="see_also">
539
624
    <title>SEE ALSO</title>
540
625
    <para>
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>
 
626
      <citerefentry><refentrytitle>intro</refentrytitle>
 
627
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
628
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
629
      <manvolnum>5</manvolnum></citerefentry>,
 
630
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
631
      <manvolnum>5</manvolnum></citerefentry>,
 
632
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
633
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
634
      <citerefentry><refentrytitle>sh</refentrytitle>
 
635
      <manvolnum>1</manvolnum></citerefentry>
550
636
    </para>
551
637
    <variablelist>
552
638
      <varlistentry>