/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/askpass-fifo.xml

minor edits

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