/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

* mandos-ctl: Also show "LastApprovalRequest" property.

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 "2010-09-25">
 
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.  (Manual
 
331
      intervention is required to re-enable a client.)  The timeout,
 
332
      checker program, and interval between checks can be configured
 
333
      both globally and per client; see <citerefentry>
 
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
 
338
    </para>
 
339
  </refsect1>
 
340
  
 
341
  <refsect1 id="approval">
 
342
    <title>APPROVAL</title>
 
343
    <para>
 
344
      The server can be configured to require manual approval for a
 
345
      client before it is sent its secret.  The delay to wait for such
 
346
      approval and the default action (approve or deny) can be
 
347
      configured both globally and per client; see <citerefentry>
 
348
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
349
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
350
      will be approved immediately without delay.
 
351
    </para>
 
352
    <para>
 
353
      This can be used to deny a client its secret if not manually
 
354
      approved within a specified time.  It can also be used to make
 
355
      the server delay before giving a client its secret, allowing
 
356
      optional manual denying of this specific client.
 
357
    </para>
 
358
    
 
359
  </refsect1>
 
360
  
 
361
  <refsect1 id="logging">
 
362
    <title>LOGGING</title>
 
363
    <para>
 
364
      The server will send log message with various severity levels to
 
365
      <filename>/dev/log</filename>.  With the
 
366
      <option>--debug</option> option, it will log even more messages,
 
367
      and also show them on the console.
 
368
    </para>
 
369
  </refsect1>
 
370
  
 
371
  <refsect1 id="dbus_interface">
 
372
    <title>D-BUS INTERFACE</title>
 
373
    <para>
 
374
      The server will by default provide a D-Bus system bus interface.
 
375
      This interface will only be accessible by the root user or a
 
376
      Mandos-specific user, if such a user exists.  For documentation
 
377
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
378
    </para>
 
379
  </refsect1>
 
380
  
 
381
  <refsect1 id="exit_status">
 
382
    <title>EXIT STATUS</title>
 
383
    <para>
 
384
      The server will exit with a non-zero exit status only when a
 
385
      critical error is encountered.
 
386
    </para>
 
387
  </refsect1>
 
388
  
 
389
  <refsect1 id="environment">
 
390
    <title>ENVIRONMENT</title>
 
391
    <variablelist>
 
392
      <varlistentry>
 
393
        <term><envar>PATH</envar></term>
 
394
        <listitem>
 
395
          <para>
 
396
            To start the configured checker (see <xref
 
397
            linkend="checking"/>), the server uses
 
398
            <filename>/bin/sh</filename>, which in turn uses
 
399
            <varname>PATH</varname> to search for matching commands if
 
400
            an absolute path is not given.  See <citerefentry>
 
401
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
402
            </citerefentry>.
 
403
          </para>
 
404
        </listitem>
 
405
      </varlistentry>
 
406
    </variablelist>
 
407
  </refsect1>
 
408
  
 
409
  <refsect1 id="files">
 
410
    <title>FILES</title>
 
411
    <para>
 
412
      Use the <option>--configdir</option> option to change where
 
413
      <command>&COMMANDNAME;</command> looks for its configurations
 
414
      files.  The default file names are listed here.
 
415
    </para>
 
416
    <variablelist>
 
417
      <varlistentry>
 
418
        <term><filename>/etc/mandos/mandos.conf</filename></term>
 
419
        <listitem>
 
420
          <para>
 
421
            Server-global settings.  See
 
422
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
423
            <manvolnum>5</manvolnum></citerefentry> for details.
 
424
          </para>
 
425
        </listitem>
 
426
      </varlistentry>
 
427
      <varlistentry>
 
428
        <term><filename>/etc/mandos/clients.conf</filename></term>
 
429
        <listitem>
 
430
          <para>
 
431
            List of clients and client-specific settings.  See
 
432
            <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
433
            <manvolnum>5</manvolnum></citerefentry> for details.
 
434
          </para>
 
435
        </listitem>
 
436
      </varlistentry>
 
437
      <varlistentry>
 
438
        <term><filename>/var/run/mandos.pid</filename></term>
 
439
        <listitem>
 
440
          <para>
 
441
            The file containing the process id of the
 
442
            <command>&COMMANDNAME;</command> process started last.
 
443
          </para>
 
444
        </listitem>
 
445
      </varlistentry>
 
446
      <varlistentry>
 
447
        <term><filename>/dev/log</filename></term>
 
448
        <listitem>
 
449
          <para>
 
450
            The Unix domain socket to where local syslog messages are
 
