/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: 2008-09-21 12:04:02 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080921120402-mgd2jl8xo634jw18
* Makefile: Put the init script before avahi-daemon.

* debian/mandos.prerm: Bug fix: stop mandos, not ssh.

* debian/rules (install-indep): Put the init script before
                                avahi-daemon.

* init.d/mandos: Require "avahi-daemon".

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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2025-06-27">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-12">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
 
      <year>2020</year>
47
 
      <year>2021</year>
48
 
      <year>2022</year>
49
34
      <holder>Teddy Hogeborn</holder>
50
35
      <holder>Björn Påhlsson</holder>
51
36
    </copyright>
98
83
      <replaceable>DIRECTORY</replaceable></option></arg>
99
84
      <sbr/>
100
85
      <arg><option>--debug</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--debuglevel
103
 
      <replaceable>LEVEL</replaceable></option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--no-dbus</option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--no-ipv6</option></arg>
108
 
      <sbr/>
109
 
      <arg><option>--no-restore</option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--statedir
112
 
      <replaceable>DIRECTORY</replaceable></option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--socket
115
 
      <replaceable>FD</replaceable></option></arg>
116
 
      <sbr/>
117
 
      <arg><option>--foreground</option></arg>
118
 
      <sbr/>
119
 
      <arg><option>--no-zeroconf</option></arg>
120
86
    </cmdsynopsis>
121
87
    <cmdsynopsis>
122
88
      <command>&COMMANDNAME;</command>
139
105
    <title>DESCRIPTION</title>
140
106
    <para>
141
107
      <command>&COMMANDNAME;</command> is a server daemon which
142
 
      handles incoming requests for passwords for a pre-defined list
143
 
      of client host computers. For an introduction, see
144
 
      <citerefentry><refentrytitle>intro</refentrytitle>
145
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
146
 
      uses Zeroconf to announce itself on the local network, and uses
147
 
      TLS to communicate securely with and to authenticate the
148
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
149
 
      use IPv6 link-local addresses, since the clients will probably
150
 
      not have any other addresses configured (see <xref
151
 
      linkend="overview"/>).  Any authenticated client is then given
152
 
      the stored pre-encrypted password for that specific client.
 
108
      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.
153
117
    </para>
154
118
  </refsect1>
155
119
  
224
188
      </varlistentry>
225
189
      
226
190
      <varlistentry>
227
 
        <term><option>--debuglevel
228
 
        <replaceable>LEVEL</replaceable></option></term>
229
 
        <listitem>
230
 
          <para>
231
 
            Set the debugging log level.
232
 
            <replaceable>LEVEL</replaceable> is a string, one of
233
 
            <quote><literal>CRITICAL</literal></quote>,
234
 
            <quote><literal>ERROR</literal></quote>,
235
 
            <quote><literal>WARNING</literal></quote>,
236
 
            <quote><literal>INFO</literal></quote>, or
237
 
            <quote><literal>DEBUG</literal></quote>, in order of
238
 
            increasing verbosity.  The default level is
239
 
            <quote><literal>WARNING</literal></quote>.
240
 
          </para>
241
 
        </listitem>
242
 
      </varlistentry>
243
 
      
244
 
      <varlistentry>
245
191
        <term><option>--priority <replaceable>
246
192
        PRIORITY</replaceable></option></term>
247
193
        <listitem>
281
227
          </para>
282
228
        </listitem>
283
229
      </varlistentry>
284
 
      
285
 
      <varlistentry>
286
 
        <term><option>--no-dbus</option></term>
287
 
        <listitem>
288
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
289
 
          <para>
290
 
            See also <xref linkend="dbus_interface"/>.
291
 
          </para>
292
 
        </listitem>
293
 
      </varlistentry>
294
 
      
295
 
      <varlistentry>
296
 
        <term><option>--no-ipv6</option></term>
297
 
        <listitem>
298
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
299
 
        </listitem>
300
 
      </varlistentry>
301
 
      
302
 
      <varlistentry>
303
 
        <term><option>--no-restore</option></term>
304
 
        <listitem>
305
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
306
 
          <para>
307
 
            See also <xref linkend="persistent_state"/>.
308
 
          </para>
309
 
        </listitem>
310
 
      </varlistentry>
311
 
      
312
 
      <varlistentry>
313
 
        <term><option>--statedir
314
 
        <replaceable>DIRECTORY</replaceable></option></term>
315
 
        <listitem>
316
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
317
 
        </listitem>
318
 
      </varlistentry>
