/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: 2019-03-12 20:37:00 UTC
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190312203700-psenofay84b3szip
mandos-ctl: Refactor

* mandos-ctl (TestEnableCmd, TestDisableCmd): Rewrite to inherit from
                                              TestPropertyCmd instead
                                              of TestCmd.

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