/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: 2013-10-20 22:20:11 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131020222011-g2fvjicx5lrv4h4e
* mandos-change-keytype: Bug fix: call mandos-keygen from $PATH, not
                         current directory.

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 "2013-10-20">
 
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>
108
109
    </cmdsynopsis>
109
110
    <cmdsynopsis>
110
111
      <command>&COMMANDNAME;</command>
122
123
      <arg choice="plain"><option>--check</option></arg>
123
124
    </cmdsynopsis>
124
125
  </refsynopsisdiv>
125
 
 
 
126
  
126
127
  <refsect1 id="description">
127
128
    <title>DESCRIPTION</title>
128
129
    <para>
129
130
      <command>&COMMANDNAME;</command> is a server daemon which
130
131
      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.
 
132
      client host computers. For an introduction, see
 
133
      <citerefentry><refentrytitle>intro</refentrytitle>
 
134
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
135
      uses Zeroconf to announce itself on the local network, and uses
 
136
      TLS to communicate securely with and to authenticate the
 
137
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
138
      use IPv6 link-local addresses, since the clients will probably
 
139
      not have any other addresses configured (see <xref
 
140
      linkend="overview"/>).  Any authenticated client is then given
 
141
      the stored pre-encrypted password for that specific client.
139
142
    </para>
140
 
 
141
143
  </refsect1>
142
144
  
143
145
  <refsect1 id="purpose">
144
146
    <title>PURPOSE</title>
145
 
 
146
147
    <para>
147
148
      The purpose of this is to enable <emphasis>remote and unattended
148
149
      rebooting</emphasis> of client host computer with an
149
150
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
151
      linkend="overview"/> for details.
151
152
    </para>
152
 
    
153
153
  </refsect1>
154
154
  
155
155
  <refsect1 id="options">
156
156
    <title>OPTIONS</title>
157
 
    
158
157
    <variablelist>
159
158
      <varlistentry>
160
159
        <term><option>--help</option></term>
212
211
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
212
        </listitem>
214
213
      </varlistentry>
215
 
 
 
214
      
 
215
      <varlistentry>
 
216
        <term><option>--debuglevel
 
217
        <replaceable>LEVEL</replaceable></option></term>
 
218
        <listitem>
 
219
          <para>
 
220
            Set the debugging log level.
 
221
            <replaceable>LEVEL</replaceable> is a string, one of
 
222
            <quote><literal>CRITICAL</literal></quote>,
 
223
            <quote><literal>ERROR</literal></quote>,
 
224
            <quote><literal>WARNING</literal></quote>,
 
225
            <quote><literal>INFO</literal></quote>, or
 
226
            <quote><literal>DEBUG</literal></quote>, in order of
 
227
            increasing verbosity.  The default level is
 
228
            <quote><literal>WARNING</literal></quote>.
 
229
          </para>
 
230
        </listitem>
 
231
      </varlistentry>
 
232
      
216
233
      <varlistentry>
217
234
        <term><option>--priority <replaceable>
218
235
        PRIORITY</replaceable></option></term>
220
237
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
238
        </listitem>
222
239
      </varlistentry>
223
 
 
 
240
      
224
241
      <varlistentry>
225
242
        <term><option>--servicename
226
243
        <replaceable>NAME</replaceable></option></term>
229
246
                      xpointer="servicename"/>
230
247
        </listitem>
231
248
      </varlistentry>
232
 
 
 
249
      
233
250
      <varlistentry>
234
251
        <term><option>--configdir
235
252
        <replaceable>DIRECTORY</replaceable></option></term>
244
261
          </para>
245
262
        </listitem>
246
263
      </varlistentry>
247
 
 
 
264
      
248
265
      <varlistentry>
249
266
        <term><option>--version</option></term>
250
267
        <listitem>
253
270
          </para>
254
271
        </listitem>
255
272
      </varlistentry>
 
273
      
 
274
      <varlistentry>
 
275
        <term><option>--no-dbus</option></term>
 
276
        <listitem>
 
277
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
278
          <para>
 
279
            See also <xref linkend="dbus_interface"/>.
 
280
          </para>
 
281
        </listitem>
 
282
      </varlistentry>
 
283
      
 
284
      <varlistentry>
 
285
        <term><option>--no-ipv6</option></term>
 
