/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

Added configuration files support for mandos-client
Removed plus argument support for mandos-client

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
 
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2011-08-08">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY VERSION "1.0">
 
7
<!ENTITY COMMANDNAME "password-request">
8
8
]>
9
9
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
11
11
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2011</year>
37
 
      <holder>Teddy Hogeborn</holder>
38
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
39
35
    </copyright>
40
 
    <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>
41
59
  </refentryinfo>
42
 
  
 
60
 
43
61
  <refmeta>
44
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
63
    <manvolnum>8mandos</manvolnum>
48
66
  <refnamediv>
49
67
    <refname><command>&COMMANDNAME;</command></refname>
50
68
    <refpurpose>
51
 
      Client for <application>Mandos</application>
 
69
      Client for mandos
52
70
    </refpurpose>
53
71
  </refnamediv>
54
 
  
 
72
 
55
73
  <refsynopsisdiv>
56
74
    <cmdsynopsis>
57
75
      <command>&COMMANDNAME;</command>
58
 
      <group>
59
 
        <arg choice="plain"><option>--connect
60
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
61
 
        ><replaceable>PORT</replaceable></option></arg>
62
 
        <arg choice="plain"><option>-c
63
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
64
 
        ><replaceable>PORT</replaceable></option></arg>
65
 
      </group>
66
 
      <sbr/>
67
 
      <group>
68
 
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
72
 
      </group>
73
 
      <sbr/>
74
 
      <group>
75
 
        <arg choice="plain"><option>--pubkey
76
 
        <replaceable>FILE</replaceable></option></arg>
77
 
        <arg choice="plain"><option>-p
78
 
        <replaceable>FILE</replaceable></option></arg>
79
 
      </group>
80
 
      <sbr/>
81
 
      <group>
82
 
        <arg choice="plain"><option>--seckey
83
 
        <replaceable>FILE</replaceable></option></arg>
84
 
        <arg choice="plain"><option>-s
85
 
        <replaceable>FILE</replaceable></option></arg>
86
 
      </group>
87
 
      <sbr/>
88
 
      <arg>
89
 
        <option>--priority <replaceable>STRING</replaceable></option>
90
 
      </arg>
91
 
      <sbr/>
92
 
      <arg>
93
 
        <option>--dh-bits <replaceable>BITS</replaceable></option>
94
 
      </arg>
95
 
      <sbr/>
96
 
      <arg>
97
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
98
 
      </arg>
99
 
      <sbr/>
100
 
      <arg>
101
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
102
 
      </arg>
103
 
      <sbr/>
104
 
      <arg>
105
 
        <option>--debug</option>
106
 
      </arg>
107
 
    </cmdsynopsis>
108
 
    <cmdsynopsis>
109
 
      <command>&COMMANDNAME;</command>
110
 
      <group choice="req">
111
 
        <arg choice="plain"><option>--help</option></arg>
112
 
        <arg choice="plain"><option>-?</option></arg>
113
 
      </group>
114
 
    </cmdsynopsis>
115
 
    <cmdsynopsis>
116
 
      <command>&COMMANDNAME;</command>
117
 
      <arg choice="plain"><option>--usage</option></arg>
118
 
    </cmdsynopsis>
119
 
    <cmdsynopsis>
120
 
      <command>&COMMANDNAME;</command>
121
 
      <group choice="req">
122
 
        <arg choice="plain"><option>--version</option></arg>
123
 
        <arg choice="plain"><option>-V</option></arg>
124
 
      </group>
125
 
    </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>    
126
97
  </refsynopsisdiv>
127
 
  
 
98
 
128
99
  <refsect1 id="description">
129
100
    <title>DESCRIPTION</title>
130
101
    <para>
131
 
      <command>&COMMANDNAME;</command> is a client program that
132
 
      communicates with <citerefentry><refentrytitle
133
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
134
 
      to get a password.  In slightly more detail, this client program
135
 
      brings up a network interface, uses the interface’s IPv6
136
 
      link-local address to get network connectivity, uses Zeroconf to
137
 
      find servers on the local network, and communicates with servers
138
 
      using TLS with an OpenPGP key to ensure authenticity and
139
 
      confidentiality.  This client program keeps running, trying all
140
 
      servers on the network, until it receives a satisfactory reply
141
 
      or a TERM signal.  After all servers have been tried, all
142
 
      servers are periodically retried.  If no servers are found it
