/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

* Makefile: Don't use PIE if BROKEN_PIE is set.
* debian/rules: Set BROKEN_PIE on mips and mipsel architectures.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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
4
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2019-07-24">
 
5
<!ENTITY TIMESTAMP "2009-09-17">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
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
36
      <holder>Teddy Hogeborn</holder>
47
37
      <holder>Björn Påhlsson</holder>
48
38
    </copyright>
96
86
      <sbr/>
97
87
      <arg><option>--debug</option></arg>
98
88
      <sbr/>
99
 
      <arg><option>--debuglevel
100
 
      <replaceable>LEVEL</replaceable></option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--no-dbus</option></arg>
103
 
      <sbr/>
104
89
      <arg><option>--no-ipv6</option></arg>
105
 
      <sbr/>
106
 
      <arg><option>--no-restore</option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--statedir
109
 
      <replaceable>DIRECTORY</replaceable></option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--socket
112
 
      <replaceable>FD</replaceable></option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--foreground</option></arg>
115
 
      <sbr/>
116
 
      <arg><option>--no-zeroconf</option></arg>
117
90
    </cmdsynopsis>
118
91
    <cmdsynopsis>
119
92
      <command>&COMMANDNAME;</command>
137
110
    <para>
138
111
      <command>&COMMANDNAME;</command> is a server daemon which
139
112
      handles incoming request for passwords for a pre-defined list of
140
 
      client host computers. For an introduction, see
141
 
      <citerefentry><refentrytitle>intro</refentrytitle>
142
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
 
      uses Zeroconf to announce itself on the local network, and uses
144
 
      TLS to communicate securely with and to authenticate the
145
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
146
 
      use IPv6 link-local addresses, since the clients will probably
147
 
      not have any other addresses configured (see <xref
148
 
      linkend="overview"/>).  Any authenticated client is then given
149
 
      the stored pre-encrypted password for that specific client.
 
113
      client host computers.  The Mandos server uses Zeroconf to
 
114
      announce itself on the local network, and uses TLS to
 
115
      communicate securely with and to authenticate the clients.  The
 
116
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
117
      link-local addresses, since the clients will probably not have
 
118
      any other addresses configured (see <xref linkend="overview"/>).
 
119
      Any authenticated client is then given the stored pre-encrypted
 
120
      password for that specific client.
150
121
    </para>
151
122
  </refsect1>
152
123
  
221
192
      </varlistentry>
222
193
      
223
194
      <varlistentry>
224
 
        <term><option>--debuglevel
225
 
        <replaceable>LEVEL</replaceable></option></term>
226
 
        <listitem>
227
 
          <para>
228
 
            Set the debugging log level.
229
 
            <replaceable>LEVEL</replaceable> is a string, one of
230
 
            <quote><literal>CRITICAL</literal></quote>,
231
 
            <quote><literal>ERROR</literal></quote>,
232
 
            <quote><literal>WARNING</literal></quote>,
233
 
            <quote><literal>INFO</literal></quote>, or
234
 
            <quote><literal>DEBUG</literal></quote>, in order of
235
 
            increasing verbosity.  The default level is
236
 
            <quote><literal>WARNING</literal></quote>.
237
 
          </para>
238
 
        </listitem>
239
 
      </varlistentry>
240
 
      
241
 
      <varlistentry>
242
195
        <term><option>--priority <replaceable>
243
196
        PRIORITY</replaceable></option></term>
244
197
        <listitem>
280
233
      </varlistentry>
281
234
      
282
235
      <varlistentry>
283
 
        <term><option>--no-dbus</option></term>
284
 
        <listitem>
285
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
286
 
          <para>
287
 
            See also <xref linkend="dbus_interface"/>.
288
 
          </para>
289
 
        </listitem>
290
 
      </varlistentry>
291
 
      
292
 
      <varlistentry>
293
236
        <term><option>--no-ipv6</option></term>
294
237
        <listitem>
295
238
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
239
        </listitem>
297
240
      </varlistentry>
298
 
      
299
 
      <varlistentry>
300
 
        <term><option>--no-restore</option></term>
301
 
        <listitem>
302
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
303
 
          <para>
304
 
            See also <xref linkend="persistent_state"/>.
305
 
          </para>
306
 
        </listitem>
307
 
      </varlistentry>
308
 
      
309
 
      <varlistentry>
