/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-30 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.

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