/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: 2018-10-14 14:11:15 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • Revision ID: teddy@recompile.se-20181014141115-1oilce79snz1ackb
Depend on either old cryptsetup or new cryptsetup-initramfs

* debian/control (Package: mandos-client/Depends): Change "cryptsetup"
  to "cryptsetup (<< 2:2.0.3-1) | cryptsetup-initramfs".

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-09-02">
 
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
150
  </refsect1>
119
151
  
186
218
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
219
        </listitem>
188
220
      </varlistentry>
189
 
 
 
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
      
190
240
      <varlistentry>
191
241
        <term><option>--priority <replaceable>
192
242
        PRIORITY</replaceable></option></term>
194
244
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
245
        </listitem>
196
246
      </varlistentry>
197
 
 
 
247
      
198
248
      <varlistentry>
199
249
        <term><option>--servicename
200
250
        <replaceable>NAME</replaceable></option></term>
203
253
                      xpointer="servicename"/>
204
254
        </listitem>
205
255
      </varlistentry>
206
 
 
 
256
      
207
257
      <varlistentry>
208
258
        <term><option>--configdir
209
259
        <replaceable>DIRECTORY</replaceable></option></term>
218
268
          </para>
219
269
        </listitem>
220
270
      </varlistentry>
221
 
 
 
271
      
222
272
      <varlistentry>
223
273
        <term><option>--version</option></term>
224
274
        <listitem>
227
277
          </para>
228
278
        </listitem>
229
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
      
230
339
    </variablelist>
231
340
  </refsect1>
232
 
 
 
341
  
233
342
  <refsect1 id="overview">
234
343
    <title>OVERVIEW</title>
235
344
    <xi:include href="overview.xml"/>
239
348
      <acronym>RAM</acronym> disk environment.
240
349
    </para>
241
350
  </refsect1>
242
 
 
 
351
  
243
352
  <refsect1 id="protocol">
244
353
    <title>NETWORK PROTOCOL</title>
245
354
    <para>
297
406
      </row>
298
407
    </tbody></tgroup></table>
299
408
  </refsect1>
300
 
 
 
409
  
301
410
  <refsect1 id="checking">
302
411
    <title>CHECKING</title>
303
412
    <para>
304
413
      The server will, by default, continually check that the clients
305
414
      are still up.  If a client has not been confirmed as being up
306
415
      for some time, the client is assumed to be compromised and is no
307
 
      longer eligible to receive the encrypted password.  The timeout,
308
 
      checker program, and interval between checks can be configured
309
 
      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>
310
432
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
312
 
    </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
    
313
443
  </refsect1>
314
 
 
 
444
  
315
445
  <refsect1 id="logging">
316
446
    <title>LOGGING</title>
317
447
    <para>
318
448
      The server will send log message with various severity levels to
319
 
      <filename>/dev/log</filename>.  With the
 
449
      <filename class="devicefile">/dev/log</filename>.  With the
320
450
      <option>--debug</option> option, it will log even more messages,
321
451
      and also show them on the console.
322
452
    </para>
323
453
  </refsect1>
324
 
 
 
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
  
325
477
  <refsect1 id="exit_status">
326
478
    <title>EXIT STATUS</title>
327
479
    <para>
329
481
      critical error is encountered.
330
482
    </para>
331
483
  </refsect1>
332
 
 
 
484
  
333
485
  <refsect1 id="environment">
334
486
    <title>ENVIRONMENT</title>
335
487
    <variablelist>
349
501
      </varlistentry>
350
502
    </variablelist>
351
503
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
504
  
 
505
  <refsect1 id="files">
354
506
    <title>FILES</title>
355
507
    <para>
356
508
      Use the <option>--configdir</option> option to change where
379
531
        </listitem>
380
532
      </varlistentry>
381
533
      <varlistentry>
382
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
383
 
        <listitem>
384
 
          <para>
385
 
            The file containing the process id of
386
 
            <command>&COMMANDNAME;</command>.
387
 
          </para>
388
 
        </listitem>
389
 
      </varlistentry>
390
 
      <varlistentry>
391
 
        <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>
392
559
        <listitem>
393
560
          <para>
394
561
            The Unix domain socket to where local syslog messages are
417
584
      backtrace.  This could be considered a feature.
418
585
    </para>
419
586
    <para>
420
 
      Currently, if a client is declared <quote>invalid</quote> due to
421
 
      having timed out, the server does not record this fact onto
422
 
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
424
 
    </para>
425
 
    <para>
426
 
      There is currently no way of querying the server of the current
