/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-02-16 02:42:42 UTC
  • Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.

* debian/control (Build-Depends): Add Python dependencies to
                                  successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.

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