/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2022-04-24">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-30">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
34
      <holder>Teddy Hogeborn</holder>
47
35
      <holder>Björn Påhlsson</holder>
48
36
    </copyright>
49
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
50
60
  </refentryinfo>
51
 
  
 
61
 
52
62
  <refmeta>
53
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
64
    <manvolnum>8</manvolnum>
60
70
      Gives encrypted passwords to authenticated Mandos clients
61
71
    </refpurpose>
62
72
  </refnamediv>
63
 
  
 
73
 
64
74
  <refsynopsisdiv>
65
75
    <cmdsynopsis>
66
76
      <command>&COMMANDNAME;</command>
95
105
      <replaceable>DIRECTORY</replaceable></option></arg>
96
106
      <sbr/>
97
107
      <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>
117
108
    </cmdsynopsis>
118
109
    <cmdsynopsis>
119
110
      <command>&COMMANDNAME;</command>
120
111
      <group choice="req">
 
112
        <arg choice="plain"><option>-h</option></arg>
121
113
        <arg choice="plain"><option>--help</option></arg>
122
 
        <arg choice="plain"><option>-h</option></arg>
123
114
      </group>
124
115
    </cmdsynopsis>
125
116
    <cmdsynopsis>
131
122
      <arg choice="plain"><option>--check</option></arg>
132
123
    </cmdsynopsis>
133
124
  </refsynopsisdiv>
134
 
  
 
125
 
135
126
  <refsect1 id="description">
136
127
    <title>DESCRIPTION</title>
137
128
    <para>
138
129
      <command>&COMMANDNAME;</command> is a server daemon which
139
 
      handles incoming requests for passwords for a pre-defined list
140
 
      of 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.
 
130
      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.
150
139
    </para>
 
140
 
151
141
  </refsect1>
152
142
  
153
143
  <refsect1 id="purpose">
154
144
    <title>PURPOSE</title>
 
145
 
155
146
    <para>
156
147
      The purpose of this is to enable <emphasis>remote and unattended
157
148
      rebooting</emphasis> of client host computer with an
158
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
159
150
      linkend="overview"/> for details.
160
151
    </para>
 
152
 
161
153
  </refsect1>
162
154
  
163
155
  <refsect1 id="options">
164
156
    <title>OPTIONS</title>
 
157
 
165
158
    <variablelist>
166
159
      <varlistentry>
 
160
        <term><option>-h</option></term>
167
161
        <term><option>--help</option></term>
168
 
        <term><option>-h</option></term>
169
162
        <listitem>
170
163
          <para>
171
164
            Show a help message and exit
172
165
          </para>
173
166
        </listitem>
174
167
      </varlistentry>
175
 
      
 
168
 
176
169
      <varlistentry>
 
170
        <term><option>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
177
172
        <term><option>--interface</option>
178
173
        <replaceable>NAME</replaceable></term>
179
 
        <term><option>-i</option>
180
 
        <replaceable>NAME</replaceable></term>
181
174
        <listitem>
182
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
183
176
        </listitem>
184
177
      </varlistentry>
185
 
      
 
178
 
186
179
      <varlistentry>
187
 
        <term><option>--address
188
 
        <replaceable>ADDRESS</replaceable></option></term>
189
 
        <term><option>-a
190
 
        <replaceable>ADDRESS</replaceable></option></term>
 
180
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
181
        ADDRESS</replaceable></literal></term>
191
182
        <listitem>
192
183
          <xi:include href="mandos-options.xml" xpointer="address"/>
193
184
        </listitem>
194
185
      </varlistentry>
195
 
      
 
186
 
196
187
      <varlistentry>
197
 
        <term><option>--port
198
 
        <replaceable>PORT</replaceable></option></term>
199
 
        <term><option>-p
200
 
        <replaceable>PORT</replaceable></option></term>
 
188
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
189
        PORT</replaceable></literal></term>
201
190
        <listitem>
202
191
          <xi:include href="mandos-options.xml" xpointer="port"/>
203
192
        </listitem>
204
193
      </varlistentry>
205
 
      
 
194
 
206
195
      <varlistentry>
207
 
        <term><option>--check</option></term>
 
196
        <term><literal>--check</literal></term>
208
197
        <listitem>
209
198
          <para>
210
199
            Run the server’s self-tests.  This includes any unit
212
201
          </para>
