/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

updated some partial manual pages

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