/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-17 06:17:10 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817061710-epkw87paysoo9g7w
* mandos-keygen.xml (NOTES): Removed section, since it is
                             automatically created for footnotes.

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