/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: 2018-02-22 14:34:19 UTC
  • Revision ID: teddy@recompile.se-20180222143419-4uh4vcpgc9hv2fzx
Check return values from newly added close() calls

* plugins.d/mandos-client.c (init_gnutls_global): Check return
  values from newly added close() calls.

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