/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-08 10:23:55 UTC
  • Revision ID: teddy@recompile.se-20180208102355-3ent7sf87i9h9kka
Update copyright year to 2018

* DBUS-API: Update copyright year to 2018.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* network-hooks.d/bridge: - '' -
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.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">
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>
105
94
      <replaceable>DIRECTORY</replaceable></option></arg>
106
95
      <sbr/>
107
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>
108
116
    </cmdsynopsis>
109
117
    <cmdsynopsis>
110
118
      <command>&COMMANDNAME;</command>
111
119
      <group choice="req">
 
120
        <arg choice="plain"><option>--help</option></arg>
112
121
        <arg choice="plain"><option>-h</option></arg>
113
 
        <arg choice="plain"><option>--help</option></arg>
114
122
      </group>
115
123
    </cmdsynopsis>
116
124
    <cmdsynopsis>
122
130
      <arg choice="plain"><option>--check</option></arg>
123
131
    </cmdsynopsis>
124
132
  </refsynopsisdiv>
125
 
 
 
133
  
126
134
  <refsect1 id="description">
127
135
    <title>DESCRIPTION</title>
128
136
    <para>
129
137
      <command>&COMMANDNAME;</command> is a server daemon which
130
138
      handles incoming request for passwords for a pre-defined list of
131
 
      client host computers.  The Mandos server uses Zeroconf to
132
 
      announce itself on the local network, and uses TLS to
133
 
      communicate securely with and to authenticate the clients.  The
134
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
135
 
      link-local addresses, since the clients will probably not have
136
 
      any other addresses configured (see <xref linkend="overview"/>).
137
 
      Any authenticated client is then given the stored pre-encrypted
138
 
      password for that specific client.
 
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.
139
149
    </para>
140
 
 
141
150
  </refsect1>
142
151
  
143
152
  <refsect1 id="purpose">
144
153
    <title>PURPOSE</title>
145
 
 
146
154
    <para>
147
155
      The purpose of this is to enable <emphasis>remote and unattended
148
156
      rebooting</emphasis> of client host computer with an
149
157
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
158
      linkend="overview"/> for details.
151
159
    </para>
152
 
 
153
160
  </refsect1>
154
161
  
155
162
  <refsect1 id="options">
156
163
    <title>OPTIONS</title>
157
 
 
158
164
    <variablelist>
159
165
      <varlistentry>
 
166
        <term><option>--help</option></term>
160
167
        <term><option>-h</option></term>
161
 
        <term><option>--help</option></term>
162
168
        <listitem>
163
169
          <para>
164
170
            Show a help message and exit
165
171
          </para>
166
172
        </listitem>
167
173
      </varlistentry>
168
 
 
 
174
      
169
175
      <varlistentry>
 
176
        <term><option>--interface</option>
 
177
        <replaceable>NAME</replaceable></term>
170
178
        <term><option>-i</option>
171
179
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>--interface</option>
173
 
        <replaceable>NAME</replaceable></term>
174
180
        <listitem>
175
181
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
182
        </listitem>
177
183
      </varlistentry>
178
 
 
 
184
      
179
185
      <varlistentry>
180
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
181
 
        ADDRESS</replaceable></literal></term>
 
186
        <term><option>--address
 
187
        <replaceable>ADDRESS</replaceable></option></term>
 
188
        <term><option>-a
 
189
        <replaceable>ADDRESS</replaceable></option></term>
182
190
        <listitem>
183
191
          <xi:include href="mandos-options.xml" xpointer="address"/>
184
192
        </listitem>
185
193
      </varlistentry>
186
 
 
 
194
      
187
195
      <varlistentry>
188
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
189
 
        PORT</replaceable></literal></term>
 
196
        <term><option>--port
 
197
        <replaceable>PORT</replaceable></option></term>
 
198
        <term><option>-p
 
199
        <replaceable>PORT</replaceable></option></term>
190
200
        <listitem>
191
201
          <xi:include href="mandos-options.xml" xpointer="port"/>
192
202
        </listitem>
193
203
      </varlistentry>
194
 
 
 
204
      
195
205
      <varlistentry>
196
 
        <term><literal>--check</literal></term>
 
206
        <term><option>--check</option></term>
197
207
        <listitem>
198
208
          <para>
199
209
            Run the server’s self-tests.  This includes any unit
201
211
          </para>
202
212
        </listitem>
203
213
      </varlistentry>
204
 
 
 
214
      
205
215
      <varlistentry>
206
 
        <term><literal>--debug</literal></term>
 
216
        <term><option>--debug</option></term>
207
217
        <listitem>
208
218
          <xi:include href="mandos-options.xml" xpointer="debug"/>
209
219
        </listitem>
210
220
      </varlistentry>
