/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: 2018-08-19 01:35:11 UTC
  • Revision ID: teddy@recompile.se-20180819013511-cku25q9yeub3dnr0
Adapt to changes in cryptsetup; use "cryptroot-unlock" program

* Makefile (install-client-nokey): Also install new script files
  "mandos-to-cryptroot-unlock" and "initramfs-tools-script-stop".
* debian/mandos-client.dirs: Add
  "usr/share/initramfs-tools/scripts/local-premount".
* initramfs-tools-hook: Also copy "mandos-to-cryptroot-unlock".
* initramfs-tools-script: Only modify keyscript setting in cryptroot
  file if the file exists, otherwise start
  "mandos-to-cryptroot-unlock" in background.
* initramfs-tools-script-stop: New script to make sure plugin-runner
  has stopped before continuing.
* mandos-to-cryptroot-unlock: New script to run plugin-runner and feed
  any password it gets into the "cryptroot-unlock" program.

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 "2011-11-26">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
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>
38
45
      <holder>Teddy Hogeborn</holder>
39
46
      <holder>Björn Påhlsson</holder>
40
47
    </copyright>
99
106
      <sbr/>
100
107
      <arg><option>--statedir
101
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>
102
116
    </cmdsynopsis>
103
117
    <cmdsynopsis>
104
118
      <command>&COMMANDNAME;</command>
285
299
        <term><option>--no-restore</option></term>
286
300
        <listitem>
287
301
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
302
          <para>
 
303
            See also <xref linkend="persistent_state"/>.
 
304
          </para>
288
305
        </listitem>
289
306
      </varlistentry>
290
307
      
295
312
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
313
        </listitem>
297
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
      
298
339
    </variablelist>
299
340
  </refsect1>
300
341
  
377
418
      extended timeout, checker program, and interval between checks
378
419
      can be configured both globally and per client; see
379
420
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
 
421
      <manvolnum>5</manvolnum></citerefentry>.
383
422
    </para>
384
423
  </refsect1>
385
424
  
407
446
    <title>LOGGING</title>
408
447
    <para>
409
448
      The server will send log message with various severity levels to
410
 
      <filename>/dev/log</filename>.  With the
 
449
      <filename class="devicefile">/dev/log</filename>.  With the
411
450
      <option>--debug</option> option, it will log even more messages,
412
451
      and also show them on the console.
413
452
    </para>
414
453
  </refsect1>
415
454
  
 
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
  
416
467
  <refsect1 id="dbus_interface">
417
468
    <title>D-BUS INTERFACE</title>
418
469
    <para>
480
531
        </listitem>
481
532
      </varlistentry>
482
533
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
534
        <term><filename>/run/mandos.pid</filename></term>
484
535
        <listitem>
485
536
          <para>
486
537
            The file containing the process id of the
487
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.
488
543
          </para>
489
544
        </listitem>
490
545
      </varlistentry>
500
555
        </listitem>
501
556
      </varlistentry>
502
557
      <varlistentry>
503
 
        <term><filename>/dev/log</filename></term>
 
558
        <term><filename class="devicefile">/dev/log</filename></term>
504
559
        <listitem>
505
560
          <para>
506
561
            The Unix domain socket to where local syslog messages are
532
587
      There is no fine-grained control over logging and debug output.
533
588
    </para>
534
589
    <para>
535
 
      Debug mode is conflated with running in the foreground.
536
 
    </para>
537
 
    <para>
538
590
      This server does not check the expire time of clients’ OpenPGP
539
591
      keys.
540
592
    </para>
 
593
    <xi:include href="bugs.xml"/>
541
594
  </refsect1>
542
595
  
543
596
  <refsect1 id="example">
656
709
      </varlistentry>
657
710
      <varlistentry>
658
711
        <term>
659
 
          <ulink url="http://www.gnu.org/software/gnutls/"
660
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
661
713
        </term>
662
714
      <listitem>
663
715
        <para>
701
753
      </varlistentry>
702
754
      <varlistentry>
703
755
        <term>
704
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
705
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
706
758
        </term>
707
759
      <listitem>
708
760
        <para>
709
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
710
762
        </para>
711
763
      </listitem>
712
764
      </varlistentry>
722
774
      </varlistentry>
723
775
      <varlistentry>
724
776
        <term>
725
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
726
 
          Security</citetitle>
 
777
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
778
          Security (TLS) Authentication</citetitle>
727
779
        </term>
728
780
      <listitem>
729
781
        <para>