/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: 2015-06-28 16:35:27 UTC
  • mto: (237.7.307 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-08-30">
 
5
<!ENTITY TIMESTAMP "2014-06-15">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
34
40
      <holder>Teddy Hogeborn</holder>
35
41
      <holder>Björn Påhlsson</holder>
36
42
    </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>
 
43
    <xi:include href="legalnotice.xml"/>
60
44
  </refentryinfo>
61
 
 
 
45
  
62
46
  <refmeta>
63
47
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
48
    <manvolnum>8</manvolnum>
70
54
      Gives encrypted passwords to authenticated Mandos clients
71
55
    </refpurpose>
72
56
  </refnamediv>
73
 
 
 
57
  
74
58
  <refsynopsisdiv>
75
59
    <cmdsynopsis>
76
60
      <command>&COMMANDNAME;</command>
105
89
      <replaceable>DIRECTORY</replaceable></option></arg>
106
90
      <sbr/>
107
91
      <arg><option>--debug</option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--debuglevel
 
94
      <replaceable>LEVEL</replaceable></option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-dbus</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-ipv6</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-restore</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--statedir
 
103
      <replaceable>DIRECTORY</replaceable></option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--socket
 
106
      <replaceable>FD</replaceable></option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--foreground</option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--no-zeroconf</option></arg>
108
111
    </cmdsynopsis>
109
112
    <cmdsynopsis>
110
113
      <command>&COMMANDNAME;</command>
111
114
      <group choice="req">
 
115
        <arg choice="plain"><option>--help</option></arg>
112
116
        <arg choice="plain"><option>-h</option></arg>
113
 
        <arg choice="plain"><option>--help</option></arg>
114
117
      </group>
115
118
    </cmdsynopsis>
116
119
    <cmdsynopsis>
122
125
      <arg choice="plain"><option>--check</option></arg>
123
126
    </cmdsynopsis>
124
127
  </refsynopsisdiv>
125
 
 
 
128
  
126
129
  <refsect1 id="description">
127
130
    <title>DESCRIPTION</title>
128
131
    <para>
129
132
      <command>&COMMANDNAME;</command> is a server daemon which
130
133
      handles incoming request for passwords for a pre-defined list of
131
 
      client host computers.  The Mandos server uses Zeroconf to
132
 
      announce itself on the local network, and uses TLS to
133
 
      communicate securely with and to authenticate the clients.  The
134
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
135
 
      link-local addresses, since the clients will probably not have
136
 
      any other addresses configured (see <xref linkend="overview"/>).
137
 
      Any authenticated client is then given the stored pre-encrypted
138
 
      password for that specific client.
 
134
      client host computers. For an introduction, see
 
135
      <citerefentry><refentrytitle>intro</refentrytitle>
 
136
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
137
      uses Zeroconf to announce itself on the local network, and uses
 
138
      TLS to communicate securely with and to authenticate the
 
139
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
140
      use IPv6 link-local addresses, since the clients will probably
 
141
      not have any other addresses configured (see <xref
 
142
      linkend="overview"/>).  Any authenticated client is then given
 
143
      the stored pre-encrypted password for that specific client.
139
144
    </para>
140
 
 
141
145
  </refsect1>
142
146
  
143
147
  <refsect1 id="purpose">
144
148
    <title>PURPOSE</title>
145
 
 
146
149
    <para>
147
150
      The purpose of this is to enable <emphasis>remote and unattended
148
151
      rebooting</emphasis> of client host computer with an
149
152
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
153
      linkend="overview"/> for details.
151
154
    </para>
152
 
 
153
155
  </refsect1>
154
156
  
155
157
  <refsect1 id="options">
156
158
    <title>OPTIONS</title>
157
 
 
158
159
    <variablelist>
159
160
      <varlistentry>
 
161
        <term><option>--help</option></term>
160
162
        <term><option>-h</option></term>
161
 
        <term><option>--help</option></term>
162
163
        <listitem>
163
164
          <para>
164
165
            Show a help message and exit
165
166
          </para>
166
167
        </listitem>
167
168
      </varlistentry>
168
 
 
 
169
      
169
170
      <varlistentry>
 
171
        <term><option>--interface</option>
 
172
        <replaceable>NAME</replaceable></term>
170
173
        <term><option>-i</option>
171
174
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>--interface</option>
173
 
        <replaceable>NAME</replaceable></term>
174
175
        <listitem>
175
176
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
177
        </listitem>
177
178
      </varlistentry>
178
 
 
 
179
      
179
180
      <varlistentry>
180
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
181
 
        ADDRESS</replaceable></literal></term>
 
181
        <term><option>--address
 
182
        <replaceable>ADDRESS</replaceable></option></term>
 
183
        <term><option>-a
 
184
        <replaceable>ADDRESS</replaceable></option></term>
182
185
        <listitem>
183
186
          <xi:include href="mandos-options.xml" xpointer="address"/>
184
187
        </listitem>
185
188
      </varlistentry>
186
 
 
 
189
      
187
190
      <varlistentry>
188
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
189
 
        PORT</replaceable></literal></term>
 
191
        <term><option>--port
 
192
        <replaceable>PORT</replaceable></option></term>
 
193
        <term><option>-p
 
194
        <replaceable>PORT</replaceable></option></term>
190
195
        <listitem>
191
196
          <xi:include href="mandos-options.xml" xpointer="port"/>
192
197
        </listitem>
193
198
      </varlistentry>
194
 
 
 
199
      
195
200
      <varlistentry>
196
 
        <term><literal>--check</literal></term>
 
201
        <term><option>--check</option></term>
197
202
        <listitem>
198
203
          <para>
199
204
            Run the server’s self-tests.  This includes any unit
201
206
          </para>
202
207
        </listitem>
203
208
      </varlistentry>
204
 
 
 
209
      
205
210
      <varlistentry>
206
 
        <term><literal>--debug</literal></term>
 
211
        <term><option>--debug</option></term>
207
212
        <listitem>
208
213
          <xi:include href="mandos-options.xml" xpointer="debug"/>
209
214
        </listitem>
210
215
      </varlistentry>
211
 
 
212
 
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        PRIORITY</replaceable></literal></term>
215
 
        <listitem>
216
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
217
 
        </listitem>
218
 
      </varlistentry>
219
 
 
220
 
      <varlistentry>
221
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
222
 
        </literal></term>
 
216
      
 
217
      <varlistentry>
 
218
        <term><option>--debuglevel
 
219
        <replaceable>LEVEL</replaceable></option></term>
 
220
        <listitem>
 
221
          <para>
 
222
            Set the debugging log level.
 
223
            <replaceable>LEVEL</replaceable> is a string, one of
 
224
            <quote><literal>CRITICAL</literal></quote>,
 
225
            <quote><literal>ERROR</literal></quote>,
 
226
            <quote><literal>WARNING</literal></quote>,
 
227
            <quote><literal>INFO</literal></quote>, or
 
228
            <quote><literal>DEBUG</literal></quote>, in order of
 
229
            increasing verbosity.  The default level is
 
230
            <quote><literal>WARNING</literal></quote>.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>
 
234
      
 
235
      <varlistentry>
 
236
        <term><option>--priority <replaceable>
 
237
        PRIORITY</replaceable></option></term>
 
238
        <listitem>
 
239
          <xi:include href="mandos-options.xml"
 
240
                      xpointer="priority_compat"/>
 
241
        </listitem>
 
242
      </varlistentry>
 
243
      
 
244
      <varlistentry>
 
245
        <term><option>--servicename
 
246
        <replaceable>NAME</replaceable></option></term>
223
247
        <listitem>
224
248
          <xi:include href="mandos-options.xml"
225
249
                      xpointer="servicename"/>
226
250
        </listitem>
227
251
      </varlistentry>
228
 
 
 
252
      
229
253
      <varlistentry>
230
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
231
 
        </literal></term>
 
254
        <term><option>--configdir
 
255
        <replaceable>DIRECTORY</replaceable></option></term>
232
256
        <listitem>
233
257
          <para>
234
258
            Directory to search for configuration files.  Default is
240
264
          </para>
241
265
        </listitem>
242
266
      </varlistentry>
243
 
 
 
267
      
244
268
      <varlistentry>
245
 
        <term><literal>--version</literal></term>
 
269
        <term><option>--version</option></term>
246
270
        <listitem>
247
271
          <para>
248
272
            Prints the program version and exit.
249
273
          </para>
250
274
        </listitem>
251
275
      </varlistentry>
 
276
      
 
277
      <varlistentry>
 
278
        <term><option>--no-dbus</option></term>
 
279
        <listitem>
 
280
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
281
          <para>
 
282
            See also <xref linkend="dbus_interface"/>.
 
283
          </para>
 
284
        </listitem>
 
285
      </varlistentry>
 
286
      
 
287
      <varlistentry>
 
288
        <term><option>--no-ipv6</option></term>
 
289
        <listitem>
 
290
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
291
        </listitem>
 
292
      </varlistentry>
 
293
      
 
294
      <varlistentry>
 
295
        <term><option>--no-restore</option></term>
 
296
        <listitem>
 
297
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
298
          <para>
 
299
            See also <xref linkend="persistent_state"/>.
 
300
          </para>
 
301
        </listitem>
 
302
      </varlistentry>
 
303
      
 
304
      <varlistentry>
 
305
        <term><option>--statedir
 
306
        <replaceable>DIRECTORY</replaceable></option></term>
 
307
        <listitem>
 
308
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
309
        </listitem>
 
310
      </varlistentry>
 
311
      
 
312
      <varlistentry>
 
313
        <term><option>--socket
 
314
        <replaceable>FD</replaceable></option></term>
 
315
        <listitem>
 
316
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      
 
320
      <varlistentry>
 
321
        <term><option>--foreground</option></term>
 
322
        <listitem>
 
323
          <xi:include href="mandos-options.xml"
 
324
                      xpointer="foreground"/>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
      
 
328
      <varlistentry>
 
329
        <term><option>--no-zeroconf</option></term>
 
330
        <listitem>
 
331
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
332
        </listitem>
 
333
      </varlistentry>
 
334
      
252
335
    </variablelist>
253
336
  </refsect1>
254
 
 
 
337
  
255
338
  <refsect1 id="overview">
256
339
    <title>OVERVIEW</title>
257
340
    <xi:include href="overview.xml"/>
258
341
    <para>
259
342
      This program is the server part.  It is a normal server program
260
343
      and will run in a normal system environment, not in an initial
261
 
      RAM disk environment.
 
344
      <acronym>RAM</acronym> disk environment.
262
345
    </para>
263
346
  </refsect1>
264
 
 
 
347
  
265
348
  <refsect1 id="protocol">
266
349
    <title>NETWORK PROTOCOL</title>
267
350
    <para>
319
402
      </row>
320
403
    </tbody></tgroup></table>
321
404
  </refsect1>
322
 
 
 
405
  
323
406
  <refsect1 id="checking">
324
407
    <title>CHECKING</title>
325
408
    <para>
326
409
      The server will, by default, continually check that the clients
327
410
      are still up.  If a client has not been confirmed as being up
328
411
      for some time, the client is assumed to be compromised and is no
329
 
      longer eligible to receive the encrypted password.  The timeout,
330
 
      checker program, and interval between checks can be configured
331
 
      both globally and per client; see <citerefentry>
 
412
      longer eligible to receive the encrypted password.  (Manual
 
413
      intervention is required to re-enable a client.)  The timeout,
 
414
      extended timeout, checker program, and interval between checks
 
415
      can be configured both globally and per client; see
 
416
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
417
      <manvolnum>5</manvolnum></citerefentry>.
 
418
    </para>
 
419
  </refsect1>
 
420
  
 
421
  <refsect1 id="approval">
 
422
    <title>APPROVAL</title>
 
423
    <para>
 
424
      The server can be configured to require manual approval for a
 
425
      client before it is sent its secret.  The delay to wait for such
 
426
      approval and the default action (approve or deny) can be
 
427
      configured both globally and per client; see <citerefentry>
332
428
      <refentrytitle>mandos-clients.conf</refentrytitle>
333
 
      <manvolnum>5</manvolnum></citerefentry>.
334
 
    </para>
 
429
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
430
      will be approved immediately without delay.
 
431
    </para>
 
432
    <para>
 
433
      This can be used to deny a client its secret if not manually
 
434
      approved within a specified time.  It can also be used to make
 
435
      the server delay before giving a client its secret, allowing
 
436
      optional manual denying of this specific client.
 
437
    </para>
 
438
    
335
439
  </refsect1>
336
 
 
 
440
  
337
441
  <refsect1 id="logging">
338
442
    <title>LOGGING</title>
339
443
    <para>
340
444
      The server will send log message with various severity levels to
341
 
      <filename>/dev/log</filename>.  With the
 
445
      <filename class="devicefile">/dev/log</filename>.  With the
342
446
      <option>--debug</option> option, it will log even more messages,
343
447
      and also show them on the console.
344
448
    </para>
345
449
  </refsect1>
346
 
 
 
450
  
 
451
  <refsect1 id="persistent_state">
 
452
    <title>PERSISTENT STATE</title>
 
453
    <para>
 
454
      Client settings, initially read from
 
455
      <filename>clients.conf</filename>, are persistent across
 
456
      restarts, and run-time changes will override settings in
 
457
      <filename>clients.conf</filename>.  However, if a setting is
 
458
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
459
      <filename>clients.conf</filename>, this will take precedence.
 
460
    </para>
 
461
  </refsect1>
 
462
  
 
463
  <refsect1 id="dbus_interface">
 
464
    <title>D-BUS INTERFACE</title>
 
465
    <para>
 
466
      The server will by default provide a D-Bus system bus interface.
 
467
      This interface will only be accessible by the root user or a
 
468
      Mandos-specific user, if such a user exists.  For documentation
 
469
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
470
    </para>
 
471
  </refsect1>
 
472
  
347
473
  <refsect1 id="exit_status">
348
474
    <title>EXIT STATUS</title>
349
475
    <para>
351
477
      critical error is encountered.
352
478
    </para>
353
479
  </refsect1>
354
 
 
 
480
  
355
481
  <refsect1 id="environment">
356
482
    <title>ENVIRONMENT</title>
357
483
    <variablelist>
371
497
      </varlistentry>
372
498
    </variablelist>
373
499
  </refsect1>
374
 
 
375
 
  <refsect1 id="file">
 
500
  
 
501
  <refsect1 id="files">
376
502
    <title>FILES</title>
377
503
    <para>
378
504
      Use the <option>--configdir</option> option to change where
401
527
        </listitem>
402
528
      </varlistentry>
403
529
      <varlistentry>
404
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
405
 
        <listitem>
406
 
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
 
530
        <term><filename>/run/mandos.pid</filename></term>
 
531
        <listitem>
 
532
          <para>
 
533
            The file containing the process id of the
 
534
            <command>&COMMANDNAME;</command> process started last.
 
535
            <emphasis >Note:</emphasis> If the <filename
 
536
            class="directory">/run</filename> directory does not
 
537
            exist, <filename>/var/run/mandos.pid</filename> will be
 
538
            used instead.
 
539
          </para>
 
540
        </listitem>
 
541
      </varlistentry>
 
542
      <varlistentry>
 
543
        <term><filename class="devicefile">/dev/log</filename></term>
 
544
      </varlistentry>
 
545
      <varlistentry>
 
546
        <term><filename
 
547
        class="directory">/var/lib/mandos</filename></term>
 
548
        <listitem>
 
549
          <para>
 
550
            Directory where persistent state will be saved.  Change
 
551
            this with the <option>--statedir</option> option.  See
 
552
            also the <option>--no-restore</option> option.
409
553
          </para>
410
554
        </listitem>
411
555
      </varlistentry>
439
583
      backtrace.  This could be considered a feature.
440
584
    </para>
441
585
    <para>
442
 
      Currently, if a client is declared <quote>invalid</quote> due to
443
 
      having timed out, the server does not record this fact onto
444
 
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="CLIENTS"/>.
446
 
    </para>
447
 
    <para>
448
 
      There is currently no way of querying the server of the current
449
 
      status of clients, other than analyzing its <systemitem
450
 
      class="service">syslog</systemitem> output.
451
 
    </para>
452
 
    <para>
453
586
      There is no fine-grained control over logging and debug output.
454
587
    </para>
455
588
    <para>
456
 
      Debug mode is conflated with running in the foreground.
457
 
    </para>
458
 
    <para>
459
 
      The console log messages does not show a timestamp.
 
589
      This server does not check the expire time of clients’ OpenPGP
 
590
      keys.
460
591
    </para>
461
592
  </refsect1>
462
593
  
473
604
    <informalexample>
474
605
      <para>
475
606
        Run the server in debug mode, read configuration files from
476
 
        the <filename>~/mandos</filename> directory, and use the
477
 
        Zeroconf service name <quote>Test</quote> to not collide with
478
 
        any other official Mandos server on this host:
 
607
        the <filename class="directory">~/mandos</filename> directory,
 
608
        and use the Zeroconf service name <quote>Test</quote> to not
 
609
        collide with any other official Mandos server on this host:
479
610
      </para>
480
611
      <para>
481
612
 
497
628
      </para>
498
629
    </informalexample>
499
630
  </refsect1>
500
 
 
 
631
  
501
632
  <refsect1 id="security">
502
633
    <title>SECURITY</title>
503
 
    <refsect2 id="SERVER">
 
634
    <refsect2 id="server">
504
635
      <title>SERVER</title>
505
636
      <para>
506
637
        Running this <command>&COMMANDNAME;</command> server program
507
638
        should not in itself present any security risk to the host
508
 
        computer running it.  The program does not need any special
509
 
        privileges to run, and is designed to run as a non-root user.
 
639
        computer running it.  The program switches to a non-root user
 
640
        soon after startup.
510
641
      </para>
511
642
    </refsect2>
512
 
    <refsect2 id="CLIENTS">
 
643
    <refsect2 id="clients">
513
644
      <title>CLIENTS</title>
514
645
      <para>
515
646
        The server only gives out its stored data to clients which
522
653
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
523
654
        <manvolnum>5</manvolnum></citerefentry>)