310
 
        <term><option>--statedir
311
 
        <replaceable>DIRECTORY</replaceable></option></term>
312
 
        <listitem>
313
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
314
 
        </listitem>
315
 
      </varlistentry>
316
 
      
317
 
      <varlistentry>
318
 
        <term><option>--socket
319
 
        <replaceable>FD</replaceable></option></term>
320
 
        <listitem>
321
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
322
 
        </listitem>
323
 
      </varlistentry>
324
 
      
325
 
      <varlistentry>
326
 
        <term><option>--foreground</option></term>
327
 
        <listitem>
328
 
          <xi:include href="mandos-options.xml"
329
 
                      xpointer="foreground"/>
330
 
        </listitem>
331
 
      </varlistentry>
332
 
      
333
 
      <varlistentry>
334
 
        <term><option>--no-zeroconf</option></term>
335
 
        <listitem>
336
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
337
 
        </listitem>
338
 
      </varlistentry>
339
 
      
340
241
    </variablelist>
341
242
  </refsect1>
342
243
  
362
263
      start a TLS protocol handshake with a slight quirk: the Mandos
363
264
      server program acts as a TLS <quote>client</quote> while the
364
265
      connecting Mandos client acts as a TLS <quote>server</quote>.
365
 
      The Mandos client must supply a TLS public key, and the key ID
366
 
      of this public key is used by the Mandos server to look up (in a
367
 
      list read from <filename>clients.conf</filename> at start time)
368
 
      which binary blob to give the client.  No other authentication
369
 
      or authorization is done by the server.
 
266
      The Mandos client must supply an OpenPGP certificate, and the
 
267
      fingerprint of this certificate is used by the Mandos server to
 
268
      look up (in a list read from <filename>clients.conf</filename>
 
269
      at start time) which binary blob to give the client.  No other
 
270
      authentication or authorization is done by the server.
370
271
    </para>
371
272
    <table>
372
273
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
293
        </emphasis></entry>
393
294
      </row>
394
295
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
296
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
297
        <entry>-><!-- &rarr; --></entry>
397
298
      </row>
398
299
      <row>
416
317
      for some time, the client is assumed to be compromised and is no
417
318
      longer eligible to receive the encrypted password.  (Manual
418
319
      intervention is required to re-enable a client.)  The timeout,
419
 
      extended timeout, checker program, and interval between checks
420
 
      can be configured both globally and per client; see
421
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
422
 
      <manvolnum>5</manvolnum></citerefentry>.
423
 
    </para>
424
 
  </refsect1>
425
 
  
426
 
  <refsect1 id="approval">
427
 
    <title>APPROVAL</title>
428
 
    <para>
429
 
      The server can be configured to require manual approval for a
430
 
      client before it is sent its secret.  The delay to wait for such
431
 
      approval and the default action (approve or deny) can be
432
 
      configured both globally and per client; see <citerefentry>
 
320
      checker program, and interval between checks can be configured
 
321
      both globally and per client; see <citerefentry>
433
322
      <refentrytitle>mandos-clients.conf</refentrytitle>
434
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
435
 
      will be approved immediately without delay.
436
 
    </para>
437
 
    <para>
438
 
      This can be used to deny a client its secret if not manually
439
 
      approved within a specified time.  It can also be used to make
440
 
      the server delay before giving a client its secret, allowing
441
 
      optional manual denying of this specific client.
442
 
    </para>
443
 
    
 
323
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
324
      receiving its password will also be treated as a successful
 
325
      checker run.
 
326
    </para>
444
327
  </refsect1>
445
328
  
446
329
  <refsect1 id="logging">
447
330
    <title>LOGGING</title>
448
331
    <para>
449
332
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
333
      <filename>/dev/log</filename>.  With the
451
334
      <option>--debug</option> option, it will log even more messages,
452
335
      and also show them on the console.
453
336
    </para>
454
337
  </refsect1>
455
338
  
456
 
  <refsect1 id="persistent_state">
457
 
    <title>PERSISTENT STATE</title>
458
 
    <para>
459
 
      Client settings, initially read from
460
 
      <filename>clients.conf</filename>, are persistent across
461
 
      restarts, and run-time changes will override settings in
462
 
      <filename>clients.conf</filename>.  However, if a setting is
463
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
464
 
      <filename>clients.conf</filename>, this will take precedence.