211
 
 
212
 
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        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>
215
243
        <listitem>
216
244
          <xi:include href="mandos-options.xml" xpointer="priority"/>
217
245
        </listitem>
218
246
      </varlistentry>
219
 
 
 
247
      
220
248
      <varlistentry>
221
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
222
 
        </literal></term>
 
249
        <term><option>--servicename
 
250
        <replaceable>NAME</replaceable></option></term>
223
251
        <listitem>
224
252
          <xi:include href="mandos-options.xml"
225
253
                      xpointer="servicename"/>
226
254
        </listitem>
227
255
      </varlistentry>
228
 
 
 
256
      
229
257
      <varlistentry>
230
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
231
 
        </literal></term>
 
258
        <term><option>--configdir
 
259
        <replaceable>DIRECTORY</replaceable></option></term>
232
260
        <listitem>
233
261
          <para>
234
262
            Directory to search for configuration files.  Default is
240
268
          </para>
241
269
        </listitem>
242
270
      </varlistentry>
243
 
 
 
271
      
244
272
      <varlistentry>
245
 
        <term><literal>--version</literal></term>
 
273
        <term><option>--version</option></term>
246
274
        <listitem>
247
275
          <para>
248
276
            Prints the program version and exit.
249
277
          </para>
250
278
        </listitem>
251
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
      
252
339
    </variablelist>
253
340
  </refsect1>
254
 
 
 
341
  
255
342
  <refsect1 id="overview">
256
343
    <title>OVERVIEW</title>
257
344
    <xi:include href="overview.xml"/>
258
345
    <para>
259
346
      This program is the server part.  It is a normal server program
260
347
      and will run in a normal system environment, not in an initial
261
 
      RAM disk environment.
 
348
      <acronym>RAM</acronym> disk environment.
262
349
    </para>
263
350
  </refsect1>
264
 
 
 
351
  
265
352
  <refsect1 id="protocol">
266
353
    <title>NETWORK PROTOCOL</title>
267
354
    <para>
319
406
      </row>
320
407
    </tbody></tgroup></table>
321
408
  </refsect1>
322
 
 
 
409
  
323
410
  <refsect1 id="checking">
324
411
    <title>CHECKING</title>
325
412
    <para>
326
413
      The server will, by default, continually check that the clients
327
414
      are still up.  If a client has not been confirmed as being up
328
415
      for some time, the client is assumed to be compromised and is no
329
 
      longer eligible to receive the encrypted password.  The timeout,
330
 
      checker program, and interval between checks can be configured
331
 
      both globally and per client; see <citerefentry>
 
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>
332
432
      <refentrytitle>mandos-clients.conf</refentrytitle>
333
 
      <manvolnum>5</manvolnum></citerefentry>.
334
 
    </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
    
335
443
  </refsect1>
336
 
 
 
444
  
337
445
  <refsect1 id="logging">
338
446
    <title>LOGGING</title>
339
447
    <para>
340
448
      The server will send log message with various severity levels to
341
 
      <filename>/dev/log</filename>.  With the
 
449
      <filename class="devicefile">/dev/log</filename>.  With the
342
450
      <option>--debug</option> option, it will log even more messages,
343
451
      and also show them on the console.
344
452
    </para>
345
453
  </refsect1>
346
 
 
 
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
  
347
477
  <refsect1 id="exit_status">
348
478
    <title>EXIT STATUS</title>
349
479
    <para>
351
481
      critical error is encountered.
352
482
    </para>
353
483
  </refsect1>
354
 
 
 
484
  
355
485
  <refsect1 id="environment">
356
486
    <title>ENVIRONMENT</title>
357
487
    <variablelist>
371
501
      </varlistentry>
372
502
    </variablelist>
373
503
  </refsect1>
374
 
 
375
 
  <refsect1 id="file">
 
504
  
 
505
  <refsect1 id="files">
376
506
    <title>FILES</title>
377
507
    <para>
378
508
      Use the <option>--configdir</option> option to change where
401
531
        </listitem>
402
532
      </varlistentry>
403
533
      <varlistentry>
404
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
405
 
        <listitem>
406
 
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
409
 
          </para>
410
 
        </listitem>
411
 
      </varlistentry>
412
 
      <varlistentry>
413
 
        <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>
414
559
        <listitem>
415
560
          <para>
416
561
            The Unix domain socket to where local syslog messages are
439
584
      backtrace.  This could be considered a feature.
440
585
    </para>
441
586
    <para>
442
 
      Currently, if a client is declared <quote>invalid</quote> due to
443
 
      having timed out, the server does not record this fact onto
444
 
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="CLIENTS"/>.
446
 
    </para>
447
 
    <para>
448
 
      There is currently no way of querying the server of the current