319
 
      
320
 
      <varlistentry>
321
 
        <term><option>--socket
322
 
        <replaceable>FD</replaceable></option></term>
323
 
        <listitem>
324
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
325
 
        </listitem>
326
 
      </varlistentry>
327
 
      
328
 
      <varlistentry>
329
 
        <term><option>--foreground</option></term>
330
 
        <listitem>
331
 
          <xi:include href="mandos-options.xml"
332
 
                      xpointer="foreground"/>
333
 
        </listitem>
334
 
      </varlistentry>
335
 
      
336
 
      <varlistentry>
337
 
        <term><option>--no-zeroconf</option></term>
338
 
        <listitem>
339
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
340
 
        </listitem>
341
 
      </varlistentry>
342
 
      
343
230
    </variablelist>
344
231
  </refsect1>
345
232
  
365
252
      start a TLS protocol handshake with a slight quirk: the Mandos
366
253
      server program acts as a TLS <quote>client</quote> while the
367
254
      connecting Mandos client acts as a TLS <quote>server</quote>.
368
 
      The Mandos client must supply a TLS public key, and the key ID
369
 
      of this public key is used by the Mandos server to look up (in a
370
 
      list read from <filename>clients.conf</filename> at start time)
371
 
      which binary blob to give the client.  No other authentication
372
 
      or authorization is done by the server.
 
255
      The Mandos client must supply an OpenPGP certificate, and the
 
256
      fingerprint of this certificate is used by the Mandos server to
 
257
      look up (in a list read from <filename>clients.conf</filename>
 
258
      at start time) which binary blob to give the client.  No other
 
259
      authentication or authorization is done by the server.
373
260
    </para>
374
261
    <table>
375
262
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
395
282
        </emphasis></entry>
396
283
      </row>
397
284
      <row>
398
 
        <entry>Public key (part of TLS handshake)</entry>
 
285
        <entry>OpenPGP public key (part of TLS handshake)</entry>
399
286
        <entry>-><!-- &rarr; --></entry>
400
287
      </row>
401
288
      <row>
417
304
      The server will, by default, continually check that the clients
418
305
      are still up.  If a client has not been confirmed as being up
419
306
      for some time, the client is assumed to be compromised and is no
420
 
      longer eligible to receive the encrypted password.  (Manual
421
 
      intervention is required to re-enable a client.)  The timeout,
422
 
      extended timeout, checker program, and interval between checks
423
 
      can be configured both globally and per client; see
424
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
307
      longer eligible to receive the encrypted password.  The timeout,
 
308
      checker program, and interval between checks can be configured
 
309
      both globally and per client; see <citerefentry>
 
310
      <refentrytitle>mandos-clients.conf</refentrytitle>
425
311
      <manvolnum>5</manvolnum></citerefentry>.
426
312
    </para>
427
313
  </refsect1>
428
314
  
429
 
  <refsect1 id="approval">
430
 
    <title>APPROVAL</title>
431
 
    <para>
432
 
      The server can be configured to require manual approval for a
433
 
      client before it is sent its secret.  The delay to wait for such
434
 
      approval and the default action (approve or deny) can be
435
 
      configured both globally and per client; see <citerefentry>
436
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
437
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
438
 
      will be approved immediately without delay.
439
 
    </para>
440
 
    <para>
441
 
      This can be used to deny a client its secret if not manually
442
 
      approved within a specified time.  It can also be used to make
443
 
      the server delay before giving a client its secret, allowing
444
 
      optional manual denying of this specific client.
445
 
    </para>
446
 
    
447
 
  </refsect1>
448
 
  
449
315
  <refsect1 id="logging">
450
316
    <title>LOGGING</title>
451
317
    <para>
452
318
      The server will send log message with various severity levels to
453
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
319
      <filename>/dev/log</filename>.  With the
454
320
      <option>--debug</option> option, it will log even more messages,
455
321
      and also show them on the console.
456
322
    </para>
457
323
  </refsect1>
458
324
  
459
 
  <refsect1 id="persistent_state">
460
 
    <title>PERSISTENT STATE</title>
461
 
    <para>
462
 
      Client settings, initially read from
463
 
      <filename>clients.conf</filename>, are persistent across
464
 
      restarts, and run-time changes will override settings in
465
 
      <filename>clients.conf</filename>.  However, if a setting is
466
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
467
 
      <filename>clients.conf</filename>, this will take precedence.
468
 
    </para>
469
 
  </refsect1>