465
 
    </para>
466
 
  </refsect1>
467
 
  
468
 
  <refsect1 id="dbus_interface">
469
 
    <title>D-BUS INTERFACE</title>
470
 
    <para>
471
 
      The server will by default provide a D-Bus system bus interface.
472
 
      This interface will only be accessible by the root user or a
473
 
      Mandos-specific user, if such a user exists.  For documentation
474
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
475
 
    </para>
476
 
  </refsect1>
477
 
  
478
339
  <refsect1 id="exit_status">
479
340
    <title>EXIT STATUS</title>
480
341
    <para>
532
393
        </listitem>
533
394
      </varlistentry>
534
395
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
536
 
        <listitem>
537
 
          <para>
538
 
            The file containing the process id of the
539
 
            <command>&COMMANDNAME;</command> process started last.
540
 
            <emphasis >Note:</emphasis> If the <filename
541
 
            class="directory">/run</filename> directory does not
542
 
            exist, <filename>/var/run/mandos.pid</filename> will be
543
 
            used instead.
544
 
          </para>
545
 
        </listitem>
546
 
      </varlistentry>
547
 
      <varlistentry>
548
 
        <term><filename
549
 
        class="directory">/var/lib/mandos</filename></term>
550
 
        <listitem>
551
 
          <para>
552
 
            Directory where persistent state will be saved.  Change
553
 
            this with the <option>--statedir</option> option.  See
554
 
            also the <option>--no-restore</option> option.
555
 
          </para>
556
 
        </listitem>
557
 
      </varlistentry>
558
 
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
396
        <term><filename>/var/run/mandos.pid</filename></term>
 
397
        <listitem>
 
398
          <para>
 
399
            The file containing the process id of
 
400
            <command>&COMMANDNAME;</command>.
 
401
          </para>
 
402
        </listitem>
 
403
      </varlistentry>
 
404
      <varlistentry>
 
405
        <term><filename>/dev/log</filename></term>
560
406
        <listitem>
561
407
          <para>
562
408
            The Unix domain socket to where local syslog messages are
585
431
      backtrace.  This could be considered a feature.
586
432
    </para>
587
433
    <para>
 
434
      Currently, if a client is declared <quote>invalid</quote> due to
 
435
      having timed out, the server does not record this fact onto
 
436
      permanent storage.  This has some security implications, see
 
437
      <xref linkend="clients"/>.
 
438
    </para>
 
439
    <para>
 
440
      There is currently no way of querying the server of the current
 
441
      status of clients, other than analyzing its <systemitem
 
442
      class="service">syslog</systemitem> output.
 
443
    </para>
 
444
    <para>
588
445
      There is no fine-grained control over logging and debug output.
589
446
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
447
    <para>
 
448
      Debug mode is conflated with running in the foreground.
 
449
    </para>
 
450
    <para>
 
451
      The console log messages do not show a time stamp.
 
452
    </para>
 
453
    <para>
 
454
      This server does not check the expire time of clients’ OpenPGP
 
455
      keys.
 
456
    </para>
591
457
  </refsect1>
592
458
  
593
459
  <refsect1 id="example">
603
469
    <informalexample>
604
470
      <para>
605
471
        Run the server in debug mode, read configuration files from
606
 
        the <filename class="directory">~/mandos</filename> directory,
607
 
        and use the Zeroconf service name <quote>Test</quote> to not
608
 
        collide with any other official Mandos server on this host:
 
472
        the <filename>~/mandos</filename> directory, and use the
 
473
        Zeroconf service name <quote>Test</quote> to not collide with
 
474
        any other official Mandos server on this host:
609
475
      </para>
610
476
      <para>
611
477
 
643
509
      <title>CLIENTS</title>
644
510
      <para>
645
511
        The server only gives out its stored data to clients which
646
 
        does have the correct key ID of the stored key ID.  This is
647
 
        guaranteed by the fact that the client sends its public key in
648
 
        the TLS handshake; this ensures it to be genuine.  The server
649
 
        computes the key ID of the key itself and looks up the key ID
650
 
        in its list of clients. The <filename>clients.conf</filename>
