/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2009-03-15 04:22:14 UTC
  • mfrom: (237.2.89 mandos)
  • mto: (237.2.90 mandos)
  • mto: This revision was merged to the branch mainline in revision 264.
  • Revision ID: teddy@fukt.bsnet.se-20090315042214-gvps0knkvuyewtxl
Merge from trunk.

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