/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 17:16:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830171633-rjyuhsemikw6lg2w
* mandos-keygen.xml (SYNOPSIS): Fixed tags.  Unify short and long
                                options.
* plugins.d/password-request.xml (SYNOPSIS): - '' -

* mandos-clients.conf.xml: Removed extra white space.
* plugin-runner.xml: - '' -
* plugins.d/password-prompt.xml: - '' -
* mandos-keygen.xml: - '' -
* plugins.d/password-request.xml: - '' -

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