/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-09-01 16:53:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901165317-77dccp81zyqimt2j
* plugin-runner.c (add_environment): Override existing environment
                                     variables when asked to do so.
                                     All callers changed.
  (main): Removed old argp.args_doc string.  Parse argument file
          before normal command line arguments.  Use ARGP_IN_ORDER
          flag in both calls to argp_parse.  Do not strdup() strings
          to be sent to add_environment().

* plugin-runner.xml (OPTIONS): Document "--global-env" and "--envs-for".
  (FILES): Note that the config file is parsed before the command line
           options.

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-09-01">
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>
34
34
      <holder>Teddy Hogeborn</holder>
35
35
      <holder>Björn Påhlsson</holder>
36
36
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
37
    <xi:include href="legalnotice.xml"/>
60
38
  </refentryinfo>
61
39
 
62
40
  <refmeta>
67
45
  <refnamediv>
68
46
    <refname><command>&COMMANDNAME;</command></refname>
69
47
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
48
      Gives encrypted passwords to authenticated Mandos clients
71
49
    </refpurpose>
72
50
  </refnamediv>
73
51
 
74
52
  <refsynopsisdiv>
75
53
    <cmdsynopsis>
76
54
      <command>&COMMANDNAME;</command>
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>
 
55
      <group>
 
56
        <arg choice="plain"><option>--interface
 
57
        <replaceable>NAME</replaceable></option></arg>
 
58
        <arg choice="plain"><option>-i
 
59
        <replaceable>NAME</replaceable></option></arg>
 
60
      </group>
 
61
      <sbr/>
 
62
      <group>
 
63
        <arg choice="plain"><option>--address
 
64
        <replaceable>ADDRESS</replaceable></option></arg>
 
65
        <arg choice="plain"><option>-a
 
66
        <replaceable>ADDRESS</replaceable></option></arg>
 
67
      </group>
 
68
      <sbr/>
 
69
      <group>
 
70
        <arg choice="plain"><option>--port
 
71
        <replaceable>PORT</replaceable></option></arg>
 
72
        <arg choice="plain"><option>-p
 
73
        <replaceable>PORT</replaceable></option></arg>
 
74
      </group>
 
75
      <sbr/>
 
76
      <arg><option>--priority
 
77
      <replaceable>PRIORITY</replaceable></option></arg>
 
78
      <sbr/>
 
79
      <arg><option>--servicename
 
80
      <replaceable>NAME</replaceable></option></arg>
 
81
      <sbr/>
 
82
      <arg><option>--configdir
 
83
      <replaceable>DIRECTORY</replaceable></option></arg>
 
84
      <sbr/>
 
85
      <arg><option>--debug</option></arg>
 
86
    </cmdsynopsis>
 
87
    <cmdsynopsis>
 
88
      <command>&COMMANDNAME;</command>
 
89
      <group choice="req">
 
90
        <arg choice="plain"><option>--help</option></arg>
 
91
        <arg choice="plain"><option>-h</option></arg>
 
92
      </group>
 
93
    </cmdsynopsis>
 
94
    <cmdsynopsis>
 
95
      <command>&COMMANDNAME;</command>
 
96
      <arg choice="plain"><option>--version</option></arg>
 
97
    </cmdsynopsis>
 
98
    <cmdsynopsis>
 
99
      <command>&COMMANDNAME;</command>
 
100
      <arg choice="plain"><option>--check</option></arg>
106
101
    </cmdsynopsis>
107
102
  </refsynopsisdiv>
108
103
 
112
107
      <command>&COMMANDNAME;</command> is a server daemon which
113
108
      handles incoming request for passwords for a pre-defined list of
114
109
      client host computers.  The Mandos server uses Zeroconf to
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.
 
110
      announce itself on the local network, and uses TLS to
 
111
      communicate securely with and to authenticate the clients.  The
 
112
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
113
      link-local addresses, since the clients will probably not have
 
