/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: 2018-04-01 19:35:00 UTC
  • Revision ID: teddy@recompile.se-20180401193500-150t7d6w89s1c0u3
Remove duplicate "Mandos plugin mandos-client:" in error output

* plugins.d/mandos-client.c (init_gpgme, pgp_packet_decrypt): Remove
  old hardcoded prefix, since it is now always printed by
  fprintf_plus().

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.xml
 
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 "password-prompt">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
 
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
      <holder>Teddy Hogeborn</holder>
 
46
      <holder>Björn Påhlsson</holder>
 
47
    </copyright>
 
48
    <xi:include href="../legalnotice.xml"/>
 
49
  </refentryinfo>
 
50
  
 
51
  <refmeta>
 
52
    <refentrytitle>&COMMANDNAME;</refentrytitle>
 
53
    <manvolnum>8mandos</manvolnum>
 
54
  </refmeta>
 
55
  
 
56
  <refnamediv>
 
57
    <refname><command>&COMMANDNAME;</command></refname>
 
58
    <refpurpose>Prompt for a password and output it.</refpurpose>
 
59
  </refnamediv>
 
60
  
 
61
  <refsynopsisdiv>
 
62
    <cmdsynopsis>
 
63
      <command>&COMMANDNAME;</command>
 
64
      <group choice="opt">
 
65
        <arg choice="plain"><option>--prefix <replaceable
 
66
        >PREFIX</replaceable></option></arg>
 
67
        <arg choice="plain"><option>-p </option><replaceable
 
68
        >PREFIX</replaceable></arg>
 
69
      </group>
 
70
      <sbr/>
 
71
      <arg choice="opt"><option>--debug</option></arg>
 
72
    </cmdsynopsis>
 
73
    <cmdsynopsis>
 
74
      <command>&COMMANDNAME;</command>
 
75
      <group choice="req">
 
76
        <arg choice="plain"><option>--help</option></arg>
 
77
        <arg choice="plain"><option>-?</option></arg>
 
78
      </group>
 
79
    </cmdsynopsis>
 
80
    <cmdsynopsis>
 
81
      <command>&COMMANDNAME;</command>
 
82
      <arg choice="plain"><option>--usage</option></arg>
 
83
    </cmdsynopsis>
 
84
    <cmdsynopsis>
 
85
      <command>&COMMANDNAME;</command>
 
86
      <group choice="req">
 
87
        <arg choice="plain"><option>--version</option></arg>
 
88
        <arg choice="plain"><option>-V</option></arg>
 
89
      </group>
 
90
    </cmdsynopsis>
 
91
  </refsynopsisdiv>
 
92
  
 
93
  <refsect1 id="description">
 
94
    <title>DESCRIPTION</title>
 
95
    <para>
 
96
      All <command>&COMMANDNAME;</command> does is prompt for a
 
97
      password and output any given password to standard output.
 
98
    </para>
 
99
    <para>
 
100
      This program is not very useful on its own.  This program is
 
101
      really meant to run as a plugin in the <application
 
102
      >Mandos</application> client-side system, where it is used as a
 
103
      fallback and alternative to retrieving passwords from a
 
104
      <application >Mandos</application> server.
 
105
    </para>
 
106
    <para>
 
107
      This program is little more than a <citerefentry><refentrytitle
 
108
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 
109
      wrapper, although actual use of that function is not guaranteed
 
110
      or implied.
 
111
    </para>
 
112
  </refsect1>
 
113
  
 
114
  <refsect1 id="options">
 
115
    <title>OPTIONS</title>
 
116
    <para>
 
117
      This program is commonly not invoked from the command line; it
 
118
      is normally started by the <application>Mandos</application>
 
119
      plugin runner, see <citerefentry><refentrytitle
 
120
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
121
      </citerefentry>.  Any command line options this program accepts
 
122
      are therefore normally provided by the plugin runner, and not
 
123
      directly.
 
124
    </para>
 
125
    
 
126
    <variablelist>
 
127
      <varlistentry>
 
128
        <term><option>--prefix=<replaceable
 
129
        >PREFIX</replaceable></option></term>
 
130
        <term><option>-p
 
131
        <replaceable>PREFIX</replaceable></option></term>
 
132
        <listitem>
 
133
          <para>
 
134
            Prefix string shown before the password prompt.
 
135
          </para>
 
136
        </listitem>
 
137
      </varlistentry>
 
138
      
 
139
      <varlistentry>
 
140
        <term><option>--debug</option></term>
 
141
        <listitem>
 
142
          <para>
 
143
            Enable debug mode.  This will enable a lot of output to
 
144
            standard error about what the program is doing.  The
 
145
            program will still perform all other functions normally.
 
146
          </para>
 
147
        </listitem>
 
148
      </varlistentry>
 
149
      
 
150
      <varlistentry>
 
151
        <term><option>--help</option></term>
 
152
        <term><option>-?</option></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Gives a help message about options and their meanings.
 
156
          </para>
 
157
        </listitem>
 
158
      </varlistentry>
 
159
      
 
160
      <varlistentry>
 
161
        <term><option>--usage</option></term>
 
162
        <listitem>
 
163
          <para>
 
164
            Gives a short usage message.
 
165
          </para>
 
166
        </listitem>
 
167
      </varlistentry>
 
168
      
 
169
      <varlistentry>
 
170
        <term><option>--version</option></term>
 
171
        <term><option>-V</option></term>
 
172
        <listitem>
 
