/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 10:27:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831102733-2u083dacxul80ynp
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
                               <literal>.  Split <term> tags into one
                               for each option.  Moved long options
                               before short.

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-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
108
    </cmdsynopsis>
104
109
    <cmdsynopsis>
105
110
      <command>&COMMANDNAME;</command>
117
122
      <arg choice="plain"><option>--check</option></arg>
118
123
    </cmdsynopsis>
119
124
  </refsynopsisdiv>
120
 
  
 
125
 
121
126
  <refsect1 id="description">
122
127
    <title>DESCRIPTION</title>
123
128
    <para>
124
129
      <command>&COMMANDNAME;</command> is a server daemon which
125
130
      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.
 
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.
136
139
    </para>
 
140
 
137
141
  </refsect1>
138
142
  
139
143
  <refsect1 id="purpose">
140
144
    <title>PURPOSE</title>
 
145
 
141
146
    <para>
142
147
      The purpose of this is to enable <emphasis>remote and unattended
143
148
      rebooting</emphasis> of client host computer with an
144
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
145
150
      linkend="overview"/> for details.
146
151
    </para>
 
152
    
147
153
  </refsect1>
148
154
  
149
155
  <refsect1 id="options">
150
156
    <title>OPTIONS</title>
 
157
    
151
158
    <variablelist>
152
159
      <varlistentry>
153
160
        <term><option>--help</option></term>
205
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
206
213
        </listitem>
207
214
      </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
 
      
 
215
 
227
216
      <varlistentry>
228
217
        <term><option>--priority <replaceable>
229
218
        PRIORITY</replaceable></option></term>
231
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
232
221
        </listitem>
233
222
      </varlistentry>
234
 
      
 
223
 
235
224
      <varlistentry>
236
225
        <term><option>--servicename
237
226
        <replaceable>NAME</replaceable></option></term>
240
229
                      xpointer="servicename"/>
241
230
        </listitem>
242
231
      </varlistentry>
243
 
      
 
232
 
244
233
      <varlistentry>
245
234
        <term><option>--configdir
246
235
        <replaceable>DIRECTORY</replaceable></option></term>
255
244
          </para>
256
245
        </listitem>
257
246
      </varlistentry>
258
 
      
 
247
 
259
248
      <varlistentry>
260
249
        <term><option>--version</option></term>
261
250
        <listitem>
264
253
          </para>
265
254
        </listitem>
266
255
      </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
256
    </variablelist>
303
257
  </refsect1>
304
 
  
 
258
 
305
259
  <refsect1 id="overview">
306
260
    <title>OVERVIEW</title>
307
261
    <xi:include href="overview.xml"/>
308
262
    <para>
309
263
      This program is the server part.  It is a normal server program
310
264
      and will run in a normal system environment, not in an initial
311
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
312
266
    </para>
313
267
  </refsect1>
314
 
  
 
268
 
315
269
  <refsect1 id="protocol">
316
270
    <title>NETWORK PROTOCOL</title>
317
271
    <para>
369
323
      </row>
370
324
    </tbody></tgroup></table>
371
325
  </refsect1>
372
 
  
 
326
 
373
327
  <refsect1 id="checking">
374
328
    <title>CHECKING</title>
375
329
    <para>
376
330
      The server will, by default, continually check that the clients
377
331
      are still up.  If a client has not been confirmed as being up
378
332
      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>
 
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>
397
336
      <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
 
    
 
337
      <manvolnum>5</manvolnum></citerefentry>.
 
338
    </para>
408
339
  </refsect1>
409
 
  
 
340
 
410
341
  <refsect1 id="logging">
411
342
    <title>LOGGING</title>
412
343
    <para>
413
344
      The server will send log message with various severity levels to
414
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
345
      <filename>/dev/log</filename>.  With the
415
346
      <option>--debug</option> option, it will log even more messages,
416
347
      and also show them on the console.
417
348
    </para>
418
349
  </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
 
  
 
350
 
442
351
  <refsect1 id="exit_status">
443
352
    <title>EXIT STATUS</title>
444
353
    <para>
446
355
      critical error is encountered.
447
356
    </para>
448
357
  </refsect1>
449
 
  
 
358
 
450
359
  <refsect1 id="environment">
451
360
    <title>ENVIRONMENT</title>
452
361
    <variablelist>
466
375
      </varlistentry>
467
376
    </variablelist>
468
377
  </refsect1>
469
 
  
470
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
471
380
    <title>FILES</title>
472
381
    <para>
473
382
      Use the <option>--configdir</option> option to change where
496
405
        </listitem>
497
406
      </varlistentry>
498
407
      <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.
 
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>.
518
413
          </para>
519
414
        </listitem>
520
415
      </varlistentry>
548
443
      backtrace.  This could be considered a feature.
549
444
    </para>
550
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>
551
457
      There is no fine-grained control over logging and debug output.
552
458
    </para>
553
459
    <para>
554
460
      Debug mode is conflated with running in the foreground.
555
461
    </para>
556
462
    <para>
557
 
      This server does not check the expire time of clients’ OpenPGP
558
 
      keys.
 
463
      The console log messages does not show a timestamp.
559
464
    </para>
560
465
  </refsect1>
561
466
  
572
477
    <informalexample>
573
478
      <para>
574
479
        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:
 
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:
578
483
      </para>
579
484
      <para>
580
485
 
596
501
      </para>
597
502
    </informalexample>
598
503
  </refsect1>
599
 
  
 
504
 
600
505
  <refsect1 id="security">
601
506
    <title>SECURITY</title>
602
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
603
508
      <title>SERVER</title>
604
509
      <para>
605
510
        Running this <command>&COMMANDNAME;</command> server program
606
511
        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.
 
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.
609
514
      </para>
610
515
    </refsect2>
611
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
612
517
      <title>CLIENTS</title>
613
518
      <para>
614
519
        The server only gives out its stored data to clients which
621
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
622
527
        <manvolnum>5</manvolnum></citerefentry>)
623
528
        <emphasis>must</emphasis> be made non-readable by anyone
624
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
625
530
      </para>
626
531
      <para>
627
532
        As detailed in <xref linkend="checking"/>, the status of all
629
534
        compromised if they are gone for too long.
630
535
      </para>
631
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>
632
553
        For more details on client-side security, see
633
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
634
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
635
556
      </para>
636
557
    </refsect2>
637
558
  </refsect1>
638
 
  
 
559
 
639
560
  <refsect1 id="see_also">
640
561
    <title>SEE ALSO</title>
641
562
    <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>
 
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>
652
572
    </para>
653
573
    <variablelist>
654
574
      <varlistentry>