/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-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long options.

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-09-03">
 
8
<!ENTITY TIMESTAMP "2008-08-30">
7
9
]>
8
10
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
10
12
  <refentryinfo>
11
13
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
13
15
    <productname>Mandos</productname>
14
16
    <productnumber>&VERSION;</productnumber>
15
17
    <date>&TIMESTAMP;</date>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
37
    </copyright>
37
 
    <xi:include href="../legalnotice.xml"/>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
38
61
  </refentryinfo>
39
62
 
40
63
  <refmeta>
63
86
      <sbr/>
64
87
      <group>
65
88
        <arg choice="plain"><option>--keydir
66
 
        <replaceable>DIRECTORY</replaceable></option></arg>
 
89
        <replaceable>KEYDIR</replaceable></option></arg>
67
90
        <arg choice="plain"><option>-d
68
 
        <replaceable>DIRECTORY</replaceable></option></arg>
 
91
        <replaceable>KEYDIR</replaceable></option></arg>
69
92
      </group>
70
93
      <sbr/>
71
94
      <group>
104
127
    <cmdsynopsis>
105
128
      <command>&COMMANDNAME;</command>
106
129
      <group choice="req">
107
 
        <arg choice="plain"><option>--help</option></arg>
108
 
        <arg choice="plain"><option>-?</option></arg>
 
130
        <arg choice='plain'><option>-?</option></arg>
 
131
        <arg choice='plain'><option>--help</option></arg>
109
132
      </group>
110
133
    </cmdsynopsis>
111
134
    <cmdsynopsis>
112
135
      <command>&COMMANDNAME;</command>
113
 
      <arg choice="plain"><option>--usage</option></arg>
 
136
      <arg choice='plain'><option>--usage</option></arg>
114
137
    </cmdsynopsis>
115
138
    <cmdsynopsis>
116
139
      <command>&COMMANDNAME;</command>
117
140
      <group choice="req">
118
 
        <arg choice="plain"><option>--version</option></arg>
119
 
        <arg choice="plain"><option>-V</option></arg>
 
141
        <arg choice='plain'><option>-V</option></arg>
 
142
        <arg choice='plain'><option>--version</option></arg>
120
143
      </group>
121
144
    </cmdsynopsis>
122
145
  </refsynopsisdiv>
124
147
  <refsect1 id="description">
125
148
    <title>DESCRIPTION</title>
126
149
    <para>
127
 
      <command>&COMMANDNAME;</command> is a client program that
128
 
      communicates with <citerefentry><refentrytitle
129
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
130
 
      to get a password.  It uses IPv6 link-local addresses to get
131
 
      network connectivity, Zeroconf to find the server, and TLS with
132
 
      an OpenPGP key to ensure authenticity and confidentiality.  It
133
 
      keeps running, trying all servers on the network, until it
134
 
      receives a satisfactory reply.
135
 
    </para>
136
 
    <para>
137
 
      This program is not meant to be run directly; it is really meant
138
 
      to run as a plugin of the <application>Mandos</application>
139
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
140
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
141
 
      initial <acronym>RAM</acronym> disk environment because it is
142
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
143
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
144
 
      </citerefentry> file.
145
 
    </para>
146
 
  </refsect1>
147
 
  
148
 
  <refsect1 id="purpose">
149
 
    <title>PURPOSE</title>
150
 
    <para>
151
 
      The purpose of this is to enable <emphasis>remote and unattended
152
 
      rebooting</emphasis> of client host computer with an
153
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
154
 
      linkend="overview"/> for details.
 
150
      <command>&COMMANDNAME;</command> is a mandos plugin that works
 
151
      like a client program that through avahi detects mandos servers,
 
152
      sets up a gnutls connect and request a encrypted password. Any
 
153
      passwords given is automaticly decrypted and passed to
 
154
      cryptsetup.
155
155
    </para>
156
156
  </refsect1>
157
157
  
158
158
  <refsect1 id="options">
159
159
    <title>OPTIONS</title>
160
160
    <para>
161
 
      This program is commonly not invoked from the command line; it
162
 
      is normally started by the <application>Mandos</application>
163
 
      plugin runner, see <citerefentry><refentrytitle
164
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
165
 
      </citerefentry>.  Any command line options this program accepts
166
 
      are therefore normally provided by the plugin runner, and not
167
 
      directly.
 
161
      Commonly not invoked as command lines but from configuration
 
162
      file of plugin runner.
168
163
    </para>
169
 
    
 
164
 
170
165
    <variablelist>
171
166
      <varlistentry>
172
 
        <term><option>--connect=<replaceable
173
 
        >ADDRESS</replaceable><literal>:</literal><replaceable
174
 
        >PORT</replaceable></option></term>
175
 
        <term><option>-c
176
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
177
 
        ><replaceable>PORT</replaceable></option></term>
178
 
        <listitem>
179
 
          <para>
180
 
            Do not use Zeroconf to locate servers.  Connect directly
181
 
            to only one specified <application>Mandos</application>
