/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-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

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 "2014-06-15">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-29">
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
 
      <year>2013</year>
40
34
      <holder>Teddy Hogeborn</holder>
41
35
      <holder>Björn Påhlsson</holder>
42
36
    </copyright>
43
 
    <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>
44
60
  </refentryinfo>
45
 
  
 
61
 
46
62
  <refmeta>
47
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
48
64
    <manvolnum>8</manvolnum>
51
67
  <refnamediv>
52
68
    <refname><command>&COMMANDNAME;</command></refname>
53
69
    <refpurpose>
54
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
55
71
    </refpurpose>
56
72
  </refnamediv>
57
 
  
 
73
 
58
74
  <refsynopsisdiv>
59
75
    <cmdsynopsis>
60
76
      <command>&COMMANDNAME;</command>
61
 
      <group>
62
 
        <arg choice="plain"><option>--interface
63
 
        <replaceable>NAME</replaceable></option></arg>
64
 
        <arg choice="plain"><option>-i
65
 
        <replaceable>NAME</replaceable></option></arg>
66
 
      </group>
67
 
      <sbr/>
68
 
      <group>
69
 
        <arg choice="plain"><option>--address
70
 
        <replaceable>ADDRESS</replaceable></option></arg>
71
 
        <arg choice="plain"><option>-a
72
 
        <replaceable>ADDRESS</replaceable></option></arg>
73
 
      </group>
74
 
      <sbr/>
75
 
      <group>
76
 
        <arg choice="plain"><option>--port
77
 
        <replaceable>PORT</replaceable></option></arg>
78
 
        <arg choice="plain"><option>-p
79
 
        <replaceable>PORT</replaceable></option></arg>
80
 
      </group>
81
 
      <sbr/>
82
 
      <arg><option>--priority
83
 
      <replaceable>PRIORITY</replaceable></option></arg>
84
 
      <sbr/>
85
 
      <arg><option>--servicename
86
 
      <replaceable>NAME</replaceable></option></arg>
87
 
      <sbr/>
88
 
      <arg><option>--configdir
89
 
      <replaceable>DIRECTORY</replaceable></option></arg>
90
 
      <sbr/>
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>
 
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>
111
94
    </cmdsynopsis>
112
95
    <cmdsynopsis>
113
96
      <command>&COMMANDNAME;</command>
114
97
      <group choice="req">
115
 
        <arg choice="plain"><option>--help</option></arg>
116
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
117
100
      </group>
118
101
    </cmdsynopsis>
119
102
    <cmdsynopsis>
120
103
      <command>&COMMANDNAME;</command>
121
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
122
105
    </cmdsynopsis>
123
106
    <cmdsynopsis>
124
107
      <command>&COMMANDNAME;</command>
125
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
126
109
    </cmdsynopsis>
127
110
  </refsynopsisdiv>
128
 
  
 
111
 
129
112
  <refsect1 id="description">
130
113
    <title>DESCRIPTION</title>
131
114
    <para>
132
115
      <command>&COMMANDNAME;</command> is a server daemon which
133
116
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
144
125
    </para>
 
126
 
145
127
  </refsect1>
146
128
  
147
129
  <refsect1 id="purpose">
148
130
    <title>PURPOSE</title>
 
131
 
149
132
    <para>
150
133
      The purpose of this is to enable <emphasis>remote and unattended
151
134
      rebooting</emphasis> of client host computer with an
152
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
153
136
      linkend="overview"/> for details.
154
137
    </para>
 
138
 
155
139
  </refsect1>
156
140
  
157
141
  <refsect1 id="options">
158
142
    <title>OPTIONS</title>
 
143
 
159
144
    <variablelist>
160
145
      <varlistentry>
161
 
        <term><option>--help</option></term>
162
 
        <term><option>-h</option></term>
 
146
        <term><literal>-h</literal>, <literal>--help</literal></term>
163
147
        <listitem>
164
148
          <para>
165
149
            Show a help message and exit
166
150
          </para>
167
151
        </listitem>
168
152
      </varlistentry>
169
 
      
 
153
 
170
154
      <varlistentry>
171
 
        <term><option>--interface</option>
172
 
        <replaceable>NAME</replaceable></term>
173
 
        <term><option>-i</option>
