/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: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "password-prompt">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
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>
34
44
      <holder>Teddy Hogeborn</holder>
35
45
      <holder>Björn Påhlsson</holder>
36
46
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
      
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
      
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
47
    <xi:include href="../legalnotice.xml"/>
60
48
  </refentryinfo>
61
49
  
62
50
  <refmeta>
105
93
    <title>DESCRIPTION</title>
106
94
    <para>
107
95
      All <command>&COMMANDNAME;</command> does is prompt for a
108
 
      password and output any given password to standard output.  This
109
 
      is not very useful on its own.  This program is really meant to
110
 
      run as a plugin in the <application>Mandos</application>
111
 
      client-side system, where it is used as a fallback and
112
 
      alternative to retriving passwords from a <application
113
 
      >Mandos</application> server.
 
96
      password and output any given password to standard output.
 
97
    </para>
 
98
    <para>
 
99
      This program is not very useful on its own.  This program is
 
100
      really meant to run as a plugin in the <application
 
101
      >Mandos</application> client-side system, where it is used as a
 
102
      fallback and alternative to retrieving passwords from a
 
103
      <application >Mandos</application> server.
114
104
    </para>
115
105
    <para>
116
106
      This program is little more than a <citerefentry><refentrytitle
201
191
    <title>ENVIRONMENT</title>
202
192
    <variablelist>
203
193
      <varlistentry>
204
 
        <term><envar>cryptsource</envar></term>
205
 
        <term><envar>crypttarget</envar></term>
 
194
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
195
        <term><envar>CRYPTTAB_NAME</envar></term>
206
196
        <listitem>
207
197
          <para>
208
198
            If set, these environment variables will be assumed to
216
206
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
217
207
          normally have inherited them from
218
208
          <filename>/scripts/local-top/cryptroot</filename> in the
219
 
          initial RAM disk environment, which will have set them from
220
 
          parsing kernel arguments and
 
209
          initial <acronym>RAM</acronym> disk environment, which will
 
210
          have set them from parsing kernel arguments and
221
211
          <filename>/conf/conf.d/cryptroot</filename> (also in the
222
212
          initial RAM disk environment), which in turn will have been
223
213
          created when the initial RAM disk image was created by
237
227
  
238
228
  <refsect1 id="bugs">
239
229
    <title>BUGS</title>
240
 
    <para>
241
 
      None are known at this time.
242
 
    </para>
 
230
    <xi:include href="../bugs.xml"/>
243
231
  </refsect1>
244
232
  
245
233
  <refsect1 id="example">
262
250
      <para>
263
251
        Show a prefix before the prompt; in this case, a host name.
264
252
        It might be useful to be reminded of which host needs a
265
 
        password, in case of KVM switches, etc.
 
253
        password, in case of <acronym>KVM</acronym> switches, etc.
266
254
      </para>
267
255
      <para>
268
256
 
292
280
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
281
      </citerefentry>, and will, when run standalone, outside, in a
294
282
      normal environment, immediately output on its standard output
295
 
      any presumably secret password it just recieved.  Therefore,
 
283
      any presumably secret password it just received.  Therefore,
296
284
      when running this program standalone (which should never
297
285
      normally be done), take care not to type in any real secret
298
286
      password by force of habit, since it would then immediately be
310
298
  <refsect1 id="see_also">
311
299
    <title>SEE ALSO</title>
312
300
    <para>
 
301
      <citerefentry><refentrytitle>intro</refentrytitle>
 
302
      <manvolnum>8mandos</manvolnum></citerefentry>
313
303
      <citerefentry><refentrytitle>crypttab</refentrytitle>
314
304
      <manvolnum>5</manvolnum></citerefentry>
315
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
305
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
316
306
      <manvolnum>8mandos</manvolnum></citerefentry>
317
307
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
308
      <manvolnum>8mandos</manvolnum></citerefentry>,