/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-09-02 15:02:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902150237-ug2fpsu5s2yvmdl7
* Makefile (run-client): Add "--config-file=plugin-runner.conf".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2015-07-20">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-01">
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
34
      <holder>Teddy Hogeborn</holder>
43
35
      <holder>Björn Påhlsson</holder>
44
36
    </copyright>
45
37
    <xi:include href="legalnotice.xml"/>
46
38
  </refentryinfo>
47
 
  
 
39
 
48
40
  <refmeta>
49
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
50
42
    <manvolnum>8</manvolnum>
56
48
      Gives encrypted passwords to authenticated Mandos clients
57
49
    </refpurpose>
58
50
  </refnamediv>
59
 
  
 
51
 
60
52
  <refsynopsisdiv>
61
53
    <cmdsynopsis>
62
54
      <command>&COMMANDNAME;</command>
91
83
      <replaceable>DIRECTORY</replaceable></option></arg>
92
84
      <sbr/>
93
85
      <arg><option>--debug</option></arg>
94
 
      <sbr/>
95
 
      <arg><option>--debuglevel
96
 
      <replaceable>LEVEL</replaceable></option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--no-dbus</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--no-ipv6</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--no-restore</option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--statedir
105
 
      <replaceable>DIRECTORY</replaceable></option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--socket
108
 
      <replaceable>FD</replaceable></option></arg>
109
 
      <sbr/>
110
 
      <arg><option>--foreground</option></arg>
111
 
      <sbr/>
112
 
      <arg><option>--no-zeroconf</option></arg>
113
86
    </cmdsynopsis>
114
87
    <cmdsynopsis>
115
88
      <command>&COMMANDNAME;</command>
127
100
      <arg choice="plain"><option>--check</option></arg>
128
101
    </cmdsynopsis>
129
102
  </refsynopsisdiv>
130
 
  
 
103
 
131
104
  <refsect1 id="description">
132
105
    <title>DESCRIPTION</title>
133
106
    <para>
134
107
      <command>&COMMANDNAME;</command> is a server daemon which
135
108
      handles incoming request for passwords for a pre-defined list of
136
 
      client host computers. For an introduction, see
137
 
      <citerefentry><refentrytitle>intro</refentrytitle>
138
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
 
      uses Zeroconf to announce itself on the local network, and uses
140
 
      TLS to communicate securely with and to authenticate the
141
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
142
 
      use IPv6 link-local addresses, since the clients will probably
143
 
      not have any other addresses configured (see <xref
144
 
      linkend="overview"/>).  Any authenticated client is then given
145
 
      the stored pre-encrypted password for that specific client.
 
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.
146
117
    </para>
 
118
 
147
119
  </refsect1>
148
120
  
149
121
  <refsect1 id="purpose">
150
122
    <title>PURPOSE</title>
 
123
 
151
124
    <para>
152
125
      The purpose of this is to enable <emphasis>remote and unattended
153
126
      rebooting</emphasis> of client host computer with an
154
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
155
128
      linkend="overview"/> for details.
156
129
    </para>
 
130
    
157
131
  </refsect1>
158
132
  
159
133
  <refsect1 id="options">
160
134
    <title>OPTIONS</title>
 
135
    
161
136
    <variablelist>
162
137
      <varlistentry>
163
138
        <term><option>--help</option></term>
215
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
216
191
        </listitem>
217
192
      </varlistentry>
218
 
      
219
 
      <varlistentry>
220
 
        <term><option>--debuglevel
221
 
        <replaceable>LEVEL</replaceable></option></term>
222
 
        <listitem>
223
 
          <para>
224
 
            Set the debugging log level.
225
 
            <replaceable>LEVEL</replaceable> is a string, one of
226
 
            <quote><literal>CRITICAL</literal></quote>,
227
 
            <quote><literal>ERROR</literal></quote>,
228
 
            <quote><literal>WARNING</literal></quote>,
