/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-12-03 21:06:34 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 329.
  • Revision ID: teddy@recompile.se-20151203210634-5dcyccalld40cygn
http://bugs.debian.org/806073
* debian/rules (override_dh_fixperms): Split into
                                       "override_dh_fixperms-arch" and
                                       "override_dh_fixperms-indep".
                                       Fixes Debian bug #806073.

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-29">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
 
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>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
34
42
      <holder>Teddy Hogeborn</holder>
35
43
      <holder>Björn Påhlsson</holder>
36
44
    </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>
 
45
    <xi:include href="legalnotice.xml"/>
60
46
  </refentryinfo>
61
 
 
 
47
  
62
48
  <refmeta>
63
49
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
50
    <manvolnum>8</manvolnum>
67
53
  <refnamediv>
68
54
    <refname><command>&COMMANDNAME;</command></refname>
69
55
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
56
      Gives encrypted passwords to authenticated Mandos clients
71
57
    </refpurpose>
72
58
  </refnamediv>
73
 
 
 
59
  
74
60
  <refsynopsisdiv>
75
61
    <cmdsynopsis>
76
62
      <command>&COMMANDNAME;</command>
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>
 
63
      <group>
 
64
        <arg choice="plain"><option>--interface
 
65
        <replaceable>NAME</replaceable></option></arg>
 
66
        <arg choice="plain"><option>-i
 
67
        <replaceable>NAME</replaceable></option></arg>
 
68
      </group>
 
69
      <sbr/>
 
70
      <group>
 
71
        <arg choice="plain"><option>--address
 
72
        <replaceable>ADDRESS</replaceable></option></arg>
 
73
        <arg choice="plain"><option>-a
 
74
        <replaceable>ADDRESS</replaceable></option></arg>
 
75
      </group>
 
76
      <sbr/>
 
77
      <group>
 
78
        <arg choice="plain"><option>--port
 
79
        <replaceable>PORT</replaceable></option></arg>
 
80
        <arg choice="plain"><option>-p
 
81
        <replaceable>PORT</replaceable></option></arg>
 
82
      </group>
 
83
      <sbr/>
 
84
      <arg><option>--priority
 
85
      <replaceable>PRIORITY</replaceable></option></arg>
 
86
      <sbr/>
 
87
      <arg><option>--servicename
 
88
      <replaceable>NAME</replaceable></option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--configdir
 
91
      <replaceable>DIRECTORY</replaceable></option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--debug</option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--debuglevel
 
96
      <replaceable>LEVEL</replaceable></option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-dbus</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-ipv6</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--no-restore</option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--statedir
 
105
      <replaceable>DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--socket
 
108
      <replaceable>FD</replaceable></option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--foreground</option></arg>
 
111
      <sbr/>
 
112
      <arg><option>--no-zeroconf</option></arg>
94
113
    </cmdsynopsis>
95
114
    <cmdsynopsis>
96
115
      <command>&COMMANDNAME;</command>
97
116
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
117
        <arg choice="plain"><option>--help</option></arg>
 
118
        <arg choice="plain"><option>-h</option></arg>
100
119
      </group>
101
120
    </cmdsynopsis>
102
121
    <cmdsynopsis>
103
122
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
123
      <arg choice="plain"><option>--version</option></arg>
105
124
    </cmdsynopsis>
106
125
    <cmdsynopsis>
107
126
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
127
      <arg choice="plain"><option>--check</option></arg>
109
128
    </cmdsynopsis>
110
129
  </refsynopsisdiv>
111
 
 
 
130
  
112
131
  <refsect1 id="description">
113
132
    <title>DESCRIPTION</title>
114
133
    <para>
115
134
      <command>&COMMANDNAME;</command> is a server daemon which
116
135
      handles incoming request for passwords for a pre-defined list of
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.
 
136
      client host computers. For an introduction, see
 
137
      <citerefentry><refentrytitle>intro</refentrytitle>
 
138
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
139
      uses Zeroconf to announce itself on the local network, and uses
 
140
      TLS to communicate securely with and to authenticate the
 
141
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
142
      use IPv6 link-local addresses, since the clients will probably
 
143
      not have any other addresses configured (see <xref
 
144
      linkend="overview"/>).  Any authenticated client is then given
 
145
      the stored pre-encrypted password for that specific client.
125
146
    </para>
126
 
 
127
147
  </refsect1>
128
148
  
129
149
  <refsect1 id="purpose">
130
150
    <title>PURPOSE</title>
