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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-25 03:53:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825035342-wheobopjfhf0hive
* Makefile (maintainer-clean): Also remove "confdir".
  (run-client): Also create a key.
  (run-server): Also create a local config including a client.
  (keydir/secring.gpg, keydir/pubring.gpg, keydir/seckey.txt
  keydir/pubkey.txt): New targets used by "run-client".
  (confdir/mandos.conf, confdir/clients.conf): New targets used by
                                               "run-server".

* mandos-keygen (KEYLENGTH): Changed default to "2048".

* mandos-keygen.xml (OPTIONS): Changed default value for "--length".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.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
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY COMMANDNAME "mandos">
8
6
]>
9
7
 
10
 
<refentry>
 
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
9
  <refentryinfo>
12
10
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
12
    <productname>&COMMANDNAME;</productname>
15
13
    <productnumber>&VERSION;</productnumber>
16
14
    <authorgroup>
74
72
  <refsynopsisdiv>
75
73
    <cmdsynopsis>
76
74
      <command>&COMMANDNAME;</command>
77
 
      <arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
78
 
      <arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
79
 
      <arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
80
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
81
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
82
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
83
 
      <arg choice='opt'>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg choice='opt'>-i<arg choice='plain'>IF</arg></arg>
88
 
      <arg choice='opt'>-a<arg choice='plain'>ADDRESS</arg></arg>
89
 
      <arg choice='opt'>-p<arg choice='plain'>PORT</arg></arg>
90
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
91
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
92
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
93
 
      <arg choice='opt'>--debug</arg>
94
 
    </cmdsynopsis>
95
 
    <cmdsynopsis>
96
 
      <command>&COMMANDNAME;</command>
97
 
      <arg choice='plain'>--help</arg>
98
 
    </cmdsynopsis>
99
 
    <cmdsynopsis>
100
 
      <command>&COMMANDNAME;</command>
101
 
      <arg choice='plain'>--version</arg>
102
 
    </cmdsynopsis>
103
 
    <cmdsynopsis>
104
 
      <command>&COMMANDNAME;</command>
105
 
      <arg choice='plain'>--check</arg>
106
 
    </cmdsynopsis>    
 
75
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
79
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
80
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
81
      <arg>--debug</arg>
 
82
    </cmdsynopsis>
 
83
    <cmdsynopsis>
 
84
      <command>&COMMANDNAME;</command>
 
85
      <arg>-i<arg choice="plain">IF</arg></arg>
 
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
89
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
90
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
91
      <arg>--debug</arg>
 
92
    </cmdsynopsis>
 
93
    <cmdsynopsis>
 
94
      <command>&COMMANDNAME;</command>
 
95
      <group choice="req">
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
 
98
      </group>
 
99
    </cmdsynopsis>
 
100
    <cmdsynopsis>
 
101
      <command>&COMMANDNAME;</command>
 
102
      <arg choice="plain">--version</arg>
 
103
    </cmdsynopsis>
 
104
    <cmdsynopsis>
 
105
      <command>&COMMANDNAME;</command>
 
106
      <arg choice="plain">--check</arg>
 
107
    </cmdsynopsis>
107
108
  </refsynopsisdiv>
108
109
 
109
110
  <refsect1 id="description">
112
113
      <command>&COMMANDNAME;</command> is a server daemon which
113
114
      handles incoming request for passwords for a pre-defined list of
114
115
      client host computers.  The Mandos server uses Zeroconf to
115
 
      announce itself on the local network, and uses GnuTLS to
116
 
      communicate securely with and to authenticate the clients.
117
 
      Mandos uses IPv6 link-local addresses, since the clients are
118
 
      assumed to not have any other addresses configured yet.  Any
119
 
      authenticated client is then given the pre-encrypted password
120
 
      for that specific client.
 
116
      announce itself on the local network, and uses TLS to
 
117
      communicate securely with and to authenticate the clients.  The
 
