/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/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-16 03:29:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080816032908-ihw7c05r2mnyk389
Add feature to specify custom environment variables for plugins.

* plugin-runner.c (plugin): New members "environ" and "envc" to
                            contain possible custom environment.
  (getplugin): Return NULL on failure instead of doing exit(); all
               callers changed.
  (add_to_char_array): New helper function for "add_argument" and
                       "add_environment".
  (addargument): Renamed to "add_argument".  Return bool.  Call
                 "add_to_char_array" to actually do things.
  (add_environment): New; analogous to "add_argument".
  (addcustomargument): Renamed to "add_to_argv" to avoid confusion
                       with "add_argument".
  (main): New options "--global-envs" and "--envs-for" to specify
          custom environment for plugins.  Print environment for
          plugins in debug mode.  Use asprintf instead of strcpy and
          strcat.  Use execve() for plugins with custom environments.
          Free environment for plugin when freeing plugin list.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
7
8
]>
8
9
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
10
11
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
14
15
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
16
    <authorgroup>
17
17
      <author>
18
18
        <firstname>Björn</firstname>
31
31
    </authorgroup>
32
32
    <copyright>
33
33
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
35
    </copyright>
37
 
    <xi:include href="../legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
38
59
  </refentryinfo>
39
60
 
40
61
  <refmeta>
52
73
  <refsynopsisdiv>
53
74
    <cmdsynopsis>
54
75
      <command>&COMMANDNAME;</command>
55
 
      <group>
56
 
        <arg choice="plain"><option>--connect
57
 
        <replaceable>IPADDR</replaceable><literal>:</literal
58
 
        ><replaceable>PORT</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
61
 
        ><replaceable>PORT</replaceable></option></arg>
62
 
      </group>
63
 
      <sbr/>
64
 
      <group>
65
 
        <arg choice="plain"><option>--keydir
66
 
        <replaceable>DIRECTORY</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-d
68
 
        <replaceable>DIRECTORY</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--interface
73
 
        <replaceable>NAME</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-i
75
 
        <replaceable>NAME</replaceable></option></arg>
76
 
      </group>
77
 
      <sbr/>
78
 
      <group>
79
 
        <arg choice="plain"><option>--pubkey
80
 
        <replaceable>FILE</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-p
82
 
        <replaceable>FILE</replaceable></option></arg>
83
 
      </group>
84
 
      <sbr/>
85
 
      <group>
86
 
        <arg choice="plain"><option>--seckey
87
 
        <replaceable>FILE</replaceable></option></arg>
88
 
        <arg choice="plain"><option>-s
89
 
        <replaceable>FILE</replaceable></option></arg>
90
 
      </group>
91
 
      <sbr/>
92
 
      <arg>
93
 
        <option>--priority <replaceable>STRING</replaceable></option>
94
 
      </arg>
95
 
      <sbr/>
96
 
      <arg>
97
 
        <option>--dh-bits <replaceable>BITS</replaceable></option>
98
 
      </arg>
99
 
      <sbr/>
100
 
      <arg>
101
 
        <option>--debug</option>
102
 
      </arg>
103
 
    </cmdsynopsis>
104
 
    <cmdsynopsis>
105
 
      <command>&COMMANDNAME;</command>
106
 
      <group choice="req">
107
 
        <arg choice="plain"><option>--help</option></arg>
108
 
        <arg choice="plain"><option>-?</option></arg>
109
 
      </group>
110
 
    </cmdsynopsis>
111
 
    <cmdsynopsis>
112
 
      <command>&COMMANDNAME;</command>
113
 
      <arg choice="plain"><option>--usage</option></arg>
114
 
    </cmdsynopsis>
115
 
    <cmdsynopsis>
116
 
      <command>&COMMANDNAME;</command>
117
 
      <group choice="req">
118
 
        <arg choice="plain"><option>--version</option></arg>
119
 
        <arg choice="plain"><option>-V</option></arg>
120
 
      </group>
121
 
    </cmdsynopsis>
 
76
      <arg choice='opt'>--connect<arg choice='plain'>IP</arg></arg>
 
77
      <arg choice='opt'>--keydir<arg choice='plain'>KEYDIR</arg></arg>
 
78
      <arg choice='opt'>--interface<arg choice='plain'>INTERFACE</arg></arg>
 
79
      <arg choice='opt'>--pubkey<arg choice='plain'>PUBKEY</arg></arg>
 
80
      <arg choice='opt'>--seckey<arg choice='plain'>SECKEY</arg></arg>
 
81
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
82
      <arg choice='opt'>--dh-bits<arg choice='plain'>BITS</arg></arg>      
 