182
 
            server.  Note that an IPv6 address has colon characters in
183
 
            it, so the <emphasis>last</emphasis> colon character is
184
 
            assumed to separate the address from the port number.
185
 
          </para>
186
 
          <para>
187
 
            This option is normally only useful for testing and
188
 
            debugging.
189
 
          </para>
190
 
        </listitem>
191
 
      </varlistentry>
192
 
      
193
 
      <varlistentry>
194
 
        <term><option>--keydir=<replaceable
195
 
        >DIRECTORY</replaceable></option></term>
196
 
        <term><option>-d
197
 
        <replaceable>DIRECTORY</replaceable></option></term>
198
 
        <listitem>
199
 
          <para>
200
 
            Directory to read the OpenPGP key files
201
 
            <filename>pubkey.txt</filename> and
202
 
            <filename>seckey.txt</filename> from.  The default is
203
 
            <filename>/conf/conf.d/mandos</filename> (in the initial
204
 
            <acronym>RAM</acronym> disk environment).
205
 
          </para>
206
 
        </listitem>
207
 
      </varlistentry>
208
 
 
209
 
      <varlistentry>
210
 
        <term><option>--interface=
211
 
        <replaceable>NAME</replaceable></option></term>
212
 
        <term><option>-i
213
 
        <replaceable>NAME</replaceable></option></term>
214
 
        <listitem>
215
 
          <para>
216
 
            Network interface that will be brought up and scanned for
217
 
            Mandos servers to connect to.  The default it
218
 
            <quote><literal>eth0</literal></quote>.
219
 
          </para>
220
 
        </listitem>
221
 
      </varlistentry>
222
 
      
223
 
      <varlistentry>
224
 
        <term><option>--pubkey=<replaceable
225
 
        >FILE</replaceable></option></term>
226
 
        <term><option>-p
227
 
        <replaceable>FILE</replaceable></option></term>
228
 
        <listitem>
229
 
          <para>
230
 
            OpenPGP public key file base name.  This will be combined
231
 
            with the directory from the <option>--keydir</option>
232
 
            option to form an absolute file name.  The default name is
233
 
            <quote><literal>pubkey.txt</literal></quote>.
234
 
          </para>
235
 
        </listitem>
236
 
      </varlistentry>
237
 
 
238
 
      <varlistentry>
239
 
        <term><option>--seckey=<replaceable
240
 
        >FILE</replaceable></option></term>
241
 
        <term><option>-s
242
 
        <replaceable>FILE</replaceable></option></term>
243
 
        <listitem>
244
 
          <para>
245
 
            OpenPGP secret key file base name.  This will be combined
246
 
            with the directory from the <option>--keydir</option>
247
 
            option to form an absolute file name.  The default name is
248
 
            <quote><literal>seckey.txt</literal></quote>.
249
 
          </para>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
      
253
 
      <varlistentry>
254
 
        <term><option>--priority=<replaceable
255
 
        >STRING</replaceable></option></term>
256
 
        <listitem>
257
 
          <xi:include href="../mandos-options.xml"
258
 
                      xpointer="priority"/>
259
 
        </listitem>
260
 
      </varlistentry>
261
 
 
262
 
      <varlistentry>
263
 
        <term><option>--dh-bits=<replaceable
264
 
        >BITS</replaceable></option></term>
265
 
        <listitem>
266
 
          <para>
267
 
            Sets the number of bits to use for the prime number in the
268
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
269
 
          </para>
270
 
        </listitem>
271
 
      </varlistentry>
272
 
      
273
 
      <varlistentry>
274
 
        <term><option>--debug</option></term>
275
 
        <listitem>
276
 
          <para>
277
 
            Enable debug mode.  This will enable a lot of output to
278
 
            standard error about what the program is doing.  The
279
 
            program will still perform all other functions normally.
280
 
          </para>
281
 
          <para>
282
 
            It will also enable debug mode in the Avahi and GnuTLS
283
 
            libraries, making them print large amounts of debugging
284
 
            output.
285
 
          </para>
286
 
        </listitem>
287
 
      </varlistentry>
288
 
      
289
 
      <varlistentry>
290
 
        <term><option>--help</option></term>
291
 
        <term><option>-?</option></term>
292
 
        <listitem>
293
 
          <para>
294
 
            Gives a help message about options and their meanings.
295
 
          </para>
296
 
        </listitem>
297
 
      </varlistentry>
298
 
      
299
 
      <varlistentry>
300
 
        <term><option>--usage</option></term>
301
 
        <listitem>
302
 
          <para>
303
 
            Gives a short usage message.
304
 
          </para>
305
 
        </listitem>
306
 
      </varlistentry>
307
 
 
308
 
      <varlistentry>
309
 
        <term><option>--version</option></term>
310
 
        <term><option>-V</option></term>
311
 
        <listitem>
312
 
          <para>
313
 
            Prints the program version.
 
167
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
168
        IP</replaceable></literal></term>
 
169
        <listitem>
 
170
          <para>
 
