/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/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2009-02-05 02:33:05 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090205023305-o7rkhr55e7w4pe1m
* plugins.d/password-prompt.c (quit_now): Changed type to "volatile
                             sig_atomic_t".  All uses changed.

Show diffs side-by-side

added added

removed removed

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