470
 
  
471
 
  <refsect1 id="dbus_interface">
472
 
    <title>D-BUS INTERFACE</title>
473
 
    <para>
474
 
      The server will by default provide a D-Bus system bus interface.
475
 
      This interface will only be accessible by the root user or a
476
 
      Mandos-specific user, if such a user exists.  For documentation
477
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
478
 
    </para>
479
 
  </refsect1>
480
 
  
481
325
  <refsect1 id="exit_status">
482
326
    <title>EXIT STATUS</title>
483
327
    <para>
506
350
    </variablelist>
507
351
  </refsect1>
508
352
  
509
 
  <refsect1 id="files">
 
353
  <refsect1 id="file">
510
354
    <title>FILES</title>
511
355
    <para>
512
356
      Use the <option>--configdir</option> option to change where
535
379
        </listitem>
536
380
      </varlistentry>
537
381
      <varlistentry>
538
 
        <term><filename>/run/mandos.pid</filename></term>
539
 
        <listitem>
540
 
          <para>
541
 
            The file containing the process id of the
542
 
            <command>&COMMANDNAME;</command> process started last.
543
 
            <emphasis >Note:</emphasis> If the <filename
544
 
            class="directory">/run</filename> directory does not
545
 
            exist, <filename>/var/run/mandos.pid</filename> will be
546
 
            used instead.
547
 
          </para>
548
 
        </listitem>
549
 
      </varlistentry>
550
 
      <varlistentry>
551
 
        <term><filename
552
 
        class="directory">/var/lib/mandos</filename></term>
553
 
        <listitem>
554
 
          <para>
555
 
            Directory where persistent state will be saved.  Change
556
 
            this with the <option>--statedir</option> option.  See
557
 
            also the <option>--no-restore</option> option.
558
 
          </para>
559
 
        </listitem>
560
 
      </varlistentry>
561
 
      <varlistentry>
562
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
382
        <term><filename>/var/run/mandos.pid</filename></term>
 
383
        <listitem>
 
384
          <para>
 
385
            The file containing the process id of
 
386
            <command>&COMMANDNAME;</command>.
 
387
          </para>
 
388
        </listitem>
 
389
      </varlistentry>
 
390
      <varlistentry>
 
391
        <term><filename>/dev/log</filename></term>
563
392
        <listitem>
564
393
          <para>
565
394
            The Unix domain socket to where local syslog messages are
588
417
      backtrace.  This could be considered a feature.
589
418
    </para>
590
419
    <para>
 
420
      Currently, if a client is declared <quote>invalid</quote> due to
 
421
      having timed out, the server does not record this fact onto
 
422
      permanent storage.  This has some security implications, see
 
423
      <xref linkend="CLIENTS"/>.
 
424
    </para>
 
425
    <para>
 
426
      There is currently no way of querying the server of the current
 
427
      status of clients, other than analyzing its <systemitem
 
428
      class="service">syslog</systemitem> output.
 
429
    </para>
 
430
    <para>
591
431
      There is no fine-grained control over logging and debug output.
592
432
    </para>
593
 
    <xi:include href="bugs.xml"/>
 
433
    <para>
 
434
      Debug mode is conflated with running in the foreground.
 
435
    </para>
 
436
    <para>
 
437
      The console log messages does not show a time stamp.
 
438
    </para>
 
439
    <para>
 
440
      This server does not check the expire time of clients’ OpenPGP
 
441
      keys.
 
442
    </para>
594
443
  </refsect1>
595
444
  
596
445
  <refsect1 id="example">
606
455
    <informalexample>
607
456
      <para>
608
457
        Run the server in debug mode, read configuration files from
609
 
        the <filename class="directory">~/mandos</filename> directory,
610
 
        and use the Zeroconf service name <quote>Test</quote> to not
611
 
        collide with any other official Mandos server on this host:
 
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:
612
461
      </para>
613
462
      <para>
614
463
 
633
482
  
634
483
  <refsect1 id="security">
635
484
    <title>SECURITY</title>
636
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
637
486
      <title>SERVER</title>
638
487
      <para>
639
488
        Running this <command>&COMMANDNAME;</command> server program
642
491
        soon after startup.
643
492
      </para>
644
493
    </refsect2>
645
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
646
495
      <title>CLIENTS</title>
647
496
      <para>
648
497
        The server only gives out its stored data to clients which
649
 
        does have the correct key ID of the stored key ID.  This is
650
 
        guaranteed by the fact that the client sends its public key in
651
 
        the TLS handshake; this ensures it to be genuine.  The server