174
 
        <replaceable>NAME</replaceable></term>
 
155
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
156
        >NAME</replaceable></literal></term>
175
157
        <listitem>
176
158
          <xi:include href="mandos-options.xml" xpointer="interface"/>
177
159
        </listitem>
178
160
      </varlistentry>
179
 
      
 
161
 
180
162
      <varlistentry>
181
 
        <term><option>--address
182
 
        <replaceable>ADDRESS</replaceable></option></term>
183
 
        <term><option>-a
184
 
        <replaceable>ADDRESS</replaceable></option></term>
 
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
164
        ADDRESS</replaceable></literal></term>
185
165
        <listitem>
186
166
          <xi:include href="mandos-options.xml" xpointer="address"/>
187
167
        </listitem>
188
168
      </varlistentry>
189
 
      
 
169
 
190
170
      <varlistentry>
191
 
        <term><option>--port
192
 
        <replaceable>PORT</replaceable></option></term>
193
 
        <term><option>-p
194
 
        <replaceable>PORT</replaceable></option></term>
 
171
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
172
        PORT</replaceable></literal></term>
195
173
        <listitem>
196
174
          <xi:include href="mandos-options.xml" xpointer="port"/>
197
175
        </listitem>
198
176
      </varlistentry>
199
 
      
 
177
 
200
178
      <varlistentry>
201
 
        <term><option>--check</option></term>
 
179
        <term><literal>--check</literal></term>
202
180
        <listitem>
203
181
          <para>
204
182
            Run the server’s self-tests.  This includes any unit
206
184
          </para>
207
185
        </listitem>
208
186
      </varlistentry>
209
 
      
 
187
 
210
188
      <varlistentry>
211
 
        <term><option>--debug</option></term>
 
189
        <term><literal>--debug</literal></term>
212
190
        <listitem>
213
191
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
192
        </listitem>
215
193
      </varlistentry>
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>
 
194
 
 
195
      <varlistentry>
 
196
        <term><literal>--priority <replaceable>
 
197
        PRIORITY</replaceable></literal></term>
 
198
        <listitem>
 
199
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
200
        </listitem>
 
201
      </varlistentry>
 
202
 
 
203
      <varlistentry>
 
204
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
205
        </literal></term>
247
206
        <listitem>
248
207
          <xi:include href="mandos-options.xml"
249
208
                      xpointer="servicename"/>
250
209
        </listitem>
251
210
      </varlistentry>
252
 
      
 
211
 
253
212
      <varlistentry>
254
 
        <term><option>--configdir
255
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
213
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
214
        </literal></term>
256
215
        <listitem>
257
216
          <para>
258
217
            Directory to search for configuration files.  Default is
264
223
          </para>
265
224
        </listitem>
266
225
      </varlistentry>
267
 
      
 
226
 
268
227
      <varlistentry>
269
 
        <term><option>--version</option></term>
 
228
        <term><literal>--version</literal></term>
270
229
        <listitem>
271
230
          <para>
272
231
            Prints the program version and exit.
273
232
          </para>
274
233
        </listitem>
275
234
      </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
 
      
335
235
    </variablelist>
336
236
  </refsect1>
337
 
  
 
237
 
338
238
  <refsect1 id="overview">
339
239
    <title>OVERVIEW</title>
340
240
    <xi:include href="overview.xml"/>
341
241
    <para>
342
242
      This program is the server part.  It is a normal server program
343
243
      and will run in a normal system environment, not in an initial
344
 
      <acronym>RAM</acronym> disk environment.
 
244
      RAM disk environment.
345
245
    </para>
346
246
  </refsect1>
347
 
  
 
247
 
348
248
  <refsect1 id="protocol">
349
249
    <title>NETWORK PROTOCOL</title>
350
250
    <para>
402
302
      </row>
403
303
    </tbody></tgroup></table>
404
304
  </refsect1>
405
 
  
 
305
 
406
306
  <refsect1 id="checking">
407
307
    <title>CHECKING</title>
408
308
    <para>
409
309
      The server will, by default, continually check that the clients
410
310
      are still up.  If a client has not been confirmed as being up
411
311
      for some time, the client is assumed to be compromised and is no
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>
 
312
      longer eligible to receive the encrypted password.  The timeout,
 
