/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-17 20:34:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817203418-l691ahxyc7vmezad
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".

* mandos.xml: More improvements.  Replaced " with <quote>'s.
  (NETWORK PROTOCOL): Replaced <informaltable> with <table> with a
                      <title>.
  (CHECKING): New section describing the continual checking of
              clients.
  (LOGGING): We log to /dev/log, not syslog(3).
  (FILES): Changed to use a <variablelist> instead of an
           <itemizedlist>.  Added "/dev/log" and brief descriptions of
           all files.
  (BUGS): Added content.
  (EXAMPLES): - '' -
  (SECURITY): Added content to subsections "SERVER" and "CLIENTS".

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 TIMESTAMP "2008-08-31">
7
8
]>
8
9
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
10
11
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
12
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
14
15
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
16
    <authorgroup>
17
17
      <author>
18
18
        <firstname>Björn</firstname>
67
67
  <refnamediv>
68
68
    <refname><command>&COMMANDNAME;</command></refname>
69
69
    <refpurpose>
70
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
71
71
    </refpurpose>
72
72
  </refnamediv>
73
73
 
74
74
  <refsynopsisdiv>
75
75
    <cmdsynopsis>
76
76
      <command>&COMMANDNAME;</command>
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
      <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>
123
106
    </cmdsynopsis>
124
107
  </refsynopsisdiv>
125
108
 
129
112
      <command>&COMMANDNAME;</command> is a server daemon which
130
113
      handles incoming request for passwords for a pre-defined list of
131
114
      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.
 
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.  Any
 
119
      authenticated client is then given the pre-encrypted password
 
120
      for that specific client.
139
121
    </para>
140
122
 
141
123
  </refsect1>
145
127
 
146
128
    <para>
147
129
      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.
 
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.
151
138
    </para>
152
 
    
 
139
 
153
140
  </refsect1>
154
141
  
155
142
  <refsect1 id="options">
156
143
    <title>OPTIONS</title>
157
 
    
 
144
 
158
145
    <variablelist>
159
146
      <varlistentry>
160
 
        <term><option>--help</option></term>
161
 
        <term><option>-h</option></term>
 
147
        <term><literal>-h</literal>, <literal>--help</literal></term>
162
148
        <listitem>
163
149
          <para>
164
150
            Show a help message and exit
165
151
          </para>
166
152
        </listitem>
167
153
      </varlistentry>
168
 
      
169
 
      <varlistentry>
170
 
        <term><option>--interface</option>
171
 
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>-i</option>
173
 
        <replaceable>NAME</replaceable></term>
174
 
        <listitem>
175
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
 
        </listitem>
177
 
      </varlistentry>
178
 
      
179
 
      <varlistentry>
180
 
        <term><option>--address
181
 
        <replaceable>ADDRESS</replaceable></option></term>
182
 
        <term><option>-a
183
 
        <replaceable>ADDRESS</replaceable></option></term>
184
 
        <listitem>
185
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
186
 
        </listitem>
187
 
      </varlistentry>
188
 
      
189
 
      <varlistentry>
190
 
        <term><option>--port
191
 
        <replaceable>PORT</replaceable></option></term>
192
 
        <term><option>-p
193
 
        <replaceable>PORT</replaceable></option></term>
194
 
        <listitem>
195
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
196
 
        </listitem>
197
 
      </varlistentry>
198
 
      
199
 
      <varlistentry>
200
 
        <term><option>--check</option></term>
201
 
        <listitem>
202
 
          <para>
203
 
            Run the server’s self-tests.  This includes any unit
 
154
 
 
155
      <varlistentry>
 
156
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
157
        IF</replaceable></literal></term>
 
158
        <listitem>
 
159
          <para>
 
160
            Only announce the server and listen to requests on network
 
161
            interface <replaceable>IF</replaceable>.  Default is to
 
162
            use all available interfaces.
 
163
          </para>
 
164
        </listitem>
 
165
      </varlistentry>
 
166
 
 
167
      <varlistentry>
 
168
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
169
        ADDRESS</replaceable></literal></term>
 
170
        <listitem>
 
171
          <para>
 
172
            If this option is used, the server will only listen to a
 
173
            specific address.  This must currently be an IPv6 address;
 