651
 
        file (see
 
512
        does have the OpenPGP key of the stored fingerprint.  This is
 
513
        guaranteed by the fact that the client sends its OpenPGP
 
514
        public key in the TLS handshake; this ensures it to be
 
515
        genuine.  The server computes the fingerprint of the key
 
516
        itself and looks up the fingerprint in its list of
 
517
        clients. The <filename>clients.conf</filename> file (see
652
518
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
519
        <manvolnum>5</manvolnum></citerefentry>)
654
520
        <emphasis>must</emphasis> be made non-readable by anyone
660
526
        compromised if they are gone for too long.
661
527
      </para>
662
528
      <para>
 
529
        If a client is compromised, its downtime should be duly noted
 
530
        by the server which would therefore declare the client
 
531
        invalid.  But if the server was ever restarted, it would
 
532
        re-read its client list from its configuration file and again
 
533
        regard all clients therein as valid, and hence eligible to
 
534
        receive their passwords.  Therefore, be careful when
 
535
        restarting servers if it is suspected that a client has, in
 
536
        fact, been compromised by parties who may now be running a
 
537
        fake Mandos client with the keys from the non-encrypted
 
538
        initial <acronym>RAM</acronym> image of the client host.  What
 
539
        should be done in that case (if restarting the server program
 
540
        really is necessary) is to stop the server program, edit the
 
541
        configuration file to omit any suspect clients, and restart
 
542
        the server program.
 
543
      </para>
 
544
      <para>
663
545
        For more details on client-side security, see
664
546
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
665
547
        <manvolnum>8mandos</manvolnum></citerefentry>.
670
552
  <refsect1 id="see_also">
671
553
    <title>SEE ALSO</title>
672
554
    <para>
673
 
      <citerefentry><refentrytitle>intro</refentrytitle>
674
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
675
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
 
      <manvolnum>5</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
680
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
681
 
      <citerefentry><refentrytitle>sh</refentrytitle>
682
 
      <manvolnum>1</manvolnum></citerefentry>
 
555
      <citerefentry>
 
556
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
557
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
558
        <refentrytitle>mandos.conf</refentrytitle>
 
559
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
560
        <refentrytitle>mandos-client</refentrytitle>
 
561
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
562
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
563
      </citerefentry>
683
564
    </para>
684
565
    <variablelist>
685
566
      <varlistentry>
695
576
      </varlistentry>
696
577
      <varlistentry>
697
578
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
579
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
580
        </term>
700
581
      <listitem>
701
582
        <para>
706
587
      </varlistentry>
707
588
      <varlistentry>
708
589
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
590
          <ulink url="http://www.gnu.org/software/gnutls/"
 
591
          >GnuTLS</ulink>
710
592
        </term>
711
593
      <listitem>
712
594
        <para>
713
595
          GnuTLS is the library this server uses to implement TLS for
714
596
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
597
          confidently get the client’s public OpenPGP key.
716
598
        </para>
717
599
      </listitem>
718
600
      </varlistentry>
750
632
      </varlistentry>
751
633
      <varlistentry>
752
634
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
635
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
636
          Protocol Version 1.1</citetitle>
755
637
        </term>
756
638
      <listitem>
757
639
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
640
          TLS 1.1 is the protocol implemented by GnuTLS.
759
641
        </para>
760
642
      </listitem>
761
643
      </varlistentry>
771
653
      </varlistentry>
772
654
      <varlistentry>
773
655
        <term>
774
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
775
 
          Layer Security (TLS) and Datagram Transport Layer Security
776
 
          (DTLS)</citetitle>
777
 
        </term>
778
 
      <listitem>
779
 
        <para>
780
 
          This is implemented by GnuTLS version 3.6.6 and is, if
781
 
          present, used by this server so that raw public keys can be
782
 
          used.
783
 
        </para>
784
 
      </listitem>
785
 
      </varlistentry>
786
 
      <varlistentry>
787
 
        <term>
788
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
789
 
          Security (TLS) Authentication</citetitle>
790
 
        </term>
791
 
      <listitem>
792
 
        <para>
793
 
          This is implemented by GnuTLS before version 3.6.0 and is,
794
 
          if present, used by this server so that OpenPGP keys can be
795
 
          used.
 
656
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
657
          Security</citetitle>
 
658
        </term>
 
659
      <listitem>
 
660
        <para>
 
661
          This is implemented by GnuTLS and used by this server so
 
662
          that OpenPGP keys can be used.
796
663
        </para>
797
664
      </listitem>
798
665
      </varlistentry>