/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: 2011-11-26 23:08:17 UTC
  • mto: (237.12.8 mandos-persistent)
  • mto: This revision was merged to the branch mainline in revision 290.
  • Revision ID: teddy@recompile.se-20111126230817-tv08v831s2yltbkd
Make "enabled" a client config option.

* DBUS-API: Fix wording on "Expires" option.
* clients.conf (enabled): New.
* mandos (Client): "last_enabled" can now be None.
  (Client.__init__): Get "enabled" from config.  Only set
                     "last_enabled" and "expires" if enabled.
  (ClientDBus.Created_dbus_property): Removed redundant dbus.String().
  (ClientDBus.Interval_dbus_property): If changed, only reschedule
                                       checker if enabled.
  (main/special_settings): Added "enabled".
* mandos-clients.conf (OPTIONS): Added "enabled".

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-10">
 
5
<!ENTITY TIMESTAMP "2011-11-26">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
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
38
      <holder>Teddy Hogeborn</holder>
47
39
      <holder>Björn Påhlsson</holder>
48
40
    </copyright>
107
99
      <sbr/>
108
100
      <arg><option>--statedir
109
101
      <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
102
    </cmdsynopsis>
118
103
    <cmdsynopsis>
119
104
      <command>&COMMANDNAME;</command>
300
285
        <term><option>--no-restore</option></term>
301
286
        <listitem>
302
287
          <xi:include href="mandos-options.xml" xpointer="restore"/>
303
 
          <para>
304
 
            See also <xref linkend="persistent_state"/>.
305
 
          </para>
306
288
        </listitem>
307
289
      </varlistentry>
308
290
      
313
295
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
314
296
        </listitem>
315
297
      </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
298
    </variablelist>
341
299
  </refsect1>
342
300
  
362
320
      start a TLS protocol handshake with a slight quirk: the Mandos
363
321
      server program acts as a TLS <quote>client</quote> while the
364
322
      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.
 
323
      The Mandos client must supply an OpenPGP certificate, and the
 
324
      fingerprint of this certificate is used by the Mandos server to
 
325
      look up (in a list read from <filename>clients.conf</filename>
 
326
      at start time) which binary blob to give the client.  No other
 
327
      authentication or authorization is done by the server.
370
328
    </para>
371
329
    <table>
372
330
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
350
        </emphasis></entry>
393
351
      </row>
394
352
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
353
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
354
        <entry>-><!-- &rarr; --></entry>
397
355
      </row>
398
356
      <row>
419
377
      extended timeout, checker program, and interval between checks
420
378
      can be configured both globally and per client; see
421
379
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
422
 
      <manvolnum>5</manvolnum></citerefentry>.
 
380
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
381
      receiving its password will also be treated as a successful
 
382
      checker run.
423
383
    </para>
424
384
  </refsect1>
425
385
  
447
407
    <title>LOGGING</title>
448
408
    <para>
449
409
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
410
      <filename>/dev/log</filename>.  With the
451
411
      <option>--debug</option> option, it will log even more messages,
452
412
      and also show them on the console.
453
413
    </para>
454
414
  </refsect1>
455
415
  
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
416
  <refsect1 id="dbus_interface">
469
417
    <title>D-BUS INTERFACE</title>
470
418
    <para>
532
480
        </listitem>
533
481
      </varlistentry>
534
482
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
 
483
        <term><filename>/var/run/mandos.pid</filename></term>
536
484
        <listitem>
537
485
          <para>
538
486
            The file containing the process id of the
539
487
            <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
488
          </para>
545
489
        </listitem>
546
490
      </varlistentry>
556
500
        </listitem>
557
501
      </varlistentry>
558
502
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
503
        <term><filename>/dev/log</filename></term>
560
504
        <listitem>
561
505
          <para>
562
506
            The Unix domain socket to where local syslog messages are
587
531
    <para>
588
532
      There is no fine-grained control over logging and debug output.
589
533
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
534
    <para>
 
535
      Debug mode is conflated with running in the foreground.
 
536
    </para>
 
537
    <para>
 
538
      This server does not check the expire time of clients’ OpenPGP
 
539
      keys.
 
540
    </para>
591
541
  </refsect1>
592
542
  
593
543
  <refsect1 id="example">
643
593
      <title>CLIENTS</title>
644
594
      <para>
645
595
        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
 
596
        does have the OpenPGP key of the stored fingerprint.  This is
 
597
        guaranteed by the fact that the client sends its OpenPGP
 
598
        public key in the TLS handshake; this ensures it to be
 
599
        genuine.  The server computes the fingerprint of the key
 
600
        itself and looks up the fingerprint in its list of
 
601
        clients. The <filename>clients.conf</filename> file (see
652
602
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
603
        <manvolnum>5</manvolnum></citerefentry>)
654
604
        <emphasis>must</emphasis> be made non-readable by anyone
706
656
      </varlistentry>
707
657
      <varlistentry>
708
658
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
659
          <ulink url="http://www.gnu.org/software/gnutls/"
 
660
          >GnuTLS</ulink>
710
661
        </term>
711
662
      <listitem>
712
663
        <para>
713
664
          GnuTLS is the library this server uses to implement TLS for
714
665
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
666
          confidently get the client’s public OpenPGP key.
716
667
        </para>
717
668
      </listitem>
718
669
      </varlistentry>
750
701
      </varlistentry>
751
702
      <varlistentry>
752
703
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
704
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
705
          Protocol Version 1.1</citetitle>
755
706
        </term>
756
707
      <listitem>
757
708
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
709
          TLS 1.1 is the protocol implemented by GnuTLS.
759
710
        </para>
760
711
      </listitem>
761
712
      </varlistentry>
771
722
      </varlistentry>
772
723
      <varlistentry>
773
724
        <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.
 
725
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
726
          Security</citetitle>
 
727
        </term>
 
728
      <listitem>
 
729
        <para>
 
730
          This is implemented by GnuTLS and used by this server so
 
731
          that OpenPGP keys can be used.
796
732
        </para>
797
733
      </listitem>
798
734
      </varlistentry>