114
      any other addresses configured (see <xref linkend="overview"/>).
 
115
      Any authenticated client is then given the stored pre-encrypted
 
116
      password for that specific client.
121
117
    </para>
122
118
 
123
119
  </refsect1>
127
123
 
128
124
    <para>
129
125
      The purpose of this is to enable <emphasis>remote and unattended
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.
 
126
      rebooting</emphasis> of client host computer with an
 
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
128
      linkend="overview"/> for details.
138
129
    </para>
139
 
 
 
130
    
140
131
  </refsect1>
141
132
  
142
133
  <refsect1 id="options">
143
134
    <title>OPTIONS</title>
144
 
 
 
135
    
145
136
    <variablelist>
146
137
      <varlistentry>
147
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
138
        <term><option>--help</option></term>
 
139
        <term><option>-h</option></term>
148
140
        <listitem>
149
141
          <para>
150
142
            Show a help message and exit
151
143
          </para>
152
144
        </listitem>
153
145
      </varlistentry>
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
 
146
      
 
147
      <varlistentry>
 
148
        <term><option>--interface</option>
 
149
        <replaceable>NAME</replaceable></term>
 
150
        <term><option>-i</option>
 
151
        <replaceable>NAME</replaceable></term>
 
152
        <listitem>
 
153
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
154
        </listitem>
 
155
      </varlistentry>
 
156
      
 
157
      <varlistentry>
 
158
        <term><option>--address
 
159
        <replaceable>ADDRESS</replaceable></option></term>
 
160
        <term><option>-a
 
161
        <replaceable>ADDRESS</replaceable></option></term>
 
162
        <listitem>
 
163
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
164
        </listitem>
 
165
      </varlistentry>
 
166
      
 
167
      <varlistentry>
 
168
        <term><option>--port
 
169
        <replaceable>PORT</replaceable></option></term>
 
170
        <term><option>-p
 
171
        <replaceable>PORT</replaceable></option></term>
 
172
        <listitem>
 
173
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
174
        </listitem>
 
175
      </varlistentry>
 
176
      
 
177
      <varlistentry>
 
178
        <term><option>--check</option></term>
 
179
        <listitem>
 
180
          <para>
 
181
            Run the server’s self-tests.  This includes any unit
201
182
            tests, etc.
202
183
          </para>
203
184
        </listitem>
204
185
      </varlistentry>
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>
 
186
      
 
187
      <varlistentry>
 
188
        <term><option>--debug</option></term>
 
189
        <listitem>
 
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
191
        </listitem>
 
192
      </varlistentry>
 
193
 
 
194
      <varlistentry>
 
195
        <term><option>--priority <replaceable>
 
196
        PRIORITY</replaceable></option></term>
 
197
        <listitem>
 
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
199
        </listitem>
 
200
      </varlistentry>
 
201
 
 
202
      <varlistentry>
 
203
        <term><option>--servicename
 
204
        <replaceable>NAME</replaceable></option></term>
 
205
        <listitem>
 
206
          <xi:include href="mandos-options.xml"
 
207
                      xpointer="servicename"/>
 
208
        </listitem>
 
209
      </varlistentry>
 
210
 
 
211
      <varlistentry>
 
212
        <term><option>--configdir
 
213
        <replaceable>DIRECTORY</replaceable></option></term>
256
214
        <listitem>
257
215
          <para>
258
216
            Directory to search for configuration files.  Default is
266
224
      </varlistentry>
267
225
 
268
226
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
227
        <term><option>--version</option></term>
270
228
        <listitem>
271
229
          <para>
272
230
            Prints the program version and exit.
276
234
    </variablelist>
277
235
  </refsect1>
278
236
 
 
237
  <refsect1 id="overview">
 
238
    <title>OVERVIEW</title>
 
239
    <xi:include href="overview.xml"/>
 
240
    <para>
 
241
      This program is the server part.  It is a normal server program
 
242
      and will run in a normal system environment, not in an initial
 
