/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/askpass-fifo.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-04 14:04:09 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904140409-anr3hckg8ew7q60e
* plugin-runner.xml (BUGS): Document the non-recursiveness of the
                            "--config-file" option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/askpass-fifo.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 "askpass-fifo">
5
 
<!ENTITY TIMESTAMP "2011-10-03">
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>2011</year>
37
 
      <holder>Teddy Hogeborn</holder>
38
 
      <holder>Björn Påhlsson</holder>
39
 
    </copyright>
40
 
    <xi:include href="../legalnotice.xml"/>
41
 
  </refentryinfo>
42
 
  
43
 
  <refmeta>
44
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
 
    <manvolnum>8mandos</manvolnum>
46
 
  </refmeta>
47
 
  
48
 
  <refnamediv>
49
 
    <refname><command>&COMMANDNAME;</command></refname>
50
 
    <refpurpose>Mandos plugin to get a password from a
51
 
    FIFO.</refpurpose>
52
 
  </refnamediv>
53
 
  
54
 
  <refsynopsisdiv>
55
 
    <cmdsynopsis>
56
 
      <command>&COMMANDNAME;</command>
57
 
    </cmdsynopsis>
58
 
  </refsynopsisdiv>
59
 
  
60
 
  <refsect1 id="description">
61
 
    <title>DESCRIPTION</title>
62
 
    <para>
63
 
      This program reads a password from a <acronym>FIFO</acronym> and
64
 
      outputs it to standard output.
65
 
    </para>
66
 
    <para>
67
 
      This program is not very useful on its own.  This program is
68
 
      really meant to run as a plugin in the <application
69
 
      >Mandos</application> client-side system, where it is used as a
70
 
      fallback and alternative to retrieving passwords from a
71
 
      <application >Mandos</application> server.
72
 
    </para>
73
 
    <para>
74
 
      This program is meant to be imitate a feature of the
75
 
      <command>askpass</command> program, so that programs written to
76
 
      interface with it can keep working under the
77
 
      <application>Mandos</application> system.
78
 
    </para>
79
 
  </refsect1>
80
 
  
81
 
  <refsect1 id="options">
82
 
    <title>OPTIONS</title>
83
 
    <para>
84
 
      This program takes no options.
85
 
    </para>
86
 
  </refsect1>
87
 
  
88
 
  <refsect1 id="exit_status">
89
 
    <title>EXIT STATUS</title>
90
 
    <para>
91
 
      If exit status is 0, the output from the program is the password
92
 
      as it was read.  Otherwise, if exit status is other than 0, the
93
 
      program was interrupted or encountered an error, and any output
94
 
      so far could be corrupt and/or truncated, and should therefore
95
 
      be ignored.
96
 
    </para>
97
 
  </refsect1>
98
 
  
99
 
  <refsect1 id="files">
100
 
    <title>FILES</title>
101
 
    <variablelist>
102
 
      <varlistentry>
103
 
        <term><filename>/lib/cryptsetup/passfifo</filename></term>
104
 
        <listitem>
105
 
          <para>
106
 
            This is the <acronym>FIFO</acronym> where this program
107
 
            will read the password.  If it does not exist, it will be
108
 
            created.
109
 
          </para>
110
 
        </listitem>
111
 
      </varlistentry>
112
 
    </variablelist>
113
 
  </refsect1>
114
 
  
115
 
  <refsect1 id="example">
116
 
    <title>EXAMPLE</title>
117
 
    <para>
118
 
      Note that normally, this program will not be invoked directly,
119
 
      but instead started by the Mandos <citerefentry><refentrytitle
120
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
121
 
      </citerefentry>.
122
 
    </para>
123
 
    <informalexample>
124
 
      <para>
125
 
        This program takes no options.
126
 
      </para>
127
 
      <para>
128
 
        <userinput>&COMMANDNAME;</userinput>
129
 
      </para>
130
 
    </informalexample>
131
 
  </refsect1>
132
 
  
133
 
  <refsect1 id="security">
134
 
    <title>SECURITY</title>
135
 
    <para>
136
 
      The only thing that could be considered worthy of note is
137
 
      this:  This program is meant to be run by <citerefentry>
138
 
      <refentrytitle>plugin-runner</refentrytitle><manvolnum
139
 
      >8mandos</manvolnum></citerefentry>, and will, when run
140
 
      standalone, outside, in a normal environment, immediately output
141
 
      on its standard output any presumably secret password it just
142
 
      received.  Therefore, when running this program standalone
143
 
      (which should never normally be done), take care not to type in
144
 
      any real secret password by force of habit, since it would then
145
 
      immediately be shown as output.
146
 
    </para>
147
 
  </refsect1>
148
 
  
149
 
  <refsect1 id="see_also">
150
 
    <title>SEE ALSO</title>
151
 
    <para>
152
 
      <citerefentry><refentrytitle>intro</refentrytitle>
153
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
154
 
      <citerefentry><refentrytitle>fifo</refentrytitle>
155
 
      <manvolnum>7</manvolnum></citerefentry>,
156
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
157
 
      <manvolnum>8mandos</manvolnum></citerefentry>
158
 
    </para>
159
 
  </refsect1>
160
 
</refentry>
161
 
<!-- Local Variables: -->
162
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
163
 
<!-- time-stamp-end: "[\"']>" -->
164
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
165
 
<!-- End: -->