524
655
        <emphasis>must</emphasis> be made non-readable by anyone
525
 
        except the user running the server.
 
656
        except the user starting the server (usually root).
526
657
      </para>
527
658
      <para>
528
659
        As detailed in <xref linkend="checking"/>, the status of all
530
661
        compromised if they are gone for too long.
531
662
      </para>
532
663
      <para>
533
 
        If a client is compromised, its downtime should be duly noted
534
 
        by the server which would therefore declare the client
535
 
        invalid.  But if the server was ever restarted, it would
536
 
        re-read its client list from its configuration file and again
537
 
        regard all clients therein as valid, and hence eligible to
538
 
        receive their passwords.  Therefore, be careful when
539
 
        restarting servers if it is suspected that a client has, in
540
 
        fact, been compromised by parties who may now be running a
541
 
        fake Mandos client with the keys from the non-encrypted
542
 
        initial RAM image of the client host.  What should be done in
543
 
        that case (if restarting the server program really is
544
 
        necessary) is to stop the server program, edit the
545
 
        configuration file to omit any suspect clients, and restart
546
 
        the server program.
547
 
      </para>
548
 
      <para>
549
664
        For more details on client-side security, see
550
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
665
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
551
666
        <manvolnum>8mandos</manvolnum></citerefentry>.
552
667
      </para>
553
668
    </refsect2>
554
669
  </refsect1>
555
 
 
 
670
  
556
671
  <refsect1 id="see_also">
557
672
    <title>SEE ALSO</title>
558
673
    <para>
559
 
      <citerefentry>
560
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
561
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
 
        <refentrytitle>mandos.conf</refentrytitle>
563
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
 
        <refentrytitle>password-request</refentrytitle>
565
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
567
 
      </citerefentry>
 
674
      <citerefentry><refentrytitle>intro</refentrytitle>
 
675
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
676
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
677
      <manvolnum>5</manvolnum></citerefentry>,
 
678
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
679
      <manvolnum>5</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
681
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
682
      <citerefentry><refentrytitle>sh</refentrytitle>
 
683
      <manvolnum>1</manvolnum></citerefentry>
568
684
    </para>
569
685
    <variablelist>
570
686
      <varlistentry>