/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: 2008-10-12 07:27:43 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081012072743-0g7o9e5mqqv4fkob
* README: Refer to man pages of usplash, splashy, and askpass-fifo.

* debian/copyright: Rewritten to conform to
  <http://wiki.debian.org/Proposals/CopyrightFormat?action=recall&rev=233>.

* mandos-keygen: Sign encrypted keys.

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-02-09">
 
5
<!ENTITY TIMESTAMP "2008-10-03">
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
 
      <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
35
      <holder>Teddy Hogeborn</holder>
46
36
      <holder>Björn Påhlsson</holder>
47
37
    </copyright>
94
84
      <replaceable>DIRECTORY</replaceable></option></arg>
95
85
      <sbr/>
96
86
      <arg><option>--debug</option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--debuglevel
99
 
      <replaceable>LEVEL</replaceable></option></arg>
100
 
      <sbr/>
101
 
      <arg><option>--no-dbus</option></arg>
102
 
      <sbr/>
103
 
      <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
87
    </cmdsynopsis>
117
88
    <cmdsynopsis>
118
89
      <command>&COMMANDNAME;</command>
136
107
    <para>
137
108
      <command>&COMMANDNAME;</command> is a server daemon which
138
109
      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.
 
110
      client host computers.  The Mandos server uses Zeroconf to
 
111
      announce itself on the local network, and uses TLS to
 
112
      communicate securely with and to authenticate the clients.  The
 
113
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
114
      link-local addresses, since the clients will probably not have
 
115
      any other addresses configured (see <xref linkend="overview"/>).
 
116
      Any authenticated client is then given the stored pre-encrypted
 
117
      password for that specific client.
149
118
    </para>
150
119
  </refsect1>
151
120
  
220
189
      </varlistentry>
221
190
      
222
191
      <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
192
        <term><option>--priority <replaceable>
242
193
        PRIORITY</replaceable></option></term>
243
194
        <listitem>
277
228
          </para>
278
229
        </listitem>
279
230
      </varlistentry>
280
 
      
281
 
      <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
 
        <term><option>--no-ipv6</option></term>
293
 
        <listitem>
294
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
295
 
        </listitem>
296
 
      </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
231
    </variablelist>
340
232
  </refsect1>
341
233
  
361
253
      start a TLS protocol handshake with a slight quirk: the Mandos
362
254
      server program acts as a TLS <quote>client</quote> while the
363
255
      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.
 
256
      The Mandos client must supply an OpenPGP certificate, and the
 
257
      fingerprint of this certificate is used by the Mandos server to
 
258
      look up (in a list read from <filename>clients.conf</filename>
 
259
      at start time) which binary blob to give the client.  No other
 
260
      authentication or authorization is done by the server.
369
261
    </para>
370
262
    <table>
371
263
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
283
        </emphasis></entry>
392
284
      </row>
393
285
      <row>
394
 
        <entry>Public key (part of TLS handshake)</entry>
 
286
        <entry>OpenPGP public key (part of TLS handshake)</entry>
395
287
        <entry>-><!-- &rarr; --></entry>
396
288
      </row>
397
289
      <row>
413
305
      The server will, by default, continually check that the clients
414
306
      are still up.  If a client has not been confirmed as being up
415
307
      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>
 
308
      longer eligible to receive the encrypted password.  The timeout,
 
309
      checker program, and interval between checks can be configured
 
310
      both globally and per client; see <citerefentry>
 
311
      <refentrytitle>mandos-clients.conf</refentrytitle>
421
312
      <manvolnum>5</manvolnum></citerefentry>.
422
313
    </para>
423
314
  </refsect1>
424
315
  
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
316
  <refsect1 id="logging">
446
317
    <title>LOGGING</title>
447
318
    <para>
448
319
      The server will send log message with various severity levels to
449
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
320
      <filename>/dev/log</filename>.  With the
450
321
      <option>--debug</option> option, it will log even more messages,
451
322
      and also show them on the console.
452
323
    </para>
453
324
  </refsect1>
454
325
  
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
326
  <refsect1 id="exit_status">
478
327
    <title>EXIT STATUS</title>
479
328
    <para>
531
380
        </listitem>
532
381
      </varlistentry>
533
382
      <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>
 
383
        <term><filename>/var/run/mandos.pid</filename></term>
 
384
        <listitem>
 
385
          <para>
 
386
            The file containing the process id of
 
387
            <command>&COMMANDNAME;</command>.
 
388
          </para>
 
389
        </listitem>
 
390
      </varlistentry>
 
391
      <varlistentry>
 
392
        <term><filename>/dev/log</filename></term>
559
393
        <listitem>
560
394
          <para>
561
395
            The Unix domain socket to where local syslog messages are
584
418
      backtrace.  This could be considered a feature.
