/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: 2009-05-17 00:50:09 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090517005009-c0iptxampo6nf177
* initramfs-tools-hook-conf: Security bug fix: Add code to handle
                             being called by "mkinitramfs-kpkg"
                             instead of "update-initramfs".

Show diffs side-by-side

added added

removed removed

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