/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 06:13:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902061347-psw61eqt17j425sq
* plugin-runner.c: Changed short option for "--global-env" to "-G",
                   changed short option for "--env-for" to "-E",
                   added new option "--enable" ("-e").

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 "2012-01-01">
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
34
      <holder>Teddy Hogeborn</holder>
40
35
      <holder>Björn Påhlsson</holder>
41
36
    </copyright>
42
37
    <xi:include href="legalnotice.xml"/>
43
38
  </refentryinfo>
44
 
  
 
39
 
45
40
  <refmeta>
46
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
47
42
    <manvolnum>8</manvolnum>
53
48
      Gives encrypted passwords to authenticated Mandos clients
54
49
    </refpurpose>
55
50
  </refnamediv>
56
 
  
 
51
 
57
52
  <refsynopsisdiv>
58
53
    <cmdsynopsis>
59
54
      <command>&COMMANDNAME;</command>
88
83
      <replaceable>DIRECTORY</replaceable></option></arg>
89
84
      <sbr/>
90
85
      <arg><option>--debug</option></arg>
91
 
      <sbr/>
92
 
      <arg><option>--debuglevel
93
 
      <replaceable>LEVEL</replaceable></option></arg>
94
 
      <sbr/>
95
 
      <arg><option>--no-dbus</option></arg>
96
 
      <sbr/>
97
 
      <arg><option>--no-ipv6</option></arg>
98
 
      <sbr/>
99
 
      <arg><option>--no-restore</option></arg>
100
 
      <sbr/>
101
 
      <arg><option>--statedir
102
 
      <replaceable>DIRECTORY</replaceable></option></arg>
103
86
    </cmdsynopsis>
104
87
    <cmdsynopsis>
105
88
      <command>&COMMANDNAME;</command>
117
100
      <arg choice="plain"><option>--check</option></arg>
118
101
    </cmdsynopsis>
119
102
  </refsynopsisdiv>
120
 
  
 
103
 
121
104
  <refsect1 id="description">
122
105
    <title>DESCRIPTION</title>
123
106
    <para>
124
107
      <command>&COMMANDNAME;</command> is a server daemon which
125
108
      handles incoming request for passwords for a pre-defined list of
126
 
      client host computers. For an introduction, see
127
 
      <citerefentry><refentrytitle>intro</refentrytitle>
128
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
129
 
      uses Zeroconf to announce itself on the local network, and uses
130
 
      TLS to communicate securely with and to authenticate the
131
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
132
 
      use IPv6 link-local addresses, since the clients will probably
133
 
      not have any other addresses configured (see <xref
134
 
      linkend="overview"/>).  Any authenticated client is then given
135
 
      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.
136
117
    </para>
 
118
 
137
119
  </refsect1>
138
120
  
139
121
  <refsect1 id="purpose">
140
122
    <title>PURPOSE</title>
 
123
 
141
124
    <para>
142
125
      The purpose of this is to enable <emphasis>remote and unattended
143
126
      rebooting</emphasis> of client host computer with an
144
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
145
128
      linkend="overview"/> for details.
146
129
    </para>
 
130
    
147
131
  </refsect1>
148
132
  
149
133
  <refsect1 id="options">
150
134
    <title>OPTIONS</title>
 
135
    
151
136
    <variablelist>
152
137
      <varlistentry>
153
138
        <term><option>--help</option></term>
205
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
206
191
        </listitem>
207
192
      </varlistentry>
208
 
      
209
 
      <varlistentry>
210
 
        <term><option>--debuglevel
211
 
        <replaceable>LEVEL</replaceable></option></term>
212
 
        <listitem>
213
 
          <para>
214
 
            Set the debugging log level.
215
 
            <replaceable>LEVEL</replaceable> is a string, one of
216
 
            <quote><literal>CRITICAL</literal></quote>,
217
 
            <quote><literal>ERROR</literal></quote>,
218
 
            <quote><literal>WARNING</literal></quote>,
219
 
            <quote><literal>INFO</literal></quote>, or
220
 
            <quote><literal>DEBUG</literal></quote>, in order of
221
 
            increasing verbosity.  The default level is
222
 
            <quote><literal>WARNING</literal></quote>.
223
 
          </para>
224
 
        </listitem>
225
 
      </varlistentry>
226
 
      
 
193
 
227
194
      <varlistentry>
228
195
        <term><option>--priority <replaceable>
229
196
        PRIORITY</replaceable></option></term>
231
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
232
199
        </listitem>
233
200
      </varlistentry>
234
 
      
 
201
 
235
202
      <varlistentry>
236
203
        <term><option>--servicename
237
204
        <replaceable>NAME</replaceable></option></term>
