/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
435 by teddy at bsnet
* Makefile (DOCS): Added "plymouth.8mandos".
1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY COMMANDNAME "plymouth">
969 by Teddy Hogeborn
Update copyright year to 2019
5
<!ENTITY TIMESTAMP "2019-02-10">
435 by teddy at bsnet
* Makefile (DOCS): Added "plymouth.8mandos".
6
<!ENTITY % common SYSTEM "../common.ent">
7
%common;
8
]>
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
  <refentryinfo>
12
    <title>Mandos Manual</title>
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
    <productname>Mandos</productname>
15
    <productnumber>&version;</productnumber>
16
    <date>&TIMESTAMP;</date>
17
    <authorgroup>
18
      <author>
19
	<firstname>Björn</firstname>
20
	<surname>Påhlsson</surname>
21
	<address>
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
22
	  <email>belorn@recompile.se</email>
435 by teddy at bsnet
* Makefile (DOCS): Added "plymouth.8mandos".
23
	</address>
24
      </author>
25
      <author>
26
	<firstname>Teddy</firstname>
27
	<surname>Hogeborn</surname>
28
	<address>
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
29
	  <email>teddy@recompile.se</email>
435 by teddy at bsnet
* Makefile (DOCS): Added "plymouth.8mandos".
30
	</address>
31
      </author>
32
    </authorgroup>
33
    <copyright>
444 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
34
      <year>2010</year>
466 by Teddy Hogeborn
Update copyright year to "2011" wherever appropriate.
35
      <year>2011</year>
544 by Teddy Hogeborn
Updated year in copyright notices.
36
      <year>2012</year>
778 by Teddy Hogeborn
Update copyright year.
37
      <year>2013</year>
38
      <year>2014</year>
39
      <year>2015</year>
807 by Teddy Hogeborn
Update copyright year.
40
      <year>2016</year>
899 by Teddy Hogeborn
Update copyright year to 2017
41
      <year>2017</year>
923 by Teddy Hogeborn
Update copyright year to 2018
42
      <year>2018</year>
969 by Teddy Hogeborn
Update copyright year to 2019
43
      <year>2019</year>
435 by teddy at bsnet
* Makefile (DOCS): Added "plymouth.8mandos".
44
      <holder>Teddy Hogeborn</holder>
45
      <holder>Björn Påhlsson</holder>
46
    </copyright>
47
    <xi:include href="../legalnotice.xml"/>
48
  </refentryinfo>
49
  
50
  <refmeta>
51
    <refentrytitle>&COMMANDNAME;</refentrytitle>
52
    <manvolnum>8mandos</manvolnum>
53
  </refmeta>
54
  
55
  <refnamediv>
56
    <refname><command>&COMMANDNAME;</command></refname>
57
    <refpurpose>Mandos plugin to use plymouth to get a
58
    password.</refpurpose>
59
  </refnamediv>
60
  
61
  <refsynopsisdiv>
62
    <cmdsynopsis>
63
      <command>&COMMANDNAME;</command>
64
    </cmdsynopsis>
65
  </refsynopsisdiv>
66
  
67
  <refsect1 id="description">
68
    <title>DESCRIPTION</title>
69
    <para>
70
      This program prompts for a password using <citerefentry>
71
      <refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum>
72
      </citerefentry> and outputs any given password to standard
73
      output.  If no <citerefentry><refentrytitle
74
      >plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
75
      process can be found, this program will immediately exit with an
76
      exit code indicating failure.
77
    </para>
78
    <para>
79
      This program is not very useful on its own.  This program is
80
      really meant to run as a plugin in the <application
81
      >Mandos</application> client-side system, where it is used as a
82
      fallback and alternative to retrieving passwords from a
83
      <application >Mandos</application> server.
84
    </para>
85
    <para>
86
      If this program is killed (presumably by
87
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
88
      <manvolnum>8mandos</manvolnum></citerefentry> because some other
89
      plugin provided the password), it cannot tell <citerefentry>
90
      <refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum>
91
      </citerefentry> to abort requesting a password, because
92
      <citerefentry><refentrytitle>plymouth</refentrytitle>
93
      <manvolnum>8</manvolnum></citerefentry> does not support this.
