/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: 2014-07-13 21:55:28 UTC
  • mfrom: (237.4.49 release)
  • Revision ID: teddy@recompile.se-20140713215528-5lez8qv009g0i1h2
Merge from release branch.

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 "2014-06-15">
 
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>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
34
40
      <holder>Teddy Hogeborn</holder>
35
41
      <holder>Björn Påhlsson</holder>
36
42
    </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>
 
43
    <xi:include href="legalnotice.xml"/>
60
44
  </refentryinfo>
61
 
 
 
45
  
62
46
  <refmeta>
63
47
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
48
    <manvolnum>8</manvolnum>
70
54
      Gives encrypted passwords to authenticated Mandos clients
71
55
    </refpurpose>
72
56
  </refnamediv>
73
 
 
 
57
  
74
58
  <refsynopsisdiv>
75
59
    <cmdsynopsis>
76
60
      <command>&COMMANDNAME;</command>
105
89
      <replaceable>DIRECTORY</replaceable></option></arg>
106
90
      <sbr/>
107
91
      <arg><option>--debug</option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--debuglevel
 
94
      <replaceable>LEVEL</replaceable></option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-dbus</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-ipv6</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-restore</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--statedir
 
103
      <replaceable>DIRECTORY</replaceable></option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--socket
 
106
      <replaceable>FD</replaceable></option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--foreground</option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--no-zeroconf</option></arg>
108
111
    </cmdsynopsis>
109
112
    <cmdsynopsis>
110
113
      <command>&COMMANDNAME;</command>
122
125
      <arg choice="plain"><option>--check</option></arg>
123
126
    </cmdsynopsis>
124
127
  </refsynopsisdiv>
125
 
 
 
128
  
126
129
  <refsect1 id="description">
127
130
    <title>DESCRIPTION</title>
128
131
    <para>
129
132
      <command>&COMMANDNAME;</command> is a server daemon which
130
133
      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.
 
134
      client host computers. For an introduction, see
 
135
      <citerefentry><refentrytitle>intro</refentrytitle>
 
136
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
137
      uses Zeroconf to announce itself on the local network, and uses
 
138
      TLS to communicate securely with and to authenticate the
 
139
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
140
      use IPv6 link-local addresses, since the clients will probably
 
141
      not have any other addresses configured (see <xref
 
142
      linkend="overview"/>).  Any authenticated client is then given
 
143
      the stored pre-encrypted password for that specific client.
139
144
    </para>
140
 
 
141
145
  </refsect1>
142
146
  
143
147
  <refsect1 id="purpose">
144
148
    <title>PURPOSE</title>
145
 
 
146
149
    <para>
147
150
      The purpose of this is to enable <emphasis>remote and unattended
148
151
      rebooting</emphasis> of client host computer with an
149
152
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
153
      linkend="overview"/> for details.
151
154
    </para>
152
 
    
153
155
  </refsect1>
154
156
  
155
157
  <refsect1 id="options">
156
158
    <title>OPTIONS</title>
157
 
    
158
159
    <variablelist>
159
160
      <varlistentry>
160
161
        <term><option>--help</option></term>
212
213
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
214
        </listitem>
214
215
      </varlistentry>
215
 
 
 
216
      
 
217
      <varlistentry>
 
218
        <term><option>--debuglevel
 
219
        <replaceable>LEVEL</replaceable></option></term>
 
220
        <listitem>
 
221
          <para>
 
222
            Set the debugging log level.
 
223
            <replaceable>LEVEL</replaceable> is a string, one of
 
224
            <quote><literal>CRITICAL</literal></quote>,
 
225
            <quote><literal>ERROR</literal></quote>,
 
226
            <quote><literal>WARNING</literal></quote>,
 
227
            <quote><literal>INFO</literal></quote>, or
 
228
            <quote><literal>DEBUG</literal></quote>, in order of
 
229
            increasing verbosity.  The default level is
 
230
            <quote><literal>WARNING</literal></quote>.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>
 
234
      
216
235
      <varlistentry>
217
236
        <term><option>--priority <replaceable>
218
237
        PRIORITY</replaceable></option></term>
219
238
        <listitem>
220
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
239
          <xi:include href="mandos-options.xml"
 
240
                      xpointer="priority_compat"/>
221
241
        </listitem>
222
242
      </varlistentry>
223
 
 
 
243
      
224
244
      <varlistentry>
225
245
        <term><option>--servicename
226
246
        <replaceable>NAME</replaceable></option></term>
229
249
                      xpointer="servicename"/>
230
250
        </listitem>
231
251
      </varlistentry>
232
 
 
 
252
      
233
253
      <varlistentry>
234
254
        <term><option>--configdir
235
255
        <replaceable>DIRECTORY</replaceable></option></term>
244
264
          </para>
245
265
        </listitem>
246
266
      </varlistentry>
247
 
 
 
267
      
