/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-01 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

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