/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: 2011-12-28 07:25:59 UTC
  • Revision ID: teddy@recompile.se-20111228072559-u9no7ozprpr28j6k
* mandos (PGPEngine.__init__): Add "--no-use-agent" to gpg options.

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
  
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>
547
491
      <varlistentry>
 
492
        <term><filename class="devicefile">/dev/log</filename></term>
 
493
      </varlistentry>
 
494
      <varlistentry>
548
495
        <term><filename
549
496
        class="directory">/var/lib/mandos</filename></term>
550
497
        <listitem>
556
503
        </listitem>
557
504
      </varlistentry>
558
505
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
506
        <term><filename>/dev/log</filename></term>
560
507
        <listitem>
561
508
          <para>
562
509
            The Unix domain socket to where local syslog messages are
587
534
    <para>
588
535
      There is no fine-grained control over logging and debug output.
589
536
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
537
    <para>
 
538
      Debug mode is conflated with running in the foreground.
 
539
    </para>
 
540
    <para>
 
541
      This server does not check the expire time of clients’ OpenPGP
 
542
      keys.
 
543
    </para>
591
544
  </refsect1>
592
545
  
593
546
  <refsect1 id="example">
643
596
      <title>CLIENTS</title>
644
597
      <para>
645
598
        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
 
599
        does have the OpenPGP key of the stored fingerprint.  This is
 
600
        guaranteed by the fact that the client sends its OpenPGP
 
601
        public key in the TLS handshake; this ensures it to be
 
602
        genuine.  The server computes the fingerprint of the key
 
603
        itself and looks up the fingerprint in its list of
 
604
        clients. The <filename>clients.conf</filename> file (see
652
605
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
606
        <manvolnum>5</manvolnum></citerefentry>)
654
607
        <emphasis>must</emphasis> be made non-readable by anyone
706
659
      </varlistentry>
707
660
      <varlistentry>
708
661
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
662
          <ulink url="http://www.gnu.org/software/gnutls/"
 
663
          >GnuTLS</ulink>
710
664
        </term>
711
665
      <listitem>
712
666
        <para>
713
667
          GnuTLS is the library this server uses to implement TLS for
714
668
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
669
          confidently get the client’s public OpenPGP key.
716
670
        </para>
717
671
      </listitem>
718
672
      </varlistentry>
750
704
      </varlistentry>
751
705
      <varlistentry>
752
706
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
707
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
708
          Protocol Version 1.1</citetitle>
755
709
        </term>
756
710
      <listitem>
757
711
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
712
          TLS 1.1 is the protocol implemented by GnuTLS.
759
713
        </para>
760
714
      </listitem>
761
715
      </varlistentry>
771
725
      </varlistentry>
772
726
      <varlistentry>
773
727
        <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.
 
728
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
729
          Security</citetitle>
 
730
        </term>
 
731
      <listitem>
 
732
        <para>
 
733
          This is implemented by GnuTLS and used by this server so
 
734
          that OpenPGP keys can be used.
796
735
        </para>
797
736
      </listitem>
798
737
      </varlistentry>