286
        <listitem>
 
287
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--no-restore</option></term>
 
293
        <listitem>
 
294
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
295
          <para>
 
296
            See also <xref linkend="persistent_state"/>.
 
297
          </para>
 
298
        </listitem>
 
299
      </varlistentry>
 
300
      
 
301
      <varlistentry>
 
302
        <term><option>--statedir
 
303
        <replaceable>DIRECTORY</replaceable></option></term>
 
304
        <listitem>
 
305
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
306
        </listitem>
 
307
      </varlistentry>
 
308
      
 
309
      <varlistentry>
 
310
        <term><option>--socket
 
311
        <replaceable>FD</replaceable></option></term>
 
312
        <listitem>
 
313
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
314
        </listitem>
 
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>--foreground</option></term>
 
319
        <listitem>
 
320
          <xi:include href="mandos-options.xml"
 
321
                      xpointer="foreground"/>
 
322
        </listitem>
 
323
      </varlistentry>
 
324
      
256
325
    </variablelist>
257
326
  </refsect1>
258
 
 
 
327
  
259
328
  <refsect1 id="overview">
260
329
    <title>OVERVIEW</title>
261
330
    <xi:include href="overview.xml"/>
262
331
    <para>
263
332
      This program is the server part.  It is a normal server program
264
333
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
334
      <acronym>RAM</acronym> disk environment.
266
335
    </para>
267
336
  </refsect1>
268
 
 
 
337
  
269
338
  <refsect1 id="protocol">
270
339
    <title>NETWORK PROTOCOL</title>
271
340
    <para>
323
392
      </row>
324
393
    </tbody></tgroup></table>
325
394
  </refsect1>
326
 
 
 
395
  
327
396
  <refsect1 id="checking">
328
397
    <title>CHECKING</title>
329
398
    <para>
330
399
      The server will, by default, continually check that the clients
331
400
      are still up.  If a client has not been confirmed as being up
332
401
      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>
 
402
      longer eligible to receive the encrypted password.  (Manual
 
403
      intervention is required to re-enable a client.)  The timeout,
 
404
      extended timeout, checker program, and interval between checks
 
405
      can be configured both globally and per client; see
 
406
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
407
      <manvolnum>5</manvolnum></citerefentry>.
 
408
    </para>
 
409
  </refsect1>
 
410
  
 
411
  <refsect1 id="approval">
 
412
    <title>APPROVAL</title>
 
413
    <para>
 
414
      The server can be configured to require manual approval for a
 
415
      client before it is sent its secret.  The delay to wait for such
 
416
      approval and the default action (approve or deny) can be
 
417
      configured both globally and per client; see <citerefentry>
336
418
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
 
      <manvolnum>5</manvolnum></citerefentry>.
338
 
    </para>
 
419
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
420
      will be approved immediately without delay.
 
421
    </para>
 
422
    <para>
 
423
      This can be used to deny a client its secret if not manually
 
424
      approved within a specified time.  It can also be used to make
 
425
      the server delay before giving a client its secret, allowing
 
426
      optional manual denying of this specific client.
 
427
    </para>
 
428
    
339
429
  </refsect1>
340
 
 
 
430
  
341
431
  <refsect1 id="logging">
342
432
    <title>LOGGING</title>
343
433
    <para>
344
434
      The server will send log message with various severity levels to
345
 
      <filename>/dev/log</filename>.  With the
 
435
      <filename class="devicefile">/dev/log</filename>.  With the
346
436
      <option>--debug</option> option, it will log even more messages,
347
437
      and also show them on the console.
348
438
    </para>
349
439
  </refsect1>
350
 
 
 
440
  
 
441
  <refsect1 id="persistent_state">
 
442
    <title>PERSISTENT STATE</title>
 
443
    <para>
 
444
      Client settings, initially read from
 
445
      <filename>clients.conf</filename>, are persistent across
 
446
      restarts, and run-time changes will override settings in
 
447
      <filename>clients.conf</filename>.  However, if a setting is
 
448
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
449
      <filename>clients.conf</filename>, this will take precedence.
 
450
    </para>
 
451
  </refsect1>
 
452
  
 
453
  <refsect1 id="dbus_interface">
 
454
    <title>D-BUS INTERFACE</title>
 