240
207
                      xpointer="servicename"/>
241
208
        </listitem>
242
209
      </varlistentry>
243
 
      
 
210
 
244
211
      <varlistentry>
245
212
        <term><option>--configdir
246
213
        <replaceable>DIRECTORY</replaceable></option></term>
255
222
          </para>
256
223
        </listitem>
257
224
      </varlistentry>
258
 
      
 
225
 
259
226
      <varlistentry>
260
227
        <term><option>--version</option></term>
261
228
        <listitem>
264
231
          </para>
265
232
        </listitem>
266
233
      </varlistentry>
267
 
      
268
 
      <varlistentry>
269
 
        <term><option>--no-dbus</option></term>
270
 
        <listitem>
271
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
272
 
          <para>
273
 
            See also <xref linkend="dbus_interface"/>.
274
 
          </para>
275
 
        </listitem>
276
 
      </varlistentry>
277
 
      
278
 
      <varlistentry>
279
 
        <term><option>--no-ipv6</option></term>
280
 
        <listitem>
281
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
282
 
        </listitem>
283
 
      </varlistentry>
284
 
      
285
 
      <varlistentry>
286
 
        <term><option>--no-restore</option></term>
287
 
        <listitem>
288
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
289
 
          <para>
290
 
            See also <xref linkend="persistent_state"/>.
291
 
          </para>
292
 
        </listitem>
293
 
      </varlistentry>
294
 
      
295
 
      <varlistentry>
296
 
        <term><option>--statedir
297
 
        <replaceable>DIRECTORY</replaceable></option></term>
298
 
        <listitem>
299
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
300
 
        </listitem>
301
 
      </varlistentry>
302
234
    </variablelist>
303
235
  </refsect1>
304
 
  
 
236
 
305
237
  <refsect1 id="overview">
306
238
    <title>OVERVIEW</title>
307
239
    <xi:include href="overview.xml"/>
311
243
      <acronym>RAM</acronym> disk environment.
312
244
    </para>
313
245
  </refsect1>
314
 
  
 
246
 
315
247
  <refsect1 id="protocol">
316
248
    <title>NETWORK PROTOCOL</title>
317
249
    <para>
369
301
      </row>
370
302
    </tbody></tgroup></table>
371
303
  </refsect1>
372
 
  
 
304
 
373
305
  <refsect1 id="checking">
374
306
    <title>CHECKING</title>
375
307
    <para>
376
308
      The server will, by default, continually check that the clients
377
309
      are still up.  If a client has not been confirmed as being up
378
310
      for some time, the client is assumed to be compromised and is no
379
 
      longer eligible to receive the encrypted password.  (Manual
380
 
      intervention is required to re-enable a client.)  The timeout,
381
 
      extended timeout, checker program, and interval between checks
382
 
      can be configured both globally and per client; see
383
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
384
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
385
 
      receiving its password will also be treated as a successful
386
 
      checker run.
387
 
    </para>
388
 
  </refsect1>
389
 
  
390
 
  <refsect1 id="approval">
391
 
    <title>APPROVAL</title>
392
 
    <para>
393
 
      The server can be configured to require manual approval for a
394
 
      client before it is sent its secret.  The delay to wait for such
395
 
      approval and the default action (approve or deny) can be
396
 
      configured both globally and per client; see <citerefentry>
 
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>
397
314
      <refentrytitle>mandos-clients.conf</refentrytitle>
398
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
399
 
      will be approved immediately without delay.
400
 
    </para>
401
 
    <para>
402
 
      This can be used to deny a client its secret if not manually
403
 
      approved within a specified time.  It can also be used to make
404
 
      the server delay before giving a client its secret, allowing
405
 
      optional manual denying of this specific client.
406
 
    </para>
407
 
    
 
315
      <manvolnum>5</manvolnum></citerefentry>.
 
316
    </para>
408
317
  </refsect1>
409
 
  
 
318
 
410
319
  <refsect1 id="logging">
411
320
    <title>LOGGING</title>
412
321
    <para>
413
322
      The server will send log message with various severity levels to
414
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
323
      <filename>/dev/log</filename>.  With the
415
324
      <option>--debug</option> option, it will log even more messages,
416
325
      and also show them on the console.
417
326
    </para>
418
327
  </refsect1>
419
 
  
420
 
  <refsect1 id="persistent_state">
421
 
    <title>PERSISTENT STATE</title>
422
 
    <para>
423
 
      Client settings, initially read from
424
 
      <filename>clients.conf</filename>, are persistent across
425
 
      restarts, and run-time changes will override settings in
426
 
      <filename>clients.conf</filename>.  However, if a setting is
427
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
428
 
      <filename>clients.conf</filename>, this will take precedence.
