/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-16 20:32:58 UTC
  • mfrom: (24.1.55 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080816203258-eq4by31vdgxkhs9g
* mandos-keygen.xml: New man page for mandos-keygen(8).

Show diffs side-by-side

added added

removed removed

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