455
    <para>
 
456
      The server will by default provide a D-Bus system bus interface.
 
457
      This interface will only be accessible by the root user or a
 
458
      Mandos-specific user, if such a user exists.  For documentation
 
459
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
460
    </para>
 
461
  </refsect1>
 
462
  
351
463
  <refsect1 id="exit_status">
352
464
    <title>EXIT STATUS</title>
353
465
    <para>
355
467
      critical error is encountered.
356
468
    </para>
357
469
  </refsect1>
358
 
 
 
470
  
359
471
  <refsect1 id="environment">
360
472
    <title>ENVIRONMENT</title>
361
473
    <variablelist>
375
487
      </varlistentry>
376
488
    </variablelist>
377
489
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
490
  
 
491
  <refsect1 id="files">
380
492
    <title>FILES</title>
381
493
    <para>
382
494
      Use the <option>--configdir</option> option to change where
405
517
        </listitem>
406
518
      </varlistentry>
407
519
      <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>.
 
520
        <term><filename>/run/mandos.pid</filename></term>
 
521
        <listitem>
 
522
          <para>
 
523
            The file containing the process id of the
 
524
            <command>&COMMANDNAME;</command> process started last.
 
525
          </para>
 
526
        </listitem>
 
527
      </varlistentry>
 
528
      <varlistentry>
 
529
        <term><filename class="devicefile">/dev/log</filename></term>
 
530
      </varlistentry>
 
531
      <varlistentry>
 
532
        <term><filename
 
533
        class="directory">/var/lib/mandos</filename></term>
 
534
        <listitem>
 
535
          <para>
 
536
            Directory where persistent state will be saved.  Change
 
537
            this with the <option>--statedir</option> option.  See
 
538
            also the <option>--no-restore</option> option.
413
539
          </para>
414
540
        </listitem>
415
541
      </varlistentry>
443
569
      backtrace.  This could be considered a feature.
444
570
    </para>
445
571
    <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
572
      There is no fine-grained control over logging and debug output.
458
573
    </para>
459
574
    <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.
 
575
      This server does not check the expire time of clients’ OpenPGP
 
576
      keys.
464
577
    </para>
465
578
  </refsect1>
466
579
  
477
590
    <informalexample>
478
591
      <para>
479
592
        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:
 
593
        the <filename class="directory">~/mandos</filename> directory,
 
594
        and use the Zeroconf service name <quote>Test</quote> to not
 
595
        collide with any other official Mandos server on this host:
483
596
      </para>
484
597
      <para>
485
598
 
501
614
      </para>
502
615
    </informalexample>
503
616
  </refsect1>
504
 
 
 
617
  
505
618
  <refsect1 id="security">
506
619
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
620
    <refsect2 id="server">
508
621
      <title>SERVER</title>
509
622
      <para>
510
623
        Running this <command>&COMMANDNAME;</command> server program
511
624
        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.
 
625
        computer running it.  The program switches to a non-root user
 
626
        soon after startup.
514
627
      </para>
515
628
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
629
    <refsect2 id="clients">
517
630
      <title>CLIENTS</title>
518
631
      <para>
519
632
        The server only gives out its stored data to clients which
526
639
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
640
        <manvolnum>5</manvolnum></citerefentry>)
528
641
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
642
        except the user starting the server (usually root).
530
643
      </para>
531
644
      <para>
532
645
        As detailed in <xref linkend="checking"/>, the status of all
534
647
        compromised if they are gone for too long.
535
648
      </para>
536
649
      <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
650
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
651
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
652
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
653
      </para>
557
654
    </refsect2>
558
655
  </refsect1>
559
 
 
 
656
  
560
657
  <refsect1 id="see_also">
561
658
    <title>SEE ALSO</title>
562
659
    <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>
 
660
      <citerefentry><refentrytitle>intro</refentrytitle>
 
661
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
662
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
663
      <manvolnum>5</manvolnum></citerefentry>,
 
664
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
665
      <manvolnum>5</manvolnum></citerefentry>,
 
666
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
667
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
668
      <citerefentry><refentrytitle>sh</refentrytitle>
 
669
      <manvolnum>1</manvolnum></citerefentry>
572
670
    </para>
573
671
    <variablelist>
574
672
      <varlistentry>