213
202
        </listitem>
214
203
      </varlistentry>
215
 
      
 
204
 
216
205
      <varlistentry>
217
 
        <term><option>--debug</option></term>
 
206
        <term><literal>--debug</literal></term>
218
207
        <listitem>
219
208
          <xi:include href="mandos-options.xml" xpointer="debug"/>
220
209
        </listitem>
221
210
      </varlistentry>
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>
 
211
 
 
212
      <varlistentry>
 
213
        <term><literal>--priority <replaceable>
 
214
        PRIORITY</replaceable></literal></term>
244
215
        <listitem>
245
216
          <xi:include href="mandos-options.xml" xpointer="priority"/>
246
217
        </listitem>
247
218
      </varlistentry>
248
 
      
 
219
 
249
220
      <varlistentry>
250
 
        <term><option>--servicename
251
 
        <replaceable>NAME</replaceable></option></term>
 
221
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
222
        </literal></term>
252
223
        <listitem>
253
224
          <xi:include href="mandos-options.xml"
254
225
                      xpointer="servicename"/>
255
226
        </listitem>
256
227
      </varlistentry>
257
 
      
 
228
 
258
229
      <varlistentry>
259
 
        <term><option>--configdir
260
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
230
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
231
        </literal></term>
261
232
        <listitem>
262
233
          <para>
263
234
            Directory to search for configuration files.  Default is
269
240
          </para>
270
241
        </listitem>
271
242
      </varlistentry>
272
 
      
 
243
 
273
244
      <varlistentry>
274
 
        <term><option>--version</option></term>
 
245
        <term><literal>--version</literal></term>
275
246
        <listitem>
276
247
          <para>
277
248
            Prints the program version and exit.
278
249
          </para>
279
250
        </listitem>
280
251
      </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
 
      
340
252
    </variablelist>
341
253
  </refsect1>
342
 
  
 
254
 
343
255
  <refsect1 id="overview">
344
256
    <title>OVERVIEW</title>
345
257
    <xi:include href="overview.xml"/>
346
258
    <para>
347
259
      This program is the server part.  It is a normal server program
348
260
      and will run in a normal system environment, not in an initial
349
 
      <acronym>RAM</acronym> disk environment.
 
261
      RAM disk environment.
350
262
    </para>
351
263
  </refsect1>
352
 
  
 
264
 
353
265
  <refsect1 id="protocol">
354
266
    <title>NETWORK PROTOCOL</title>
355
267
    <para>
362
274
      start a TLS protocol handshake with a slight quirk: the Mandos
363
275
      server program acts as a TLS <quote>client</quote> while the
364
276
      connecting Mandos client acts as a TLS <quote>server</quote>.
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.
 
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.
370
282
    </para>
371
283
    <table>
372
284
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
304
        </emphasis></entry>
393
305
      </row>
394
306
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
307
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
308
        <entry>-><!-- &rarr; --></entry>
397
309
      </row>
398
310
      <row>
407
319
      </row>
408
320
    </tbody></tgroup></table>
409
321
  </refsect1>
410
 
  
 
322
 
411
323
  <refsect1 id="checking">
412
324
    <title>CHECKING</title>
413
325
    <para>
414
326
      The server will, by default, continually check that the clients
415
327
      are still up.  If a client has not been confirmed as being up
416
328
      for some time, the client is assumed to be compromised and is no
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>
 
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>
 
332
      <refentrytitle>mandos-clients.conf</refentrytitle>
422
333
      <manvolnum>5</manvolnum></citerefentry>.
423
334
    </para>
424
335
  </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>
433
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
444
 
  </refsect1>
445
 
  
 
336
 
446
337
  <refsect1 id="logging">
447
338
    <title>LOGGING</title>
448
339
    <para>
449
340
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
341
      <filename>/dev/log</filename>.  With the
451
342
      <option>--debug</option> option, it will log even more messages,
452
343
      and also show them on the console.
453
344
    </para>
454
345
  </refsect1>
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
 
  
 
346
 
478
347
  <refsect1 id="exit_status">
479
348
    <title>EXIT STATUS</title>
480
349
    <para>
482
351
      critical error is encountered.
483
352
    </para>
484
353
  </refsect1>
485
 
  
 
354
 
486
355
  <refsect1 id="environment">
487
356
    <title>ENVIRONMENT</title>
