/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugins.d/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

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 "2009-02-09">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY VERSION "1.0">
 
7
<!ENTITY COMMANDNAME "password-request">
 
8
<!ENTITY TIMESTAMP "2008-08-29">
8
9
]>
9
10
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
11
12
  <refentryinfo>
12
13
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
16
    <productnumber>&VERSION;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <holder>Teddy Hogeborn</holder>
37
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
38
37
    </copyright>
39
 
    <xi:include href="../legalnotice.xml"/>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
40
61
  </refentryinfo>
41
 
  
 
62
 
42
63
  <refmeta>
43
64
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
65
    <manvolnum>8mandos</manvolnum>
47
68
  <refnamediv>
48
69
    <refname><command>&COMMANDNAME;</command></refname>
49
70
    <refpurpose>
50
 
      Client for <application>Mandos</application>
 
71
      Client for mandos
51
72
    </refpurpose>
52
73
  </refnamediv>
53
 
  
 
74
 
54
75
  <refsynopsisdiv>
55
76
    <cmdsynopsis>
56
77
      <command>&COMMANDNAME;</command>
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>
 
78
      <arg choice='opt'>--connect<arg choice='plain'>IP</arg></arg>
 
79
      <arg choice='opt'>--keydir<arg choice='plain'>KEYDIR</arg></arg>
 
80
      <arg choice='opt'>--interface<arg choice='plain'>INTERFACE</arg></arg>
 
81
      <arg choice='opt'>--pubkey<arg choice='plain'>PUBKEY</arg></arg>
 
82
      <arg choice='opt'>--seckey<arg choice='plain'>SECKEY</arg></arg>
 
83
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
84
      <arg choice='opt'>--dh-bits<arg choice='plain'>BITS</arg></arg>      
 
85
      <arg choice='opt'>--debug</arg>
 
86
    </cmdsynopsis>
 
87
    <cmdsynopsis>
 
88
      <command>&COMMANDNAME;</command>
 
89
      <arg choice='plain'>--help</arg>
 
90
    </cmdsynopsis>
 
91
    <cmdsynopsis>
 
92
      <command>&COMMANDNAME;</command>
 
93
      <arg choice='plain'>--usage</arg>
 
94
    </cmdsynopsis>
 
95
    <cmdsynopsis>
 
96
      <command>&COMMANDNAME;</command>
 
97
      <arg choice='plain'>--version</arg>
 
98
    </cmdsynopsis>    
121
99
  </refsynopsisdiv>
122
 
  
 
100
 
123
101
  <refsect1 id="description">
124
102
    <title>DESCRIPTION</title>
125
103
    <para>
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>
 
104
      <command>&COMMANDNAME;</command> is a mandos plugin that works
 
105
      like a client program that through avahi detects mandos servers,
 
106
      sets up a gnutls connect and request a encrypted password. Any
 
107
      passwords given is automaticly decrypted and passed to
 
108
      cryptsetup.
 
109
    </para>
 
110
  </refsect1>  
161
111
  
162
112
  <refsect1 id="options">
163
113
    <title>OPTIONS</title>
164
114
    <para>
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
      Commonly not invoked as command lines but from configuration
 
116
      file of plugin runner.
172
117
    </para>
173
 
    
 
118
 
174
119
    <variablelist>
175
120
      <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=<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.
336
 
          </para>
337
 
        </listitem>
338
 
      </varlistentry>
 
121
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
122
        IP</replaceable></literal></term>
 
123
        <listitem>
 
124
          <para>
 
125
            Connect directly to a specified mandos server
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>
 
129
 
 
130
      <varlistentry>
 
131
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
132
        KEYDIR</replaceable></literal></term>
 
133
        <listitem>
 
134
          <para>
 
135
            Directory where the openpgp keyring is
 
136
          </para>
 
137
        </listitem>
 
138
      </varlistentry>      
 
139
 
 
140
      <varlistentry>
 
141
        <term><literal>-i</literal>, <literal>--interface=
 
142
        <replaceable>INTERFACE</replaceable></literal></term>
 
143
        <listitem>
 
144
          <para>
 
145
            Interface that Avahi will conntect through
 
146
          </para>
 
147
        </listitem>
 
148
      </varlistentry>      
 
149
 
 
150
      <varlistentry>
 
151
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
152
        PUBKEY</replaceable></literal></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Public openpgp key for gnutls authentication
 
156
          </para>
 
157
        </listitem>
 
158
      </varlistentry>      
 
159
 
 
160
      <varlistentry>
 
161
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
162
        SECKEY</replaceable></literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            Secret openpgp key for gnutls authentication
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>            
 
169
      
 
170
      <varlistentry>
 
171
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
172
        </literal></term>
 
173
        <listitem>
 
174
          <para>
 
175
            GNUTLS priority
 
176
          </para>
 