143
 
      will wait indefinitely for new servers to appear.
144
 
    </para>
145
 
    <para>
146
 
      This program is not meant to be run directly; it is really meant
147
 
      to run as a plugin of the <application>Mandos</application>
148
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
149
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
150
 
      initial <acronym>RAM</acronym> disk environment because it is
151
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
152
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
153
 
      </citerefentry> file.
154
 
    </para>
155
 
  </refsect1>
156
 
  
157
 
  <refsect1 id="purpose">
158
 
    <title>PURPOSE</title>
159
 
    <para>
160
 
      The purpose of this is to enable <emphasis>remote and unattended
161
 
      rebooting</emphasis> of client host computer with an
162
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
163
 
      linkend="overview"/> for details.
164
 
    </para>
165
 
  </refsect1>
166
 
  
167
 
  <refsect1 id="options">
168
 
    <title>OPTIONS</title>
169
 
    <para>
170
 
      This program is commonly not invoked from the command line; it
171
 
      is normally started by the <application>Mandos</application>
172
 
      plugin runner, see <citerefentry><refentrytitle
173
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
174
 
      </citerefentry>.  Any command line options this program accepts
175
 
      are therefore normally provided by the plugin runner, and not
176
 
      directly.
177
 
    </para>
178
 
    
179
 
    <variablelist>
180
 
      <varlistentry>
181
 
        <term><option>--connect=<replaceable
182
 
        >ADDRESS</replaceable><literal>:</literal><replaceable
183
 
        >PORT</replaceable></option></term>
184
 
        <term><option>-c
185
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
186
 
        ><replaceable>PORT</replaceable></option></term>
187
 
        <listitem>
188
 
          <para>
189
 
            Do not use Zeroconf to locate servers.  Connect directly
190
 
            to only one specified <application>Mandos</application>
191
 
            server.  Note that an IPv6 address has colon characters in
192
 
            it, so the <emphasis>last</emphasis> colon character is
193
 
            assumed to separate the address from the port number.
194
 
          </para>
195
 
          <para>
196
 
            This option is normally only useful for testing and
197
 
            debugging.
198
 
          </para>
199
 
        </listitem>
200
 
      </varlistentry>
201
 
      
202
 
      <varlistentry>
203
 
        <term><option>--interface=<replaceable
204
 
        >NAME</replaceable></option></term>
205
 
        <term><option>-i
206
 
        <replaceable>NAME</replaceable></option></term>
207
 
        <listitem>
208
 
          <para>
209
 
            Network interface that will be brought up and scanned for
210
 
            Mandos servers to connect to.  The default is the empty
211
 
            string, which will automatically choose an appropriate
212
 
            interface.
213
 
          </para>
214
 
          <para>
215
 
            If the <option>--connect</option> option is used, this
216
 
            specifies the interface to use to connect to the address
217
 
            given.
218
 
          </para>
219
 
          <para>
220
 
            Note that since this program will normally run in the
221
 
            initial RAM disk environment, the interface must be an
222
 
            interface which exists at that stage.  Thus, the interface
223
 
            can not be a pseudo-interface such as <quote>br0</quote>
224
 
            or <quote>tun0</quote>; such interfaces will not exist
225
 
            until much later in the boot process, and can not be used
226
 
            by this program.
227
 
          </para>
228
 
          <para>
229
 
            <replaceable>NAME</replaceable> can be the string
230
 
            <quote><literal>none</literal></quote>; this will not use
231
 
            any specific interface, and will not bring up an interface
232
 
            on startup.  This is not recommended, and only meant for
233
 
            advanced users.
234
 
          </para>
235
 
        </listitem>
236
 
      </varlistentry>
237
 
      
238
 
      <varlistentry>
239
 
        <term><option>--pubkey=<replaceable
240
 
        >FILE</replaceable></option></term>
241
 
        <term><option>-p
242
 
        <replaceable>FILE</replaceable></option></term>
243
 
        <listitem>
244
 
          <para>
245
 
            OpenPGP public key file name.  The default name is
246
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
247
 
            ></quote>.
248
 
          </para>
249
 
        </listitem>
250
 
      </varlistentry>
251
 
      
252
 
      <varlistentry>
253
 
        <term><option>--seckey=<replaceable
254
 
        >FILE</replaceable></option></term>
255
 
        <term><option>-s
