/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-08-31 14:00:36 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140036-5bruinjq267s5f8p
* mandos-clients.conf.xml: Changed all single quotes to double quotes
                           for consistency.
* mandos.conf.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

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-06-17">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
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
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
43
60
  </refentryinfo>
44
 
  
 
61
 
45
62
  <refmeta>
46
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
47
64
    <manvolnum>8</manvolnum>
53
70
      Gives encrypted passwords to authenticated Mandos clients
54
71
    </refpurpose>
55
72
  </refnamediv>
56
 
  
 
73
 
57
74
  <refsynopsisdiv>
58
75
    <cmdsynopsis>
59
76
      <command>&COMMANDNAME;</command>
88
105
      <replaceable>DIRECTORY</replaceable></option></arg>
89
106
      <sbr/>
90
107
      <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
 
      <sbr/>
104
 
      <arg><option>--socket
105
 
      <replaceable>FD</replaceable></option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--foreground</option></arg>
108
108
    </cmdsynopsis>
109
109
    <cmdsynopsis>
110
110
      <command>&COMMANDNAME;</command>
122
122
      <arg choice="plain"><option>--check</option></arg>
123
123
    </cmdsynopsis>
124
124
  </refsynopsisdiv>
125
 
  
 
125
 
126
126
  <refsect1 id="description">
127
127
    <title>DESCRIPTION</title>
128
128
    <para>
129
129
      <command>&COMMANDNAME;</command> is a server daemon which
130
130
      handles incoming request for passwords for a pre-defined list of
131
 
      client host computers. For an introduction, see
132
 
      <citerefentry><refentrytitle>intro</refentrytitle>
133
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
134
 
      uses Zeroconf to announce itself on the local network, and uses
135
 
      TLS to communicate securely with and to authenticate the
136
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
137
 
      use IPv6 link-local addresses, since the clients will probably
138
 
      not have any other addresses configured (see <xref
139
 
      linkend="overview"/>).  Any authenticated client is then given
140
 
      the stored pre-encrypted password for that specific client.
 
131
      client host computers.  The Mandos server uses Zeroconf to
 
132
      announce itself on the local network, and uses TLS to
 
133
      communicate securely with and to authenticate the clients.  The
 
134
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
135
      link-local addresses, since the clients will probably not have
 
136
      any other addresses configured (see <xref linkend="overview"/>).
 
137
      Any authenticated client is then given the stored pre-encrypted
 
138
      password for that specific client.
141
139
    </para>
 
140
 
142
141
  </refsect1>
143
142
  
144
143
  <refsect1 id="purpose">
145
144
    <title>PURPOSE</title>
 
145
 
146
146
    <para>
147
147
      The purpose of this is to enable <emphasis>remote and unattended
148
148
      rebooting</emphasis> of client host computer with an
149
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
150
      linkend="overview"/> for details.
151
151
    </para>
 
152
    
152
153
  </refsect1>
153
154
  
154
155
  <refsect1 id="options">
155
156
    <title>OPTIONS</title>
 
157
    
156
158
    <variablelist>
157
159
      <varlistentry>
158
160
        <term><option>--help</option></term>
210
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
211
213
        </listitem>
212
214
      </varlistentry>
213
 
      
214
 
      <varlistentry>
215
 
        <term><option>--debuglevel
216
 
        <replaceable>LEVEL</replaceable></option></term>
217
 
        <listitem>
218
 
          <para>
219
 
            Set the debugging log level.
220
 
            <replaceable>LEVEL</replaceable> is a string, one of
221
 
            <quote><literal>CRITICAL</literal></quote>,
222
 
            <quote><literal>ERROR</literal></quote>,
223
 
            <quote><literal>WARNING</literal></quote>,
224
 
            <quote><literal>INFO</literal></quote>, or
225
 
            <quote><literal>DEBUG</literal></quote>, in order of
226
 
            increasing verbosity.  The default level is
227
 
            <quote><literal>WARNING</literal></quote>.
228
 
          </para>
229
 
        </listitem>
230
 
      </varlistentry>
231
 
      
 
215
 
232
216
      <varlistentry>
233
217
        <term><option>--priority <replaceable>