131
 
 
132
151
    <para>
133
152
      The purpose of this is to enable <emphasis>remote and unattended
134
153
      rebooting</emphasis> of client host computer with an
135
154
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
155
      linkend="overview"/> for details.
137
156
    </para>
138
 
 
139
157
  </refsect1>
140
158
  
141
159
  <refsect1 id="options">
142
160
    <title>OPTIONS</title>
143
 
 
144
161
    <variablelist>
145
162
      <varlistentry>
146
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
163
        <term><option>--help</option></term>
 
164
        <term><option>-h</option></term>
147
165
        <listitem>
148
166
          <para>
149
167
            Show a help message and exit
150
168
          </para>
151
169
        </listitem>
152
170
      </varlistentry>
153
 
 
 
171
      
154
172
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
173
        <term><option>--interface</option>
 
174
        <replaceable>NAME</replaceable></term>
 
175
        <term><option>-i</option>
 
176
        <replaceable>NAME</replaceable></term>
157
177
        <listitem>
158
178
          <xi:include href="mandos-options.xml" xpointer="interface"/>
159
179
        </listitem>
160
180
      </varlistentry>
161
 
 
 
181
      
162
182
      <varlistentry>
163
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
 
        ADDRESS</replaceable></literal></term>
 
183
        <term><option>--address
 
184
        <replaceable>ADDRESS</replaceable></option></term>
 
185
        <term><option>-a
 
186
        <replaceable>ADDRESS</replaceable></option></term>
165
187
        <listitem>
166
188
          <xi:include href="mandos-options.xml" xpointer="address"/>
167
189
        </listitem>
168
190
      </varlistentry>
169
 
 
 
191
      
170
192
      <varlistentry>
171
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
172
 
        PORT</replaceable></literal></term>
 
193
        <term><option>--port
 
194
        <replaceable>PORT</replaceable></option></term>
 
195
        <term><option>-p
 
196
        <replaceable>PORT</replaceable></option></term>
173
197
        <listitem>
174
198
          <xi:include href="mandos-options.xml" xpointer="port"/>
175
199
        </listitem>
176
200
      </varlistentry>
177
 
 
 
201
      
178
202
      <varlistentry>
179
 
        <term><literal>--check</literal></term>
 
203
        <term><option>--check</option></term>
180
204
        <listitem>
181
205
          <para>
182
206
            Run the server’s self-tests.  This includes any unit
184
208
          </para>
185
209
        </listitem>
186
210
      </varlistentry>
187
 
 
 
211
      
188
212
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
213
        <term><option>--debug</option></term>
190
214
        <listitem>
191
215
          <xi:include href="mandos-options.xml" xpointer="debug"/>
192
216
        </listitem>
193
217
      </varlistentry>
194
 
 
195
 
      <varlistentry>
196
 
        <term><literal>--priority <replaceable>
197
 
        PRIORITY</replaceable></literal></term>
 
218
      
 
219
      <varlistentry>
 
220
        <term><option>--debuglevel
 
221
        <replaceable>LEVEL</replaceable></option></term>
 
222
        <listitem>
 
223
          <para>
 
224
            Set the debugging log level.
 
225
            <replaceable>LEVEL</replaceable> is a string, one of
 
226
            <quote><literal>CRITICAL</literal></quote>,
 
227
            <quote><literal>ERROR</literal></quote>,
 
228
            <quote><literal>WARNING</literal></quote>,
 
229
            <quote><literal>INFO</literal></quote>, or
 
230
            <quote><literal>DEBUG</literal></quote>, in order of
 
231
            increasing verbosity.  The default level is
 
232
            <quote><literal>WARNING</literal></quote>.
 
233
          </para>
 
234
        </listitem>
 
235
      </varlistentry>
 
236
      
 
237
      <varlistentry>
 
238
        <term><option>--priority <replaceable>
 
239
        PRIORITY</replaceable></option></term>
198
240
        <listitem>
199
241
          <xi:include href="mandos-options.xml" xpointer="priority"/>
200
242
        </listitem>
201
243
      </varlistentry>
202
 
 
 
244
      
203
245
      <varlistentry>
204
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
205
 
        </literal></term>
 
246
        <term><option>--servicename
 
247
        <replaceable>NAME</replaceable></option></term>
206
248
        <listitem>
207
249
          <xi:include href="mandos-options.xml"
208
250
                      xpointer="servicename"/>
209
251
        </listitem>
210
252
      </varlistentry>