652
 
        computes the key ID of the key itself and looks up the key ID
653
 
        in its list of clients. The <filename>clients.conf</filename>
654
 
        file (see
 
498
        does have the OpenPGP key of the stored fingerprint.  This is
 
499
        guaranteed by the fact that the client sends its OpenPGP
 
500
        public key in the TLS handshake; this ensures it to be
 
501
        genuine.  The server computes the fingerprint of the key
 
502
        itself and looks up the fingerprint in its list of
 
503
        clients. The <filename>clients.conf</filename> file (see
655
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
656
505
        <manvolnum>5</manvolnum></citerefentry>)
657
506
        <emphasis>must</emphasis> be made non-readable by anyone
658
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
659
508
      </para>
660
509
      <para>
661
510
        As detailed in <xref linkend="checking"/>, the status of all
663
512
        compromised if they are gone for too long.
664
513
      </para>
665
514
      <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>
666
531
        For more details on client-side security, see
667
532
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
668
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
673
538
  <refsect1 id="see_also">
674
539
    <title>SEE ALSO</title>
675
540
    <para>
676
 
      <citerefentry><refentrytitle>intro</refentrytitle>
677
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
678
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
679
 
      <manvolnum>5</manvolnum></citerefentry>,
680
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
681
 
      <manvolnum>5</manvolnum></citerefentry>,
682
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
683
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
684
 
      <citerefentry><refentrytitle>sh</refentrytitle>
685
 
      <manvolnum>1</manvolnum></citerefentry>
 
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>mandos-client</refentrytitle>
 
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
549
      </citerefentry>
686
550
    </para>
687
551
    <variablelist>
688
552
      <varlistentry>
698
562
      </varlistentry>
699
563
      <varlistentry>
700
564
        <term>
701
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
565
          <ulink url="http://www.avahi.org/">Avahi</ulink>
702
566
        </term>
703
567
      <listitem>
704
568
        <para>
709
573
      </varlistentry>
710
574
      <varlistentry>
711
575
        <term>
712
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
576
          <ulink url="http://www.gnu.org/software/gnutls/"
 
577
          >GnuTLS</ulink>
713
578
        </term>
714
579
      <listitem>
715
580
        <para>
716
581
          GnuTLS is the library this server uses to implement TLS for
717
582
          communicating securely with the client, and at the same time
718
 
          confidently get the client’s public key.
 
583
          confidently get the client’s public OpenPGP key.
719
584
        </para>
720
585
      </listitem>
721
586
      </varlistentry>
742
607
            <listitem>
743
608
              <para>
744
609
                The clients use IPv6 link-local addresses, which are
745
 
                immediately usable since a link-local address is
 
610
                immediately usable since a link-local addresses is
746
611
                automatically assigned to a network interfaces when it
747
612
                is brought up.
748
613
              </para>
753
618
      </varlistentry>
754
619
      <varlistentry>
755
620
        <term>
756
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
757
 
          Protocol Version 1.2</citetitle>
 
621
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
622
          Protocol Version 1.1</citetitle>
758
623
        </term>
759
624
      <listitem>
760
625
        <para>
761
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
626
          TLS 1.1 is the protocol implemented by GnuTLS.
762
627
        </para>
763
628
      </listitem>
764
629
      </varlistentry>
774
639
      </varlistentry>
775
640
      <varlistentry>
776
641
        <term>
777
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
778
 
          Layer Security (TLS) and Datagram Transport Layer Security
779
 
          (DTLS)</citetitle>
780
 
        </term>
781
 
      <listitem>
782
 
        <para>
783
 
          This is implemented by GnuTLS version 3.6.6 and is, if
784
 
          present, used by this server so that raw public keys can be
785
 
          used.
786
 
        </para>
787
 
      </listitem>
788
 
      </varlistentry>
789
 
      <varlistentry>
790
 
        <term>
791
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
792
 
          Security (TLS) Authentication</citetitle>
793
 
        </term>
794
 
      <listitem>
795
 
        <para>
796
 
          This is implemented by GnuTLS before version 3.6.0 and is,
797
 
          if present, used by this server so that OpenPGP keys can be
798
 
          used.
 
642
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
643
          Security</citetitle>
 
644
        </term>
 
645
      <listitem>
 
646
        <para>
 
647
          This is implemented by GnuTLS and used by this server so
 
648
          that OpenPGP keys can be used.
799
649
        </para>
800
650
      </listitem>
801
651
      </varlistentry>