243
      <acronym>RAM</acronym> disk environment.
 
244
    </para>
 
245
  </refsect1>
 
246
 
279
247
  <refsect1 id="protocol">
280
248
    <title>NETWORK PROTOCOL</title>
281
249
    <para>
307
275
        <entry>-><!-- &rarr; --></entry>
308
276
      </row>
309
277
      <row>
310
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
278
        <entry><quote><literal>1\r\n</literal></quote></entry>
311
279
        <entry>-><!-- &rarr; --></entry>
312
280
      </row>
313
281
      <row>
341
309
      are still up.  If a client has not been confirmed as being up
342
310
      for some time, the client is assumed to be compromised and is no
343
311
      longer eligible to receive the encrypted password.  The timeout,
344
 
      checker program and interval between checks can be configured
 
312
      checker program, and interval between checks can be configured
345
313
      both globally and per client; see <citerefentry>
346
 
      <refentrytitle>mandos.conf</refentrytitle>
347
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
348
314
      <refentrytitle>mandos-clients.conf</refentrytitle>
349
315
      <manvolnum>5</manvolnum></citerefentry>.
350
316
    </para>
353
319
  <refsect1 id="logging">
354
320
    <title>LOGGING</title>
355
321
    <para>
356
 
      The server will send log messaged with various severity levels
357
 
      to <filename>/dev/log</filename>.  With the
 
322
      The server will send log message with various severity levels to
 
323
      <filename>/dev/log</filename>.  With the
358
324
      <option>--debug</option> option, it will log even more messages,
359
325
      and also show them on the console.
360
326
    </para>
368
334
    </para>
369
335
  </refsect1>
370
336
 
 
337
  <refsect1 id="environment">
 
338
    <title>ENVIRONMENT</title>
 
339
    <variablelist>
 
340
      <varlistentry>
 
341
        <term><envar>PATH</envar></term>
 
342
        <listitem>
 
343
          <para>
 
344
            To start the configured checker (see <xref
 
345
            linkend="checking"/>), the server uses
 
346
            <filename>/bin/sh</filename>, which in turn uses
 
347
            <varname>PATH</varname> to search for matching commands if
 
348
            an absolute path is not given.  See <citerefentry>
 
349
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
350
            </citerefentry>.
 
351
          </para>
 
352
        </listitem>
 
353
      </varlistentry>
 
354
    </variablelist>
 
355
  </refsect1>
 
356
 
371
357
  <refsect1 id="file">
372
358
    <title>FILES</title>
373
359
    <para>
414
400
          </para>
415
401
        </listitem>
416
402
      </varlistentry>
 
403
      <varlistentry>
 
404
        <term><filename>/bin/sh</filename></term>
 
405
        <listitem>
 
406
          <para>
 
407
            This is used to start the configured checker command for
 
408
            each client.  See <citerefentry>
 
409
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
410
            <manvolnum>5</manvolnum></citerefentry> for details.
 
411
          </para>
 
412
        </listitem>
 
413
      </varlistentry>
417
414
    </variablelist>
418
415
  </refsect1>
419
 
 
 
416
  
420
417
  <refsect1 id="bugs">
421
418
    <title>BUGS</title>
422
419
    <para>
423
420
      This server might, on especially fatal errors, emit a Python
424
421
      backtrace.  This could be considered a feature.
425
422
    </para>
 
423
    <para>
 
424
      Currently, if a client is declared <quote>invalid</quote> due to
 
425
      having timed out, the server does not record this fact onto
 
426
      permanent storage.  This has some security implications, see
 
427
      <xref linkend="CLIENTS"/>.
 
428
    </para>
 
429
    <para>
 
430
      There is currently no way of querying the server of the current
 
431
      status of clients, other than analyzing its <systemitem
 
432
      class="service">syslog</systemitem> output.
 
433
    </para>
 
434
    <para>
 
435
      There is no fine-grained control over logging and debug output.
 
436
    </para>
 
