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