94
      Therefore, this program will then <emphasis>kill</emphasis> the
95
      running <citerefentry><refentrytitle>plymouth</refentrytitle>
96
      <manvolnum>8</manvolnum></citerefentry> process and start a
97
      <emphasis>new</emphasis> one using the same command line
98
      arguments as the old one was using.
99
    </para>
100
  </refsect1>
101
  
102
  <refsect1 id="options">
103
    <title>OPTIONS</title>
104
    <para>
105
      This program takes no options.
106
    </para>
107
  </refsect1>
108
  
109
  <refsect1 id="exit_status">
110
    <title>EXIT STATUS</title>
111
    <para>
112
      If exit status is 0, the output from the program is the password
113
      as it was read.  Otherwise, if exit status is other than 0, the
114
      program was interrupted or encountered an error, and any output
115
      so far could be corrupt and/or truncated, and should therefore
116
      be ignored.
117
    </para>
118
  </refsect1>
119
  
120
  <refsect1 id="environment">
121
    <title>ENVIRONMENT</title>
122
    <variablelist>
123
      <varlistentry>
124
	<term><envar>cryptsource</envar></term>
125
	<term><envar>crypttarget</envar></term>
126
	<listitem>
127
	  <para>
128
	    If set, these environment variables will be assumed to
129
	    contain the source device name and the target device
130
	    mapper name, respectively, and will be shown as part of
131
	    the prompt.
132
	</para>
133
	<para>
134
	  These variables will normally be inherited from
135
	  <citerefentry><refentrytitle>plugin-runner</refentrytitle>
136
	  <manvolnum>8mandos</manvolnum></citerefentry>, which will
137
	  normally have inherited them from
138
	  <filename>/scripts/local-top/cryptroot</filename> in the
139
	  initial <acronym>RAM</acronym> disk environment, which will
140
	  have set them from parsing kernel arguments and
141
	  <filename>/conf/conf.d/cryptroot</filename> (also in the
142
	  initial RAM disk environment), which in turn will have been
143
	  created when the initial RAM disk image was created by
144
	  <filename
145
	  >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
146
	  extracting the information of the root file system from
147
	  <filename >/etc/crypttab</filename>.
148
	</para>
149
	<para>
150
	  This behavior is meant to exactly mirror the behavior of
151
	  <command>askpass</command>, the default password prompter.
152
	</para>
153
	</listitem>
154
      </varlistentry>
155
    </variablelist>
156
  </refsect1>
157
  
158
  <refsect1 id="files">
159
    <title>FILES</title>
160
    <variablelist>
161
      <varlistentry>
162
	<term><filename>/bin/plymouth</filename></term>
163
	<listitem>
164
	  <para>
165
	    This is the command run to retrieve a password from
166
	    <citerefentry><refentrytitle>plymouth</refentrytitle>
167
	    <manvolnum>8</manvolnum></citerefentry>.
168
	  </para>
169
	</listitem>
170
      </varlistentry>
171
      <varlistentry>
521.1.1 by teddy at bsnet
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
172
	<term><filename class="directory">/proc</filename></term>
435 by teddy at bsnet
* Makefile (DOCS): Added "plymouth.8mandos".
173
	<listitem>
174
	  <para>
175
	    To find the running <citerefentry><refentrytitle
176
	    >plymouth</refentrytitle><manvolnum>8</manvolnum>
177
	    </citerefentry>, this directory will be searched for
178
	    numeric entries which will be assumed to be directories.
179
	    In all those directories, the <filename>exe</filename> and
180
	    <filename>cmdline</filename> entries will be used to
181
	    determine the name of the running binary, effective user
182
	    and group <abbrev>ID</abbrev>, and the command line
183
	    arguments.  See <citerefentry><refentrytitle
184
	    >proc</refentrytitle><manvolnum>5</manvolnum>
185
	    </citerefentry>.
186
	  </para>
187
	</listitem>
188
      </varlistentry>
189
      <varlistentry>
190
	<term><filename>/sbin/plymouthd</filename></term>
191
	<listitem>
192
	  <para>
193
	    This is the name of the binary which will be searched for
194
	    in the process list.  See <citerefentry><refentrytitle