174
            an IPv4 address can be specified using the
 
175
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
 
176
            Also, if a link-local address is specified, an interface
 
177
            should be set, since a link-local address is only valid on
 
178
            a single interface.  By default, the server will listen to
 
179
            all available addresses.
 
180
          </para>
 
181
        </listitem>
 
182
      </varlistentry>
 
183
 
 
184
      <varlistentry>
 
185
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
186
        PORT</replaceable></literal></term>
 
187
        <listitem>
 
188
          <para>
 
189
            If this option is used, the server to bind to that
 
190
            port. By default, the server will listen to an arbitrary
 
191
            port given by the operating system.
 
192
          </para>
 
193
        </listitem>
 
194
      </varlistentry>
 
195
 
 
196
      <varlistentry>
 
197
        <term><literal>--check</literal></term>
 
198
        <listitem>
 
199
          <para>
 
200
            Run the server's self-tests.  This includes any unit
204
201
            tests, etc.
205
202
          </para>
206
203
        </listitem>
207
204
      </varlistentry>
208
 
      
209
 
      <varlistentry>
210
 
        <term><option>--debug</option></term>
211
 
        <listitem>
212
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
 
        </listitem>
214
 
      </varlistentry>
215
 
 
216
 
      <varlistentry>
217
 
        <term><option>--priority <replaceable>
218
 
        PRIORITY</replaceable></option></term>
219
 
        <listitem>
220
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
 
        </listitem>
222
 
      </varlistentry>
223
 
 
224
 
      <varlistentry>
225
 
        <term><option>--servicename
226
 
        <replaceable>NAME</replaceable></option></term>
227
 
        <listitem>
228
 
          <xi:include href="mandos-options.xml"
229
 
                      xpointer="servicename"/>
230
 
        </listitem>
231
 
      </varlistentry>
232
 
 
233
 
      <varlistentry>
234
 
        <term><option>--configdir
235
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
205
 
 
206
      <varlistentry>
 
207
        <term><literal>--debug</literal></term>
 
208
        <listitem>
 
209
          <para>
 
210
            If the server is run in debug mode, it will run in the
 
211
            foreground and print a lot of debugging information.  The
 
212
            default is <emphasis>not</emphasis> to run in debug mode.
 
213
          </para>
 
214
        </listitem>
 
215
      </varlistentry>
 
216
 
 
217
      <varlistentry>
 
218
        <term><literal>--priority <replaceable>
 
219
        PRIORITY</replaceable></literal></term>
 
220
        <listitem>
 
221
          <para>
 
222
            GnuTLS priority string for the TLS handshake with the
 
223
            clients.  See
 
224
            <citerefentry><refentrytitle>gnutls_priority_init
 
225
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
 
226
            for the syntax.  The default is
 
227
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
 
228
            <emphasis>Warning</emphasis>: changing this may make the
 
229
            TLS handshake fail, making communication with clients
 
230
            impossible.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>
 
234
 
 
235
      <varlistentry>
 
236
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
237
        </literal></term>
 
238
        <listitem>
 
239
          <para>
 
240
            Zeroconf service name.  The default is
 
241
            <quote><literal>Mandos</literal></quote>.  You only need
 
242
            to change this if you for some reason want to run more
 
243
            than one server on the same <emphasis>host</emphasis>,
 
244
            which would not normally be useful.  If there are name
 
245
            collisions on the same <emphasis>network</emphasis>, the
 
246
            newer server will automatically rename itself to
 
247
            <quote><literal>Mandos #2</literal></quote>, and so on,
 
248
            therefore this option is not needed in that case.
 
249
          </para>
 
250
        </listitem>
 
251
      </varlistentry>
 
252
 
 
253
      <varlistentry>
 
254
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
255
        </literal></term>
236
256
        <listitem>
237
257
          <para>
238
258
            Directory to search for configuration files.  Default is
246
266
      </varlistentry>
247
267
 
248
268
      <varlistentry>
249
 
        <term><option>--version</option></term>
 
269
        <term><literal>--version</literal></term>
250
270
        <listitem>
251
271
          <para>
252
272
            Prints the program version and exit.
256
276
    </variablelist>
257
277
  </refsect1>
258
278
 
259
 
  <refsect1 id="overview">