229
 
            <quote><literal>INFO</literal></quote>, or
230
 
            <quote><literal>DEBUG</literal></quote>, in order of
231
 
            increasing verbosity.  The default level is
232
 
            <quote><literal>WARNING</literal></quote>.
233
 
          </para>
234
 
        </listitem>
235
 
      </varlistentry>
236
 
      
 
193
 
237
194
      <varlistentry>
238
195
        <term><option>--priority <replaceable>
239
196
        PRIORITY</replaceable></option></term>
241
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
242
199
        </listitem>
243
200
      </varlistentry>
244
 
      
 
201
 
245
202
      <varlistentry>
246
203
        <term><option>--servicename
247
204
        <replaceable>NAME</replaceable></option></term>
250
207
                      xpointer="servicename"/>
251
208
        </listitem>
252
209
      </varlistentry>
253
 
      
 
210
 
254
211
      <varlistentry>
255
212
        <term><option>--configdir
256
213
        <replaceable>DIRECTORY</replaceable></option></term>
265
222
          </para>
266
223
        </listitem>
267
224
      </varlistentry>
268
 
      
 
225
 
269
226
      <varlistentry>
270
227
        <term><option>--version</option></term>
271
228
        <listitem>
274
231
          </para>
275
232
        </listitem>
276
233
      </varlistentry>
277
 
      
278
 
      <varlistentry>
279
 
        <term><option>--no-dbus</option></term>
280
 
        <listitem>
281
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
282
 
          <para>
283
 
            See also <xref linkend="dbus_interface"/>.
284
 
          </para>
285
 
        </listitem>
286
 
      </varlistentry>
287
 
      
288
 
      <varlistentry>
289
 
        <term><option>--no-ipv6</option></term>
290
 
        <listitem>
291
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
292
 
        </listitem>
293
 
      </varlistentry>
294
 
      
295
 
      <varlistentry>
296
 
        <term><option>--no-restore</option></term>
297
 
        <listitem>
298
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
299
 
          <para>
300
 
            See also <xref linkend="persistent_state"/>.
301
 
          </para>
302
 
        </listitem>
303
 
      </varlistentry>
304
 
      
305
 
      <varlistentry>
306
 
        <term><option>--statedir
307
 
        <replaceable>DIRECTORY</replaceable></option></term>
308
 
        <listitem>
309
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
310
 
        </listitem>
311
 
      </varlistentry>
312
 
      
313
 
      <varlistentry>
314
 
        <term><option>--socket
315
 
        <replaceable>FD</replaceable></option></term>
316
 
        <listitem>
317
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
318
 
        </listitem>
319
 
      </varlistentry>
320
 
      
321
 
      <varlistentry>
322
 
        <term><option>--foreground</option></term>
323
 
        <listitem>
324
 
          <xi:include href="mandos-options.xml"
325
 
                      xpointer="foreground"/>
326
 
        </listitem>
327
 
      </varlistentry>
328
 
      
329
 
      <varlistentry>
330
 
        <term><option>--no-zeroconf</option></term>
331
 
        <listitem>
332
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
333
 
        </listitem>
334
 
      </varlistentry>
335
 
      
336
234
    </variablelist>
337
235
  </refsect1>
338
 
  
 
236
 
339
237
  <refsect1 id="overview">
340
238
    <title>OVERVIEW</title>
341
239
    <xi:include href="overview.xml"/>
345
243
      <acronym>RAM</acronym> disk environment.
346
244
    </para>
347
245
  </refsect1>
348
 
  
 
246
 
349
247
  <refsect1 id="protocol">
350
248
    <title>NETWORK PROTOCOL</title>
351
249
    <para>
403
301
      </row>
404
302
    </tbody></tgroup></table>
405
303
  </refsect1>
406
 
  
 
304
 
407
305
  <refsect1 id="checking">
408
306
    <title>CHECKING</title>
409
307
    <para>
410
308
      The server will, by default, continually check that the clients