211
 
 
 
253
      
212
254
      <varlistentry>
213
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
214
 
        </literal></term>
 
255
        <term><option>--configdir
 
256
        <replaceable>DIRECTORY</replaceable></option></term>
215
257
        <listitem>
216
258
          <para>
217
259
            Directory to search for configuration files.  Default is
223
265
          </para>
224
266
        </listitem>
225
267
      </varlistentry>
226
 
 
 
268
      
227
269
      <varlistentry>
228
 
        <term><literal>--version</literal></term>
 
270
        <term><option>--version</option></term>
229
271
        <listitem>
230
272
          <para>
231
273
            Prints the program version and exit.
232
274
          </para>
233
275
        </listitem>
234
276
      </varlistentry>
 
277
      
 
278
      <varlistentry>
 
279
        <term><option>--no-dbus</option></term>
 
280
        <listitem>
 
281
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
282
          <para>
 
283
            See also <xref linkend="dbus_interface"/>.
 
284
          </para>
 
285
        </listitem>
 
286
      </varlistentry>
 
287
      
 
288
      <varlistentry>
 
289
        <term><option>--no-ipv6</option></term>
 
290
        <listitem>
 
291
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--no-restore</option></term>
 
297
        <listitem>
 
298
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
299
          <para>
 
300
            See also <xref linkend="persistent_state"/>.
 
301
          </para>
 
302
        </listitem>
 
303
      </varlistentry>
 
304
      
 
305
      <varlistentry>
 
306
        <term><option>--statedir
 
307
        <replaceable>DIRECTORY</replaceable></option></term>
 
308
        <listitem>
 
309
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
310
        </listitem>
 
311
      </varlistentry>
 
312
      
 
313
      <varlistentry>
 
314
        <term><option>--socket
 
315
        <replaceable>FD</replaceable></option></term>
 
316
        <listitem>
 
317
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
318
        </listitem>
 
319
      </varlistentry>
 
320
      
 
321
      <varlistentry>
 
322
        <term><option>--foreground</option></term>
 
323
        <listitem>
 
324
          <xi:include href="mandos-options.xml"
 
325
                      xpointer="foreground"/>
 
326
        </listitem>
 
327
      </varlistentry>
 
328
      
 
329
      <varlistentry>
 
330
        <term><option>--no-zeroconf</option></term>
 
331
        <listitem>
 
332
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
333
        </listitem>
 
334
      </varlistentry>
 
335
      
235
336
    </variablelist>
236
337
  </refsect1>
237
 
 
 
338
  
238
339
  <refsect1 id="overview">
239
340
    <title>OVERVIEW</title>
240
341
    <xi:include href="overview.xml"/>
241
342
    <para>
242
343
      This program is the server part.  It is a normal server program
243
344
      and will run in a normal system environment, not in an initial
244
 
      RAM disk environment.
 
345
      <acronym>RAM</acronym> disk environment.
245
346
    </para>
246
347
  </refsect1>
247
 
 
 
348
  
248
349
  <refsect1 id="protocol">
249
350
    <title>NETWORK PROTOCOL</title>
250
351
    <para>
302
403
      </row>
303
404
    </tbody></tgroup></table>
304
405
  </refsect1>
305
 
 
 
406
  
306
407
  <refsect1 id="checking">
307
408
    <title>CHECKING</title>
308
409
    <para>
309
410
      The server will, by default, continually check that the clients
310
411
      are still up.  If a client has not been confirmed as being up
311
412
      for some time, the client is assumed to be compromised and is no
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>
 
413
      longer eligible to receive the encrypted password.  (Manual
 
414
      intervention is required to re-enable a client.)  The timeout,
 
415
      extended timeout, checker program, and interval between checks
 
416
      can be configured both globally and per client; see
 
417
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
418
      <manvolnum>5</manvolnum></citerefentry>.
 
419
    </para>
 
420
  </refsect1>
 
421
  
 
422
  <refsect1 id="approval">
 
423
    <title>APPROVAL</title>
 
424
    <para>
 
425
      The server can be configured to require manual approval for a
 
426
      client before it is sent its secret.  The delay to wait for such
 
427
      approval and the default action (approve or deny) can be
 
428
      configured both globally and per client; see <citerefentry>
315
429
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
 
      <manvolnum>5</manvolnum></citerefentry>.
317
 
    </para>
 
430
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
431
      will be approved immediately without delay.
 
432
    </para>
 
433
    <para>
 
