/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: 2015-07-01 20:01:26 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150701200126-qb3f6c3jcas2f4og
mandos-client: Try to start a plugin to add and remove a local route.

* debian/mandos-client.README.Debian: Add setting of environment
                                      variable MANDOSPLUGINHELPERDIR
                                      to command line testing
                                      mandos-client.
* mandos-client.c (raise_privileges): Moved to top of file.
                  (raise_privileges_permanently): - '' -
                  (lower_privileges): - '' -
                  (lower_privileges_permanently): - '' -
  (add_remove_local_route, add_local_route, remove_local_route): New.
  (start_mandos_communication): Set SOCK_CLOEXEC flag on socket.  Run
                                the above functions to add (and
                                remove) local route, if the conditions
                                indicates it could help.
  (run_network_hooks): Use O_DIRECTORY, O_PATH, and O_CLOEXEC flags
                       when opening network hook directory. Do
                       TEMP_FAILURE_RETRY around opening of /dev/null
                       and network hook executables.  Move redirecting
                       of stdout and stderr to as late as possible
                       before fexecve().
  (main): Use O_DIRECTORY and O_PATH when opening temporary directory.
* plugins.d/mandos-client.xml (ENVIRONMENT): Document usage of the
                                             MANDOSPLUGINHELPERDIR
                                             environment variable.

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