/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 14:02:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140237-oz9knd88esz8cj4y
* plugin-runner.xml: Removed <?xml-stylesheet>.
* plugins.d/password-request.xml: - '' -

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