/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-10 20:35:01 UTC
  • mfrom: (24.1.42 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080810203501-euh3qcf1nopilksm
Merge.

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
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
36
    <legalnotice>
38
37
      <para>
74
73
  <refsynopsisdiv>
75
74
    <cmdsynopsis>
76
75
      <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>
 
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>    
144
97
  </refsynopsisdiv>
145
98
 
146
99
  <refsect1 id="description">
152
105
      passwords given is automaticly decrypted and passed to
153
106
      cryptsetup.
154
107
    </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
108
 
164
109
    <variablelist>
165
110
      <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>
 
111
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
112
        IP</replaceable></literal></term>
172
113
        <listitem>
173
114
          <para>
174
 
            Connect directly to a specified mandos server
 
115
            Connect directly to a sepcified mandos server
175
116
          </para>
176
117
        </listitem>
177
118
      </varlistentry>
178
119
 
179
120
      <varlistentry>
180
 
        <term><option>--keydir=<replaceable
181
 
        >DIRECTORY</replaceable></option></term>
182
 
        <term><option>-d
183
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
121
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
122
        KEYDIR</replaceable></literal></term>
184
123
        <listitem>
185
124
          <para>
186
125
            Directory where the openpgp keyring is
187
126
          </para>
188
127
        </listitem>
189
 
      </varlistentry>
 
128
      </varlistentry>      
190
129
 
191
130
      <varlistentry>
192
 
        <term><option>--interface=
193
 
        <replaceable>NAME</replaceable></option></term>
194
 
        <term><option>-i
195
 
        <replaceable>NAME</replaceable></option></term>
 
131
        <term><literal>-i</literal>, <literal>--interface=
 
132
        <replaceable>INTERFACE</replaceable></literal></term>
196
133
        <listitem>
197
134
          <para>
198
 
            Interface that Avahi will connect through
 
135
            Interface that Avahi will conntect through
199
136
          </para>
200
137
        </listitem>
201
 
      </varlistentry>
 
138
      </varlistentry>      
202
139
 
203
140
      <varlistentry>
204
 
        <term><option>--pubkey=<replaceable
205
 
        >FILE</replaceable></option></term>
206
 
        <term><option>-p
207
 
        <replaceable>FILE</replaceable></option></term>
 
141
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
142
        PUBKEY</replaceable></literal></term>
208
143
        <listitem>
209
144
          <para>
210
145
            Public openpgp key for gnutls authentication
211
146
          </para>
212
147
        </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>
 
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>
249
182
        <listitem>
250
183
          <para>
251
184
            Debug mode
254
187
      </varlistentry>
255
188
      
256
189
      <varlistentry>
257
 
        <term><option>--help</option></term>
258
 
        <term><option>-?</option></term>
 
190
        <term><literal>-?</literal>, <literal>--help</literal></term>
259
191
        <listitem>
260
192
          <para>
261
193
            Gives a help message
264
196
      </varlistentry>
265
197
      
266
198
      <varlistentry>
267
 
        <term><option>--usage</option></term>
 
199
        <term><literal>--usage</literal></term>
268
200
        <listitem>
269
201
          <para>
270
202
            Gives a short usage message
273
205
      </varlistentry>
274
206
 
275
207
      <varlistentry>
276
 
        <term><option>--version</option></term>
277
 
        <term><option>-V</option></term>
 
208
        <term><literal>-V</literal>, <literal>--version</literal></term>
278
209
        <listitem>
279
210
          <para>
280
211
            Prints the program version
281
212
          </para>
282
213
        </listitem>
283
 
      </varlistentry>
 
214
      </varlistentry>            
284
215
    </variablelist>
285
216
  </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
217
</refentry>
372
 
<!-- Local Variables: -->
373
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
374
 
<!-- time-stamp-end: "[\"']>" -->
375
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
376
 
<!-- End: -->