234
218
        PRIORITY</replaceable></option></term>
236
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
237
221
        </listitem>
238
222
      </varlistentry>
239
 
      
 
223
 
240
224
      <varlistentry>
241
225
        <term><option>--servicename
242
226
        <replaceable>NAME</replaceable></option></term>
245
229
                      xpointer="servicename"/>
246
230
        </listitem>
247
231
      </varlistentry>
248
 
      
 
232
 
249
233
      <varlistentry>
250
234
        <term><option>--configdir
251
235
        <replaceable>DIRECTORY</replaceable></option></term>
260
244
          </para>
261
245
        </listitem>
262
246
      </varlistentry>
263
 
      
 
247
 
264
248
      <varlistentry>
265
249
        <term><option>--version</option></term>
266
250
        <listitem>
269
253
          </para>
270
254
        </listitem>
271
255
      </varlistentry>
272
 
      
273
 
      <varlistentry>
274
 
        <term><option>--no-dbus</option></term>
275
 
        <listitem>
276
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
277
 
          <para>
278
 
            See also <xref linkend="dbus_interface"/>.
279
 
          </para>
280
 
        </listitem>
281
 
      </varlistentry>
282
 
      
283
 
      <varlistentry>
284
 
        <term><option>--no-ipv6</option></term>
285
 
        <listitem>
286
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
287
 
        </listitem>
288
 
      </varlistentry>
289
 
      
290
 
      <varlistentry>
291
 
        <term><option>--no-restore</option></term>
292
 
        <listitem>
293
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
294
 
          <para>
295
 
            See also <xref linkend="persistent_state"/>.
296
 
          </para>
297
 
        </listitem>
298
 
      </varlistentry>
299
 
      
300
 
      <varlistentry>
301
 
        <term><option>--statedir
302
 
        <replaceable>DIRECTORY</replaceable></option></term>
303
 
        <listitem>
304
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
305
 
        </listitem>
306
 
      </varlistentry>
307
 
      
308
 
      <varlistentry>
309
 
        <term><option>--socket
310
 
        <replaceable>FD</replaceable></option></term>
311
 
        <listitem>
312
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
313
 
        </listitem>
314
 
      </varlistentry>
315
 
      
316
 
      <varlistentry>
317
 
        <term><option>--foreground</option></term>
318
 
        <listitem>
319
 
          <xi:include href="mandos-options.xml"
320
 
                      xpointer="foreground"/>
321
 
        </listitem>
322
 
      </varlistentry>
323
 
      
324
256
    </variablelist>
325
257
  </refsect1>
326
 
  
 
258
 
327
259
  <refsect1 id="overview">
328
260
    <title>OVERVIEW</title>
329
261
    <xi:include href="overview.xml"/>
330
262
    <para>
331
263
      This program is the server part.  It is a normal server program
332
264
      and will run in a normal system environment, not in an initial
333
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
334
266
    </para>
335
267
  </refsect1>
336
 
  
 
268
 
337
269
  <refsect1 id="protocol">
338
270
    <title>NETWORK PROTOCOL</title>
339
271
    <para>
391
323
      </row>
392
324
    </tbody></tgroup></table>
393
325
  </refsect1>
394
 
  
 
326
 
395
327
  <refsect1 id="checking">
396
328
    <title>CHECKING</title>
397
329
    <para>
398
330
      The server will, by default, continually check that the clients
399
331
      are still up.  If a client has not been confirmed as being up
400
332
      for some time, the client is assumed to be compromised and is no
401
 
      longer eligible to receive the encrypted password.  (Manual
402
 
      intervention is required to re-enable a client.)  The timeout,
403
 
      extended timeout, checker program, and interval between checks
404
 
      can be configured both globally and per client; see
405
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
333
      longer eligible to receive the encrypted password.  The timeout,
 
334
      checker program, and interval between checks can be configured
 
335
      both globally and per client; see <citerefentry>
 
336
      <refentrytitle>mandos-clients.conf</refentrytitle>
406
337
      <manvolnum>5</manvolnum></citerefentry>.
407
338
    </para>
408
339
  </refsect1>