118
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
119
      link-local addresses, since the clients will probably not have
 
120
      any other addresses configured (see <xref linkend="overview"/>).
 
121
      Any authenticated client is then given the stored pre-encrypted
 
122
      password for that specific client.
121
123
    </para>
122
124
 
123
 
  </refsect1>  
 
125
  </refsect1>
124
126
  
125
127
  <refsect1 id="purpose">
126
128
    <title>PURPOSE</title>
127
129
 
128
130
    <para>
129
131
      The purpose of this is to enable <emphasis>remote and unattended
130
 
      rebooting</emphasis> of any client host computer with an
131
 
      <emphasis>encrypted root file system</emphasis>.  The client
132
 
      host computer should start a Mandos client in the initial RAM
133
 
      disk environment, the Mandos client program communicates with
134
 
      this server program to get an encrypted password, which is then
135
 
      decrypted and used to unlock the encrypted root file system.
136
 
      The client host computer can then continue its boot sequence
137
 
      normally.
 
132
      rebooting</emphasis> of client host computer with an
 
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
134
      linkend="overview"/> for details.
138
135
    </para>
139
136
 
140
 
  </refsect1>  
 
137
  </refsect1>
141
138
  
142
139
  <refsect1 id="options">
143
140
    <title>OPTIONS</title>
156
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
157
154
        IF</replaceable></literal></term>
158
155
        <listitem>
159
 
          <para>
160
 
            Only announce the server and listen to requests on network
161
 
            interface <replaceable>IF</replaceable>.  Default is to
162
 
            use all available interfaces.
163
 
          </para>
 
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
164
157
        </listitem>
165
 
      </varlistentry>      
 
158
      </varlistentry>
166
159
 
167
160
      <varlistentry>
168
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
169
162
        ADDRESS</replaceable></literal></term>
170
163
        <listitem>
171
 
          <para>
172
 
            If this option is used, the server will only listen to a
173
 
            specific address.  This must currently be an IPv6 address;
174
 
            an IPv4 address can be specified using the
175
 
            "<literal>::FFFF:192.0.2.3</literal>" syntax.  Also, if a
176
 
            link-local address is specified, an interface should be
177
 
            set, since a link-local address is only valid on a single
178
 
            interface.  By default, the server will listen to all
179
 
            available addresses.
180
 
          </para>
 
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
181
165
        </listitem>
182
 
      </varlistentry>          
 
166
      </varlistentry>
183
167
 
184
168
      <varlistentry>
185
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
170
        PORT</replaceable></literal></term>
187
171
        <listitem>
188
 
          <para>
189
 
            If this option is used, the server to bind to that
190
 
            port. By default, the server will listen to an arbitrary
191
 
            port given by the operating system.
192
 
          </para>
 
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
193
173
        </listitem>
194
 
      </varlistentry>          
 
174
      </varlistentry>
195
175
 
196
176
      <varlistentry>
197
177
        <term><literal>--check</literal></term>
198
178
        <listitem>
199
179
          <para>
200
 
            Run the server's self-tests.  This includes any unit
 
180
            Run the server’s self-tests.  This includes any unit
201
181
            tests, etc.
202
182
          </para>
203
183
        </listitem>
204
 
      </varlistentry>      
 
184
      </varlistentry>
205
185
 
206
186
      <varlistentry>
207
187
        <term><literal>--debug</literal></term>
208
188
        <listitem>
209
 
          <para>
210
 
            If the server is run in debug mode, it will run in the
211
 
            foreground and print a lot of debugging information.  The
212
 
            default is <emphasis>not</emphasis> to run in debug mode.
213
 
          </para>
 
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
190
        </listitem>
215
191
      </varlistentry>
216
192
 
218
194
        <term><literal>--priority <replaceable>
219
195
        PRIORITY</replaceable></literal></term>
220
196
        <listitem>
221
 
          <para>
222
 
            GnuTLS priority string for the TLS handshake with the