260
 
    <title>OVERVIEW</title>
261
 
    <xi:include href="overview.xml"/>
262
 
    <para>
263
 
      This program is the server part.  It is a normal server program
264
 
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
266
 
    </para>
267
 
  </refsect1>
268
 
 
269
279
  <refsect1 id="protocol">
270
280
    <title>NETWORK PROTOCOL</title>
271
281
    <para>
297
307
        <entry>-><!-- &rarr; --></entry>
298
308
      </row>
299
309
      <row>
300
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
310
        <entry><quote><literal>1\r\en</literal></quote></entry>
301
311
        <entry>-><!-- &rarr; --></entry>
302
312
      </row>
303
313
      <row>
331
341
      are still up.  If a client has not been confirmed as being up
332
342
      for some time, the client is assumed to be compromised and is no
333
343
      longer eligible to receive the encrypted password.  The timeout,
334
 
      checker program, and interval between checks can be configured
 
344
      checker program and interval between checks can be configured
335
345
      both globally and per client; see <citerefentry>
 
346
      <refentrytitle>mandos.conf</refentrytitle>
 
347
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
336
348
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
349
      <manvolnum>5</manvolnum></citerefentry>.
338
350
    </para>
341
353
  <refsect1 id="logging">
342
354
    <title>LOGGING</title>
343
355
    <para>
344
 
      The server will send log message with various severity levels to
345
 
      <filename>/dev/log</filename>.  With the
 
356
      The server will send log messaged with various severity levels
 
357
      to <filename>/dev/log</filename>.  With the
346
358
      <option>--debug</option> option, it will log even more messages,
347
359
      and also show them on the console.
348
360
    </para>
356
368
    </para>
357
369
  </refsect1>
358
370
 
359
 
  <refsect1 id="environment">
360
 
    <title>ENVIRONMENT</title>
361
 
    <variablelist>
362
 
      <varlistentry>
363
 
        <term><envar>PATH</envar></term>
364
 
        <listitem>
365
 
          <para>
366
 
            To start the configured checker (see <xref
367
 
            linkend="checking"/>), the server uses
368
 
            <filename>/bin/sh</filename>, which in turn uses
369
 
            <varname>PATH</varname> to search for matching commands if
370
 
            an absolute path is not given.  See <citerefentry>
371
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
372
 
            </citerefentry>.
373
 
          </para>
374
 
        </listitem>
375
 
      </varlistentry>
376
 
    </variablelist>
377
 
  </refsect1>
378
 
 
379
371
  <refsect1 id="file">
380
372
    <title>FILES</title>
381
373
    <para>
422
414
          </para>
423
415
        </listitem>
424
416
      </varlistentry>
425
 
      <varlistentry>
426
 
        <term><filename>/bin/sh</filename></term>
427
 
        <listitem>
428
 
          <para>
429
 
            This is used to start the configured checker command for
430
 
            each client.  See <citerefentry>
431
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
432
 
            <manvolnum>5</manvolnum></citerefentry> for details.
433
 
          </para>
434
 
        </listitem>
435
 
      </varlistentry>
436
417
    </variablelist>
437
418
  </refsect1>
438
 
  
 
419
 
439
420
  <refsect1 id="bugs">
440
421
    <title>BUGS</title>
441
422
    <para>
442
423
      This server might, on especially fatal errors, emit a Python
443
424
      backtrace.  This could be considered a feature.
444
425
    </para>
445
 
    <para>
446
 
      Currently, if a client is declared <quote>invalid</quote> due to
447
 
      having timed out, the server does not record this fact onto
448
 
      permanent storage.  This has some security implications, see
449
 
      <xref linkend="CLIENTS"/>.
450
 
    </para>
451
 
    <para>
452
 
      There is currently no way of querying the server of the current
453
 
      status of clients, other than analyzing its <systemitem
454
 
      class="service">syslog</systemitem> output.
455
 
    </para>
456
 
    <para>
457
 
      There is no fine-grained control over logging and debug output.
458
 
    </para>
459
 
    <para>
460
 
      Debug mode is conflated with running in the foreground.
461
 
    </para>
462
 
    <para>
463
 
      The console log messages does not show a timestamp.
464
 
    </para>