451
            sent.
 
452
          </para>
 
453
        </listitem>
 
454
      </varlistentry>
 
455
      <varlistentry>
 
456
        <term><filename>/bin/sh</filename></term>
 
457
        <listitem>
 
458
          <para>
 
459
            This is used to start the configured checker command for
 
460
            each client.  See <citerefentry>
 
461
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
462
            <manvolnum>5</manvolnum></citerefentry> for details.
 
463
          </para>
 
464
        </listitem>
 
465
      </varlistentry>
 
466
    </variablelist>
 
467
  </refsect1>
 
468
  
 
469
  <refsect1 id="bugs">
 
470
    <title>BUGS</title>
 
471
    <para>
 
472
      This server might, on especially fatal errors, emit a Python
 
473
      backtrace.  This could be considered a feature.
 
474
    </para>
 
475
    <para>
 
476
      Currently, if a client is disabled due to having timed out, the
 
477
      server does not record this fact onto permanent storage.  This
 
478
      has some security implications, see <xref linkend="clients"/>.
 
479
    </para>
 
480
    <para>
 
481
      There is no fine-grained control over logging and debug output.
 
482
    </para>
 
483
    <para>
 
484
      Debug mode is conflated with running in the foreground.
 
485
    </para>
 
486
    <para>
 
487
      The console log messages do not show a time stamp.
 
488
    </para>
 
489
    <para>
 
490
      This server does not check the expire time of clients’ OpenPGP
 
491
      keys.
 
492
    </para>
 
493
  </refsect1>
 
494
  
 
495
  <refsect1 id="example">
 
496
    <title>EXAMPLE</title>
 
497
    <informalexample>
 
498
      <para>
 
499
        Normal invocation needs no options:
 
500
      </para>
 
501
      <para>
 
502
        <userinput>&COMMANDNAME;</userinput>
 
503
      </para>
 
504
    </informalexample>
 
505
    <informalexample>
 
506
      <para>
 
507
        Run the server in debug mode, read configuration files from
 
508
        the <filename>~/mandos</filename> directory, and use the
 
509
        Zeroconf service name <quote>Test</quote> to not collide with
 
510
        any other official Mandos server on this host:
 
511
      </para>
 
512
      <para>
 
513
 
 
514
<!-- do not wrap this line -->
 
515
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
516
 
 
517
      </para>
 
518
    </informalexample>
 
519
    <informalexample>
 
520
      <para>
 
521
        Run the server normally, but only listen to one interface and
 
522
        only on the link-local address on that interface:
 
523
      </para>
 
524
      <para>
 
525
 
 
526
<!-- do not wrap this line -->
 
527
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
528
 
 
529
      </para>
 
530
    </informalexample>
 
531
  </refsect1>
 
532
  
 
533
  <refsect1 id="security">
 
534
    <title>SECURITY</title>
 
535
    <refsect2 id="server">
 
536
      <title>SERVER</title>
 
537
      <para>
 
538
        Running this <command>&COMMANDNAME;</command> server program
 
539
        should not in itself present any security risk to the host
 
540
        computer running it.  The program switches to a non-root user
 
541
        soon after startup.
 
542
      </para>
 
543
    </refsect2>
 
544
    <refsect2 id="clients">
 
545
      <title>CLIENTS</title>
 
546
      <para>
 
547
        The server only gives out its stored data to clients which
 
548
        does have the OpenPGP key of the stored fingerprint.  This is
 
549
        guaranteed by the fact that the client sends its OpenPGP
 
550
        public key in the TLS handshake; this ensures it to be
 
551
        genuine.  The server computes the fingerprint of the key
 
552
        itself and looks up the fingerprint in its list of
 
553
        clients. The <filename>clients.conf</filename> file (see
 
554
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
555
        <manvolnum>5</manvolnum></citerefentry>)
 
556
        <emphasis>must</emphasis> be made non-readable by anyone
 
557
        except the user starting the server (usually root).
 
558
      </para>
 
559
      <para>
 
560
        As detailed in <xref linkend="checking"/>, the status of all
 
561
        client computers will continually be checked and be assumed
 
562
        compromised if they are gone for too long.
 
563
      </para>
 
564
      <para>
 
565
        If a client is compromised, its downtime should be duly noted
 
566
        by the server which would therefore disable the client.  But
 
567
        if the server was ever restarted, it would re-read its client
 
568
        list from its configuration file and again regard all clients
 
569
        therein as enabled, and hence eligible to receive their
 
570
        passwords.  Therefore, be careful when restarting servers if
 