409
 
  
410
 
  <refsect1 id="approval">
411
 
    <title>APPROVAL</title>
412
 
    <para>
413
 
      The server can be configured to require manual approval for a
414
 
      client before it is sent its secret.  The delay to wait for such
415
 
      approval and the default action (approve or deny) can be
416
 
      configured both globally and per client; see <citerefentry>
417
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
418
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
419
 
      will be approved immediately without delay.
420
 
    </para>
421
 
    <para>
422
 
      This can be used to deny a client its secret if not manually
423
 
      approved within a specified time.  It can also be used to make
424
 
      the server delay before giving a client its secret, allowing
425
 
      optional manual denying of this specific client.
426
 
    </para>
427
 
    
428
 
  </refsect1>
429
 
  
 
340
 
430
341
  <refsect1 id="logging">
431
342
    <title>LOGGING</title>
432
343
    <para>
433
344
      The server will send log message with various severity levels to
434
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
345
      <filename>/dev/log</filename>.  With the
435
346
      <option>--debug</option> option, it will log even more messages,
436
347
      and also show them on the console.
437
348
    </para>
438
349
  </refsect1>
439
 
  
440
 
  <refsect1 id="persistent_state">
441
 
    <title>PERSISTENT STATE</title>
442
 
    <para>
443
 
      Client settings, initially read from
444
 
      <filename>clients.conf</filename>, are persistent across
445
 
      restarts, and run-time changes will override settings in
446
 
      <filename>clients.conf</filename>.  However, if a setting is
447
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
448
 
      <filename>clients.conf</filename>, this will take precedence.
449
 
    </para>
450
 
  </refsect1>
451
 
  
452
 
  <refsect1 id="dbus_interface">
453
 
    <title>D-BUS INTERFACE</title>
454
 
    <para>
455
 
      The server will by default provide a D-Bus system bus interface.
456
 
      This interface will only be accessible by the root user or a
457
 
      Mandos-specific user, if such a user exists.  For documentation
458
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
459
 
    </para>
460
 
  </refsect1>
461
 
  
 
350
 
462
351
  <refsect1 id="exit_status">
463
352
    <title>EXIT STATUS</title>
464
353
    <para>
466
355
      critical error is encountered.
467
356
    </para>
468
357
  </refsect1>
469
 
  
 
358
 
470
359
  <refsect1 id="environment">
471
360
    <title>ENVIRONMENT</title>
472
361
    <variablelist>
486
375
      </varlistentry>
487
376
    </variablelist>
488
377
  </refsect1>
489
 
  
490
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
491
380
    <title>FILES</title>
492
381
    <para>
493
382
      Use the <option>--configdir</option> option to change where
516
405
        </listitem>
517
406
      </varlistentry>
518
407
      <varlistentry>
519
 
        <term><filename>/var/run/mandos.pid</filename></term>
520
 
        <listitem>
521
 
          <para>
522
 
            The file containing the process id of the
523
 
            <command>&COMMANDNAME;</command> process started last.
524
 
          </para>
525
 
        </listitem>
526
 
      </varlistentry>
527
 
      <varlistentry>
528
 
        <term><filename class="devicefile">/dev/log</filename></term>
529
 
      </varlistentry>
530
 
      <varlistentry>
531
 
        <term><filename
532
 
        class="directory">/var/lib/mandos</filename></term>
533
 
        <listitem>
534
 
          <para>
535
 
            Directory where persistent state will be saved.  Change
536
 
            this with the <option>--statedir</option> option.  See
537
 
            also the <option>--no-restore</option> option.
 
408
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
409
        <listitem>
 
410
          <para>
 
411
            The file containing the process id of
 
412
            <command>&COMMANDNAME;</command>.
538
413
          </para>
539
414
        </listitem>
540
415
      </varlistentry>
568
443
      backtrace.  This could be considered a feature.
569
444
    </para>
570
445
    <para>
 
446
      Currently, if a client is declared <quote>invalid</quote> due to
 
447
      having timed out, the server does not record this fact onto
 
448
      permanent storage.  This has some security implications, see
 
449
      <xref linkend="CLIENTS"/>.
 
450
    </para>
 
