/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-17 06:17:10 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817061710-epkw87paysoo9g7w
* mandos-keygen.xml (NOTES): Removed section, since it is
                             automatically created for footnotes.

Show diffs side-by-side

added added

removed removed

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