223
 
            clients.  See
224
 
            <citerefentry><refentrytitle>gnutls_priority_init
225
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
226
 
            for the syntax.  The default is
227
 
            "<literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal>".
228
 
            <emphasis>Warning</emphasis>: changing this may make the
229
 
            TLS handshake fail, making communication with clients
230
 
            impossible.
231
 
          </para>
 
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
232
198
        </listitem>
233
 
      </varlistentry>      
 
199
      </varlistentry>
234
200
 
235
201
      <varlistentry>
236
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
237
203
        </literal></term>
238
204
        <listitem>
239
 
          <para>
240
 
            Zeroconf service name.  The default is
241
 
            "<literal>Mandos</literal>".  You only need to change this
242
 
            if you for some reason want to run more than one server on
243
 
            the same <emphasis>host</emphasis>.  If there are name
244
 
            collisions on the same <emphasis>network</emphasis>, the
245
 
            new server will automatically rename itself to "Mandos
246
 
            #2", etc.
247
 
          </para>
 
205
          <xi:include href="mandos-options.xml"
 
206
                      xpointer="servicename"/>
248
207
        </listitem>
249
 
      </varlistentry>     
 
208
      </varlistentry>
250
209
 
251
210
      <varlistentry>
252
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
254
213
        <listitem>
255
214
          <para>
256
215
            Directory to search for configuration files.  Default is
257
 
            "<literal>/etc/mandos</literal>".  See <citerefentry>
258
 
            <refentrytitle>mandos.conf</refentrytitle>
 
216
            <quote><literal>/etc/mandos</literal></quote>.  See
 
217
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
259
218
            <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
260
219
            <refentrytitle>mandos-clients.conf</refentrytitle>
261
220
            <manvolnum>5</manvolnum></citerefentry>.
270
229
            Prints the program version and exit.
271
230
          </para>
272
231
        </listitem>
273
 
      </varlistentry>      
 
232
      </varlistentry>
274
233
    </variablelist>
275
234
  </refsect1>
276
235
 
 
236
  <refsect1 id="overview">
 
237
    <title>OVERVIEW</title>
 
238
    <xi:include href="overview.xml"/>
 
239
    <para>
 
240
      This program is the server part.  It is a normal server program
 
241
      and will run in a normal system environment, not in an initial
 
242
      RAM disk environment.
 
243
    </para>
 
244
  </refsect1>
 
245
 
277
246
  <refsect1 id="protocol">
278
247
    <title>NETWORK PROTOCOL</title>
279
248
    <para>
280
249
      The Mandos server announces itself as a Zeroconf service of type
281
 
      "<literal>_mandos._tcp</literal>".  The Mandos client connects
282
 
      to the announced address and port, and sends a line of text
283
 
      where the first whitespace-separated field is the protocol
284
 
      version, which currently is "<literal>1</literal>".  The client
285
 
      and server then start a TLS protocol handshake with a slight
286
 
      quirk: the Mandos server program acts as a TLS "client" while
287
 
      the connecting Mandos client acts as a TLS "server".  The Mandos
288
 
      client must supply an OpenPGP certificate, and the fingerprint
289
 
      of this certificate is used by the Mandos server to look up (in
290
 
      a list read from a file at start time) which binary blob to give
291
 
      the client.  No other authentication or authorization is done by
292
 
      the server.
 
250
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
 
251
      client connects to the announced address and port, and sends a
 
252
      line of text where the first whitespace-separated field is the
 
253
      protocol version, which currently is
 
254
      <quote><literal>1</literal></quote>.  The client and server then
 
255
      start a TLS protocol handshake with a slight quirk: the Mandos
 
256
      server program acts as a TLS <quote>client</quote> while the
 
257
      connecting Mandos client acts as a TLS <quote>server</quote>.
 
258
      The Mandos client must supply an OpenPGP certificate, and the
 
259
      fingerprint of this certificate is used by the Mandos server to
 
