/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/splashy.xml

  • Committer: teddy at recompile
  • Date: 2020-01-12 01:44:43 UTC
  • Revision ID: teddy@recompile.se-20200112014443-kjpllaz75e1ox0jr
mandos-ctl: Minor code clarification

* mandos-ctl (dbus.SystemBus.call_method): New virtual method, for
  clarity only.

Show diffs side-by-side

added added

removed removed

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