585
419
    </para>
586
420
    <para>
 
421
      Currently, if a client is declared <quote>invalid</quote> due to
 
422
      having timed out, the server does not record this fact onto
 
423
      permanent storage.  This has some security implications, see
 
424
      <xref linkend="clients"/>.
 
425
    </para>
 
426
    <para>
 
427
      There is currently no way of querying the server of the current
 
428
      status of clients, other than analyzing its <systemitem
 
429
      class="service">syslog</systemitem> output.
 
430
    </para>
 
431
    <para>
587
432
      There is no fine-grained control over logging and debug output.
588
433
    </para>
589
 
    <xi:include href="bugs.xml"/>
 
434
    <para>
 
435
      Debug mode is conflated with running in the foreground.
 
436
    </para>
 
437
    <para>
 
438
      The console log messages does not show a time stamp.
 
439
    </para>
 
440
    <para>
 
441
      This server does not check the expire time of clients’ OpenPGP
 
442
      keys.
 
443
    </para>
590
444
  </refsect1>
591
445
  
592
446
  <refsect1 id="example">
602
456
    <informalexample>
603
457
      <para>
604
458
        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:
 
459
        the <filename>~/mandos</filename> directory, and use the
 
460
        Zeroconf service name <quote>Test</quote> to not collide with
 
461
        any other official Mandos server on this host:
608
462
      </para>
609
463
      <para>
610
464
 
642
496
      <title>CLIENTS</title>
643
497
      <para>
644
498
        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
 
499
        does have the OpenPGP key of the stored fingerprint.  This is
 
500
        guaranteed by the fact that the client sends its OpenPGP
 
501
        public key in the TLS handshake; this ensures it to be
 
502
        genuine.  The server computes the fingerprint of the key
 
503
        itself and looks up the fingerprint in its list of
 
504
        clients. The <filename>clients.conf</filename> file (see
651
505
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
506
        <manvolnum>5</manvolnum></citerefentry>)
653
507
        <emphasis>must</emphasis> be made non-readable by anyone
659
513
        compromised if they are gone for too long.
660
514
      </para>
661
515
      <para>
 
516
        If a client is compromised, its downtime should be duly noted
 
517
        by the server which would therefore declare the client
 
518
        invalid.  But if the server was ever restarted, it would
 
519
        re-read its client list from its configuration file and again
 
520
        regard all clients therein as valid, and hence eligible to
 
521
        receive their passwords.  Therefore, be careful when
 
522
        restarting servers if it is suspected that a client has, in
 
523
        fact, been compromised by parties who may now be running a
 
524
        fake Mandos client with the keys from the non-encrypted
 
525
        initial <acronym>RAM</acronym> image of the client host.  What
 
526
        should be done in that case (if restarting the server program
 
527
        really is necessary) is to stop the server program, edit the
 
528
        configuration file to omit any suspect clients, and restart
 
529
        the server program.
 
530
      </para>
 
531
      <para>
662
532
        For more details on client-side security, see
663
533
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
664
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
669
539
  <refsect1 id="see_also">
670
540
    <title>SEE ALSO</title>
671
541
    <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>
 
542
      <citerefentry>
 
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>mandos.conf</refentrytitle>
 
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>mandos-client</refentrytitle>
 
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
550
      </citerefentry>
682
551
    </para>
683
552
    <variablelist>
684
553
      <varlistentry>
705
574
      </varlistentry>
706
575
      <varlistentry>
707
576
        <term>
708
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
577
          <ulink url="http://www.gnu.org/software/gnutls/"
 
578
          >GnuTLS</ulink>
709
579
        </term>
710
580
      <listitem>
711
581
        <para>
712
582
          GnuTLS is the library this server uses to implement TLS for
713
583
          communicating securely with the client, and at the same time
714
 
          confidently get the client’s public key.
 
584
          confidently get the client’s public OpenPGP key.
715
585
        </para>
716
586
      </listitem>
717
587
      </varlistentry>
749
619
      </varlistentry>
750
620
      <varlistentry>
751
621
        <term>
752
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
 
          Protocol Version 1.2</citetitle>
 
622
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
623
          Protocol Version 1.1</citetitle>
754
624
        </term>
755
625
      <listitem>
756
626
        <para>
757
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
627
          TLS 1.1 is the protocol implemented by GnuTLS.
758
628
        </para>
759
629
      </listitem>
760
630
      </varlistentry>
770
640
      </varlistentry>
771
641
      <varlistentry>
772
642
        <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.
 
643
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
644
          Security</citetitle>
 
645
        </term>
 
646
      <listitem>
 
647
        <para>
 
648
          This is implemented by GnuTLS and used by this server so
 
649
          that OpenPGP keys can be used.
795
650
        </para>
796
651
      </listitem>
797
652
      </varlistentry>