256
 
        <replaceable>FILE</replaceable></option></term>
257
 
        <listitem>
258
 
          <para>
259
 
            OpenPGP secret key file name.  The default name is
260
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
261
 
            ></quote>.
262
 
          </para>
263
 
        </listitem>
264
 
      </varlistentry>
265
 
      
266
 
      <varlistentry>
267
 
        <term><option>--priority=<replaceable
268
 
        >STRING</replaceable></option></term>
269
 
        <listitem>
270
 
          <xi:include href="../mandos-options.xml"
271
 
                      xpointer="priority"/>
272
 
        </listitem>
273
 
      </varlistentry>
274
 
      
275
 
      <varlistentry>
276
 
        <term><option>--dh-bits=<replaceable
277
 
        >BITS</replaceable></option></term>
278
 
        <listitem>
279
 
          <para>
280
 
            Sets the number of bits to use for the prime number in the
281
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
282
 
          </para>
283
 
        </listitem>
284
 
      </varlistentry>
285
 
 
286
 
      <varlistentry>
287
 
        <term><option>--delay=<replaceable
288
 
        >SECONDS</replaceable></option></term>
289
 
        <listitem>
290
 
          <para>
291
 
            After bringing the network interface up, the program waits
292
 
            for the interface to arrive in a <quote>running</quote>
293
 
            state before proceeding.  During this time, the kernel log
294
 
            level will be lowered to reduce clutter on the system
295
 
            console, alleviating any other plugins which might be
296
 
            using the system console.  This option sets the upper
297
 
            limit of seconds to wait.  The default is 2.5 seconds.
298
 
          </para>
299
 
        </listitem>
300
 
      </varlistentry>
301
 
 
302
 
      <varlistentry>
303
 
        <term><option>--retry=<replaceable
304
 
        >SECONDS</replaceable></option></term>
305
 
        <listitem>
306
 
          <para>
307
 
            All Mandos servers are tried repeatedly until a password
308
 
            is received.  This value specifies, in seconds, how long
309
 
            between each successive try <emphasis>for the same
310
 
            server</emphasis>.  The default is 10 seconds.
311
 
          </para>
312
 
        </listitem>
313
 
      </varlistentry>
314
 
      
315
 
      <varlistentry>
316
 
        <term><option>--debug</option></term>
317
 
        <listitem>
318
 
          <para>
319
 
            Enable debug mode.  This will enable a lot of output to
320
 
            standard error about what the program is doing.  The
321
 
            program will still perform all other functions normally.
322
 
          </para>
323
 
          <para>
324
 
            It will also enable debug mode in the Avahi and GnuTLS
325
 
            libraries, making them print large amounts of debugging
326
 
            output.
327
 
          </para>
328
 
        </listitem>
329
 
      </varlistentry>
330
 
      
331
 
      <varlistentry>
332
 
        <term><option>--help</option></term>
333
 
        <term><option>-?</option></term>
334
 
        <listitem>
335
 
          <para>
336
 
            Gives a help message about options and their meanings.
337
 
          </para>
338
 
        </listitem>
339
 
      </varlistentry>
340
 
      
341
 
      <varlistentry>
342
 
        <term><option>--usage</option></term>
343
 
        <listitem>
344
 
          <para>
345
 
            Gives a short usage message.
346
 
          </para>
347
 
        </listitem>
348
 
      </varlistentry>
349
 
      
350
 
      <varlistentry>
351
 
        <term><option>--version</option></term>
352
 
        <term><option>-V</option></term>
353
 
        <listitem>
354
 
          <para>
355
 
            Prints the program version.
356
 
          </para>
357
 
        </listitem>
358
 
      </varlistentry>
359
 
    </variablelist>
360
 
  </refsect1>
361
 
  
362
 
  <refsect1 id="overview">
363
 
    <title>OVERVIEW</title>
364
 
    <xi:include href="../overview.xml"/>
365
 
    <para>
366
 
      This program is the client part.  It is a plugin started by
367
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
368
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
369
 
      an initial <acronym>RAM</acronym> disk environment.
370
 
    </para>
371
 
    <para>
372
 
      This program could, theoretically, be used as a keyscript in
373
 
      <filename>/etc/crypttab</filename>, but it would then be
374
 
      impossible to enter a password for the encrypted root disk at
375
 
      the console, since this program does not read from the console
