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-02-09">
6
6
<!ENTITY % common SYSTEM "../common.ent">
203
197
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"/>.
198
to run as a plugin of the <application>Mandos</application>
199
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
200
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
201
initial <acronym>RAM</acronym> disk environment because it is
202
specified as a <quote>keyscript</quote> in the <citerefentry>
203
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
204
</citerefentry> file.
221
219
<title>OPTIONS</title>
223
221
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,
222
is normally started by the <application>Mandos</application>
223
plugin runner, see <citerefentry><refentrytitle
224
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
225
</citerefentry>. Any command line options this program accepts
226
are therefore normally provided by the plugin runner, and not
481
481
<title>OVERVIEW</title>
482
482
<xi:include href="../overview.xml"/>
484
This program is the client part. It is run automatically in an
485
initial <acronym>RAM</acronym> disk environment.
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.
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.
484
This program is the client part. It is a plugin started by
485
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
486
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
487
an initial <acronym>RAM</acronym> disk environment.
511
490
This program could, theoretically, be used as a keyscript in
512
491
<filename>/etc/crypttab</filename>, but it would then be
513
492
impossible to enter a password for the encrypted root disk at
514
493
the console, since this program does not read from the console
494
at all. This is why a separate plugin runner (<citerefentry>
495
<refentrytitle>plugin-runner</refentrytitle>
496
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
497
both this program and others in in parallel,
498
<emphasis>one</emphasis> of which (<citerefentry>
499
<refentrytitle>password-prompt</refentrytitle>
500
<manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
501
passwords on the system console.
539
525
This environment variable will be assumed to contain the
540
526
directory containing any helper executables. The use and
541
nature of these helper executables, if any, is purposely
527
nature of these helper executables, if any, is
528
purposefully not documented.
775
761
<title>EXAMPLE</title>
777
763
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"/>.
764
directly, but via options for the Mandos <citerefentry
765
><refentrytitle>plugin-runner</refentrytitle>
766
<manvolnum>8mandos</manvolnum></citerefentry>.
781
768
<informalexample>
828
815
<refsect1 id="security">
829
816
<title>SECURITY</title>
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.
818
This program is set-uid to root, but will switch back to the
819
original (and presumably non-privileged) user and group after
820
bringing up the network interface.
836
823
To use this program for its intended purpose (see <xref
884
871
<manvolnum>5</manvolnum></citerefentry>,
885
872
<citerefentry><refentrytitle>mandos</refentrytitle>
886
873
<manvolnum>8</manvolnum></citerefentry>,
887
<citerefentry><refentrytitle>password-agent</refentrytitle>
874
<citerefentry><refentrytitle>password-prompt</refentrytitle>
888
875
<manvolnum>8mandos</manvolnum></citerefentry>,
889
876
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
890
877
<manvolnum>8mandos</manvolnum></citerefentry>