437
    <para>
 
438
      Debug mode is conflated with running in the foreground.
 
439
    </para>
 
440
    <para>
 
441
      The console log messages does not show a timestamp.
 
442
    </para>
426
443
  </refsect1>
427
 
 
428
 
  <refsect1 id="examples">
429
 
    <title>EXAMPLES</title>
 
444
  
 
445
  <refsect1 id="example">
 
446
    <title>EXAMPLE</title>
430
447
    <informalexample>
431
448
      <para>
432
449
        Normal invocation needs no options:
433
450
      </para>
434
451
      <para>
435
 
        <userinput>mandos</userinput>
 
452
        <userinput>&COMMANDNAME;</userinput>
436
453
      </para>
437
454
    </informalexample>
438
455
    <informalexample>
439
456
      <para>
440
 
        Run the server in debug mode and read configuration files from
441
 
        the <filename>~/mandos</filename> directory:
 
457
        Run the server in debug mode, read configuration files from
 
458
        the <filename>~/mandos</filename> directory, and use the
 
459
        Zeroconf service name <quote>Test</quote> to not collide with
 
460
        any other official Mandos server on this host:
442
461
      </para>
443
462
      <para>
444
463
 
445
464
<!-- do not wrap this line -->
446
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
465
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
447
466
 
448
467
      </para>
449
468
    </informalexample>
455
474
      <para>
456
475
 
457
476
<!-- do not wrap this line -->
458
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
477
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
459
478
 
460
479
      </para>
461
480
    </informalexample>
463
482
 
464
483
  <refsect1 id="security">
465
484
    <title>SECURITY</title>
466
 
    <refsect2>
 
485
    <refsect2 id="SERVER">
467
486
      <title>SERVER</title>
468
487
      <para>
469
 
        Running the server should not in itself present any security
470
 
        risk to the host computer running it.
 
488
        Running this <command>&COMMANDNAME;</command> server program
 
489
        should not in itself present any security risk to the host
 
490
        computer running it.  The program does not need any special
 
491
        privileges to run, and is designed to run as a non-root user.
471
492
      </para>
472
493
    </refsect2>
473
 
    <refsect2>
 
494
    <refsect2 id="CLIENTS">
474
495
      <title>CLIENTS</title>
475
496
      <para>
476
497
        The server only gives out its stored data to clients which
481
502
        itself and looks up the fingerprint in its list of
482
503
        clients. The <filename>clients.conf</filename> file (see
483
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
484
 
        <manvolnum>5</manvolnum></citerefentry>) must be non-readable
485
 
        by anyone except the user running the server.
 
505
        <manvolnum>5</manvolnum></citerefentry>)
 
506
        <emphasis>must</emphasis> be made non-readable by anyone
 
507
        except the user running the server.
 
508
      </para>
 
509
      <para>
 
510
        As detailed in <xref linkend="checking"/>, the status of all
 
511
        client computers will continually be checked and be assumed
 
512
        compromised if they are gone for too long.
 
513
      </para>
 
514
      <para>
 
515
        If a client is compromised, its downtime should be duly noted
 
516
        by the server which would therefore declare the client
 
517
        invalid.  But if the server was ever restarted, it would
 
518
        re-read its client list from its configuration file and again
 
519
        regard all clients therein as valid, and hence eligible to
 
520
        receive their passwords.  Therefore, be careful when
 
521
        restarting servers if it is suspected that a client has, in
 
522
        fact, been compromised by parties who may now be running a
 
523
        fake Mandos client with the keys from the non-encrypted
 
524
        initial <acronym>RAM</acronym> image of the client host.  What
 
525
        should be done in that case (if restarting the server program
 
526
        really is necessary) is to stop the server program, edit the
 
527
        configuration file to omit any suspect clients, and restart
 
528
        the server program.
486
529
      </para>
487
530
      <para>
488
531
        For more details on client-side security, see
494
537
 
495
538
  <refsect1 id="see_also">