449
 
      status of clients, other than analyzing its <systemitem
450
 
      class="service">syslog</systemitem> output.
451
 
    </para>
452
 
    <para>
453
587
      There is no fine-grained control over logging and debug output.
454
588
    </para>
455
589
    <para>
456
 
      Debug mode is conflated with running in the foreground.
457
 
    </para>
458
 
    <para>
459
 
      The console log messages does not show a timestamp.
460
 
    </para>
 
590
      This server does not check the expire time of clients’ OpenPGP
 
591
      keys.
 
592
    </para>
 
593
    <xi:include href="bugs.xml"/>
461
594
  </refsect1>
462
595
  
463
596
  <refsect1 id="example">
473
606
    <informalexample>
474
607
      <para>
475
608
        Run the server in debug mode, read configuration files from
476
 
        the <filename>~/mandos</filename> directory, and use the
477
 
        Zeroconf service name <quote>Test</quote> to not collide with
478
 
        any other official Mandos server on this host:
 
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:
479
612
      </para>
480
613
      <para>
481
614
 
497
630
      </para>
498
631
    </informalexample>
499
632
  </refsect1>
500
 
 
 
633
  
501
634
  <refsect1 id="security">
502
635
    <title>SECURITY</title>
503
 
    <refsect2 id="SERVER">
 
636
    <refsect2 id="server">
504
637
      <title>SERVER</title>
505
638
      <para>
506
639
        Running this <command>&COMMANDNAME;</command> server program
507
640
        should not in itself present any security risk to the host
508
 
        computer running it.  The program does not need any special
509
 
        privileges to run, and is designed to run as a non-root user.
 
641
        computer running it.  The program switches to a non-root user
 
642
        soon after startup.
510
643
      </para>
511
644
    </refsect2>
512
 
    <refsect2 id="CLIENTS">
 
645
    <refsect2 id="clients">
513
646
      <title>CLIENTS</title>
514
647
      <para>
515
648
        The server only gives out its stored data to clients which
522
655
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
523
656
        <manvolnum>5</manvolnum></citerefentry>)
524
657
        <emphasis>must</emphasis> be made non-readable by anyone
525
 
        except the user running the server.
 
658
        except the user starting the server (usually root).
526
659
      </para>
527
660
      <para>
528
661
        As detailed in <xref linkend="checking"/>, the status of all
530
663
        compromised if they are gone for too long.
531
664
      </para>
532
665
      <para>
533
 
        If a client is compromised, its downtime should be duly noted
534
 
        by the server which would therefore declare the client
535
 
        invalid.  But if the server was ever restarted, it would
536
 
        re-read its client list from its configuration file and again
537
 
        regard all clients therein as valid, and hence eligible to
538
 
        receive their passwords.  Therefore, be careful when
539
 
        restarting servers if it is suspected that a client has, in
540
 
        fact, been compromised by parties who may now be running a
541
 
        fake Mandos client with the keys from the non-encrypted
542
 
        initial RAM image of the client host.  What should be done in
543
 
        that case (if restarting the server program really is
544
 
        necessary) is to stop the server program, edit the
545
 
        configuration file to omit any suspect clients, and restart
546
 
        the server program.
547
 
      </para>
548
 
      <para>
549
666
        For more details on client-side security, see
550
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
667
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
551
668
        <manvolnum>8mandos</manvolnum></citerefentry>.
552
669
      </para>
553
670
    </refsect2>
554
671
  </refsect1>
555
 
 
 
672
  
556
673
  <refsect1 id="see_also">
557
674
    <title>SEE ALSO</title>
558
675
    <para>
559
 
      <citerefentry>
560
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
561
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
 
        <refentrytitle>mandos.conf</refentrytitle>
563
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
 
        <refentrytitle>password-request</refentrytitle>
565
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
567
 
      </citerefentry>
 
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>
568
686
    </para>
569
687
    <variablelist>
570
688
      <varlistentry>
591
709
      </varlistentry>
592
710
      <varlistentry>
593
711
        <term>
594
 
          <ulink url="http://www.gnu.org/software/gnutls/"
595
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
596
713
        </term>
597
714
      <listitem>
598
715
        <para>
636
753
      </varlistentry>
637
754
      <varlistentry>
638
755
        <term>
639
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
640
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
641
758
        </term>
642
759
      <listitem>
643
760
        <para>
644
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
645
762
        </para>
646
763
      </listitem>
647
764
      </varlistentry>
657
774
      </varlistentry>
658
775
      <varlistentry>
659
776
        <term>
660
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
661
 
          Security</citetitle>
 
777
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
778
          Security (TLS) Authentication</citetitle>
662
779
        </term>
663
780
      <listitem>
664
781
        <para>