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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 20:01:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831200103-wvjp5oagtxj7s25g
* plugin-runner.c: Break a couple of long lines.

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"?>
 
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 VERSION "1.0">
 
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
 
7
]>
 
8
 
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
  <refentryinfo>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
 
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
 
16
    <authorgroup>
 
17
      <author>
 
18
        <firstname>Björn</firstname>
 
19
        <surname>Påhlsson</surname>
 
20
        <address>
 
21
          <email>belorn@fukt.bsnet.se</email>
 
22
        </address>
 
23
      </author>
 
24
      <author>
 
25
        <firstname>Teddy</firstname>
 
26
        <surname>Hogeborn</surname>
 
27
        <address>
 
28
          <email>teddy@fukt.bsnet.se</email>
 
29
        </address>
 
30
      </author>
 
31
    </authorgroup>
 
32
    <copyright>
 
33
      <year>2008</year>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
 
36
    </copyright>
 
37
    <xi:include href="../legalnotice.xml"/>
 
38
  </refentryinfo>
 
39
 
 
40
  <refmeta>
 
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
 
42
    <manvolnum>8mandos</manvolnum>
 
43
  </refmeta>
 
44
  
 
45
  <refnamediv>
 
46
    <refname><command>&COMMANDNAME;</command></refname>
 
47
    <refpurpose>
 
48
      Client for mandos
 
49
    </refpurpose>
 
50
  </refnamediv>
 
51
 
 
52
  <refsynopsisdiv>
 
53
    <cmdsynopsis>
 
54
      <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>
 
122
  </refsynopsisdiv>
 
123
 
 
124
  <refsect1 id="description">
 
125
    <title>DESCRIPTION</title>
 
126
    <para>
 
127
      <command>&COMMANDNAME;</command> is a mandos plugin that works
 
128
      like a client program that through avahi detects mandos servers,
 
129
      sets up a gnutls connect and request a encrypted password. Any
 
130
      passwords given is automaticly decrypted and passed to
 
131
      cryptsetup.
 
132
    </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
 
 
142
    <variablelist>
 
143
      <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>
 
150
        <listitem>
 
151
          <para>
 
152
            Connect directly to a specified mandos server
 
153
          </para>
 
154
        </listitem>
 
155
      </varlistentry>
 
156
 
 
157
      <varlistentry>
 
158
        <term><option>--keydir=<replaceable
 
159
        >DIRECTORY</replaceable></option></term>
 
160
        <term><option>-d
 
161
        <replaceable>DIRECTORY</replaceable></option></term>
 
162
        <listitem>
 
163
          <para>
 
164
            Directory where the openpgp keyring is
 
165
          </para>
 
166
        </listitem>
 
167
      </varlistentry>
 
168
 
 
169
      <varlistentry>
 
170
        <term><option>--interface=
 
171
        <replaceable>NAME</replaceable></option></term>
 
172
        <term><option>-i
 
173
        <replaceable>NAME</replaceable></option></term>
 
174
        <listitem>
 
175
          <para>
 
176
            Interface that Avahi will connect through
 
177
          </para>
 
178
        </listitem>
 
179
      </varlistentry>
 
180
 
 
181
      <varlistentry>
 
182
        <term><option>--pubkey=<replaceable
 
183
        >FILE</replaceable></option></term>
 
184
        <term><option>-p
 
185
        <replaceable>FILE</replaceable></option></term>
 
186
        <listitem>
 
187
          <para>
 
188
            Public openpgp key for gnutls authentication
 
189
          </para>
 
190
        </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>
 
227
        <listitem>
 
228
          <para>
 
229
            Debug mode
 
230
          </para>
 
231
        </listitem>
 
232
      </varlistentry>
 
233
      
 
234
      <varlistentry>
 
235
        <term><option>--help</option></term>
 
236
        <term><option>-?</option></term>
 
237
        <listitem>
 
238
          <para>
 
239
            Gives a help message
 
240
          </para>
 
241
        </listitem>
 
242
      </varlistentry>
 
243
      
 
244
      <varlistentry>
 
245
        <term><option>--usage</option></term>
 
246
        <listitem>
 
247
          <para>
 
248
            Gives a short usage message
 
249
          </para>
 
250
        </listitem>
 
251
      </varlistentry>
 
252
 
 
253
      <varlistentry>
 
254
        <term><option>--version</option></term>
 
255
        <term><option>-V</option></term>
 
256
        <listitem>
 
257
          <para>
 
258
            Prints the program version
 
259
          </para>
 
260
        </listitem>
 
261
      </varlistentry>
 
262
    </variablelist>
 
263
  </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
</refentry>
 
350
<!-- Local Variables: -->
 
351
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
352
<!-- time-stamp-end: "[\"']>" -->
 
353
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
354
<!-- End: -->