248
268
      <varlistentry>
249
269
        <term><option>--version</option></term>
250
270
        <listitem>
253
273
          </para>
254
274
        </listitem>
255
275
      </varlistentry>
 
276
      
 
277
      <varlistentry>
 
278
        <term><option>--no-dbus</option></term>
 
279
        <listitem>
 
280
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
281
          <para>
 
282
            See also <xref linkend="dbus_interface"/>.
 
283
          </para>
 
284
        </listitem>
 
285
      </varlistentry>
 
286
      
 
287
      <varlistentry>
 
288
        <term><option>--no-ipv6</option></term>
 
289
        <listitem>
 
290
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
291
        </listitem>
 
292
      </varlistentry>
 
293
      
 
294
      <varlistentry>
 
295
        <term><option>--no-restore</option></term>
 
296
        <listitem>
 
297
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
298
          <para>
 
299
            See also <xref linkend="persistent_state"/>.
 
300
          </para>
 
301
        </listitem>
 
302
      </varlistentry>
 
303
      
 
304
      <varlistentry>
 
305
        <term><option>--statedir
 
306
        <replaceable>DIRECTORY</replaceable></option></term>
 
307
        <listitem>
 
308
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
309
        </listitem>
 
310
      </varlistentry>
 
311
      
 
312
      <varlistentry>
 
313
        <term><option>--socket
 
314
        <replaceable>FD</replaceable></option></term>
 
315
        <listitem>
 
316
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      
 
320
      <varlistentry>
 
321
        <term><option>--foreground</option></term>
 
322
        <listitem>
 
323
          <xi:include href="mandos-options.xml"
 
324
                      xpointer="foreground"/>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
      
 
328
      <varlistentry>
 
329
        <term><option>--no-zeroconf</option></term>
 
330
        <listitem>
 
331
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
332
        </listitem>
 
333
      </varlistentry>
 
334
      
256
335
    </variablelist>
257
336
  </refsect1>
258
 
 
 
337
  
259
338
  <refsect1 id="overview">
260
339
    <title>OVERVIEW</title>
261
340
    <xi:include href="overview.xml"/>
262
341
    <para>
263
342
      This program is the server part.  It is a normal server program
264
343
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
344
      <acronym>RAM</acronym> disk environment.
266
345
    </para>
267
346
  </refsect1>
268
 
 
 
347
  
269
348
  <refsect1 id="protocol">
270
349
    <title>NETWORK PROTOCOL</title>
271
350
    <para>
323
402
      </row>
324
403
    </tbody></tgroup></table>
325
404
  </refsect1>
326
 
 
 
405
  
327
406
  <refsect1 id="checking">
328
407
    <title>CHECKING</title>
329
408
    <para>
330
409
      The server will, by default, continually check that the clients
331
410
      are still up.  If a client has not been confirmed as being up
332
411
      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>
 
412
      longer eligible to receive the encrypted password.  (Manual
 
413
      intervention is required to re-enable a client.)  The timeout,
 
414
      extended timeout, checker program, and interval between checks
 
415
      can be configured both globally and per client; see
 
416
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
417
      <manvolnum>5</manvolnum></citerefentry>.
 
418
    </para>
 
419
  </refsect1>
 
420
  
 
421
  <refsect1 id="approval">
 
422
    <title>APPROVAL</title>
 
423
    <para>
 
424
      The server can be configured to require manual approval for a
 
425
      client before it is sent its secret.  The delay to wait for such
 
426
      approval and the default action (approve or deny) can be
 
427
      configured both globally and per client; see <citerefentry>
336
428
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
 
      <manvolnum>5</manvolnum></citerefentry>.
338
 
    </para>
 
429
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
430
      will be approved immediately without delay.
 
431
    </para>
 
432
    <para>
 
433
      This can be used to deny a client its secret if not manually
 
434
      approved within a specified time.  It can also be used to make
 
435
      the server delay before giving a client its secret, allowing
 
436
      optional manual denying of this specific client.
 
437
    </para>
 
438
    
339
439
  </refsect1>
340
 
 
 
440
  
341
441
  <refsect1 id="logging">
342
442
    <title>LOGGING</title>
343
443
    <para>
344
444
      The server will send log message with various severity levels to
345
 
      <filename>/dev/log</filename>.  With the
 
445
      <filename class="devicefile">/dev/log</filename>.  With the
346
446
      <option>--debug</option> option, it will log even more messages,
347
447
      and also show them on the console.
348
448
    </para>
349
449
  </refsect1>
350
 
 
 
450
  
 
451
  <refsect1 id="persistent_state">
 
452
    <title>PERSISTENT STATE</title>
 
453
    <para>
 
454
      Client settings, initially read from
 
455
      <filename>clients.conf</filename>, are persistent across
 
456
      restarts, and run-time changes will override settings in
 
457
      <filename>clients.conf</filename>.  However, if a setting is
 
