/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 16:19:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901161932-ostp7tulh9aijulh
* plugin-runner.c (add_environment): Never insert existing environment
                                     variables.
  (main): Rename "--global-envs" to "--global-env" and "--envs-for" to
          "--env-for".

* plugin-runner.xml (SYNOPSIS): Rename "--global-envs" to
                                "--global-env" and "--envs-for" to
                                "--env-for".
  (OPTIONS): Added "--global-env" and "--env-for".
  (FALLBACK): Add id attribute.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): New section.
  (FILES): Document configuration file.

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