260
      look up (in a list read from <filename>clients.conf</filename>
 
261
      at start time) which binary blob to give the client.  No other
 
262
      authentication or authorization is done by the server.
293
263
    </para>
294
 
    <informaltable><tgroup cols="3"><thead>
 
264
    <table>
 
265
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
295
266
      <row>
296
267
        <entry>Mandos Client</entry>
297
268
        <entry>Direction</entry>
303
274
        <entry>-><!-- &rarr; --></entry>
304
275
      </row>
305
276
      <row>
306
 
        <entry>"<literal>1\r\en</literal>"</entry>
 
277
        <entry><quote><literal>1\r\n</literal></quote></entry>
307
278
        <entry>-><!-- &rarr; --></entry>
308
279
      </row>
309
280
      <row>
310
 
        <entry>TLS handshake</entry>
 
281
        <entry>TLS handshake <emphasis>as TLS <quote>server</quote>
 
282
        </emphasis></entry>
311
283
        <entry>&lt;-><!-- &xharr; --></entry>
312
 
        <entry>TLS handshake</entry>
 
284
        <entry>TLS handshake <emphasis>as TLS <quote>client</quote>
 
285
        </emphasis></entry>
313
286
      </row>
314
287
      <row>
315
288
        <entry>OpenPGP public key (part of TLS handshake)</entry>
318
291
      <row>
319
292
        <entry/>
320
293
        <entry>&lt;-<!-- &larr; --></entry>
321
 
        <entry>Binary blob</entry>
 
294
        <entry>Binary blob (client will assume OpenPGP data)</entry>
322
295
      </row>
323
296
      <row>
324
297
        <entry/>
325
298
        <entry>&lt;-<!-- &larr; --></entry>
326
299
        <entry>Close</entry>
327
300
      </row>
328
 
    </tbody></tgroup></informaltable>
 
301
    </tbody></tgroup></table>
 
302
  </refsect1>
 
303
 
 
304
  <refsect1 id="checking">
 
305
    <title>CHECKING</title>
 
306
    <para>
 
307
      The server will, by default, continually check that the clients
 
308
      are still up.  If a client has not been confirmed as being up
 
309
      for some time, the client is assumed to be compromised and is no
 
310
      longer eligible to receive the encrypted password.  The timeout,
 
311
      checker program, and interval between checks can be configured
 
312
      both globally and per client; see <citerefentry>
 
313
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
314
      <manvolnum>5</manvolnum></citerefentry>.
 
315
    </para>
329
316
  </refsect1>
330
317
 
331
318
  <refsect1 id="logging">
332
319
    <title>LOGGING</title>
333
320
    <para>
334
 
      The server will log a lot of information with various severity
335
 
      levels to
336
 
      <citerefentry><refentrytitle>syslog</refentrytitle>
337
 
      <manvolnum>8</manvolnum></citerefentry>.  With the
 
321
      The server will send log message with various severity levels to
 
322
      <filename>/dev/log</filename>.  With the
338
323
      <option>--debug</option> option, it will log even more messages,
339
324
      and also show them on the console.
340
325
    </para>
348
333
    </para>
349
334
  </refsect1>
350
335
 
 
336
  <refsect1 id="environment">
 
337
    <title>ENVIRONMENT</title>
 
338
    <variablelist>
 
339
      <varlistentry>
 
340
        <term><varname>PATH</varname></term>
 
341
        <listitem>
 
342
          <para>
 
343
            To start the configured checker (see <xref
 
344
            linkend="checking"/>), the server uses
 
345
            <filename>/bin/sh</filename>, which in turn uses
 
346
            <varname>PATH</varname> to search for matching commands if
 
347
            an absolute path is not given.  See <citerefentry>
 
348
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
349
            </citerefentry>.
 
350
          </para>
 
351
        </listitem>
 
352
      </varlistentry>
 
353
    </variablelist>
 
354
  </refsect1>
 
355
 
351
356
  <refsect1 id="file">