434
      This can be used to deny a client its secret if not manually
 
435
      approved within a specified time.  It can also be used to make
 
436
      the server delay before giving a client its secret, allowing
 
437
      optional manual denying of this specific client.
 
438
    </para>
 
439
    
318
440
  </refsect1>
319
 
 
 
441
  
320
442
  <refsect1 id="logging">
321
443
    <title>LOGGING</title>
322
444
    <para>
323
445
      The server will send log message with various severity levels to
324
 
      <filename>/dev/log</filename>.  With the
 
446
      <filename class="devicefile">/dev/log</filename>.  With the
325
447
      <option>--debug</option> option, it will log even more messages,
326
448
      and also show them on the console.
327
449
    </para>
328
450
  </refsect1>
329
 
 
 
451
  
 
452
  <refsect1 id="persistent_state">
 
453
    <title>PERSISTENT STATE</title>
 
454
    <para>
 
455
      Client settings, initially read from
 
456
      <filename>clients.conf</filename>, are persistent across
 
457
      restarts, and run-time changes will override settings in
 
458
      <filename>clients.conf</filename>.  However, if a setting is
 
459
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
460
      <filename>clients.conf</filename>, this will take precedence.
 
461
    </para>
 
462
  </refsect1>
 
463
  
 
464
  <refsect1 id="dbus_interface">
 
465
    <title>D-BUS INTERFACE</title>
 
466
    <para>
 
467
      The server will by default provide a D-Bus system bus interface.
 
468
      This interface will only be accessible by the root user or a
 
469
      Mandos-specific user, if such a user exists.  For documentation
 
470
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
471
    </para>
 
472
  </refsect1>
 
473
  
330
474
  <refsect1 id="exit_status">
331
475
    <title>EXIT STATUS</title>
332
476
    <para>
334
478
      critical error is encountered.
335
479
    </para>
336
480
  </refsect1>
337
 
 
 
481
  
338
482
  <refsect1 id="environment">
339
483
    <title>ENVIRONMENT</title>
340
484
    <variablelist>
341
485
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
486
        <term><envar>PATH</envar></term>
343
487
        <listitem>
344
488
          <para>
345
489
            To start the configured checker (see <xref
354
498
      </varlistentry>
355
499
    </variablelist>
356
500
  </refsect1>
357
 
 
358
 
  <refsect1 id="file">
 
501
  
 
502
  <refsect1 id="files">
359
503
    <title>FILES</title>
360
504
    <para>
361
505
      Use the <option>--configdir</option> option to change where
384
528
        </listitem>
385
529
      </varlistentry>
386
530
      <varlistentry>
387
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
388
 
        <listitem>
389
 
          <para>
390
 
            The file containing the process id of
391
 
            <command>&COMMANDNAME;</command>.
 
531
        <term><filename>/run/mandos.pid</filename></term>
 
532
        <listitem>
 
533
          <para>
 
534
            The file containing the process id of the
 
535
            <command>&COMMANDNAME;</command> process started last.
 
536
            <emphasis >Note:</emphasis> If the <filename
 
537
            class="directory">/run</filename> directory does not
 
538
            exist, <filename>/var/run/mandos.pid</filename> will be
 
539
            used instead.
 
540
          </para>
 
541
        </listitem>
 
542
      </varlistentry>
 
543
      <varlistentry>
 
544
        <term><filename class="devicefile">/dev/log</filename></term>
 
545
      </varlistentry>
 
546
      <varlistentry>
 
547
        <term><filename
 
548
        class="directory">/var/lib/mandos</filename></term>
 
549
        <listitem>
 
550
          <para>
 
551
            Directory where persistent state will be saved.  Change
 
552
            this with the <option>--statedir</option> option.  See
 
553
            also the <option>--no-restore</option> option.
392
554
          </para>
393
555
        </listitem>
394
556
      </varlistentry>
422
584
      backtrace.  This could be considered a feature.
423
585
    </para>
424
586
    <para>
425
 
      Currently, if a client is declared <quote>invalid</quote> due to
426
 
      having timed out, the server does not record this fact onto
427
 
      permanent storage.  This has some security implications, see
428
 
      <xref linkend="CLIENTS"/>.
429
 
    </para>
430
 
    <para>
431
 
      There is currently no way of querying the server of the current
432
 
      status of clients, other than analyzing its <systemitem
433
 
      class="service">syslog</systemitem> output.
434
 
    </para>
435
 
    <para>
436
587
      There is no fine-grained control over logging and debug output.
437
588
    </para>
438
589
    <para>
439
 
      Debug mode is conflated with running in the foreground.
440
 
    </para>
441
 
    <para>
442
 
      The console log messages does not show a timestamp.
 
590
      This server does not check the expire time of clients’ OpenPGP
 
591
      keys.
443
592
    </para>
444
593
  </refsect1>
445
594
  
456
605
    <informalexample>
457
606
      <para>
458
607
        Run the server in debug mode, read configuration files from
459
 
        the <filename>~/mandos</filename> directory, and use the
460
 
        Zeroconf service name <quote>Test</quote> to not collide with
461
 
        any other official Mandos server on this host:
 
608
        the <filename class="directory">~/mandos</filename> directory,
 
609
        and use the Zeroconf service name <quote>Test</quote> to not
 
610
        collide with any other official Mandos server on this host:
462
611
      </para>
463
612
      <para>
464
613
 
480
629
      </para>
481
630
    </informalexample>
482
631
  </refsect1>
483
 
 
 
632
  
484
633
  <refsect1 id="security">
485
634
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
635
    <refsect2 id="server">
487
636
      <title>SERVER</title>
488
637
      <para>
489
638
        Running this <command>&COMMANDNAME;</command> server program
490
639
        should not in itself present any security risk to the host
491
 
        computer running it.  The program does not need any special
492
 
        privileges to run, and is designed to run as a non-root user.
 
640
        computer running it.  The program switches to a non-root user
 
641
        soon after startup.
493
642
      </para>
494
643
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
644
    <refsect2 id="clients">
496
645
      <title>CLIENTS</title>
497
646
      <para>
498
647
        The server only gives out its stored data to clients which
505
654
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
655
        <manvolnum>5</manvolnum></citerefentry>)