427
 
      status of clients, other than analyzing its <systemitem
428
 
      class="service">syslog</systemitem> output.
429
 
    </para>
430
 
    <para>
431
587
      There is no fine-grained control over logging and debug output.
432
588
    </para>
433
589
    <para>
434
 
      Debug mode is conflated with running in the foreground.
435
 
    </para>
436
 
    <para>
437
 
      The console log messages does not show a timestamp.
438
 
    </para>
 
590
      This server does not check the expire time of clients’ OpenPGP
 
591
      keys.
 
592
    </para>
 
593
    <xi:include href="bugs.xml"/>
439
594
  </refsect1>
440
595
  
441
596
  <refsect1 id="example">
451
606
    <informalexample>
452
607
      <para>
453
608
        Run the server in debug mode, read configuration files from
454
 
        the <filename>~/mandos</filename> directory, and use the
455
 
        Zeroconf service name <quote>Test</quote> to not collide with
456
 
        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:
457
612
      </para>
458
613
      <para>
459
614
 
475
630
      </para>
476
631
    </informalexample>
477
632
  </refsect1>
478
 
 
 
633
  
479
634
  <refsect1 id="security">
480
635
    <title>SECURITY</title>
481
 
    <refsect2 id="SERVER">
 
636
    <refsect2 id="server">
482
637
      <title>SERVER</title>
483
638
      <para>
484
639
        Running this <command>&COMMANDNAME;</command> server program
485
640
        should not in itself present any security risk to the host
486
 
        computer running it.  The program does not need any special
487
 
        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.
488
643
      </para>
489
644
    </refsect2>
490
 
    <refsect2 id="CLIENTS">
 
645
    <refsect2 id="clients">
491
646
      <title>CLIENTS</title>
492
647
      <para>
493
648
        The server only gives out its stored data to clients which
500
655
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
501
656
        <manvolnum>5</manvolnum></citerefentry>)
502
657
        <emphasis>must</emphasis> be made non-readable by anyone
503
 
        except the user running the server.
 
658
        except the user starting the server (usually root).
504
659
      </para>
505
660
      <para>
506
661
        As detailed in <xref linkend="checking"/>, the status of all
508
663
        compromised if they are gone for too long.
509
664
      </para>
510
665
      <para>
511
 
        If a client is compromised, its downtime should be duly noted
512
 
        by the server which would therefore declare the client
513
 
        invalid.  But if the server was ever restarted, it would
514
 
        re-read its client list from its configuration file and again
515
 
        regard all clients therein as valid, and hence eligible to
516
 
        receive their passwords.  Therefore, be careful when
517
 
        restarting servers if it is suspected that a client has, in
518
 
        fact, been compromised by parties who may now be running a
519
 
        fake Mandos client with the keys from the non-encrypted
520
 
        initial <acronym>RAM</acronym> image of the client host.  What
521
 
        should be done in that case (if restarting the server program
522
 
        really is necessary) is to stop the server program, edit the
523
 
        configuration file to omit any suspect clients, and restart
524
 
        the server program.
525
 
      </para>
526
 
      <para>
527
666
        For more details on client-side security, see
528
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
667
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
529
668
        <manvolnum>8mandos</manvolnum></citerefentry>.
530
669
      </para>
531
670
    </refsect2>
532
671
  </refsect1>
533
 
 
 
672
  
534
673
  <refsect1 id="see_also">
535
674
    <title>SEE ALSO</title>
536
675
    <para>
537
 
      <citerefentry>
538
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
539
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
540
 
        <refentrytitle>mandos.conf</refentrytitle>
541
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
542
 
        <refentrytitle>password-request</refentrytitle>
543
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
544
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
545
 
      </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>
546
686
    </para>
547
687
    <variablelist>
548
688
      <varlistentry>
569
709
      </varlistentry>
570
710
      <varlistentry>
571
711
        <term>
572
 
          <ulink url="http://www.gnu.org/software/gnutls/"
573
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
574
713
        </term>
575
714
      <listitem>
576
715
        <para>
614
753
      </varlistentry>
615
754
      <varlistentry>
616
755
        <term>
617
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
618
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
619
758
        </term>
620
759
      <listitem>
621
760
        <para>
622
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
623
762
        </para>
624
763
      </listitem>
625
764
      </varlistentry>
635
774
      </varlistentry>
636
775
      <varlistentry>
637
776
        <term>
638
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
639
 
          Security</citetitle>
 
777
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
778
          Security (TLS) Authentication</citetitle>
640
779
        </term>
641
780
      <listitem>
642
781
        <para>