171
            Connect directly to a specified mandos server
 
172
          </para>
 
173
        </listitem>
 
174
      </varlistentry>
 
175
 
 
176
      <varlistentry>
 
177
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
178
        KEYDIR</replaceable></literal></term>
 
179
        <listitem>
 
180
          <para>
 
181
            Directory where the openpgp keyring is
 
182
          </para>
 
183
        </listitem>
 
184
      </varlistentry>
 
185
 
 
186
      <varlistentry>
 
187
        <term><literal>-i</literal>, <literal>--interface=
 
188
        <replaceable>INTERFACE</replaceable></literal></term>
 
189
        <listitem>
 
190
          <para>
 
191
            Interface that Avahi will conntect through
 
192
          </para>
 
193
        </listitem>
 
194
      </varlistentry>
 
195
 
 
196
      <varlistentry>
 
197
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
198
        PUBKEY</replaceable></literal></term>
 
199
        <listitem>
 
200
          <para>
 
201
            Public openpgp key for gnutls authentication
 
202
          </para>
 
203
        </listitem>
 
204
      </varlistentry>
 
205
 
 
206
      <varlistentry>
 
207
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
208
        SECKEY</replaceable></literal></term>
 
209
        <listitem>
 
210
          <para>
 
211
            Secret openpgp key for gnutls authentication
 
212
          </para>
 
213
        </listitem>
 
214
      </varlistentry>
 
215
      
 
216
      <varlistentry>
 
217
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
218
        </literal></term>
 
219
        <listitem>
 
220
          <para>
 
221
            GNUTLS priority
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>
 
225
 
 
226
      <varlistentry>
 
227
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
228
        </literal></term>
 
229
        <listitem>
 
230
          <para>
 
231
            dh-bits to use in gnutls communication
 
232
          </para>
 
233
        </listitem>
 
234
      </varlistentry>
 
235
      
 
236
      <varlistentry>
 
237
        <term><literal>--debug</literal></term>
 
238
        <listitem>
 
239
          <para>
 
240
            Debug mode
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
      
 
245
      <varlistentry>
 
246
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
247
        <listitem>
 
248
          <para>
 
249
            Gives a help message
 
250
          </para>
 
251
        </listitem>
 
252
      </varlistentry>
 
253
      
 
254
      <varlistentry>
 
255
        <term><literal>--usage</literal></term>
 
256
        <listitem>
 
257
          <para>
 
258
            Gives a short usage message
 
259
          </para>
 
260
        </listitem>
 
261
      </varlistentry>
 
262
 
 
263
      <varlistentry>
 
264
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
265
        <listitem>
 
266
          <para>
 
267
            Prints the program version
314
268
          </para>
315
269
        </listitem>
316
270
      </varlistentry>
317
271
    </variablelist>
318
272
  </refsect1>
319
273
 
320
 
  <refsect1 id="overview">
321
 
    <title>OVERVIEW</title>
322
 
    <xi:include href="../overview.xml"/>
323
 
    <para>
324
 
      This program is the client part.  It is a plugin started by
325
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
326
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
327
 
      an initial <acronym>RAM</acronym> disk environment.
328
 
    </para>
329
 
    <para>
330
 
      This program could, theoretically, be used as a keyscript in
331
 
      <filename>/etc/crypttab</filename>, but it would then be
332
 
      impossible to enter the encrypted root disk password at the
333
 
      console, since this program does not read from the console at
334
 
      all.  This is why a separate plugin does that, which will be run
335
 
      in parallell to this one.
336
 
    </para>
337
 
  </refsect1>
338
 
  
339
274
  <refsect1 id="exit_status">
340
275
    <title>EXIT STATUS</title>
341
276
    <para>
342
 
      This program will exit with a successful (zero) exit status if a
343
 
      server could be found and the password received from it could be
344
 
      successfully decrypted and output on standard output.  The
345
 
      program will exit with a non-zero exit status only if a critical
346
 
      error occurs.  Otherwise, it will forever connect to new
347
 
      <application>Mandosservers</application> servers as they appear,
348
 
      trying to get a decryptable password.
349
277
    </para>
350
278
  </refsect1>
351
 
  
 
279
 
352
280
  <refsect1 id="environment">
353
281
    <title>ENVIRONMENT</title>
354
282
    <para>
355
 
      This program does not use any environment variables, not even
356
 
      the ones provided by <citerefentry><refentrytitle
357
 
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
358
 
    </citerefentry>.
359
283
    </para>
360
284
  </refsect1>
361
 
  
 
285
 
362
286
  <refsect1 id="file">
363
287
    <title>FILES</title>
364
288
    <para>
409
333
      
410
334
      <listitem><para>
411
335
        <ulink
412
 
        url="http://www.gnupg.org/related_software/gpgme/"
413
 
        >GPGME</ulink>
 
336
        url="http://www.gnupg.org/related_software/gpgme/">
 
337
        GPGME</ulink>
414
338
      </para></listitem>
415
339
      
416
340
      <listitem><para>