195
	    >plymouth</refentrytitle><manvolnum>8</manvolnum>
196
	    </citerefentry>.
197
	  </para>
198
	</listitem>
199
      </varlistentry>
200
    </variablelist>
201
  </refsect1>
202
  
203
  <refsect1 id="bugs">
204
    <title>BUGS</title>
205
    <para>
206
      Killing the <citerefentry><refentrytitle
207
      >plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
208
      daemon and starting a new one is ugly, but necessary as long as
209
      it does not support aborting a password request.
210
    </para>
821 by Teddy Hogeborn
Add bug reporting information to manual pages
211
    <xi:include href="../bugs.xml"/>
435 by teddy at bsnet
* Makefile (DOCS): Added "plymouth.8mandos".
212
  </refsect1>
213
  
214
  <refsect1 id="example">
215
    <title>EXAMPLE</title>
216
    <para>
217
      Note that normally, this program will not be invoked directly,
218
      but instead started by the Mandos <citerefentry><refentrytitle
219
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
220
      </citerefentry>.
221
    </para>
222
    <informalexample>
223
      <para>
224
	This program takes no options.
225
      </para>
226
      <para>
227
	<userinput>&COMMANDNAME;</userinput>
228
      </para>
229
    </informalexample>
230
  </refsect1>
231
  
232
  <refsect1 id="security">
233
    <title>SECURITY</title>
234
    <para>
235
      If this program is killed by a signal, it will kill the process
236
      <abbrev>ID</abbrev> which at the start of this program was
237
      determined to run <citerefentry><refentrytitle
238
      >plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
239
      as root (see also <xref linkend="files"/>).  There is a very
240
      slight risk that, in the time between those events, that process
241
      <abbrev>ID</abbrev> was freed and then taken up by another
242
      process; the wrong process would then be killed.  Now, this
243
      program can only be killed by the user who started it; see
244
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
245
      <manvolnum>8mandos</manvolnum></citerefentry>.  This program
246
      should therefore be started by a completely separate
247
      non-privileged user, and no other programs should be allowed to
248
      run as that special user.  This means that it is not recommended
249
      to use the user "nobody" to start this program, as other
250
      possibly less trusted programs could be running as "nobody", and
251
      they would then be able to kill this program, triggering the
252
      killing of the process <abbrev>ID</abbrev> which may or may not
253
      be <citerefentry><refentrytitle>plymouth</refentrytitle>
254
      <manvolnum>8</manvolnum></citerefentry>.
255
    </para>
256
    <para>
257
      The only other thing that could be considered worthy of note is
258
      this:  This program is meant to be run by <citerefentry>
259
      <refentrytitle>plugin-runner</refentrytitle><manvolnum
260
      >8mandos</manvolnum></citerefentry>, and will, when run
261
      standalone, outside, in a normal environment, immediately output
262
      on its standard output any presumably secret password it just
263
      received.  Therefore, when running this program standalone
264
      (which should never normally be done), take care not to type in
265
      any real secret password by force of habit, since it would then
266
      immediately be shown as output.
267
    </para>
268
  </refsect1>
269
  
270
  <refsect1 id="see_also">
271
    <title>SEE ALSO</title>
272
    <para>
493 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
273
      <citerefentry><refentrytitle>intro</refentrytitle>
274
      <manvolnum>8mandos</manvolnum></citerefentry>,
435 by teddy at bsnet
* Makefile (DOCS): Added "plymouth.8mandos".
275
      <citerefentry><refentrytitle>crypttab</refentrytitle>
276
      <manvolnum>5</manvolnum></citerefentry>,
277
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
278
      <manvolnum>8mandos</manvolnum></citerefentry>,
279
      <citerefentry><refentrytitle>proc</refentrytitle>
280
      <manvolnum>5</manvolnum></citerefentry>,
281
      <citerefentry><refentrytitle>plymouth</refentrytitle>
282
      <manvolnum>8</manvolnum></citerefentry>
283
    </para>
284
  </refsect1>
285
</refentry>
286
<!-- Local Variables: -->
287
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
288
<!-- time-stamp-end: "[\"']>" -->
289
<!-- time-stamp-format: "%:y-%02m-%02d" -->
290
<!-- End: -->