/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

  • Committer: Teddy Hogeborn
  • Date: 2011-12-21 17:17:32 UTC
  • mto: This revision was merged to the branch mainline in revision 527.
  • 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-08-31">
 
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
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
41
    <xi:include href="legalnotice.xml"/>
60
42
  </refentryinfo>
61
 
 
 
43
  
62
44
  <refmeta>
63
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
    <manvolnum>8</manvolnum>
70
52
      Gives encrypted passwords to authenticated Mandos clients
71
53
    </refpurpose>
72
54
  </refnamediv>
73
 
 
 
55
  
74
56
  <refsynopsisdiv>
75
57
    <cmdsynopsis>
76
58
      <command>&COMMANDNAME;</command>
105
87
      <replaceable>DIRECTORY</replaceable></option></arg>
106
88
      <sbr/>
107
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>
108
102
    </cmdsynopsis>
109
103
    <cmdsynopsis>
110
104
      <command>&COMMANDNAME;</command>
122
116
      <arg choice="plain"><option>--check</option></arg>
123
117
    </cmdsynopsis>
124
118
  </refsynopsisdiv>
125
 
 
 
119
  
126
120
  <refsect1 id="description">
127
121
    <title>DESCRIPTION</title>
128
122
    <para>
129
123
      <command>&COMMANDNAME;</command> is a server daemon which
130
124
      handles incoming request for passwords for a pre-defined list of
131
 
      client host computers.  The Mandos server uses Zeroconf to
132
 
      announce itself on the local network, and uses TLS to
133
 
      communicate securely with and to authenticate the clients.  The
134
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
135
 
      link-local addresses, since the clients will probably not have
136
 
      any other addresses configured (see <xref linkend="overview"/>).
137
 
      Any authenticated client is then given the stored pre-encrypted
138
 
      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.
139
135
    </para>
140
 
 
141
136
  </refsect1>
142
137
  
143
138
  <refsect1 id="purpose">
144
139
    <title>PURPOSE</title>
145
 
 
146
140
    <para>
147
141
      The purpose of this is to enable <emphasis>remote and unattended
148
142
      rebooting</emphasis> of client host computer with an
149
143
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
144
      linkend="overview"/> for details.
151
145
    </para>
152
 
    
153
146
  </refsect1>
154
147
  
155
148
  <refsect1 id="options">
156
149
    <title>OPTIONS</title>
157
 
    
158
150
    <variablelist>
159
151
      <varlistentry>
160
152
        <term><option>--help</option></term>
212
204
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
205
        </listitem>
214
206
      </varlistentry>
215
 
 
 
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
      
216
226
      <varlistentry>
217
227
        <term><option>--priority <replaceable>
218
228
        PRIORITY</replaceable></option></term>
220
230
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
231
        </listitem>
222
232
      </varlistentry>
223
 
 
 
233
      
224
234
      <varlistentry>
225
235
        <term><option>--servicename
226
236
        <replaceable>NAME</replaceable></option></term>
229
239
                      xpointer="servicename"/>
230
240
        </listitem>
231
241
      </varlistentry>
232
 
 
 
242
      
233
243
      <varlistentry>
234
244
        <term><option>--configdir
235
245
        <replaceable>DIRECTORY</replaceable></option></term>
244
254
          </para>
245
255
        </listitem>
246
256
      </varlistentry>
247
 
 
 
257
      
248
258
      <varlistentry>
249
259
        <term><option>--version</option></term>
250
260
        <listitem>
253
263
          </para>
254
264
        </listitem>
255
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>
256
298
    </variablelist>
257
299
  </refsect1>
258
 
 
 
300
  
259
301
  <refsect1 id="overview">
260
302
    <title>OVERVIEW</title>
261
303
    <xi:include href="overview.xml"/>
262
304
    <para>
263
305
      This program is the server part.  It is a normal server program
264
306
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
307
      <acronym>RAM</acronym> disk environment.
266
308
    </para>
267
309
  </refsect1>
268
 
 
 
310
  
269
311
  <refsect1 id="protocol">
270
312
    <title>NETWORK PROTOCOL</title>
271
313
    <para>
323
365
      </row>
324
366
    </tbody></tgroup></table>
325
367
  </refsect1>
326
 
 
 
368
  
327
369
  <refsect1 id="checking">
328
370
    <title>CHECKING</title>
329
371
    <para>
330
372
      The server will, by default, continually check that the clients
331
373
      are still up.  If a client has not been confirmed as being up
332
374
      for some time, the client is assumed to be compromised and is no
333
 
      longer eligible to receive the encrypted password.  The timeout,
334
 
      checker program, and interval between checks can be configured
335
 
      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>
336
393
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
 
      <manvolnum>5</manvolnum></citerefentry>.
338
 
    </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
    
339
404
  </refsect1>
340
 
 
 
405
  
341
406
  <refsect1 id="logging">
342
407
    <title>LOGGING</title>