352
357
    <title>FILES</title>
353
358
    <para>
354
 
      <itemizedlist>
355
 
        <listitem><para>
356
 
          <filename>/etc/mandos/mandos.conf</filename>  See <citerefentry>
357
 
            <refentrytitle>mandos.conf</refentrytitle>
358
 
            <manvolnum>5</manvolnum></citerefentry>.
359
 
        </para></listitem>
360
 
        <listitem><para>
361
 
          <filename>/etc/mandos/clients.conf</filename> See <citerefentry>
 
359
      Use the <option>--configdir</option> option to change where
 
360
      <command>&COMMANDNAME;</command> looks for its configurations
 
361
      files.  The default file names are listed here.
 
362
    </para>
 
363
    <variablelist>
 
364
      <varlistentry>
 
365
        <term><filename>/etc/mandos/mandos.conf</filename></term>
 
366
        <listitem>
 
367
          <para>
 
368
            Server-global settings.  See
 
369
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
370
            <manvolnum>5</manvolnum></citerefentry> for details.
 
371
          </para>
 
372
        </listitem>
 
373
      </varlistentry>
 
374
      <varlistentry>
 
375
        <term><filename>/etc/mandos/clients.conf</filename></term>
 
376
        <listitem>
 
377
          <para>
 
378
            List of clients and client-specific settings.  See
 
379
            <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
380
            <manvolnum>5</manvolnum></citerefentry> for details.
 
381
          </para>
 
382
        </listitem>
 
383
      </varlistentry>
 
384
      <varlistentry>
 
385
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
386
        <listitem>
 
387
          <para>
 
388
            The file containing the process id of
 
389
            <command>&COMMANDNAME;</command>.
 
390
          </para>
 
391
        </listitem>
 
392
      </varlistentry>
 
393
      <varlistentry>
 
394
        <term><filename>/dev/log</filename></term>
 
395
        <listitem>
 
396
          <para>
 
397
            The Unix domain socket to where local syslog messages are
 
398
            sent.
 
399
          </para>
 
400
        </listitem>
 
401
      </varlistentry>
 
402
      <varlistentry>
 
403
        <term><filename>/bin/sh</filename></term>
 
404
        <listitem>
 
405
          <para>
 
406
            This is used to start the configured checker command for
 
407
            each client.  See <citerefentry>
362
408
            <refentrytitle>mandos-clients.conf</refentrytitle>
363
 
            <manvolnum>5</manvolnum></citerefentry>.
364
 
        </para></listitem>
365
 
        <listitem><para>
366
 
          <filename>/var/run/mandos/mandos.pid</filename>
367
 
        </para></listitem>
368
 
      </itemizedlist>
369
 
    </para>
370
 
  </refsect1>  
371
 
 
 
409
            <manvolnum>5</manvolnum></citerefentry> for details.
 
410
          </para>
 
411
        </listitem>
 
412
      </varlistentry>
 
413
    </variablelist>
 
414
  </refsect1>
 
415
  
372
416
  <refsect1 id="bugs">
373
417
    <title>BUGS</title>
374
418
    <para>
375
 
    </para>
376
 
  </refsect1>  
377
 
 
378
 
  <refsect1 id="examples">
379
 
    <title>EXAMPLES</title>
380
 
    <para>
381
 
    </para>
 
419
      This server might, on especially fatal errors, emit a Python
 
420
      backtrace.  This could be considered a feature.
 
421
    </para>
 
422
    <para>
 
423
      Currently, if a client is declared <quote>invalid</quote> due to
 
424
      having timed out, the server does not record this fact onto
 
425
      permanent storage.  This has some security implications, see
 
426
      <xref linkend="CLIENTS"/>.
 
427
    </para>
 
428
    <para>
 
429
      There is currently no way of querying the server of the current
 
430
      status of clients, other than analyzing its <systemitem
 
431
      class="service">syslog</systemitem> output.
 