83
      <arg choice='opt'>--debug</arg>
 
84
    </cmdsynopsis>
 
85
    <cmdsynopsis>
 
86
      <command>&COMMANDNAME;</command>
 
87
      <arg choice='plain'>--help</arg>
 
88
    </cmdsynopsis>
 
89
    <cmdsynopsis>
 
90
      <command>&COMMANDNAME;</command>
 
91
      <arg choice='plain'>--usage</arg>
 
92
    </cmdsynopsis>
 
93
    <cmdsynopsis>
 
94
      <command>&COMMANDNAME;</command>
 
95
      <arg choice='plain'>--version</arg>
 
96
    </cmdsynopsis>    
122
97
  </refsynopsisdiv>
123
98
 
124
99
  <refsect1 id="description">
130
105
      passwords given is automaticly decrypted and passed to
131
106
      cryptsetup.
132
107
    </para>
133
 
  </refsect1>
134
 
  
135
 
  <refsect1 id="options">
136
 
    <title>OPTIONS</title>
137
 
    <para>
138
 
      Commonly not invoked as command lines but from configuration
139
 
      file of plugin runner.
140
 
    </para>
141
108
 
142
109
    <variablelist>
143
110
      <varlistentry>
144
 
        <term><option>--connect=<replaceable
145
 
        >IPADDR</replaceable><literal>:</literal><replaceable
146
 
        >PORT</replaceable></option></term>
147
 
        <term><option>-c
148
 
        <replaceable>IPADDR</replaceable><literal>:</literal
149
 
        ><replaceable>PORT</replaceable></option></term>
 
111
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
112
        IP</replaceable></literal></term>
150
113
        <listitem>
151
114
          <para>
152
 
            Connect directly to a specified mandos server
 
115
            Connect directly to a sepcified mandos server
153
116
          </para>
154
117
        </listitem>
155
118
      </varlistentry>
156
119
 
157
120
      <varlistentry>
158
 
        <term><option>--keydir=<replaceable
159
 
        >DIRECTORY</replaceable></option></term>
160
 
        <term><option>-d
161
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
121
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
122
        KEYDIR</replaceable></literal></term>
162
123
        <listitem>
163
124
          <para>
164
125
            Directory where the openpgp keyring is
165
126
          </para>
166
127
        </listitem>
167
 
      </varlistentry>
 
128
      </varlistentry>      
168
129
 
169
130
      <varlistentry>
170
 
        <term><option>--interface=
171
 
        <replaceable>NAME</replaceable></option></term>
172
 
        <term><option>-i
173
 
        <replaceable>NAME</replaceable></option></term>
 
131
        <term><literal>-i</literal>, <literal>--interface=
 
132
        <replaceable>INTERFACE</replaceable></literal></term>
174
133
        <listitem>
175
134
          <para>
176
 
            Interface that Avahi will connect through
 
135
            Interface that Avahi will conntect through
177
136
          </para>
178
137
        </listitem>
179
 
      </varlistentry>
 
138
      </varlistentry>      
180
139
 
181
140
      <varlistentry>
182
 
        <term><option>--pubkey=<replaceable
183
 
        >FILE</replaceable></option></term>
184
 
        <term><option>-p
185
 
        <replaceable>FILE</replaceable></option></term>
 
141
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
142
        PUBKEY</replaceable></literal></term>
186
143
        <listitem>
187
144
          <para>
188
145
            Public openpgp key for gnutls authentication
189
146
          </para>
190
147
        </listitem>
191
 
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><option>--seckey=<replaceable
195
 
        >FILE</replaceable></option></term>
196
 
        <term><option>-s
197
 
        <replaceable>FILE</replaceable></option></term>
198
 
        <listitem>
199
 
          <para>
200
 
            Secret OpenPGP key for GnuTLS authentication
201
 
          </para>
202
 
        </listitem>
203
 
      </varlistentry>
204
 
      
205
 
      <varlistentry>
206
 
        <term><option>--priority=<replaceable
207
 
        >STRING</replaceable></option></term>
208
 
        <listitem>
209
 
          <para>
210
 
            GnuTLS priority
211
 
          </para>
212
 
        </listitem>
213
 
      </varlistentry>
214
 
 
215
 
      <varlistentry>
216
 
        <term><option>--dh-bits=<replaceable
217
 
        >BITS</replaceable></option></term>
218
 
        <listitem>
219
 
          <para>
220
 
            DH bits to use in gnutls communication
221
 
          </para>
222
 
        </listitem>
223
 
      </varlistentry>
224
 
      
225
 
      <varlistentry>