411
309
      are still up.  If a client has not been confirmed as being up
412
310
      for some time, the client is assumed to be compromised and is no
413
 
      longer eligible to receive the encrypted password.  (Manual
414
 
      intervention is required to re-enable a client.)  The timeout,
415
 
      extended timeout, checker program, and interval between checks
416
 
      can be configured both globally and per client; see
417
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
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>
 
314
      <refentrytitle>mandos-clients.conf</refentrytitle>
418
315
      <manvolnum>5</manvolnum></citerefentry>.
419
316
    </para>
420
317
  </refsect1>
421
 
  
422
 
  <refsect1 id="approval">
423
 
    <title>APPROVAL</title>
424
 
    <para>
425
 
      The server can be configured to require manual approval for a
426
 
      client before it is sent its secret.  The delay to wait for such
427
 
      approval and the default action (approve or deny) can be
428
 
      configured both globally and per client; see <citerefentry>
429
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
430
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
431
 
      will be approved immediately without delay.
432
 
    </para>
433
 
    <para>
434
 
      This can be used to deny a client its secret if not manually
435
 
      approved within a specified time.  It can also be used to make
436
 
      the server delay before giving a client its secret, allowing
437
 
      optional manual denying of this specific client.
438
 
    </para>
439
 
    
440
 
  </refsect1>
441
 
  
 
318
 
442
319
  <refsect1 id="logging">
443
320
    <title>LOGGING</title>
444
321
    <para>
445
322
      The server will send log message with various severity levels to
446
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
323
      <filename>/dev/log</filename>.  With the
447
324
      <option>--debug</option> option, it will log even more messages,
448
325
      and also show them on the console.
449
326
    </para>
450
327
  </refsect1>
451
 
  
452
 
  <refsect1 id="persistent_state">
453
 
    <title>PERSISTENT STATE</title>
454
 
    <para>
455
 
      Client settings, initially read from
456
 
      <filename>clients.conf</filename>, are persistent across
457
 
      restarts, and run-time changes will override settings in
458
 
      <filename>clients.conf</filename>.  However, if a setting is
459
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
460
 
      <filename>clients.conf</filename>, this will take precedence.
461
 
    </para>
462
 
  </refsect1>
463
 
  
464
 
  <refsect1 id="dbus_interface">
465
 
    <title>D-BUS INTERFACE</title>
466
 
    <para>
467
 
      The server will by default provide a D-Bus system bus interface.
468
 
      This interface will only be accessible by the root user or a
469
 
      Mandos-specific user, if such a user exists.  For documentation
470
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
471
 
    </para>
472
 
  </refsect1>
473
 
  
 
328
 
474
329
  <refsect1 id="exit_status">
475
330
    <title>EXIT STATUS</title>
476
331
    <para>
478
333
      critical error is encountered.
479
334
    </para>
480
335
  </refsect1>
481
 
  
 
336
 
482
337
  <refsect1 id="environment">
483
338
    <title>ENVIRONMENT</title>
484
339
    <variablelist>
498
353
      </varlistentry>
499
354
    </variablelist>
500
355
  </refsect1>
501
 
  
502
 
  <refsect1 id="files">
 
356
 
 
357
  <refsect1 id="file">
503
358
    <title>FILES</title>
504
359
    <para>
505
360
      Use the <option>--configdir</option> option to change where
528
383
        </listitem>
529
384
      </varlistentry>
530
385
      <varlistentry>
531
 
        <term><filename>/run/mandos.pid</filename></term>
532
 
        <listitem>
533
 
          <para>
534
 
            The file containing the process id of the
535
 
            <command>&COMMANDNAME;</command> process started last.
536
 
            <emphasis >Note:</emphasis> If the <filename
537
 
            class="directory">/run</filename> directory does not
538
 
            exist, <filename>/var/run/mandos.pid</filename> will be
539
 
            used instead.
540
 
          </para>
541
 
        </listitem>
542
 
      </varlistentry>
