/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: 2012-01-01 01:16:15 UTC
  • Revision ID: teddy@recompile.se-20120101011615-1jzyuxbw1z4700a3
* mandos-ctl (main): Bug fix: Make --secret actually work.

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 "2012-01-01">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
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
39
      <holder>Teddy Hogeborn</holder>
46
40
      <holder>Björn Påhlsson</holder>
47
41
    </copyright>
106
100
      <sbr/>
107
101
      <arg><option>--statedir
108
102
      <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
103
    </cmdsynopsis>
117
104
    <cmdsynopsis>
118
105
      <command>&COMMANDNAME;</command>
299
286
        <term><option>--no-restore</option></term>
300
287
        <listitem>
301
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
302
 
          <para>
303
 
            See also <xref linkend="persistent_state"/>.
304
 
          </para>
305
289
        </listitem>
306
290
      </varlistentry>
307
291
      
312
296
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
313
297
        </listitem>
314
298
      </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
299
    </variablelist>
340
300
  </refsect1>
341
301
  
361
321
      start a TLS protocol handshake with a slight quirk: the Mandos
362
322
      server program acts as a TLS <quote>client</quote> while the
363
323
      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.
 
324
      The Mandos client must supply an OpenPGP certificate, and the
 
325
      fingerprint of this certificate is used by the Mandos server to
 
326
      look up (in a list read from <filename>clients.conf</filename>
 
327
      at start time) which binary blob to give the client.  No other
 
328
      authentication or authorization is done by the server.
369
329
    </para>
370
330
    <table>
371
331
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
351
        </emphasis></entry>
392
352
      </row>
393
353
      <row>
394
 
        <entry>Public key (part of TLS handshake)</entry>
 
354
        <entry>OpenPGP public key (part of TLS handshake)</entry>
395
355
        <entry>-><!-- &rarr; --></entry>
396
356
      </row>
397
357
      <row>
418
378
      extended timeout, checker program, and interval between checks
419
379
      can be configured both globally and per client; see
420
380
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
421
 
      <manvolnum>5</manvolnum></citerefentry>.
 
381
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
382
      receiving its password will also be treated as a successful
 
383
      checker run.
422
384
    </para>
423
385
  </refsect1>
424
386
  
452
414
    </para>
453
415
  </refsect1>
454
416
  
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
417
  <refsect1 id="dbus_interface">
468
418
    <title>D-BUS INTERFACE</title>
469
419
    <para>
531
481
        </listitem>
532
482
      </varlistentry>
533
483
      <varlistentry>
534
 
        <term><filename>/run/mandos.pid</filename></term>
 
484
        <term><filename>/var/run/mandos.pid</filename></term>
535
485
        <listitem>
536
486
          <para>
537
487
            The file containing the process id of the
538
488
            <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
489
          </para>
544
490
        </listitem>
545
491
      </varlistentry>
546
492
      <varlistentry>
 
493
        <term><filename class="devicefile">/dev/log</filename></term>
 
494
      </varlistentry>
 
495
      <varlistentry>
547
496
        <term><filename
548
497
        class="directory">/var/lib/mandos</filename></term>
549
498
        <listitem>
555
504
        </listitem>
556
505
      </varlistentry>
557
506
      <varlistentry>
558
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
        <term><filename>/dev/log</filename></term>
559
508
        <listitem>
560
509
          <para>
561
510
            The Unix domain socket to where local syslog messages are
586
535
    <para>
587
536
      There is no fine-grained control over logging and debug output.
588
537
    </para>
589
 
    <xi:include href="bugs.xml"/>
 
538
    <para>
 
539
      Debug mode is conflated with running in the foreground.
 
540
    </para>
 
541
    <para>
 
542
      This server does not check the expire time of clients’ OpenPGP
 
543
      keys.
 
544
    </para>
590
545
  </refsect1>
591
546
  
592
547
  <refsect1 id="example">
642
597
      <title>CLIENTS</title>
643
598
      <para>
644
599
        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
 
600
        does have the OpenPGP key of the stored fingerprint.  This is
 
601
        guaranteed by the fact that the client sends its OpenPGP
 
602
        public key in the TLS handshake; this ensures it to be
 
603
        genuine.  The server computes the fingerprint of the key
 
604
        itself and looks up the fingerprint in its list of
 
605
        clients. The <filename>clients.conf</filename> file (see
651
606
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
607
        <manvolnum>5</manvolnum></citerefentry>)
653
608
        <emphasis>must</emphasis> be made non-readable by anyone
705
660
      </varlistentry>
706
661
      <varlistentry>
707
662
        <term>
708
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
663
          <ulink url="http://www.gnu.org/software/gnutls/"
 
664
          >GnuTLS</ulink>
709
665
        </term>
710
666
      <listitem>
711
667
        <para>
712
668
          GnuTLS is the library this server uses to implement TLS for
713
669
          communicating securely with the client, and at the same time
714
 
          confidently get the client’s public key.
 
670
          confidently get the client’s public OpenPGP key.
715
671
        </para>
716
672
      </listitem>
717
673
      </varlistentry>
749
705
      </varlistentry>
750
706
      <varlistentry>
751
707
        <term>
752
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
 
          Protocol Version 1.2</citetitle>
 
708
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
709
          Protocol Version 1.1</citetitle>
754
710
        </term>
755
711
      <listitem>
756
712
        <para>
757
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
713
          TLS 1.1 is the protocol implemented by GnuTLS.
758
714
        </para>
759
715
      </listitem>
760
716
      </varlistentry>
770
726
      </varlistentry>
771
727
      <varlistentry>
772
728
        <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.
 
729
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
730
          Security</citetitle>
 
731
        </term>
 
732
      <listitem>
 
733
        <para>
 
734
          This is implemented by GnuTLS and used by this server so
 
735
          that OpenPGP keys can be used.
795
736
        </para>
796
737
      </listitem>
797
738
      </varlistentry>