465
426
  </refsect1>
466
 
  
467
 
  <refsect1 id="example">
468
 
    <title>EXAMPLE</title>
 
427
 
 
428
  <refsect1 id="examples">
 
429
    <title>EXAMPLES</title>
469
430
    <informalexample>
470
431
      <para>
471
432
        Normal invocation needs no options:
472
433
      </para>
473
434
      <para>
474
 
        <userinput>&COMMANDNAME;</userinput>
 
435
        <userinput>mandos</userinput>
475
436
      </para>
476
437
    </informalexample>
477
438
    <informalexample>
478
439
      <para>
479
 
        Run the server in debug mode, read configuration files from
480
 
        the <filename>~/mandos</filename> directory, and use the
481
 
        Zeroconf service name <quote>Test</quote> to not collide with
482
 
        any other official Mandos server on this host:
 
440
        Run the server in debug mode and read configuration files from
 
441
        the <filename>~/mandos</filename> directory:
483
442
      </para>
484
443
      <para>
485
444
 
486
445
<!-- do not wrap this line -->
487
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
446
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
488
447
 
489
448
      </para>
490
449
    </informalexample>
496
455
      <para>
497
456
 
498
457
<!-- do not wrap this line -->
499
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
458
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
500
459
 
501
460
      </para>
502
461
    </informalexample>
504
463
 
505
464
  <refsect1 id="security">
506
465
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
466
    <refsect2>
508
467
      <title>SERVER</title>
509
468
      <para>
510
 
        Running this <command>&COMMANDNAME;</command> server program
511
 
        should not in itself present any security risk to the host
512
 
        computer running it.  The program does not need any special
513
 
        privileges to run, and is designed to run as a non-root user.
 
469
        Running the server should not in itself present any security
 
470
        risk to the host computer running it.
514
471
      </para>
515
472
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
473
    <refsect2>
517
474
      <title>CLIENTS</title>
518
475
      <para>
519
476
        The server only gives out its stored data to clients which
524
481
        itself and looks up the fingerprint in its list of
525
482
        clients. The <filename>clients.conf</filename> file (see
526
483
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
 
        <manvolnum>5</manvolnum></citerefentry>)
528
 
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
530
 
      </para>
531
 
      <para>
532
 
        As detailed in <xref linkend="checking"/>, the status of all
533
 
        client computers will continually be checked and be assumed
534
 
        compromised if they are gone for too long.
535
 
      </para>
536
 
      <para>
537
 
        If a client is compromised, its downtime should be duly noted
538
 
        by the server which would therefore declare the client
539
 
        invalid.  But if the server was ever restarted, it would
540
 
        re-read its client list from its configuration file and again
541
 
        regard all clients therein as valid, and hence eligible to
542
 
        receive their passwords.  Therefore, be careful when
543
 
        restarting servers if it is suspected that a client has, in
544
 
        fact, been compromised by parties who may now be running a
545
 
        fake Mandos client with the keys from the non-encrypted
546
 
        initial RAM image of the client host.  What should be done in
547
 
        that case (if restarting the server program really is
548
 
        necessary) is to stop the server program, edit the
549
 
        configuration file to omit any suspect clients, and restart
550
 
        the server program.
 
484
        <manvolnum>5</manvolnum></citerefentry>) must be non-readable
 
485
        by anyone except the user running the server.
551
486
      </para>
552
487
      <para>
553
488
        For more details on client-side security, see
559
494
 
560
495
  <refsect1 id="see_also">
561
496
    <title>SEE ALSO</title>
562
 
    <para>
563
 
      <citerefentry>
564
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
565
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>mandos.conf</refentrytitle>
567
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>password-request</refentrytitle>
569
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
 
      </citerefentry>
572
 
    </para>
573
 
    <variablelist>
574
 
      <varlistentry>
575
 
        <term>
576
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
577
 
        </term>
578
 
        <listitem>
579
 
          <para>
580
 
            Zeroconf is the network protocol standard used by clients
581
 
            for finding this Mandos server on the local network.
582
 
          </para>
583
 
        </listitem>
584
 
      </varlistentry>
585
 
      <varlistentry>
586
 
        <term>
587
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
588
 
        </term>
589
 
      <listitem>
590
 
        <para>