343
408
    <para>
344
409
      The server will send log message with various severity levels to
345
 
      <filename>/dev/log</filename>.  With the
 
410
      <filename class="devicefile">/dev/log</filename>.  With the
346
411
      <option>--debug</option> option, it will log even more messages,
347
412
      and also show them on the console.
348
413
    </para>
349
414
  </refsect1>
350
 
 
 
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
  
351
426
  <refsect1 id="exit_status">
352
427
    <title>EXIT STATUS</title>
353
428
    <para>
355
430
      critical error is encountered.
356
431
    </para>
357
432
  </refsect1>
358
 
 
 
433
  
359
434
  <refsect1 id="environment">
360
435
    <title>ENVIRONMENT</title>
361
436
    <variablelist>
375
450
      </varlistentry>
376
451
    </variablelist>
377
452
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
453
  
 
454
  <refsect1 id="files">
380
455
    <title>FILES</title>
381
456
    <para>
382
457
      Use the <option>--configdir</option> option to change where
405
480
        </listitem>
406
481
      </varlistentry>
407
482
      <varlistentry>
408
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
409
 
        <listitem>
410
 
          <para>
411
 
            The file containing the process id of
412
 
            <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.
413
502
          </para>
414
503
        </listitem>
415
504
      </varlistentry>
443
532
      backtrace.  This could be considered a feature.
444
533
    </para>
445
534
    <para>
446
 
      Currently, if a client is declared <quote>invalid</quote> due to
447
 
      having timed out, the server does not record this fact onto
448
 
      permanent storage.  This has some security implications, see
449
 
      <xref linkend="CLIENTS"/>.
450
 
    </para>
451
 
    <para>
452
 
      There is currently no way of querying the server of the current
453
 
      status of clients, other than analyzing its <systemitem
454
 
      class="service">syslog</systemitem> output.
455
 
    </para>
456
 
    <para>
457
535
      There is no fine-grained control over logging and debug output.
458
536
    </para>
459
537
    <para>
460
538
      Debug mode is conflated with running in the foreground.
461
539
    </para>
462
540
    <para>
463
 
      The console log messages does not show a timestamp.
 
541
      This server does not check the expire time of clients’ OpenPGP
 
542
      keys.
464
543
    </para>
465
544
  </refsect1>
466
545
  
477
556
    <informalexample>
478
557
      <para>
479
558
        Run the server in debug mode, read configuration files from
480
 
        the <filename>~/mandos</filename> directory, and use the
481
 
        Zeroconf service name <quote>Test</quote> to not collide with
482
 
        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:
483
562
      </para>
484
563
      <para>
485
564
 
501
580
      </para>
502
581
    </informalexample>
503
582
  </refsect1>
504
 
 
 
583
  
505
584
  <refsect1 id="security">
506
585
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
586
    <refsect2 id="server">
508
587
      <title>SERVER</title>
509
588
      <para>
510
589
        Running this <command>&COMMANDNAME;</command> server program
511
590
        should not in itself present any security risk to the host
512
 
        computer running it.  The program does not need any special
513
 
        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.
514
593
      </para>
515
594
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
595
    <refsect2 id="clients">
517
596
      <title>CLIENTS</title>
518
597
      <para>
519
598
        The server only gives out its stored data to clients which
526
605
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
606
        <manvolnum>5</manvolnum></citerefentry>)
528
607
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
608
        except the user starting the server (usually root).
530
609
      </para>
531
610
      <para>
532
611
        As detailed in <xref linkend="checking"/>, the status of all
534
613
        compromised if they are gone for too long.
535
614
      </para>
536
615
      <para>
537
 
        If a client is compromised, its downtime should be duly noted
538
 
        by the server which would therefore declare the client
539
 
        invalid.  But if the server was ever restarted, it would
540
 
        re-read its client list from its configuration file and again
541
 
        regard all clients therein as valid, and hence eligible to
542
 
        receive their passwords.  Therefore, be careful when
543
 
        restarting servers if it is suspected that a client has, in
544
 
        fact, been compromised by parties who may now be running a
545
 
        fake Mandos client with the keys from the non-encrypted
546
 
        initial RAM image of the client host.  What should be done in
547
 
        that case (if restarting the server program really is
548
 
        necessary) is to stop the server program, edit the
549
 
        configuration file to omit any suspect clients, and restart
550
 
        the server program.
551
 
      </para>
552
 
      <para>
553
616
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
617
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
618
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
619
      </para>
557
620
    </refsect2>
558
621
  </refsect1>
559
 
 
 
622
  
560
623
  <refsect1 id="see_also">
561
624
    <title>SEE ALSO</title>
562
625
    <para>
563
 
      <citerefentry>
564
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
565
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>mandos.conf</refentrytitle>
567
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>password-request</refentrytitle>
569
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
 
      </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>
572
636
    </para>
573
637
    <variablelist>
574
638
      <varlistentry>