/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-08-19 20:59:06 UTC
  • mfrom: (237.4.100 release)
  • Revision ID: teddy@recompile.se-20180819205906-c2nlh8f4f7ylxers
Merge from release branch

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 "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
48
    <xi:include href="legalnotice.xml"/>
38
49
  </refentryinfo>
39
 
 
 
50
  
40
51
  <refmeta>
41
52
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
53
    <manvolnum>8</manvolnum>
48
59
      Gives encrypted passwords to authenticated Mandos clients
49
60
    </refpurpose>
50
61
  </refnamediv>
51
 
 
 
62
  
52
63
  <refsynopsisdiv>
53
64
    <cmdsynopsis>
54
65
      <command>&COMMANDNAME;</command>
83
94
      <replaceable>DIRECTORY</replaceable></option></arg>
84
95
      <sbr/>
85
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>
86
116
    </cmdsynopsis>
87
117
    <cmdsynopsis>
88
118
      <command>&COMMANDNAME;</command>
100
130
      <arg choice="plain"><option>--check</option></arg>
101
131
    </cmdsynopsis>
102
132
  </refsynopsisdiv>
103
 
 
 
133
  
104
134
  <refsect1 id="description">
105
135
    <title>DESCRIPTION</title>
106
136
    <para>
107
137
      <command>&COMMANDNAME;</command> is a server daemon which
108
138
      handles incoming request for passwords for a pre-defined list of
109
 
      client host computers.  The Mandos server uses Zeroconf to
110
 
      announce itself on the local network, and uses TLS to
111
 
      communicate securely with and to authenticate the clients.  The
112
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
113
 
      link-local addresses, since the clients will probably not have
114
 
      any other addresses configured (see <xref linkend="overview"/>).
115
 
      Any authenticated client is then given the stored pre-encrypted
116
 
      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.
117
149
    </para>
118
 
 
119
150
  </refsect1>
120
151
  
121
152
  <refsect1 id="purpose">
122
153
    <title>PURPOSE</title>
123
 
 
124
154
    <para>
125
155
      The purpose of this is to enable <emphasis>remote and unattended
126
156
      rebooting</emphasis> of client host computer with an
127
157
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
158
      linkend="overview"/> for details.
129
159
    </para>
130
 
    
131
160
  </refsect1>
132
161
  
133
162
  <refsect1 id="options">
134
163
    <title>OPTIONS</title>
135
 
    
136
164
    <variablelist>
137
165
      <varlistentry>
138
166
        <term><option>--help</option></term>
190
218
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
219
        </listitem>
192
220
      </varlistentry>
193
 
 
 
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
      
194
240
      <varlistentry>
195
241
        <term><option>--priority <replaceable>
196
242
        PRIORITY</replaceable></option></term>
198
244
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
245
        </listitem>
200
246
      </varlistentry>
201
 
 
 
247
      
202
248
      <varlistentry>
203
249
        <term><option>--servicename
204
250
        <replaceable>NAME</replaceable></option></term>
207
253
                      xpointer="servicename"/>
208
254
        </listitem>
209
255
      </varlistentry>
210
 
 
 
256
      
211
257
      <varlistentry>
212
258
        <term><option>--configdir
213
259
        <replaceable>DIRECTORY</replaceable></option></term>
222
268
          </para>
223
269
        </listitem>
224
270
      </varlistentry>
225
 
 
 
271
      
226
272
      <varlistentry>
227
273
        <term><option>--version</option></term>
228
274
        <listitem>
231
277
          </para>
232
278
        </listitem>
233
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
      
234
339
    </variablelist>
235
340
  </refsect1>
236
 
 
 
341
  
237
342
  <refsect1 id="overview">
238
343
    <title>OVERVIEW</title>
239
344
    <xi:include href="overview.xml"/>
240
345
    <para>
241
346
      This program is the server part.  It is a normal server program
242
347
      and will run in a normal system environment, not in an initial
243
 
      RAM disk environment.
 
348
      <acronym>RAM</acronym> disk environment.
244
349
    </para>
245
350
  </refsect1>
246
 
 
 
351
  
247
352
  <refsect1 id="protocol">
248
353
    <title>NETWORK PROTOCOL</title>
249
354
    <para>
301
406
      </row>
302
407
    </tbody></tgroup></table>
303
408
  </refsect1>
304
 
 
 
409
  
305
410
  <refsect1 id="checking">
306
411
    <title>CHECKING</title>
307
412
    <para>
308
413
      The server will, by default, continually check that the clients
309
414
      are still up.  If a client has not been confirmed as being up
310
415
      for some time, the client is assumed to be compromised and is no
311
 
      longer eligible to receive the encrypted password.  The timeout,
312
 
      checker program, and interval between checks can be configured
313
 
      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>
314
432
      <refentrytitle>mandos-clients.conf</refentrytitle>
315
 
      <manvolnum>5</manvolnum></citerefentry>.
316
 
    </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
    
317
443
  </refsect1>
318
 
 
 
444
  
319
445
  <refsect1 id="logging">
320
446
    <title>LOGGING</title>
321
447
    <para>
322
448
      The server will send log message with various severity levels to
323
 
      <filename>/dev/log</filename>.  With the
 
449
      <filename class="devicefile">/dev/log</filename>.  With the
324
450
      <option>--debug</option> option, it will log even more messages,
325
451
      and also show them on the console.
326
452
    </para>
327
453
  </refsect1>
328
 
 
 
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
  
329
477
  <refsect1 id="exit_status">
330
478
    <title>EXIT STATUS</title>
