/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-25 01:16:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825011638-zgqej2cafhne05ay
* mandos-keygen: Strip 24-bit checksum of Radix-64 from output to make
                 output strictly base64.

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>
 
108
  </refsect1>  
134
109
  
135
110
  <refsect1 id="options">
136
111
    <title>OPTIONS</title>
141
116
 
142
117
    <variablelist>
143
118
      <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>
 
119
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
120
        IP</replaceable></literal></term>
150
121
        <listitem>
151
122
          <para>
152
123
            Connect directly to a specified mandos server
155
126
      </varlistentry>
156
127
 
157
128
      <varlistentry>
158
 
        <term><option>--keydir=<replaceable
159
 
        >DIRECTORY</replaceable></option></term>
160
 
        <term><option>-d
161
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
129
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
130
        KEYDIR</replaceable></literal></term>
162
131
        <listitem>
163
132
          <para>
164
133
            Directory where the openpgp keyring is
165
134
          </para>
166
135
        </listitem>
167
 
      </varlistentry>
 
136
      </varlistentry>      
168
137
 
169
138
      <varlistentry>
170
 
        <term><option>--interface=
171
 
        <replaceable>NAME</replaceable></option></term>
172
 
        <term><option>-i
173
 
        <replaceable>NAME</replaceable></option></term>
 
139
        <term><literal>-i</literal>, <literal>--interface=
 
140
        <replaceable>INTERFACE</replaceable></literal></term>
174
141
        <listitem>
175
142
          <para>
176
 
            Interface that Avahi will connect through
 
143
            Interface that Avahi will conntect through
177
144
          </para>
178
145
        </listitem>
179
 
      </varlistentry>
 
146
      </varlistentry>      
180
147
 
181
148
      <varlistentry>
182
 
        <term><option>--pubkey=<replaceable
183
 
        >FILE</replaceable></option></term>
184
 
        <term><option>-p
185
 
        <replaceable>FILE</replaceable></option></term>
 
149
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
150
        PUBKEY</replaceable></literal></term>
186
151
        <listitem>
187
152
          <para>
188
153
            Public openpgp key for gnutls authentication
189
154
          </para>
190
155
        </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>
 
156
      </varlistentry>      
 
157
 
 
158
      <varlistentry>
 
159
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
160
        SECKEY</replaceable></literal></term>
 
161
        <listitem>
 
162
          <para>
 
163
            Secret openpgp key for gnutls authentication
 
164
          </para>
 
165
        </listitem>
 
166
      </varlistentry>            
 
167
      
 
168
      <varlistentry>
 
169
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
170
        </literal></term>
 
171
        <listitem>
 
172
          <para>
 
173
            GNUTLS priority
 
174
          </para>
 
175
        </listitem>
 
176
      </varlistentry>            
 
177
 
 
178
      <varlistentry>
 
179
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
180
        </literal></term>
 
181
        <listitem>
 
182
          <para>
 
183
            dh-bits to use in gnutls communication
 
184
          </para>
 
185
        </listitem>
 
186
      </varlistentry>      
 
187
      
 
188
      <varlistentry>
 
189
        <term><literal>--debug</literal></term>
227
190
        <listitem>
228
191
          <para>
229
192
            Debug mode
232
195
      </varlistentry>
233
196
      
234
197
      <varlistentry>
235
 
        <term><option>--help</option></term>
236
 
        <term><option>-?</option></term>
 
198
        <term><literal>-?</literal>, <literal>--help</literal></term>
237
199
        <listitem>
238
200
          <para>
239
201
            Gives a help message
242
204
      </varlistentry>
243
205
      
244
206
      <varlistentry>
245
 
        <term><option>--usage</option></term>
 
207
        <term><literal>--usage</literal></term>
246
208
        <listitem>
247
209
          <para>
248
210
            Gives a short usage message
251
213
      </varlistentry>
252
214
 
253
215
      <varlistentry>
254
 
        <term><option>--version</option></term>
255
 
        <term><option>-V</option></term>
 
216
        <term><literal>-V</literal>, <literal>--version</literal></term>
256
217
        <listitem>
257
218
          <para>
258
219
            Prints the program version
259
220
          </para>
260
221
        </listitem>
261
 
      </varlistentry>
 
222
      </varlistentry>            
262
223
    </variablelist>
263
224
  </refsect1>
264
225
 
272
233
    <title>ENVIRONMENT</title>
273
234
    <para>
274
235
    </para>
275
 
  </refsect1>
 
236
  </refsect1>  
276
237
 
277
238
  <refsect1 id="file">
278
239
    <title>FILES</title>
279
240
    <para>
280
241
    </para>
281
 
  </refsect1>
 
242
  </refsect1>  
282
243
  
283
244
  <refsect1 id="bugs">
284
245
    <title>BUGS</title>
285
246
    <para>
286
247
    </para>
287
 
  </refsect1>
 
248
  </refsect1>  
288
249
 
289
250
  <refsect1 id="example">
290
251
    <title>EXAMPLE</title>
300
261
 
301
262
  <refsect1 id="see_also">
302
263
    <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
264
    <itemizedlist>
312
265
      <listitem><para>
 
266
        <citerefentry><refentrytitle>mandos</refentrytitle>
 
267
        <manvolnum>8</manvolnum></citerefentry>
 
268
      </para></listitem>
 
269
      
 
270
      <listitem><para>
 
271
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
272
        <manvolnum>8mandos</manvolnum></citerefentry>
 
273
      </para></listitem>
 
274
      
 
275
      <listitem><para>
 
276
        <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
277
        <manvolnum>8mandos</manvolnum></citerefentry>
 
278
      </para></listitem>
 
279
      
 
280
      <listitem><para>
313
281
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
314
282
      </para></listitem>
315
283
      
347
315
  </refsect1>
348
316
 
349
317
</refentry>
350
 
<!-- Local Variables: -->
351
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
352
 
<!-- time-stamp-end: "[\"']>" -->
353
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
354
 
<!-- End: -->