432
    </para>
 
433
    <para>
 
434
      There is no fine-grained control over logging and debug output.
 
435
    </para>
 
436
    <para>
 
437
      Debug mode is conflated with running in the foreground.
 
438
    </para>
 
439
    <para>
 
440
      The console log messages does not show a timestamp.
 
441
    </para>
 
442
  </refsect1>
 
443
  
 
444
  <refsect1 id="example">
 
445
    <title>EXAMPLE</title>
 
446
    <informalexample>
 
447
      <para>
 
448
        Normal invocation needs no options:
 
449
      </para>
 
450
      <para>
 
451
        <userinput>mandos</userinput>
 
452
      </para>
 
453
    </informalexample>
 
454
    <informalexample>
 
455
      <para>
 
456
        Run the server in debug mode, read configuration files from
 
457
        the <filename>~/mandos</filename> directory, and use the
 
458
        Zeroconf service name <quote>Test</quote> to not collide with
 
459
        any other official Mandos server on this host:
 
460
      </para>
 
461
      <para>
 
462
 
 
463
<!-- do not wrap this line -->
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
465
 
 
466
      </para>
 
467
    </informalexample>
 
468
    <informalexample>
 
469
      <para>
 
470
        Run the server normally, but only listen to one interface and
 
471
        only on the link-local address on that interface:
 
472
      </para>
 
473
      <para>
 
474
 
 
475
<!-- do not wrap this line -->
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
477
 
 
478
      </para>
 
479
    </informalexample>
382
480
  </refsect1>
383
481
 
384
482
  <refsect1 id="security">
385
483
    <title>SECURITY</title>
386
 
    <para>
387
 
    </para>
 
484
    <refsect2 id="SERVER">
 
485
      <title>SERVER</title>
 
486
      <para>
 
487
        Running this <command>&COMMANDNAME;</command> server program
 
488
        should not in itself present any security risk to the host
 
489
        computer running it.  The program does not need any special
 
490
        privileges to run, and is designed to run as a non-root user.
 
491
      </para>
 
492
    </refsect2>
 
493
    <refsect2 id="CLIENTS">
 
494
      <title>CLIENTS</title>
 
495
      <para>
 
496
        The server only gives out its stored data to clients which
 
497
        does have the OpenPGP key of the stored fingerprint.  This is
 
498
        guaranteed by the fact that the client sends its OpenPGP
 
499
        public key in the TLS handshake; this ensures it to be
 
500
        genuine.  The server computes the fingerprint of the key
 
501
        itself and looks up the fingerprint in its list of
 
502
        clients. The <filename>clients.conf</filename> file (see
 
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
504
        <manvolnum>5</manvolnum></citerefentry>)
 
505
        <emphasis>must</emphasis> be made non-readable by anyone
 
506
        except the user running the server.
 
507
      </para>
 
508
      <para>
 
509
        As detailed in <xref linkend="checking"/>, the status of all
 
510
        client computers will continually be checked and be assumed
 
511
        compromised if they are gone for too long.
 
512
      </para>
 
513
      <para>
 
514
        If a client is compromised, its downtime should be duly noted
 
515
        by the server which would therefore declare the client
 
516
        invalid.  But if the server was ever restarted, it would
 
517
        re-read its client list from its configuration file and again
 
518
        regard all clients therein as valid, and hence eligible to
 
519
        receive their passwords.  Therefore, be careful when
 
520
        restarting servers if it is suspected that a client has, in
 
521
        fact, been compromised by parties who may now be running a
 
522
        fake Mandos client with the keys from the non-encrypted
 
523
        initial RAM image of the client host.  What should be done in
 
524
        that case (if restarting the server program really is
 
525
        necessary) is to stop the server program, edit the
 
526
        configuration file to omit any suspect clients, and restart
 
527
        the server program.
 
528
      </para>
 
529
      <para>
 
530
        For more details on client-side security, see
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
 
533
      </para>
 