543
 
      <varlistentry>
544
 
        <term><filename class="devicefile">/dev/log</filename></term>
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.
 
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>.
554
391
          </para>
555
392
        </listitem>
556
393
      </varlistentry>
584
421
      backtrace.  This could be considered a feature.
585
422
    </para>
586
423
    <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>
587
435
      There is no fine-grained control over logging and debug output.
588
436
    </para>
589
437
    <para>
590
 
      This server does not check the expire time of clients’ OpenPGP
591
 
      keys.
 
438
      Debug mode is conflated with running in the foreground.
 
439
    </para>
 
440
    <para>
 
441
      The console log messages does not show a timestamp.
592
442
    </para>
593
443
  </refsect1>
594
444
  
605
455
    <informalexample>
606
456
      <para>
607
457
        Run the server in debug mode, read configuration files from
608
 
        the <filename class="directory">~/mandos</filename> directory,
609
 
        and use the Zeroconf service name <quote>Test</quote> to not
610
 
        collide with any other official Mandos server on this host:
 
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:
611
461
      </para>
612
462
      <para>
613
463
 
629
479
      </para>
630
480
    </informalexample>
631
481
  </refsect1>
632
 
  
 
482
 
633
483
  <refsect1 id="security">
634
484
    <title>SECURITY</title>
635
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
636
486
      <title>SERVER</title>
637
487
      <para>
638
488
        Running this <command>&COMMANDNAME;</command> server program
639
489
        should not in itself present any security risk to the host
640
 
        computer running it.  The program switches to a non-root user
641
 
        soon after startup.
 
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.
642
492
      </para>
643
493
    </refsect2>
644
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
645
495
      <title>CLIENTS</title>
646
496
      <para>
647
497
        The server only gives out its stored data to clients which
654
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
505
        <manvolnum>5</manvolnum></citerefentry>)
656
506
        <emphasis>must</emphasis> be made non-readable by anyone
657
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
658
508
      </para>
659
509
      <para>
660
510
        As detailed in <xref linkend="checking"/>, the status of all
662
512
        compromised if they are gone for too long.
663
513
      </para>
664
514
      <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 <acronym>RAM</acronym> image of the client host.  What
 
525
        should be done in that case (if restarting the server program
 
526
        really is 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>
665
531
        For more details on client-side security, see
666
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
667
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
668
534
      </para>
669
535
    </refsect2>
670
536
  </refsect1>
671
 
  
 
537
 
672
538
  <refsect1 id="see_also">
673
539
    <title>SEE ALSO</title>
674
540
    <para>
675
 
      <citerefentry><refentrytitle>intro</refentrytitle>
676
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
680
 
      <manvolnum>5</manvolnum></citerefentry>,
681
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
682
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
683
 
      <citerefentry><refentrytitle>sh</refentrytitle>
684
 
      <manvolnum>1</manvolnum></citerefentry>
 
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>
685
550
    </para>
686
551
    <variablelist>
687
552
      <varlistentry>
708
573
      </varlistentry>
709
574
      <varlistentry>
710
575
        <term>
711
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
576
          <ulink url="http://www.gnu.org/software/gnutls/"
 
577
          >GnuTLS</ulink>
712
578
        </term>
713
579
      <listitem>
714
580
        <para>
752
618
      </varlistentry>
753
619
      <varlistentry>
754
620
        <term>
755
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.2</citetitle>
 
621
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
622
          Protocol Version 1.1</citetitle>
757
623
        </term>
758
624
      <listitem>
759
625
        <para>
760
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
626
          TLS 1.1 is the protocol implemented by GnuTLS.
761
627
        </para>
762
628
      </listitem>
763
629
      </varlistentry>
773
639
      </varlistentry>
774
640
      <varlistentry>
775
641
        <term>
776
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security (TLS) Authentication</citetitle>
 
642
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
643
          Security</citetitle>
778
644
        </term>
779
645
      <listitem>
780
646
        <para>