/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-18 03:50:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818035028-su31apqs2pv2147v
* mandos-keygen.xml: Removed <?xml-stylesheet>.  New entity
                     "&OVERVIEW;" referring to "overview.xml".
  (PURPOSE, OVERVIEW): New sections, same as in mandos(8).
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* mandos.xml (OPTIONS, CLIENTS): Slight wording change.

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