/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/password-prompt.xml

  • Committer: Teddy Hogeborn
  • Date: 2021-02-03 23:10:42 UTC
  • Revision ID: teddy@recompile.se-20210203231042-2z3egrvpo1zt7nej
mandos-ctl: Fix bad test for command.Remove and related minor issues

The test for command.Remove removes all clients from the spy server,
and then loops over all clients, looking for the corresponding Remove
command as recorded by the spy server.  But since since there aren't
any clients left after they were removed, no assertions are made, and
the test therefore does nothing.  Fix this.

In tests for command.Approve and command.Deny, add checks that clients
were not somehow removed by the command (in which case, likewise, no
assertions are made).

Add related checks to TestPropertySetterCmd.runTest; i.e. test that a
sequence is not empty before looping over it and making assertions.

* mandos-ctl (TestBaseCommands.test_Remove): Save a copy of the
  original "clients" dict, and loop over those instead.  Add assertion
  that all clients were indeed removed.  Also fix the code which looks
  for the Remove command, which now needs to actually work.
  (TestBaseCommands.test_Approve, TestBaseCommands.test_Deny): Add
  assertion that there are still clients before looping over them.
  (TestPropertySetterCmd.runTest): Add assertion that the list of
  values to get is not empty before looping over them.  Also add check
  that there are still clients before looping over clients.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "password-prompt">
5
 
<!ENTITY TIMESTAMP "2008-09-30">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
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>
35
46
      <holder>Teddy Hogeborn</holder>
36
47
      <holder>Björn Påhlsson</holder>
37
48
    </copyright>
58
69
        >PREFIX</replaceable></arg>
59
70
      </group>
60
71
      <sbr/>
 
72
      <arg choice="opt">
 
73
        <option>--prompt <replaceable>PROMPT</replaceable></option>
 
74
      </arg>
61
75
      <arg choice="opt"><option>--debug</option></arg>
62
76
    </cmdsynopsis>
63
77
    <cmdsynopsis>
84
98
    <title>DESCRIPTION</title>
85
99
    <para>
86
100
      All <command>&COMMANDNAME;</command> does is prompt for a
87
 
      password and output any given password to standard output.  This
88
 
      is not very useful on its own.  This program is really meant to
89
 
      run as a plugin in the <application>Mandos</application>
90
 
      client-side system, where it is used as a fallback and
91
 
      alternative to retrieving passwords from a <application
92
 
      >Mandos</application> server.
 
101
      password and output any given password to standard output.
 
102
    </para>
 
103
    <para>
 
104
      This program is not very useful on its own.  This program is
 
105
      really meant to run as a plugin in the <application
 
106
      >Mandos</application> client-side system, where it is used as a
 
107
      fallback and alternative to retrieving passwords from a
 
108
      <application >Mandos</application> server.
93
109
    </para>
94
110
    <para>
95
111
      This program is little more than a <citerefentry><refentrytitle
97
113
      wrapper, although actual use of that function is not guaranteed
98
114
      or implied.
99
115
    </para>
 
116
    <para>
 
117
      This program tries to detect if a Plymouth daemon
 
118
      (<citerefentry><refentrytitle
 
119
      >plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
 
120
      is running, by looking for a
 
121
      <filename>/run/plymouth/pid</filename> file or a process named
 
122
      <quote><literal>plymouthd</literal></quote>.  If it is detected,
 
123
      this process will immediately exit without doing anything.
 
124
    </para>
100
125
  </refsect1>
101
126
  
102
127
  <refsect1 id="options">
125
150
      </varlistentry>
126
151
      
127
152
      <varlistentry>
 
153
        <term><option>--prompt=<replaceable
 
154
        >PROMPT</replaceable></option></term>
 
155
        <listitem>
 
156
          <para>
 
157
            The password prompt.  Using this option will make this
 
158
            program ignore the <envar>CRYPTTAB_SOURCE</envar> and
 
159
            <envar>CRYPTTAB_NAME</envar> environment variables.
 
160
          </para>
 
161
        </listitem>
 
162
      </varlistentry>
 
163
      
 
164
      <varlistentry>
128
165
        <term><option>--debug</option></term>
129
166
        <listitem>
130
167
          <para>
180
217
    <title>ENVIRONMENT</title>
181
218
    <variablelist>
182
219
      <varlistentry>
183
 
        <term><envar>cryptsource</envar></term>
184
 
        <term><envar>crypttarget</envar></term>
 
220
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
221
        <term><envar>CRYPTTAB_NAME</envar></term>
185
222
        <listitem>
186
223
          <para>
187
 
            If set, these environment variables will be assumed to
 
224
            If set, and if the <option>--prompt</option> option is not
 
225
            used, these environment variables will be assumed to
188
226
            contain the source device name and the target device
189
227
            mapper name, respectively, and will be shown as part of
190
228
            the prompt.
192
230
        <para>
193
231
          These variables will normally be inherited from
194
232
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
195
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
196
 
          normally have inherited them from
197
 
          <filename>/scripts/local-top/cryptroot</filename> in the
198
 
          initial <acronym>RAM</acronym> disk environment, which will
199
 
          have set them from parsing kernel arguments and
200
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
201
 
          initial RAM disk environment), which in turn will have been
202
 
          created when the initial RAM disk image was created by
203
 
          <filename
204
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
205
 
          extracting the information of the root file system from
206
 
          <filename >/etc/crypttab</filename>.
 
233
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
234
          have in turn inherited them from its calling process.
207
235
        </para>
208
236
        <para>
209
237
          This behavior is meant to exactly mirror the behavior of
210
 
          <command>askpass</command>, the default password prompter.
 
238
          <command>askpass</command>, the default password prompter
 
239
          from initramfs-tools.
211
240
        </para>
212
241
        </listitem>
213
242
      </varlistentry>
216
245
  
217
246
  <refsect1 id="bugs">
218
247
    <title>BUGS</title>
219
 
    <para>
220
 
      None are known at this time.
221
 
    </para>
 
248
    <xi:include href="../bugs.xml"/>
222
249
  </refsect1>
223
250
  
224
251
  <refsect1 id="example">
289
316
  <refsect1 id="see_also">
290
317
    <title>SEE ALSO</title>
291
318
    <para>
292
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
293
 
      <manvolnum>5</manvolnum></citerefentry>
 
319
      <citerefentry><refentrytitle>intro</refentrytitle>
 
320
      <manvolnum>8mandos</manvolnum></citerefentry>,
294
321
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
295
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
322
      <manvolnum>8mandos</manvolnum></citerefentry>,
296
323
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
297
324
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
325
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
 
326
      <manvolnum>8</manvolnum></citerefentry>
298
327
    </para>
299
328
  </refsect1>
300
329
</refentry>