/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: 2008-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

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