591
 
          Avahi is the library this server calls to implement
592
 
          Zeroconf service announcements.
593
 
        </para>
594
 
      </listitem>
595
 
      </varlistentry>
596
 
      <varlistentry>
597
 
        <term>
598
 
          <ulink url="http://www.gnu.org/software/gnutls/"
599
 
          >GnuTLS</ulink>
600
 
        </term>
601
 
      <listitem>
602
 
        <para>
603
 
          GnuTLS is the library this server uses to implement TLS for
604
 
          communicating securely with the client, and at the same time
605
 
          confidently get the client’s public OpenPGP key.
606
 
        </para>
607
 
      </listitem>
608
 
      </varlistentry>
609
 
      <varlistentry>
610
 
        <term>
611
 
          RFC 4291: <citetitle>IP Version 6 Addressing
612
 
          Architecture</citetitle>
613
 
        </term>
614
 
        <listitem>
615
 
          <variablelist>
616
 
            <varlistentry>
617
 
              <term>Section 2.2: <citetitle>Text Representation of
618
 
              Addresses</citetitle></term>
619
 
              <listitem><para/></listitem>
620
 
            </varlistentry>
621
 
            <varlistentry>
622
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
623
 
              Address</citetitle></term>
624
 
              <listitem><para/></listitem>
625
 
            </varlistentry>
626
 
            <varlistentry>
627
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
628
 
            Addresses</citetitle></term>
629
 
            <listitem>
630
 
              <para>
631
 
                The clients use IPv6 link-local addresses, which are
632
 
                immediately usable since a link-local addresses is
633
 
                automatically assigned to a network interfaces when it
634
 
                is brought up.
635
 
              </para>
636
 
            </listitem>
637
 
            </varlistentry>
638
 
          </variablelist>
639
 
        </listitem>
640
 
      </varlistentry>
641
 
      <varlistentry>
642
 
        <term>
643
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
644
 
          Protocol Version 1.1</citetitle>
645
 
        </term>
646
 
      <listitem>
647
 
        <para>
648
 
          TLS 1.1 is the protocol implemented by GnuTLS.
649
 
        </para>
650
 
      </listitem>
651
 
      </varlistentry>
652
 
      <varlistentry>
653
 
        <term>
654
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
655
 
        </term>
656
 
      <listitem>
657
 
        <para>
658
 
          The data sent to clients is binary encrypted OpenPGP data.
659
 
        </para>
660
 
      </listitem>
661
 
      </varlistentry>
662
 
      <varlistentry>
663
 
        <term>
664
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
665
 
          Security</citetitle>
666
 
        </term>
667
 
      <listitem>
668
 
        <para>
669
 
          This is implemented by GnuTLS and used by this server so
670
 
          that OpenPGP keys can be used.
671
 
        </para>
672
 
      </listitem>
673
 
      </varlistentry>
674
 
    </variablelist>
 
497
    <itemizedlist spacing="compact">
 
498
      <listitem><para>
 
499
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
500
        <manvolnum>8mandos</manvolnum></citerefentry>
 
501
      </para></listitem>
 
502
      
 
503
      <listitem><para>
 
504
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
505
        <manvolnum>8mandos</manvolnum></citerefentry>
 
506
      </para></listitem>
 
507
      
 
508
      <listitem><para>
 
509
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
510
      </para></listitem>
 
511
      
 
512
      <listitem><para>
 
513
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
514
      </para></listitem>
 
515
      
 
516
      <listitem><para>
 
517
        <ulink
 
518
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
519
      </para></listitem>
 
520
      
 
521
      <listitem><para>
 
522
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
523
        Format</citetitle></citation>
 
524
      </para></listitem>
 
525
      
 
526
      <listitem><para>
 
527
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
528
        Transport Layer Security</citetitle></citation>
 
529
      </para></listitem>
 
530
      
 
531
      <listitem><para>
 
532
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
533
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
534
        Unicast Addresses</citation>
 
535
      </para></listitem>
 
536
    </itemizedlist>
675
537
  </refsect1>
676
538
</refentry>
677
 
<!-- Local Variables: -->
678
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
679
 
<!-- time-stamp-end: "[\"']>" -->
680
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
681
 
<!-- End: -->