496
539
    <title>SEE ALSO</title>
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>
 
540
    <para>
 
541
      <citerefentry>
 
542
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
544
        <refentrytitle>mandos.conf</refentrytitle>
 
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
546
        <refentrytitle>password-request</refentrytitle>
 
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
549
      </citerefentry>
 
550
    </para>
 
551
    <variablelist>
 
552
      <varlistentry>
 
553
        <term>
 
554
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
555
        </term>
 
556
        <listitem>
 
557
          <para>
 
558
            Zeroconf is the network protocol standard used by clients
 
559
            for finding this Mandos server on the local network.
 
560
          </para>
 
561
        </listitem>
 
562
      </varlistentry>
 
563
      <varlistentry>
 
564
        <term>
 
565
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
566
        </term>
 
567
      <listitem>
 
568
        <para>
 
569
          Avahi is the library this server calls to implement
 
570
          Zeroconf service announcements.
 
571
        </para>
 
572
      </listitem>
 
573
      </varlistentry>
 
574
      <varlistentry>
 
575
        <term>
 
576
          <ulink url="http://www.gnu.org/software/gnutls/"
 
577
          >GnuTLS</ulink>
 
578
        </term>
 
579
      <listitem>
 
580
        <para>
 
581
          GnuTLS is the library this server uses to implement TLS for
 
582
          communicating securely with the client, and at the same time
 
583
          confidently get the client’s public OpenPGP key.
 
584
        </para>
 
585
      </listitem>
 
586
      </varlistentry>
 
587
      <varlistentry>
 
588
        <term>
 
589
          RFC 4291: <citetitle>IP Version 6 Addressing
 
590
          Architecture</citetitle>
 
591
        </term>
 
592
        <listitem>
 
593
          <variablelist>
 
594
            <varlistentry>
 
595
              <term>Section 2.2: <citetitle>Text Representation of
 
596
              Addresses</citetitle></term>
 
597
              <listitem><para/></listitem>
 
598
            </varlistentry>
 
599
            <varlistentry>
 
600
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
601
              Address</citetitle></term>
 
602
              <listitem><para/></listitem>
 
603
            </varlistentry>
 
604
            <varlistentry>
 
605
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
606
            Addresses</citetitle></term>
 
607
            <listitem>
 
608
              <para>
 
609
                The clients use IPv6 link-local addresses, which are
 
610
                immediately usable since a link-local addresses is
 
611
                automatically assigned to a network interfaces when it
 
612
                is brought up.
 
613
              </para>
 
614
            </listitem>
 
615
            </varlistentry>
 
616
          </variablelist>
 
617
        </listitem>
 
618
      </varlistentry>
 
619
      <varlistentry>
 
620
        <term>
 
621
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
622
          Protocol Version 1.1</citetitle>
 
623
        </term>
 
624
      <listitem>
 
625
        <para>
 
626
          TLS 1.1 is the protocol implemented by GnuTLS.
 
627
        </para>
 
628
      </listitem>
 
629
      </varlistentry>
 
630
      <varlistentry>
 
631
        <term>
 
632
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
633
        </term>
 
634
      <listitem>
 
635
        <para>
 
636
          The data sent to clients is binary encrypted OpenPGP data.
 
637
        </para>
 
638
      </listitem>
 
639
      </varlistentry>
 
640
      <varlistentry>
 
641
        <term>
 
642
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
643
          Security</citetitle>
 
644
        </term>
 
645
      <listitem>
 
646
        <para>
 
647
          This is implemented by GnuTLS and used by this server so
 
648
          that OpenPGP keys can be used.
 
649
        </para>
 
650
      </listitem>
 
651
      </varlistentry>
 
652
    </variablelist>
537
653
  </refsect1>
538
654
</refentry>
 
655
<!-- Local Variables: -->
 
656
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
657
<!-- time-stamp-end: "[\"']>" -->
 
658
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
659
<!-- End: -->