571
        it is suspected that a client has, in fact, been compromised
 
572
        by parties who may now be running a fake Mandos client with
 
573
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
574
        image of the client host.  What should be done in that case
 
575
        (if restarting the server program really is necessary) is to
 
576
        stop the server program, edit the configuration file to omit
 
577
        any suspect clients, and restart the server program.
 
578
      </para>
 
579
      <para>
 
580
        For more details on client-side security, see
 
581
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
582
        <manvolnum>8mandos</manvolnum></citerefentry>.
 
583
      </para>
 
584
    </refsect2>
 
585
  </refsect1>
 
586
  
 
587
  <refsect1 id="see_also">
 
588
    <title>SEE ALSO</title>
 
589
    <para>
 
590
      <citerefentry>
 
591
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
592
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
593
        <refentrytitle>mandos.conf</refentrytitle>
 
594
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
595
        <refentrytitle>mandos-client</refentrytitle>
 
596
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
597
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
598
      </citerefentry>
 
599
    </para>
 
600
    <variablelist>
 
601
      <varlistentry>
 
602
        <term>
 
603
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
604
        </term>
 
605
        <listitem>
 
606
          <para>
 
607
            Zeroconf is the network protocol standard used by clients
 
608
            for finding this Mandos server on the local network.
 
609
          </para>
 
610
        </listitem>
 
611
      </varlistentry>
 
612
      <varlistentry>
 
613
        <term>
 
614
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
615
        </term>
 
616
      <listitem>
 
617
        <para>
 
618
          Avahi is the library this server calls to implement
 
619
          Zeroconf service announcements.
 
620
        </para>
 
621
      </listitem>
 
622
      </varlistentry>
 
623
      <varlistentry>
 
624
        <term>
 
625
          <ulink url="http://www.gnu.org/software/gnutls/"
 
626
          >GnuTLS</ulink>
 
627
        </term>
 
628
      <listitem>
 
629
        <para>
 
630
          GnuTLS is the library this server uses to implement TLS for
 
631
          communicating securely with the client, and at the same time
 
632
          confidently get the client’s public OpenPGP key.
 
633
        </para>
 
634
      </listitem>
 
635
      </varlistentry>
 
636
      <varlistentry>
 
637
        <term>
 
638
          RFC 4291: <citetitle>IP Version 6 Addressing
 
639
          Architecture</citetitle>
 
640
        </term>
 
641
        <listitem>
 
642
          <variablelist>
 
643
            <varlistentry>
 
644
              <term>Section 2.2: <citetitle>Text Representation of
 
645
              Addresses</citetitle></term>
 
646
              <listitem><para/></listitem>
 
647
            </varlistentry>
 
648
            <varlistentry>
 
649
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
650
              Address</citetitle></term>
 
651
              <listitem><para/></listitem>
 
652
            </varlistentry>
 
653
            <varlistentry>
 
654
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
655
            Addresses</citetitle></term>
 
656
            <listitem>
 
657
              <para>
 
658
                The clients use IPv6 link-local addresses, which are
 
659
                immediately usable since a link-local addresses is
 
660
                automatically assigned to a network interfaces when it
 
661
                is brought up.
 
662
              </para>
 
663
            </listitem>
 
664
            </varlistentry>
 
665
          </variablelist>
 
666
        </listitem>
 
667
      </varlistentry>
 
668
      <varlistentry>
 
669
        <term>
 
670
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
671
          Protocol Version 1.1</citetitle>
 
672
        </term>
 
673
      <listitem>
 
674
        <para>
 
675
          TLS 1.1 is the protocol implemented by GnuTLS.
 
676
        </para>
 
677
      </listitem>
 
678
      </varlistentry>
 
679
      <varlistentry>
 
680
        <term>
 
681
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
682
        </term>
 
683
      <listitem>
 
684
        <para>
 
685
          The data sent to clients is binary encrypted OpenPGP data.
 
686
        </para>
 
687
      </listitem>
 
688
      </varlistentry>
 
689
      <varlistentry>
 
690
        <term>
 
691
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
692
          Security</citetitle>
 
693
        </term>
 
694
      <listitem>
 
695
        <para>
 
696
          This is implemented by GnuTLS and used by this server so
 
697
          that OpenPGP keys can be used.
 
698
        </para>
 
699
      </listitem>
 
700
      </varlistentry>
 
701
    </variablelist>
 
702
  </refsect1>
 
703
</refentry>
 
704
<!-- Local Variables: -->
 
705
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
706
<!-- time-stamp-end: "[\"']>" -->
 
707
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
708
<!-- End: -->