/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: 2011-08-08 21:12:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110808211237-jejsz5brjytrjot8
* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

Show diffs side-by-side

added added

removed removed

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