177
        </listitem>
 
178
      </varlistentry>            
 
179
 
 
180
      <varlistentry>
 
181
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
182
        </literal></term>
 
183
        <listitem>
 
184
          <para>
 
185
            dh-bits to use in gnutls communication
 
186
          </para>
 
187
        </listitem>
 
188
      </varlistentry>      
 
189
      
 
190
      <varlistentry>
 
191
        <term><literal>--debug</literal></term>
 
192
        <listitem>
 
193
          <para>
 
194
            Debug mode
 
195
          </para>
 
196
        </listitem>
 
197
      </varlistentry>
 
198
      
 
199
      <varlistentry>
 
200
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
201
        <listitem>
 
202
          <para>
 
203
            Gives a help message
 
204
          </para>
 
205
        </listitem>
 
206
      </varlistentry>
 
207
      
 
208
      <varlistentry>
 
209
        <term><literal>--usage</literal></term>
 
210
        <listitem>
 
211
          <para>
 
212
            Gives a short usage message
 
213
          </para>
 
214
        </listitem>
 
215
      </varlistentry>
 
216
 
 
217
      <varlistentry>
 
218
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
219
        <listitem>
 
220
          <para>
 
221
            Prints the program version
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>            
339
225
    </variablelist>
340
226
  </refsect1>
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
 
  
 
227
 
365
228
  <refsect1 id="exit_status">
366
229
    <title>EXIT STATUS</title>
367
230
    <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.
375
231
    </para>
376
232
  </refsect1>
377
 
  
 
233
 
378
234
  <refsect1 id="environment">
379
235
    <title>ENVIRONMENT</title>
380
236
    <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>.
385
237
    </para>
386
 
  </refsect1>
387
 
  
388
 
  <refsect1 id="files">
 
238
  </refsect1>  
 
239
 
 
240
  <refsect1 id="file">
389
241
    <title>FILES</title>
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
 
  
 
242
    <para>
 
243
    </para>
 
244
  </refsect1>  
 
245
  
 
246
  <refsect1 id="bugs">
 
247
    <title>BUGS</title>
 
248
    <para>
 
249
    </para>
 
250
  </refsect1>  
 
251
 
414
252
  <refsect1 id="example">
415
253
    <title>EXAMPLE</title>
416
254
    <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>.
421
255
    </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>
467
256
  </refsect1>
468
 
  
 
257
 
469
258
  <refsect1 id="security">
470
259
    <title>SECURITY</title>
471
260
    <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.
513
261
    </para>
514
262
  </refsect1>
515
 
  
 
263
 
516
264
  <refsect1 id="see_also">
517
265
    <title>SEE ALSO</title>
518
 
    <para>
519
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
520
 
      <manvolnum>8</manvolnum></citerefentry>,
521
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
522
 
      <manvolnum>5</manvolnum></citerefentry>,
523
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
524
 
      <manvolnum>8</manvolnum></citerefentry>,
525
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
526
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
527
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
528
 
      <manvolnum>8mandos</manvolnum></citerefentry>
529
 
    </para>
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>
 
266
    <itemizedlist>
 
267
      <listitem><para>
 
268
        <citerefentry><refentrytitle>mandos</refentrytitle>
 
269
        <manvolnum>8</manvolnum></citerefentry>
 
270
      </para></listitem>
 
271
      
 
272
      <listitem><para>
 
273
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
274
        <manvolnum>8mandos</manvolnum></citerefentry>
 
275
      </para></listitem>
 
276
      
 
277
      <listitem><para>
 
278
        <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
279
        <manvolnum>8mandos</manvolnum></citerefentry>
 
280
      </para></listitem>
 
281
      
 
282
      <listitem><para>
 
283
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
284
      </para></listitem>
 
285
      
 
286
      <listitem><para>
 
287
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
288
      </para></listitem>
 
289
      
 
290
      <listitem><para>
 
291
        <ulink
 
292
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
293
      </para></listitem>
 
294
      
 
295
      <listitem><para>
 
296
        <ulink
 
297
        url="http://www.gnupg.org/related_software/gpgme/">
 
298
        GPGME</ulink>
 
299
      </para></listitem>
 
300
      
 
301
      <listitem><para>
 
302
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
303
        Format</citetitle></citation>
 
304
      </para></listitem>
 
305
      
 
306
      <listitem><para>
 
307
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
308
        Transport Layer Security</citetitle></citation>
 
309
      </para></listitem>
 
310
      
 
311
      <listitem><para>
 
312
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
313
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
314
        Unicast Addresses</citation>
 
315
      </para></listitem>
 
316
    </itemizedlist>
645
317
  </refsect1>
 
318
 
646
319
</refentry>
647
 
 
648
320
<!-- Local Variables: -->
649
321
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
650
322
<!-- time-stamp-end: "[\"']>" -->