534
    </refsect2>
388
535
  </refsect1>
389
536
 
390
537
  <refsect1 id="see_also">
391
538
    <title>SEE ALSO</title>
392
 
    <itemizedlist spacing="compact">
393
 
      <listitem><para>
394
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
395
 
        <manvolnum>8mandos</manvolnum></citerefentry>
396
 
      </para></listitem>
397
 
      
398
 
      <listitem><para>
399
 
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
400
 
        <manvolnum>8mandos</manvolnum></citerefentry>
401
 
      </para></listitem>
402
 
      
403
 
      <listitem><para>
404
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
405
 
      </para></listitem>
406
 
      
407
 
      <listitem><para>
408
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
409
 
      </para></listitem>
410
 
      
411
 
      <listitem><para>
412
 
        <ulink
413
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
414
 
      </para></listitem>
415
 
      
416
 
      <listitem><para>
417
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
418
 
        Format</citetitle></citation>
419
 
      </para></listitem>
420
 
      
421
 
      <listitem><para>
422
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
423
 
        Transport Layer Security</citetitle></citation>
424
 
      </para></listitem>
425
 
      
426
 
      <listitem><para>
427
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
428
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
429
 
        Unicast Addresses</citation>
430
 
      </para></listitem>
431
 
    </itemizedlist>
 
539
    <para>
 
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>password-request</refentrytitle>
 
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
548
      </citerefentry>
 
549
    </para>
 
550
    <variablelist>
 
551
      <varlistentry>
 
552
        <term>
 
553
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
554
        </term>
 
555
        <listitem>
 
556
          <para>
 
557
            Zeroconf is the network protocol standard used by clients
 
558
            for finding this Mandos server on the local network.
 
559
          </para>
 
560
        </listitem>
 
561
      </varlistentry>
 
562
      <varlistentry>
 
563
        <term>
 
564
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
565
        </term>
 
566
      <listitem>
 
567
        <para>
 
568
          Avahi is the library this server calls to implement
 
569
          Zeroconf service announcements.
 
570
        </para>
 
571
      </listitem>
 
572
      </varlistentry>
 
573
      <varlistentry>
 
574
        <term>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
577
        </term>
 
578
      <listitem>
 
579
        <para>
 
580
          GnuTLS is the library this server uses to implement TLS for
 
581
          communicating securely with the client, and at the same time
 
582
          confidently get the client’s public OpenPGP key.
 
583
        </para>
 
584
      </listitem>
 
585
      </varlistentry>
 
586
      <varlistentry>
 
587
        <term>
 
588
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
589
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
590
          Unicast Addresses</citation>
 
591
        </term>
 
592
        <listitem>
 
593
          <para>
 
594
            The clients use IPv6 link-local addresses, which are
 
595
            immediately usable since a link-local addresses is
 
596
            automatically assigned to a network interfaces when it is
 
597
            brought up.
 
598
          </para>
 
599
        </listitem>
 
600
      </varlistentry>
 
601
      <varlistentry>
 
602
        <term>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
 
605
        </term>
 
606
      <listitem>
 
607
        <para>
 
608
          TLS 1.1 is the protocol implemented by GnuTLS.
 
609
        </para>
 
610
      </listitem>
 
611
      </varlistentry>
 
612
      <varlistentry>
 
613
        <term>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
 
616
        </term>
 
617
      <listitem>
 
618
        <para>
 
619
          The data sent to clients is binary encrypted OpenPGP data.
 
620
        </para>
 
621
      </listitem>
 
622
      </varlistentry>
 
623
      <varlistentry>
 
624
        <term>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
 
627
        </term>
 
628
      <listitem>
 
629
        <para>
 
630
          This is implemented by GnuTLS and used by this server so
 
631
          that OpenPGP keys can be used.
 
632
        </para>
 
633
      </listitem>
 
634
      </varlistentry>
 
635
    </variablelist>
432
636
  </refsect1>
433
637
</refentry>