313
      checker program, and interval between checks can be configured
 
314
      both globally and per client; see <citerefentry>
 
315
      <refentrytitle>mandos-clients.conf</refentrytitle>
417
316
      <manvolnum>5</manvolnum></citerefentry>.
418
317
    </para>
419
318
  </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>
428
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
439
 
  </refsect1>
440
 
  
 
319
 
441
320
  <refsect1 id="logging">
442
321
    <title>LOGGING</title>
443
322
    <para>
444
323
      The server will send log message with various severity levels to
445
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
324
      <filename>/dev/log</filename>.  With the
446
325
      <option>--debug</option> option, it will log even more messages,
447
326
      and also show them on the console.
448
327
    </para>
449
328
  </refsect1>
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
 
  
 
329
 
473
330
  <refsect1 id="exit_status">
474
331
    <title>EXIT STATUS</title>
475
332
    <para>
477
334
      critical error is encountered.
478
335
    </para>
479
336
  </refsect1>
480
 
  
 
337
 
481
338
  <refsect1 id="environment">
482
339
    <title>ENVIRONMENT</title>
483
340
    <variablelist>
484
341
      <varlistentry>
485
 
        <term><envar>PATH</envar></term>
 
342
        <term><varname>PATH</varname></term>
486
343
        <listitem>
487
344
          <para>
488
345
            To start the configured checker (see <xref
497
354
      </varlistentry>
498
355
    </variablelist>
499
356
  </refsect1>
500
 
  
501
 
  <refsect1 id="files">
 
357
 
 
358
  <refsect1 id="file">
502
359
    <title>FILES</title>
503
360
    <para>
504
361
      Use the <option>--configdir</option> option to change where
527
384
        </listitem>
528
385
      </varlistentry>
529
386
      <varlistentry>
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.
 
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>.
553
392
          </para>
554
393
        </listitem>
555
394
      </varlistentry>
583
422
      backtrace.  This could be considered a feature.
584
423
    </para>
585
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>
586
436
      There is no fine-grained control over logging and debug output.
587
437
    </para>
588
438
    <para>
589
 
      This server does not check the expire time of clients’ OpenPGP
590
 
      keys.
 
439
      Debug mode is conflated with running in the foreground.
 
440
    </para>
 
441
    <para>
 
442
      The console log messages does not show a timestamp.
591
443
    </para>
592
444
  </refsect1>
593
445
  
604
456
    <informalexample>
605
457
      <para>
606
458
        Run the server in debug mode, read configuration files from
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:
 
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:
610
462
      </para>
611
463
      <para>
612
464
 
628
480
      </para>
629
481
    </informalexample>
630
482
  </refsect1>
631
 
  
 
483
 
632
484
  <refsect1 id="security">
633
485
    <title>SECURITY</title>
634
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
635
487
      <title>SERVER</title>
636
488
      <para>
637
489
        Running this <command>&COMMANDNAME;</command> server program
638
490
        should not in itself present any security risk to the host
639
 
        computer running it.  The program switches to a non-root user
640
 
        soon after startup.
 
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.
641
493
      </para>
642
494
    </refsect2>
643
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
644
496
      <title>CLIENTS</title>
645
497
      <para>
646
498
        The server only gives out its stored data to clients which
653
505
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
654
506
        <manvolnum>5</manvolnum></citerefentry>)
655
507
        <emphasis>must</emphasis> be made non-readable by anyone
656
 
        except the user starting the server (usually root).
 
508
        except the user running the server.
657
509
      </para>
658
510
      <para>
659
511
        As detailed in <xref linkend="checking"/>, the status of all
661
513
        compromised if they are gone for too long.
662
514
      </para>
663
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>
664
532
        For more details on client-side security, see
665
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
        <citerefentry><refentrytitle>password-request</refentrytitle>
666
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
667
535
      </para>
668
536
    </refsect2>
669
537
  </refsect1>
670
 
  
 
538
 
671
539
  <refsect1 id="see_also">
672
540
    <title>SEE ALSO</title>
673
541
    <para>
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>
 
542
      <citerefentry>
 
543
        <refentrytitle>mandos.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>password-request</refentrytitle>
 
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
550
      </citerefentry>
684
551
    </para>
685
552
    <variablelist>
686
553
      <varlistentry>