488
357
    <variablelist>
502
371
      </varlistentry>
503
372
    </variablelist>
504
373
  </refsect1>
505
 
  
506
 
  <refsect1 id="files">
 
374
 
 
375
  <refsect1 id="file">
507
376
    <title>FILES</title>
508
377
    <para>
509
378
      Use the <option>--configdir</option> option to change where
532
401
        </listitem>
533
402
      </varlistentry>
534
403
      <varlistentry>
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>
 
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>
560
414
        <listitem>
561
415
          <para>
562
416
            The Unix domain socket to where local syslog messages are
585
439
      backtrace.  This could be considered a feature.
586
440
    </para>
587
441
    <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>
588
453
      There is no fine-grained control over logging and debug output.
589
454
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
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>
591
461
  </refsect1>
592
462
  
593
463
  <refsect1 id="example">
603
473
    <informalexample>
604
474
      <para>
605
475
        Run the server in debug mode, read configuration files from
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:
 
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
479
      </para>
610
480
      <para>
611
481
 
627
497
      </para>
628
498
    </informalexample>
629
499
  </refsect1>
630
 
  
 
500
 
631
501
  <refsect1 id="security">
632
502
    <title>SECURITY</title>
633
 
    <refsect2 id="server">
 
503
    <refsect2 id="SERVER">
634
504
      <title>SERVER</title>
635
505
      <para>
636
506
        Running this <command>&COMMANDNAME;</command> server program
637
507
        should not in itself present any security risk to the host
638
 
        computer running it.  The program switches to a non-root user
639
 
        soon after startup.
 
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.
640
510
      </para>
641
511
    </refsect2>
642
 
    <refsect2 id="clients">
 
512
    <refsect2 id="CLIENTS">
643
513
      <title>CLIENTS</title>
644
514
      <para>
645
515
        The server only gives out its stored data to clients which
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
 
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
652
522
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
523
        <manvolnum>5</manvolnum></citerefentry>)
654
524
        <emphasis>must</emphasis> be made non-readable by anyone
655
 
        except the user starting the server (usually root).
 
525
        except the user running the server.
656
526
      </para>
657
527
      <para>
658
528
        As detailed in <xref linkend="checking"/>, the status of all
660
530
        compromised if they are gone for too long.
661
531
      </para>
662
532
      <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>
663
549
        For more details on client-side security, see
664
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
550
        <citerefentry><refentrytitle>password-request</refentrytitle>
665
551
        <manvolnum>8mandos</manvolnum></citerefentry>.
666
552
      </para>
667
553
    </refsect2>
668
554
  </refsect1>
669
 
  
 
555
 
670
556
  <refsect1 id="see_also">
671
557
    <title>SEE ALSO</title>
672
558
    <para>
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>
 
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>
683
568
    </para>
684
569
    <variablelist>
685
570
      <varlistentry>
695
580
      </varlistentry>
696
581
      <varlistentry>
697
582
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
583
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
584
        </term>
700
585
      <listitem>
701
586
        <para>
706
591
      </varlistentry>
707
592
      <varlistentry>
708
593
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
594
          <ulink url="http://www.gnu.org/software/gnutls/"
 
595
          >GnuTLS</ulink>
710
596
        </term>
711
597
      <listitem>
712
598
        <para>
713
599
          GnuTLS is the library this server uses to implement TLS for
714
600
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
601
          confidently get the client’s public OpenPGP key.
716
602
        </para>
717
603
      </listitem>
718
604
      </varlistentry>
739
625
            <listitem>
740
626
              <para>
741
627
                The clients use IPv6 link-local addresses, which are
742
 
                immediately usable since a link-local address is
 
628
                immediately usable since a link-local addresses is
743
629
                automatically assigned to a network interfaces when it
744
630
                is brought up.
745
631
              </para>
750
636
      </varlistentry>
751
637
      <varlistentry>
752
638
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
639
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
640
          Protocol Version 1.1</citetitle>
755
641
        </term>
756
642
      <listitem>
757
643
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
644
          TLS 1.1 is the protocol implemented by GnuTLS.
759
645
        </para>
760
646
      </listitem>
761
647
      </varlistentry>
771
657
      </varlistentry>
772
658
      <varlistentry>
773
659
        <term>
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.
 
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.
796
667
        </para>
797
668
      </listitem>
798
669
      </varlistentry>