/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-04-03 03:36:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090403033608-ftgzsnnuzo7gbvzc
* mandos (peer_certificate, fingerprint): Moved into "TCP_handler"
                                          class.
  (TCP_handler.peer_certificate, TCP_handler.fingerprint): Moved here.
  (TCP_handler.handle): Do not log conditions also sent via IPC.
  (IPv6_TCPServer.handle_ipc): Bug fix: Remove extra newline from IPC
                               command log message.  Bug fix:  Strip
                               CR and NL from IPC line.  Log
                               conditions recieved via IPC.  Log error
                               if IPC recieved about unknown client.

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