429
 
    </para>
430
 
  </refsect1>
431
 
  
432
 
  <refsect1 id="dbus_interface">
433
 
    <title>D-BUS INTERFACE</title>
434
 
    <para>
435
 
      The server will by default provide a D-Bus system bus interface.
436
 
      This interface will only be accessible by the root user or a
437
 
      Mandos-specific user, if such a user exists.  For documentation
438
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
439
 
    </para>
440
 
  </refsect1>
441
 
  
 
328
 
442
329
  <refsect1 id="exit_status">
443
330
    <title>EXIT STATUS</title>
444
331
    <para>
446
333
      critical error is encountered.
447
334
    </para>
448
335
  </refsect1>
449
 
  
 
336
 
450
337
  <refsect1 id="environment">
451
338
    <title>ENVIRONMENT</title>
452
339
    <variablelist>
466
353
      </varlistentry>
467
354
    </variablelist>
468
355
  </refsect1>
469
 
  
470
 
  <refsect1 id="files">
 
356
 
 
357
  <refsect1 id="file">
471
358
    <title>FILES</title>
472
359
    <para>
473
360
      Use the <option>--configdir</option> option to change where
496
383
        </listitem>
497
384
      </varlistentry>
498
385
      <varlistentry>
499
 
        <term><filename>/var/run/mandos.pid</filename></term>
500
 
        <listitem>
501
 
          <para>
502
 
            The file containing the process id of the
503
 
            <command>&COMMANDNAME;</command> process started last.
504
 
          </para>
505
 
        </listitem>
506
 
      </varlistentry>
507
 
      <varlistentry>
508
 
        <term><filename class="devicefile">/dev/log</filename></term>
509
 
      </varlistentry>
510
 
      <varlistentry>
511
 
        <term><filename
512
 
        class="directory">/var/lib/mandos</filename></term>
513
 
        <listitem>
514
 
          <para>
515
 
            Directory where persistent state will be saved.  Change
516
 
            this with the <option>--statedir</option> option.  See
517
 
            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>.
518
391
          </para>
519
392
        </listitem>
520
393
      </varlistentry>
548
421
      backtrace.  This could be considered a feature.
549
422
    </para>
550
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>
551
435
      There is no fine-grained control over logging and debug output.
552
436
    </para>
553
437
    <para>
554
438
      Debug mode is conflated with running in the foreground.
555
439
    </para>
556
440
    <para>
557
 
      This server does not check the expire time of clients’ OpenPGP
558
 
      keys.
 
441
      The console log messages does not show a timestamp.
559
442
    </para>
560
443
  </refsect1>
561
444
  
572
455
    <informalexample>
573
456
      <para>
574
457
        Run the server in debug mode, read configuration files from
575
 
        the <filename class="directory">~/mandos</filename> directory,
576
 
        and use the Zeroconf service name <quote>Test</quote> to not
577
 
        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:
578
461
      </para>
579
462
      <para>
580
463
 
596
479
      </para>
597
480
    </informalexample>
598
481
  </refsect1>
599
 
  
 
482
 
600
483
  <refsect1 id="security">
601
484
    <title>SECURITY</title>
602
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
603
486
      <title>SERVER</title>
604
487
      <para>
605
488
        Running this <command>&COMMANDNAME;</command> server program
606
489
        should not in itself present any security risk to the host
607
 
        computer running it.  The program switches to a non-root user
608
 
        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.
609
492
      </para>
610
493
    </refsect2>
611
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
612
495
      <title>CLIENTS</title>
613
496
      <para>
614
497
        The server only gives out its stored data to clients which
621
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
622
505
        <manvolnum>5</manvolnum></citerefentry>)
623
506
        <emphasis>must</emphasis> be made non-readable by anyone
624
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
625
508
      </para>
626
509
      <para>
627
510
        As detailed in <xref linkend="checking"/>, the status of all
629
512
        compromised if they are gone for too long.
630
513
      </para>
631
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>
632
531
        For more details on client-side security, see
633
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
634
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
635
534
      </para>
636
535
    </refsect2>
637
536
  </refsect1>
638
 
  
 
537
 
639
538
  <refsect1 id="see_also">
640
539
    <title>SEE ALSO</title>
641
540
    <para>
642
 
      <citerefentry><refentrytitle>intro</refentrytitle>
643
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
644
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
 
      <manvolnum>5</manvolnum></citerefentry>,
646
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
647
 
      <manvolnum>5</manvolnum></citerefentry>,
648
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
649
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
650
 
      <citerefentry><refentrytitle>sh</refentrytitle>
651
 
      <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>
652
550
    </para>
653
551
    <variablelist>
654
552
      <varlistentry>