376
 
      at all.  This is why a separate plugin runner (<citerefentry>
377
 
      <refentrytitle>plugin-runner</refentrytitle>
378
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
379
 
      both this program and others in in parallel,
380
 
      <emphasis>one</emphasis> of which will prompt for passwords on
381
 
      the system console.
382
 
    </para>
383
 
  </refsect1>
384
 
  
385
 
  <refsect1 id="exit_status">
386
 
    <title>EXIT STATUS</title>
387
 
    <para>
388
 
      This program will exit with a successful (zero) exit status if a
389
 
      server could be found and the password received from it could be
390
 
      successfully decrypted and output on standard output.  The
391
 
      program will exit with a non-zero exit status only if a critical
392
 
      error occurs.  Otherwise, it will forever connect to any
393
 
      discovered <application>Mandos</application> servers, trying to
394
 
      get a decryptable password and print it.
395
 
    </para>
396
 
  </refsect1>
397
 
  
398
 
  <refsect1 id="environment">
399
 
    <title>ENVIRONMENT</title>
400
 
    <para>
401
 
      This program does not use any environment variables, not even
402
 
      the ones provided by <citerefentry><refentrytitle
403
 
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
404
 
    </citerefentry>.
405
 
    </para>
406
 
  </refsect1>
407
 
  
408
 
  <refsect1 id="files">
409
 
    <title>FILES</title>
410
 
    <variablelist>
411
 
      <varlistentry>
412
 
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
413
 
        ></term>
414
 
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
415
 
        ></term>
416
 
        <listitem>
417
 
          <para>
418
 
            OpenPGP public and private key files, in <quote>ASCII
419
 
            Armor</quote> format.  These are the default file names,
420
 
            they can be changed with the <option>--pubkey</option> and
421
 
            <option>--seckey</option> options.
422
 
          </para>
423
 
        </listitem>
424
 
      </varlistentry>
425
 
    </variablelist>
426
 
  </refsect1>
427
 
  
428
 
<!--   <refsect1 id="bugs"> -->
429
 
<!--     <title>BUGS</title> -->
430
 
<!--     <para> -->
431
 
<!--     </para> -->
432
 
<!--   </refsect1> -->
433
 
  
434
 
  <refsect1 id="example">
435
 
    <title>EXAMPLE</title>
436
 
    <para>
437
 
      Note that normally, command line options will not be given
438
 
      directly, but via options for the Mandos <citerefentry
439
 
      ><refentrytitle>plugin-runner</refentrytitle>
440
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
441
 
    </para>
442
 
    <informalexample>
443
 
      <para>
444
 
        Normal invocation needs no options, if the network interface
445
 
        is <quote>eth0</quote>:
446
 
      </para>
447
 
      <para>
448
 
        <userinput>&COMMANDNAME;</userinput>
449
 
      </para>
450
 
    </informalexample>
451
 
    <informalexample>
452
 
      <para>
453
 
        Search for Mandos servers (and connect to them) using another
454
 
        interface:
455
 
      </para>
456
 
      <para>
457
 
        <!-- do not wrap this line -->
458
 
        <userinput>&COMMANDNAME; --interface eth1</userinput>
459
 
      </para>
460
 
    </informalexample>
461
 
    <informalexample>
462
 
      <para>
463
 
        Run in debug mode, and use a custom key:
464
 
      </para>
465
 
      <para>
466
 
 
467
 
<!-- do not wrap this line -->
468
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
469
 
 
470
 
      </para>
471
 
    </informalexample>
472
 
    <informalexample>
473
 
      <para>
474
 
        Run in debug mode, with a custom key, and do not use Zeroconf
475
 
        to locate a server; connect directly to the IPv6 link-local
476
 
        address <quote><systemitem class="ipaddress"
477
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
478
 
        using interface eth2:
479
 
      </para>
480
 
      <para>
481
 
 
482
 
<!-- do not wrap this line -->
483
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
484
 
 
485
 
      </para>
486
 
    </informalexample>
487
 
  </refsect1>
488
 
  
489
 
  <refsect1 id="security">
490
 
    <title>SECURITY</title>
491
 
    <para>
492
 
      This program is set-uid to root, but will switch back to the
493
 
      original (and presumably non-privileged) user and group after
494
 
      bringing up the network interface.
495
 
    </para>
496
 
    <para>
497
 
      To use this program for its intended purpose (see <xref
498
 
      linkend="purpose"/>), the password for the root file system will
499
 
      have to be given out to be stored in a server computer, after
500
 
      having been encrypted using an OpenPGP key.  This encrypted data
501
 
      which will be stored in a server can only be decrypted by the
502
 
      OpenPGP key, and the data will only be given out to those
503
 
      clients who can prove they actually have that key.  This key,
504
 
      however, is stored unencrypted on the client side in its initial
505
 
      <acronym>RAM</acronym> disk image file system.  This is normally
506
 
      readable by all, but this is normally fixed during installation
507
 
      of this program; file permissions are set so that no-one is able
508
 
      to read that file.
509
 
    </para>
510
 
    <para>
511
 
      The only remaining weak point is that someone with physical
512
 
      access to the client hard drive might turn off the client
513
 
      computer, read the OpenPGP keys directly from the hard drive,
514
 
      and communicate with the server.  To safeguard against this, the
515
 
      server is supposed to notice the client disappearing and stop
516
 
      giving out the encrypted data.  Therefore, it is important to
517
 
      set the timeout and checker interval values tightly on the
518
 
      server.  See <citerefentry><refentrytitle
519
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
520
 
    </para>
521
 
    <para>
522
 
      It will also help if the checker program on the server is
523
 
      configured to request something from the client which can not be
524
 
      spoofed by someone else on the network, unlike unencrypted
525
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
526
 
    </para>
527
 
    <para>
528
 
      <emphasis>Note</emphasis>: This makes it completely insecure to
529
 
      have <application >Mandos</application> clients which dual-boot
530
 
      to another operating system which is <emphasis>not</emphasis>
531
 
      trusted to keep the initial <acronym>RAM</acronym> disk image
532
 
      confidential.
533
 
    </para>
534
 
  </refsect1>
535
 
  
536
 
  <refsect1 id="see_also">
537
 
    <title>SEE ALSO</title>
538
 
    <para>
539
 
      <citerefentry><refentrytitle>intro</refentrytitle>
540
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
541
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
542
 
      <manvolnum>8</manvolnum></citerefentry>,
543
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
544
 
      <manvolnum>5</manvolnum></citerefentry>,
545
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
546
 
      <manvolnum>8</manvolnum></citerefentry>,
547
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
548
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
549
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
550
 
      <manvolnum>8mandos</manvolnum></citerefentry>
551
 
    </para>
552
 
    <variablelist>
553
 
      <varlistentry>
554
 
        <term>
555
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
556
 
        </term>
557
 
        <listitem>
558
 
          <para>
559
 
            Zeroconf is the network protocol standard used for finding
560
 
            Mandos servers on the local network.
561
 
          </para>
562
 
        </listitem>
563
 
      </varlistentry>
564
 
      <varlistentry>
565
 
        <term>
566
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
567
 
        </term>
568
 
      <listitem>
569
 
        <para>
570
 
          Avahi is the library this program calls to find Zeroconf
571
 
          services.
572
 
        </para>
573
 
      </listitem>
574
 
      </varlistentry>
575
 
      <varlistentry>
576
 
        <term>
577
 
          <ulink url="http://www.gnu.org/software/gnutls/"
578
 
          >GnuTLS</ulink>
579
 
        </term>
580
 
      <listitem>
581
 
        <para>
582
 
          GnuTLS is the library this client uses to implement TLS for
583
 
          communicating securely with the server, and at the same time
584
 
          send the public OpenPGP key to the server.
585
 
        </para>
586
 
      </listitem>
587
 
      </varlistentry>
588
 
      <varlistentry>
589
 
        <term>
590
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
591
 
                 >GPGME</ulink>
592
 
        </term>
593
 
        <listitem>
594
 
          <para>
595
 
            GPGME is the library used to decrypt the OpenPGP data sent
596
 
            by the server.
597
 
          </para>
598
 
        </listitem>
599
 
      </varlistentry>
600
 
      <varlistentry>
601
 
        <term>
602
 
          RFC 4291: <citetitle>IP Version 6 Addressing
603
 
          Architecture</citetitle>
604
 
        </term>
605
 
        <listitem>
606
 
          <variablelist>
607
 
            <varlistentry>
608
 
              <term>Section 2.2: <citetitle>Text Representation of
609
 
              Addresses</citetitle></term>
610
 
              <listitem><para/></listitem>
611
 
            </varlistentry>
612
 
            <varlistentry>
613
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
614
 
              Address</citetitle></term>
615
 
              <listitem><para/></listitem>
616
 
            </varlistentry>
617
 
            <varlistentry>
618
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
619
 
            Addresses</citetitle></term>
620
 
            <listitem>
621
 
              <para>
622
 
                This client uses IPv6 link-local addresses, which are
623
 
                immediately usable since a link-local addresses is
624
 
                automatically assigned to a network interfaces when it
625
 
                is brought up.
626
 
              </para>
627
 
            </listitem>
628
 
            </varlistentry>
629
 
          </variablelist>
630
 
        </listitem>
631
 
      </varlistentry>
632
 
      <varlistentry>
633
 
        <term>
634
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
635
 
          Protocol Version 1.1</citetitle>
636
 
        </term>
637
 
      <listitem>
638
 
        <para>
639
 
          TLS 1.1 is the protocol implemented by GnuTLS.
640
 
        </para>
641
 
      </listitem>
642
 
      </varlistentry>
643
 
      <varlistentry>
644
 
        <term>
645
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
646
 
        </term>
647
 
      <listitem>
648
 
        <para>
649
 
          The data received from the server is binary encrypted
650
 
          OpenPGP data.
651
 
        </para>
652
 
      </listitem>
653
 
      </varlistentry>
654
 
      <varlistentry>
655
 
        <term>
656
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
657
 
          Security</citetitle>
658
 
        </term>
659
 
      <listitem>
660
 
        <para>
661
 
          This is implemented by GnuTLS and used by this program so
662
 
          that OpenPGP keys can be used.
663
 
        </para>
664
 
      </listitem>
665
 
      </varlistentry>
 
102
      <command>&COMMANDNAME;</command> is a mandos plugin that works
 
103
      like a client program that through avahi detects mandos servers,
 
104
      sets up a gnutls connect and request a encrypted password. Any
 
105
      passwords given is automaticly decrypted and passed to
 
106
      cryptsetup.
 
107
    </para>
 
108
 
 
109
    <variablelist>
 
110
      <varlistentry>
 
111
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
112
        IP</replaceable></literal></term>
 
113
        <listitem>
 
114
          <para>
 
115
            Connect directly to a sepcified mandos server
 
116
          </para>
 
117
        </listitem>
 
118
      </varlistentry>
 
119
 
 
120
      <varlistentry>
 
121
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
122
        KEYDIR</replaceable></literal></term>
 
123
        <listitem>
 
124
          <para>
 
125
            Directory where the openpgp keyring is
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>      
 
129
 
 
130
      <varlistentry>
 
131
        <term><literal>-i</literal>, <literal>--interface=
 
132
        <replaceable>INTERFACE</replaceable></literal></term>
 
133
        <listitem>
 
134
          <para>
 
135
            Interface that Avahi will conntect through
 
136
          </para>
 
137
        </listitem>
 
138
      </varlistentry>      
 
139
 
 
140
      <varlistentry>
 
141
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
142
        PUBKEY</replaceable></literal></term>
 
143
        <listitem>
 
144
          <para>
 
145
            Public openpgp key for gnutls authentication
 
146
          </para>
 
147
        </listitem>
 
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>
 
182
        <listitem>
 
183
          <para>
 
184
            Debug mode
 
185
          </para>
 
186
        </listitem>
 
187
      </varlistentry>
 
188
      
 
189
      <varlistentry>
 
190
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
191
        <listitem>
 
192
          <para>
 
193
            Gives a help message
 
194
          </para>
 
195
        </listitem>
 
196
      </varlistentry>
 
197
      
 
198
      <varlistentry>
 
199
        <term><literal>--usage</literal></term>
 
200
        <listitem>
 
201
          <para>
 
202
            Gives a short usage message
 
203
          </para>
 
204
        </listitem>
 
205
      </varlistentry>
 
206
 
 
207
      <varlistentry>
 
208
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
209
        <listitem>
 
210
          <para>
 
211
            Prints the program version
 
212
          </para>
 
213
        </listitem>
 
214
      </varlistentry>            
666
215
    </variablelist>
667
216
  </refsect1>
668
217
</refentry>
669
 
 
670
 
<!-- Local Variables: -->
671
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
672
 
<!-- time-stamp-end: "[\"']>" -->
673
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
674
 
<!-- End: -->