451
    <para>
 
452
      There is currently no way of querying the server of the current
 
453
      status of clients, other than analyzing its <systemitem
 
454
      class="service">syslog</systemitem> output.
 
455
    </para>
 
456
    <para>
571
457
      There is no fine-grained control over logging and debug output.
572
458
    </para>
573
459
    <para>
574
 
      This server does not check the expire time of clients’ OpenPGP
575
 
      keys.
 
460
      Debug mode is conflated with running in the foreground.
 
461
    </para>
 
462
    <para>
 
463
      The console log messages does not show a timestamp.
576
464
    </para>
577
465
  </refsect1>
578
466
  
589
477
    <informalexample>
590
478
      <para>
591
479
        Run the server in debug mode, read configuration files from
592
 
        the <filename class="directory">~/mandos</filename> directory,
593
 
        and use the Zeroconf service name <quote>Test</quote> to not
594
 
        collide with any other official Mandos server on this host:
 
480
        the <filename>~/mandos</filename> directory, and use the
 
481
        Zeroconf service name <quote>Test</quote> to not collide with
 
482
        any other official Mandos server on this host:
595
483
      </para>
596
484
      <para>
597
485
 
613
501
      </para>
614
502
    </informalexample>
615
503
  </refsect1>
616
 
  
 
504
 
617
505
  <refsect1 id="security">
618
506
    <title>SECURITY</title>
619
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
620
508
      <title>SERVER</title>
621
509
      <para>
622
510
        Running this <command>&COMMANDNAME;</command> server program
623
511
        should not in itself present any security risk to the host
624
 
        computer running it.  The program switches to a non-root user
625
 
        soon after startup.
 
512
        computer running it.  The program does not need any special
 
513
        privileges to run, and is designed to run as a non-root user.
626
514
      </para>
627
515
    </refsect2>
628
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
629
517
      <title>CLIENTS</title>
630
518
      <para>
631
519
        The server only gives out its stored data to clients which
638
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
639
527
        <manvolnum>5</manvolnum></citerefentry>)
640
528
        <emphasis>must</emphasis> be made non-readable by anyone
641
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
642
530
      </para>
643
531
      <para>
644
532
        As detailed in <xref linkend="checking"/>, the status of all
646
534
        compromised if they are gone for too long.
647
535
      </para>
648
536
      <para>
 
537
        If a client is compromised, its downtime should be duly noted
 
538
        by the server which would therefore declare the client
 
539
        invalid.  But if the server was ever restarted, it would
 
540
        re-read its client list from its configuration file and again
 
541
        regard all clients therein as valid, and hence eligible to
 
542
        receive their passwords.  Therefore, be careful when
 
543
        restarting servers if it is suspected that a client has, in
 
544
        fact, been compromised by parties who may now be running a
 
545
        fake Mandos client with the keys from the non-encrypted
 
546
        initial RAM image of the client host.  What should be done in
 
547
        that case (if restarting the server program really is
 
548
        necessary) is to stop the server program, edit the
 
549
        configuration file to omit any suspect clients, and restart
 
550
        the server program.
 
551
      </para>
 
552
      <para>
649
553
        For more details on client-side security, see
650
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
651
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
652
556
      </para>
653
557
    </refsect2>
654
558
  </refsect1>
655
 
  
 
559
 
656
560
  <refsect1 id="see_also">
657
561
    <title>SEE ALSO</title>
658
562
    <para>
659
 
      <citerefentry><refentrytitle>intro</refentrytitle>
660
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
661
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
662
 
      <manvolnum>5</manvolnum></citerefentry>,
663
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
664
 
      <manvolnum>5</manvolnum></citerefentry>,
665
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
666
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
667
 
      <citerefentry><refentrytitle>sh</refentrytitle>
668
 
      <manvolnum>1</manvolnum></citerefentry>
 
563
      <citerefentry>
 
564
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
565
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
566
        <refentrytitle>mandos.conf</refentrytitle>
 
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
568
        <refentrytitle>password-request</refentrytitle>
 
569
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
570
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
571
      </citerefentry>
669
572
    </para>
670
573
    <variablelist>
671
574
      <varlistentry>