173
          <para>
 
174
            Prints the program version.
 
175
          </para>
 
176
        </listitem>
 
177
      </varlistentry>
 
178
    </variablelist>
 
179
  </refsect1>
 
180
  
 
181
  <refsect1 id="exit_status">
 
182
    <title>EXIT STATUS</title>
 
183
    <para>
 
184
      If exit status is 0, the output from the program is the password
 
185
      as it was read.  Otherwise, if exit status is other than 0, the
 
186
      program has encountered an error, and any output so far could be
 
187
      corrupt and/or truncated, and should therefore be ignored.
 
188
    </para>
 
189
  </refsect1>
 
190
  
 
191
  <refsect1 id="environment">
 
192
    <title>ENVIRONMENT</title>
 
193
    <variablelist>
 
194
      <varlistentry>
 
195
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
196
        <term><envar>CRYPTTAB_NAME</envar></term>
 
197
        <listitem>
 
198
          <para>
 
199
            If set, these environment variables will be assumed to
 
200
            contain the source device name and the target device
 
201
            mapper name, respectively, and will be shown as part of
 
202
            the prompt.
 
203
        </para>
 
204
        <para>
 
205
          These variables will normally be inherited from
 
206
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
207
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
 
208
          normally have inherited them from
 
209
          <filename>/scripts/local-top/cryptroot</filename> in the
 
210
          initial <acronym>RAM</acronym> disk environment, which will
 
211
          have set them from parsing kernel arguments and
 
212
          <filename>/conf/conf.d/cryptroot</filename> (also in the
 
213
          initial RAM disk environment), which in turn will have been
 
214
          created when the initial RAM disk image was created by
 
215
          <filename
 
216
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
 
217
          extracting the information of the root file system from
 
218
          <filename >/etc/crypttab</filename>.
 
219
        </para>
 
220
        <para>
 
221
          This behavior is meant to exactly mirror the behavior of
 
222
          <command>askpass</command>, the default password prompter.
 
223
        </para>
 
224
        </listitem>
 
225
      </varlistentry>
 
226
    </variablelist>
 
227
  </refsect1>
 
228
  
 
229
  <refsect1 id="bugs">
 
230
    <title>BUGS</title>
 
231
    <xi:include href="../bugs.xml"/>
 
232
  </refsect1>
 
233
  
 
234
  <refsect1 id="example">
 
235
    <title>EXAMPLE</title>
 
236
    <para>
 
237
      Note that normally, command line options will not be given
 
238
      directly, but via options for the Mandos <citerefentry
 
239
      ><refentrytitle>plugin-runner</refentrytitle>
 
240
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
241
    </para>
 
242
    <informalexample>
 
243
      <para>
 
244
        Normal invocation needs no options:
 
245
      </para>
 
246
      <para>
 
247
        <userinput>&COMMANDNAME;</userinput>
 
248
      </para>
 
249
    </informalexample>
 
250
    <informalexample>
 
251
      <para>
 
252
        Show a prefix before the prompt; in this case, a host name.
 
253
        It might be useful to be reminded of which host needs a
 
254
        password, in case of <acronym>KVM</acronym> switches, etc.
 
255
      </para>
 
256
      <para>
 
257
 
 
258
<!-- do not wrap this line -->
 
259
<userinput>&COMMANDNAME; --prefix=host.example.org:</userinput>
 
260
 
 
261
      </para>
 
262
    </informalexample>
 
263
    <informalexample>
 
264
      <para>
 
265
        Run in debug mode.
 
266
      </para>
 
267
      <para>
 
268
        <!-- do not wrap this line -->
 
269
        <userinput>&COMMANDNAME; --debug</userinput>
 
270
      </para>
 
271
    </informalexample>
 
272
  </refsect1>
 
273
  
 
274
  <refsect1 id="security">
 
275
    <title>SECURITY</title>
 
276
    <para>
 
277
      On its own, this program is very simple, and does not exactly
 
278
      present any security risks.  The one thing that could be
 
279
      considered worthy of note is this: This program is meant to be
 
280
      run by <citerefentry><refentrytitle
 
281
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
282
      </citerefentry>, and will, when run standalone, outside, in a
 
283
      normal environment, immediately output on its standard output
 
284
      any presumably secret password it just received.  Therefore,
 
285
      when running this program standalone (which should never
 
286
      normally be done), take care not to type in any real secret
 
287
      password by force of habit, since it would then immediately be
 
288
      shown as output.
 
289
    </para>
 
290
    <para>
 
291
      To further alleviate any risk of being locked out of a system,
 
292
      the <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
293
      <manvolnum>8mandos</manvolnum></citerefentry> has a fallback
 
294
      mode which does the same thing as this program, only with less
 
295
      features.
 
296
    </para>
 
297
  </refsect1>
 
298
  
 
299
  <refsect1 id="see_also">
 
300
    <title>SEE ALSO</title>
 
301
    <para>
 
302
      <citerefentry><refentrytitle>intro</refentrytitle>
 
303
      <manvolnum>8mandos</manvolnum></citerefentry>
 
304
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
305
      <manvolnum>5</manvolnum></citerefentry>
 
306
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
307
      <manvolnum>8mandos</manvolnum></citerefentry>
 
308
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
309
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
310
    </para>
 
311
  </refsect1>
 
312
</refentry>
 
313
<!-- Local Variables: -->
 
314
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
315
<!-- time-stamp-end: "[\"']>" -->
 
316
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
317
<!-- End: -->