/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 Hogeborn
  • Date: 2025-06-27 19:49:05 UTC
  • Revision ID: teddy@recompile.se-20250627194905-ijufqn8ytzdgkf34
Update copyright year

* dracut-module/ask-password-mandos.service: Update copyright year to
  2024.
* dracut-module/password-agent.c: Update copyright year to 2023.
* initramfs-unpack: Update copyright year to 2024.
* mandos: - '' -
* mandos-clients.conf.xml: Update copyright year to 2023.
* mandos-ctl: Update copyright year to 2024.
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: Update copyright year to 2022.
* plugin-runner.xml: Update copyright year to 2024.
* plugins.d/mandos-client.xml: - '' -
* plugins.d/plymouth.c: - '' -

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 "2019-07-24">
 
5
<!ENTITY TIMESTAMP "2025-06-27">
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>
46
51
      <holder>Teddy Hogeborn</holder>
47
52
      <holder>Björn Påhlsson</holder>
48
53
    </copyright>
196
201
    </para>
197
202
    <para>
198
203
      This program is not meant to be run directly; it is really meant
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.
 
204
      to be run by other programs in the initial
 
205
      <acronym>RAM</acronym> disk environment; see <xref
 
206
      linkend="overview"/>.
206
207
    </para>
207
208
  </refsect1>
208
209
  
220
221
    <title>OPTIONS</title>
221
222
    <para>
222
223
      This program is commonly not invoked from the command line; it
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.
 
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.
229
228
    </para>
230
229
    
231
230
    <variablelist>
482
481
    <title>OVERVIEW</title>
483
482
    <xi:include href="../overview.xml"/>
484
483
    <para>
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.
 
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.
489
509
    </para>
490
510
    <para>
491
511
      This program could, theoretically, be used as a keyscript in
492
512
      <filename>/etc/crypttab</filename>, but it would then be
493
513
      impossible to enter a password for the encrypted root disk at
494
514
      the console, since this program does not read from the console
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.
 
515
      at all.
503
516
    </para>
504
517
  </refsect1>
505
518
  
762
775
    <title>EXAMPLE</title>
763
776
    <para>
764
777
      Note that normally, command line options will not be given
765
 
      directly, but via options for the Mandos <citerefentry
766
 
      ><refentrytitle>plugin-runner</refentrytitle>
767
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
778
      directly, but passed on via the program responsible for starting
 
779
      this program; see <xref linkend="overview"/>.
768
780
    </para>
769
781
    <informalexample>
770
782
      <para>
816
828
  <refsect1 id="security">
817
829
    <title>SECURITY</title>
818
830
    <para>
819
 
      This program is set-uid to root, but will switch back to the
820
 
      original (and presumably non-privileged) user and group after
821
 
      bringing up the network interface.
 
831
      This program assumes that it is set-uid to root, and will switch
 
832
      back to the original (and presumably non-privileged) user and
 
833
      group after bringing up the network interface.
822
834
    </para>
823
835
    <para>
824
836
      To use this program for its intended purpose (see <xref
872
884
      <manvolnum>5</manvolnum></citerefentry>,
873
885
      <citerefentry><refentrytitle>mandos</refentrytitle>
874
886
      <manvolnum>8</manvolnum></citerefentry>,
875
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
887
      <citerefentry><refentrytitle>password-agent</refentrytitle>
876
888
      <manvolnum>8mandos</manvolnum></citerefentry>,
877
889
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
878
890
      <manvolnum>8mandos</manvolnum></citerefentry>