458
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
459
      <filename>clients.conf</filename>, this will take precedence.
 
460
    </para>
 
461
  </refsect1>
 
462
  
 
463
  <refsect1 id="dbus_interface">
 
464
    <title>D-BUS INTERFACE</title>
 
465
    <para>
 
466
      The server will by default provide a D-Bus system bus interface.
 
467
      This interface will only be accessible by the root user or a
 
468
      Mandos-specific user, if such a user exists.  For documentation
 
469
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
470
    </para>
 
471
  </refsect1>
 
472
  
351
473
  <refsect1 id="exit_status">
352
474
    <title>EXIT STATUS</title>
353
475
    <para>
355
477
      critical error is encountered.
356
478
    </para>
357
479
  </refsect1>
358
 
 
 
480
  
359
481
  <refsect1 id="environment">
360
482
    <title>ENVIRONMENT</title>
361
483
    <variablelist>
375
497
      </varlistentry>
376
498
    </variablelist>
377
499
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
500
  
 
501
  <refsect1 id="files">
380
502
    <title>FILES</title>
381
503
    <para>
382
504
      Use the <option>--configdir</option> option to change where
405
527
        </listitem>
406
528
      </varlistentry>
407
529
      <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>.
 
530
        <term><filename>/run/mandos.pid</filename></term>
 
531
        <listitem>
 
532
          <para>
 
533
            The file containing the process id of the
 
534
            <command>&COMMANDNAME;</command> process started last.
 
535
            <emphasis >Note:</emphasis> If the <filename
 
536
            class="directory">/run</filename> directory does not
 
537
            exist, <filename>/var/run/mandos.pid</filename> will be
 
538
            used instead.
 
539
          </para>
 
540
        </listitem>
 
541
      </varlistentry>
 
542
      <varlistentry>
 
543
        <term><filename class="devicefile">/dev/log</filename></term>
 
544
      </varlistentry>
 
545
      <varlistentry>
 
546
        <term><filename
 
547
        class="directory">/var/lib/mandos</filename></term>
 
548
        <listitem>
 
549
          <para>
 
550
            Directory where persistent state will be saved.  Change
 
551
            this with the <option>--statedir</option> option.  See
 
552
            also the <option>--no-restore</option> option.
413
553
          </para>
414
554
        </listitem>
415
555
      </varlistentry>
443
583
      backtrace.  This could be considered a feature.
444
584
    </para>
445
585
    <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
586
      There is no fine-grained control over logging and debug output.
458
587
    </para>
459
588
    <para>
460
 
      Debug mode is conflated with running in the foreground.
461
 
    </para>
462
 
    <para>
463
 
      The console log messages does not show a timestamp.
 
589
      This server does not check the expire time of clients’ OpenPGP
 
590
      keys.
464
591
    </para>
465
592
  </refsect1>
466
593
  
477
604
    <informalexample>
478
605
      <para>
479
606
        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:
 
607
        the <filename class="directory">~/mandos</filename> directory,
 
608
        and use the Zeroconf service name <quote>Test</quote> to not
 
609
        collide with any other official Mandos server on this host:
483
610
      </para>
484
611
      <para>
485
612
 
501
628
      </para>
502
629
    </informalexample>
503
630
  </refsect1>
504
 
 
 
631
  
505
632
  <refsect1 id="security">
506
633
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
634
    <refsect2 id="server">
508
635
      <title>SERVER</title>
509
636
      <para>
510
637
        Running this <command>&COMMANDNAME;</command> server program
511
638
        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.
 
639
        computer running it.  The program switches to a non-root user
 
640
        soon after startup.
514
641
      </para>
515
642
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
643
    <refsect2 id="clients">
517
644
      <title>CLIENTS</title>
518
645
      <para>
519
646
        The server only gives out its stored data to clients which
526
653
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
654
        <manvolnum>5</manvolnum></citerefentry>)
528
655
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
656
        except the user starting the server (usually root).
530
657
      </para>
531
658
      <para>
532
659
        As detailed in <xref linkend="checking"/>, the status of all
534
661
        compromised if they are gone for too long.
535
662
      </para>
536
663
      <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
664
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
665
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
666
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
667
      </para>
557
668
    </refsect2>
558
669
  </refsect1>
559
 
 
 
670
  
560
671
  <refsect1 id="see_also">
561
672
    <title>SEE ALSO</title>
562
673
    <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>
 
674
      <citerefentry><refentrytitle>intro</refentrytitle>
 
675
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
676
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
677
      <manvolnum>5</manvolnum></citerefentry>,
 
678
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
679
      <manvolnum>5</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
681
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
682
      <citerefentry><refentrytitle>sh</refentrytitle>
 
683
      <manvolnum>1</manvolnum></citerefentry>
572
684
    </para>
573
685
    <variablelist>
574
686
      <varlistentry>