/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 plugins.d/mandos-client.xml

  • Committer: teddy at recompile
  • Date: 2020-02-09 17:57:08 UTC
  • Revision ID: teddy@recompile.se-20200209175708-bmprnuxqmr2lkhfh
initramfs-tools-hook: Properly quote argument to test -n

* initramfs-tools-hook: Quote output from subshell so that test -n
  always get exactly one argument, never more than one.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.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-client">
5
 
<!ENTITY TIMESTAMP "2025-06-27">
 
5
<!ENTITY TIMESTAMP "2019-07-24">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
43
43
      <year>2017</year>
44
44
      <year>2018</year>
45
45
      <year>2019</year>
46
 
      <year>2020</year>
47
 
      <year>2021</year>
48
 
      <year>2022</year>
49
 
      <year>2023</year>
50
 
      <year>2024</year>
51
46
      <holder>Teddy Hogeborn</holder>
52
47
      <holder>Björn Påhlsson</holder>
53
48
    </copyright>
201
196
    </para>
202
197
    <para>
203
198
      This program is not meant to be run directly; it is really meant
204
 
      to be run by other programs in the initial
205
 
      <acronym>RAM</acronym> disk environment; see <xref
206
 
      linkend="overview"/>.
 
199
      to run as a plugin of the <application>Mandos</application>
 
200
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
201
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
202
      initial <acronym>RAM</acronym> disk environment because it is
 
203
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
204
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
205
      </citerefentry> file.
207
206
    </para>
208
207
  </refsect1>
209
208
  
221
220
    <title>OPTIONS</title>
222
221
    <para>
223
222
      This program is commonly not invoked from the command line; it
224
 
      is normally started by another program as described in <xref
225
 
      linkend="description"/>.  Any command line options this program
226
 
      accepts are therefore normally provided by the invoking program,
227
 
      and not directly.
 
223
      is normally started by the <application>Mandos</application>
 
224
      plugin runner, see <citerefentry><refentrytitle
 
225
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
226
      </citerefentry>.  Any command line options this program accepts
 
227
      are therefore normally provided by the plugin runner, and not
 
228
      directly.
228
229
    </para>
229
230
    
230
231
    <variablelist>
481
482
    <title>OVERVIEW</title>
482
483
    <xi:include href="../overview.xml"/>
483
484
    <para>
484
 
      This program is the client part.  It is run automatically in an
485
 
      initial <acronym>RAM</acronym> disk environment.
486
 
    </para>
487
 
    <para>
488
 
      In an initial <acronym>RAM</acronym> disk environment using
489
 
      <citerefentry><refentrytitle>systemd</refentrytitle>
490
 
      <manvolnum>1</manvolnum></citerefentry>, this program is started
491
 
      by the <application>Mandos</application> <citerefentry>
492
 
      <refentrytitle>password-agent</refentrytitle>
493
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn is
494
 
      started automatically by the <citerefentry>
495
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
496
 
      </citerefentry> <quote>Password Agent</quote> system.
497
 
    </para>
498
 
    <para>
499
 
      In the case of a non-<citerefentry>
500
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
501
 
      </citerefentry> environment, this program is started as a plugin
502
 
      of the <application>Mandos</application> <citerefentry>
503
 
      <refentrytitle>plugin-runner</refentrytitle>
504
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
505
 
      initial <acronym>RAM</acronym> disk environment because it is
506
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
507
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
508
 
      </citerefentry> file.
 
485
      This program is the client part.  It is a plugin started by
 
486
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
487
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
488
      an initial <acronym>RAM</acronym> disk environment.
509
489
    </para>
510
490
    <para>
511
491
      This program could, theoretically, be used as a keyscript in
512
492
      <filename>/etc/crypttab</filename>, but it would then be
513
493
      impossible to enter a password for the encrypted root disk at
514
494
      the console, since this program does not read from the console
515
 
      at all.
 
495
      at all.  This is why a separate plugin runner (<citerefentry>
 
496
      <refentrytitle>plugin-runner</refentrytitle>
 
497
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
498
      both this program and others in in parallel,
 
499
      <emphasis>one</emphasis> of which (<citerefentry>
 
500
      <refentrytitle>password-prompt</refentrytitle>
 
501
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
502
      passwords on the system console.
516
503
    </para>
517
504
  </refsect1>
518
505
  
775
762
    <title>EXAMPLE</title>
776
763
    <para>
777
764
      Note that normally, command line options will not be given
778
 
      directly, but passed on via the program responsible for starting
779
 
      this program; see <xref linkend="overview"/>.
 
765
      directly, but via options for the Mandos <citerefentry
 
766
      ><refentrytitle>plugin-runner</refentrytitle>
 
767
      <manvolnum>8mandos</manvolnum></citerefentry>.
780
768
    </para>
781
769
    <informalexample>
782
770
      <para>
884
872
      <manvolnum>5</manvolnum></citerefentry>,
885
873
      <citerefentry><refentrytitle>mandos</refentrytitle>
886
874
      <manvolnum>8</manvolnum></citerefentry>,
887
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
875
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
888
876
      <manvolnum>8mandos</manvolnum></citerefentry>,
889
877
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
890
878
      <manvolnum>8mandos</manvolnum></citerefentry>