331
479
    <para>
333
481
      critical error is encountered.
334
482
    </para>
335
483
  </refsect1>
336
 
 
 
484
  
337
485
  <refsect1 id="environment">
338
486
    <title>ENVIRONMENT</title>
339
487
    <variablelist>
353
501
      </varlistentry>
354
502
    </variablelist>
355
503
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
504
  
 
505
  <refsect1 id="files">
358
506
    <title>FILES</title>
359
507
    <para>
360
508
      Use the <option>--configdir</option> option to change where
383
531
        </listitem>
384
532
      </varlistentry>
385
533
      <varlistentry>
386
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
387
 
        <listitem>
388
 
          <para>
389
 
            The file containing the process id of
390
 
            <command>&COMMANDNAME;</command>.
391
 
          </para>
392
 
        </listitem>
393
 
      </varlistentry>
394
 
      <varlistentry>
395
 
        <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>
396
559
        <listitem>
397
560
          <para>
398
561
            The Unix domain socket to where local syslog messages are
421
584
      backtrace.  This could be considered a feature.
422
585
    </para>
423
586
    <para>
424
 
      Currently, if a client is declared <quote>invalid</quote> due to
425
 
      having timed out, the server does not record this fact onto
426
 
      permanent storage.  This has some security implications, see
427
 
      <xref linkend="CLIENTS"/>.
428
 
    </para>
429
 
    <para>
430
 
      There is currently no way of querying the server of the current
431
 
      status of clients, other than analyzing its <systemitem
432
 
      class="service">syslog</systemitem> output.
433
 
    </para>
434
 
    <para>
435
587
      There is no fine-grained control over logging and debug output.
436
588
    </para>
437
589
    <para>
438
 
      Debug mode is conflated with running in the foreground.
439
 
    </para>
440
 
    <para>
441
 
      The console log messages does not show a timestamp.
442
 
    </para>
 
590
      This server does not check the expire time of clients’ OpenPGP
 
591
      keys.
 
592
    </para>
 
593
    <xi:include href="bugs.xml"/>
443
594
  </refsect1>
444
595
  
445
596
  <refsect1 id="example">
455
606
    <informalexample>
456
607
      <para>
457
608
        Run the server in debug mode, read configuration files from
458
 
        the <filename>~/mandos</filename> directory, and use the
459
 
        Zeroconf service name <quote>Test</quote> to not collide with
460
 
        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:
461
612
      </para>
462
613
      <para>
463
614
 
479
630
      </para>
480
631
    </informalexample>
481
632
  </refsect1>
482
 
 
 
633
  
483
634
  <refsect1 id="security">
484
635
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
636
    <refsect2 id="server">
486
637
      <title>SERVER</title>
487
638
      <para>
488
639
        Running this <command>&COMMANDNAME;</command> server program
489
640
        should not in itself present any security risk to the host
490
 
        computer running it.  The program does not need any special
491
 
        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.
492
643
      </para>
493
644
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
645
    <refsect2 id="clients">
495
646
      <title>CLIENTS</title>
496
647
      <para>
497
648
        The server only gives out its stored data to clients which
504
655
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
656
        <manvolnum>5</manvolnum></citerefentry>)
506
657
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
658
        except the user starting the server (usually root).
508
659
      </para>
509
660
      <para>
510
661
        As detailed in <xref linkend="checking"/>, the status of all
512
663
        compromised if they are gone for too long.
513
664
      </para>
514
665
      <para>
515
 
        If a client is compromised, its downtime should be duly noted
516
 
        by the server which would therefore declare the client
517
 
        invalid.  But if the server was ever restarted, it would
518
 
        re-read its client list from its configuration file and again
519
 
        regard all clients therein as valid, and hence eligible to
520
 
        receive their passwords.  Therefore, be careful when
521
 
        restarting servers if it is suspected that a client has, in
522
 
        fact, been compromised by parties who may now be running a
523
 
        fake Mandos client with the keys from the non-encrypted
524
 
        initial RAM image of the client host.  What should be done in
525
 
        that case (if restarting the server program really is
526
 
        necessary) is to stop the server program, edit the
527
 
        configuration file to omit any suspect clients, and restart
528
 
        the server program.
529
 
      </para>
530
 
      <para>
531
666
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
667
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
668
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
669
      </para>
535
670
    </refsect2>
536
671
  </refsect1>
537
 
 
 
672
  
538
673
  <refsect1 id="see_also">
539
674
    <title>SEE ALSO</title>
540
675
    <para>
541
 
      <citerefentry>
542
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
543
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
 
        <refentrytitle>mandos.conf</refentrytitle>
545
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
547
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
 
      </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>
550
686
    </para>
551
687
    <variablelist>
552
688
      <varlistentry>
573
709
      </varlistentry>
574
710
      <varlistentry>
575
711
        <term>
576
 
          <ulink url="http://www.gnu.org/software/gnutls/"
577
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
578
713
        </term>
579
714
      <listitem>
580
715
        <para>
618
753
      </varlistentry>
619
754
      <varlistentry>
620
755
        <term>
621
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
622
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
623
758
        </term>
624
759
      <listitem>
625
760
        <para>
626
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
627
762
        </para>
628
763
      </listitem>
629
764
      </varlistentry>
639
774
      </varlistentry>
640
775
      <varlistentry>
641
776
        <term>
642
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
643
 
          Security</citetitle>
 
777
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
778
          Security (TLS) Authentication</citetitle>
644
779
        </term>
645
780
      <listitem>
646
781
        <para>