226
 
        <term><option>--debug</option></term>
 
148
      </varlistentry>      
 
149
 
 
150
      <varlistentry>
 
151
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
152
        SECKEY</replaceable></literal></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Secret openpgp key for gnutls authentication
 
156
          </para>
 
157
        </listitem>
 
158
      </varlistentry>            
 
159
      
 
160
      <varlistentry>
 
161
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
162
        </literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            GNUTLS priority
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>            
 
169
 
 
170
      <varlistentry>
 
171
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
172
        </literal></term>
 
173
        <listitem>
 
174
          <para>
 
175
            dh-bits to use in gnutls communication
 
176
          </para>
 
177
        </listitem>
 
178
      </varlistentry>      
 
179
      
 
180
      <varlistentry>
 
181
        <term><literal>--debug</literal></term>
227
182
        <listitem>
228
183
          <para>
229
184
            Debug mode
232
187
      </varlistentry>
233
188
      
234
189
      <varlistentry>
235
 
        <term><option>--help</option></term>
236
 
        <term><option>-?</option></term>
 
190
        <term><literal>-?</literal>, <literal>--help</literal></term>
237
191
        <listitem>
238
192
          <para>
239
193
            Gives a help message
242
196
      </varlistentry>
243
197
      
244
198
      <varlistentry>
245
 
        <term><option>--usage</option></term>
 
199
        <term><literal>--usage</literal></term>
246
200
        <listitem>
247
201
          <para>
248
202
            Gives a short usage message
251
205
      </varlistentry>
252
206
 
253
207
      <varlistentry>
254
 
        <term><option>--version</option></term>
255
 
        <term><option>-V</option></term>
 
208
        <term><literal>-V</literal>, <literal>--version</literal></term>
256
209
        <listitem>
257
210
          <para>
258
211
            Prints the program version
259
212
          </para>
260
213
        </listitem>
261
 
      </varlistentry>
 
214
      </varlistentry>            
262
215
    </variablelist>
263
216
  </refsect1>
264
 
 
265
 
  <refsect1 id="exit_status">
266
 
    <title>EXIT STATUS</title>
267
 
    <para>
268
 
    </para>
269
 
  </refsect1>
270
 
 
271
 
  <refsect1 id="environment">
272
 
    <title>ENVIRONMENT</title>
273
 
    <para>
274
 
    </para>
275
 
  </refsect1>
276
 
 
277
 
  <refsect1 id="file">
278
 
    <title>FILES</title>
279
 
    <para>
280
 
    </para>
281
 
  </refsect1>
282
 
  
283
 
  <refsect1 id="bugs">
284
 
    <title>BUGS</title>
285
 
    <para>
286
 
    </para>
287
 
  </refsect1>
288
 
 
289
 
  <refsect1 id="example">
290
 
    <title>EXAMPLE</title>
291
 
    <para>
292
 
    </para>
293
 
  </refsect1>
294
 
 
295
 
  <refsect1 id="security">
296
 
    <title>SECURITY</title>
297
 
    <para>
298
 
    </para>
299
 
  </refsect1>
300
 
 
301
 
  <refsect1 id="see_also">
302
 
    <title>SEE ALSO</title>
303
 
    <para>
304
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
305
 
      <manvolnum>8</manvolnum></citerefentry>,
306
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
307
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
308
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
309
 
      <manvolnum>8mandos</manvolnum></citerefentry>
310
 
    </para>
311
 
    <itemizedlist>
312
 
      <listitem><para>
313
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
314
 
      </para></listitem>
315
 
      
316
 
      <listitem><para>
317
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
318
 
      </para></listitem>
319
 
      
320
 
      <listitem><para>
321
 
        <ulink
322
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
323
 
      </para></listitem>
324
 
      
325
 
      <listitem><para>
326
 
        <ulink
327
 
        url="http://www.gnupg.org/related_software/gpgme/">
328
 
        GPGME</ulink>
329
 
      </para></listitem>
330
 
      
331
 
      <listitem><para>
332
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
333
 
        Format</citetitle></citation>
334
 
      </para></listitem>
335
 
      
336
 
      <listitem><para>
337
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
338
 
        Transport Layer Security</citetitle></citation>
339
 
      </para></listitem>
340
 
      
341
 
      <listitem><para>
342
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
343
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
344
 
        Unicast Addresses</citation>
345
 
      </para></listitem>
346
 
    </itemizedlist>
347
 
  </refsect1>
348
 
 
349
217
</refentry>
350
 
<!-- Local Variables: -->
351
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
352
 
<!-- time-stamp-end: "[\"']>" -->
353
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
354
 
<!-- End: -->