507
656
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user running the server.
 
657
        except the user starting the server (usually root).
509
658
      </para>
510
659
      <para>
511
660
        As detailed in <xref linkend="checking"/>, the status of all
513
662
        compromised if they are gone for too long.
514
663
      </para>
515
664
      <para>
516
 
        If a client is compromised, its downtime should be duly noted
517
 
        by the server which would therefore declare the client
518
 
        invalid.  But if the server was ever restarted, it would
519
 
        re-read its client list from its configuration file and again
520
 
        regard all clients therein as valid, and hence eligible to
521
 
        receive their passwords.  Therefore, be careful when
522
 
        restarting servers if it is suspected that a client has, in
523
 
        fact, been compromised by parties who may now be running a
524
 
        fake Mandos client with the keys from the non-encrypted
525
 
        initial RAM image of the client host.  What should be done in
526
 
        that case (if restarting the server program really is
527
 
        necessary) is to stop the server program, edit the
528
 
        configuration file to omit any suspect clients, and restart
529
 
        the server program.
530
 
      </para>
531
 
      <para>
532
665
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
666
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
667
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
668
      </para>
536
669
    </refsect2>
537
670
  </refsect1>
538
 
 
 
671
  
539
672
  <refsect1 id="see_also">
540
673
    <title>SEE ALSO</title>
541
674
    <para>
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>
 
675
      <citerefentry><refentrytitle>intro</refentrytitle>
 
676
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
677
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
678
      <manvolnum>5</manvolnum></citerefentry>,
 
679
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
680
      <manvolnum>5</manvolnum></citerefentry>,
 
681
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
682
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
683
      <citerefentry><refentrytitle>sh</refentrytitle>
 
684
      <manvolnum>1</manvolnum></citerefentry>
551
685
    </para>
552
686
    <variablelist>
553
687
      <varlistentry>
574
708
      </varlistentry>
575
709
      <varlistentry>
576
710
        <term>
577
 
          <ulink url="http://www.gnu.org/software/gnutls/"
578
 
          >GnuTLS</ulink>
 
711
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
579
712
        </term>
580
713
      <listitem>
581
714
        <para>
619
752
      </varlistentry>
620
753
      <varlistentry>
621
754
        <term>
622
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
 
          Protocol Version 1.1</citetitle>
 
755
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
624
757
        </term>
625
758
      <listitem>
626
759
        <para>
627
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
628
761
        </para>
629
762
      </listitem>
630
763
      </varlistentry>
640
773
      </varlistentry>
641
774
      <varlistentry>
642
775
        <term>
643
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
644
 
          Security</citetitle>
 
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</citetitle>
645
778
        </term>
646
779
      <listitem>
647
780
        <para>