/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 16:04:47 UTC
  • mfrom: (24.1.77 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080831160447-2xte5k90onspphki
Merge.

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 "2013-10-26">
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
 
      <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
86
    </cmdsynopsis>
110
87
    <cmdsynopsis>
111
88
      <command>&COMMANDNAME;</command>
123
100
      <arg choice="plain"><option>--check</option></arg>
124
101
    </cmdsynopsis>
125
102
  </refsynopsisdiv>
126
 
  
 
103
 
127
104
  <refsect1 id="description">
128
105
    <title>DESCRIPTION</title>
129
106
    <para>
130
107
      <command>&COMMANDNAME;</command> is a server daemon which
131
108
      handles incoming request for passwords for a pre-defined list of
132
 
      client host computers. For an introduction, see
133
 
      <citerefentry><refentrytitle>intro</refentrytitle>
134
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
 
      uses Zeroconf to announce itself on the local network, and uses
136
 
      TLS to communicate securely with and to authenticate the
137
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
138
 
      use IPv6 link-local addresses, since the clients will probably
139
 
      not have any other addresses configured (see <xref
140
 
      linkend="overview"/>).  Any authenticated client is then given
141
 
      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.
142
117
    </para>
 
118
 
143
119
  </refsect1>
144
120
  
145
121
  <refsect1 id="purpose">
146
122
    <title>PURPOSE</title>
 
123
 
147
124
    <para>
148
125
      The purpose of this is to enable <emphasis>remote and unattended
149
126
      rebooting</emphasis> of client host computer with an
150
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
151
128
      linkend="overview"/> for details.
152
129
    </para>
 
130
    
153
131
  </refsect1>
154
132
  
155
133
  <refsect1 id="options">
156
134
    <title>OPTIONS</title>
 
135
    
157
136
    <variablelist>
158
137
      <varlistentry>
159
138
        <term><option>--help</option></term>
211
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
212
191
        </listitem>
213
192
      </varlistentry>
214
 
      
215
 
      <varlistentry>
216
 
        <term><option>--debuglevel
217
 
        <replaceable>LEVEL</replaceable></option></term>
218
 
        <listitem>
219
 
          <para>
220
 
            Set the debugging log level.
221
 
            <replaceable>LEVEL</replaceable> is a string, one of
222
 
            <quote><literal>CRITICAL</literal></quote>,
223
 
            <quote><literal>ERROR</literal></quote>,
224
 
            <quote><literal>WARNING</literal></quote>,
225
 
            <quote><literal>INFO</literal></quote>, or
226
 
            <quote><literal>DEBUG</literal></quote>, in order of
227
 
            increasing verbosity.  The default level is
228
 
            <quote><literal>WARNING</literal></quote>.
229
 
          </para>
230
 
        </listitem>
231
 
      </varlistentry>
232
 
      
 
193
 
233
194
      <varlistentry>
234
195
        <term><option>--priority <replaceable>
235
196
        PRIORITY</replaceable></option></term>
236
197
        <listitem>
237
 
          <xi:include href="mandos-options.xml"
238
 
                      xpointer="priority_compat"/>
 
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
239
199
        </listitem>
240
200
      </varlistentry>
241
 
      
 
201
 
242
202
      <varlistentry>
243
203
        <term><option>--servicename
244
204
        <replaceable>NAME</replaceable></option></term>
247
207
                      xpointer="servicename"/>
248
208
        </listitem>
249
209
      </varlistentry>
250
 
      
 
210
 
251
211
      <varlistentry>
252
212
        <term><option>--configdir
253
213
        <replaceable>DIRECTORY</replaceable></option></term>
262
222
          </para>
263
223
        </listitem>
264
224
      </varlistentry>
265
 
      
 
225
 
266
226
      <varlistentry>
267
227
        <term><option>--version</option></term>
268
228
        <listitem>
271
231
          </para>
272
232
        </listitem>
273
233
      </varlistentry>
274
 
      
275
 
      <varlistentry>
276
 
        <term><option>--no-dbus</option></term>
277
 
        <listitem>
278
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
279
 
          <para>
280
 
            See also <xref linkend="dbus_interface"/>.
281
 
          </para>
282
 
        </listitem>
283
 
      </varlistentry>
284
 
      
285
 
      <varlistentry>
286
 
        <term><option>--no-ipv6</option></term>
287
 
        <listitem>
288
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
289
 
        </listitem>
290
 
      </varlistentry>
291
 
      
292
 
      <varlistentry>
293
 
        <term><option>--no-restore</option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
296
 
          <para>
297
 
            See also <xref linkend="persistent_state"/>.
298
 
          </para>
299
 
        </listitem>
300
 
      </varlistentry>
301
 
      
302
 
      <varlistentry>
303
 
        <term><option>--statedir
304
 
        <replaceable>DIRECTORY</replaceable></option></term>
305
 
        <listitem>
306
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
307
 
        </listitem>
308
 
      </varlistentry>
309
 
      
310
 
      <varlistentry>
311
 
        <term><option>--socket
312
 
        <replaceable>FD</replaceable></option></term>
313
 
        <listitem>
314
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
315
 
        </listitem>
316
 
      </varlistentry>
317
 
      
318
 
      <varlistentry>
319
 
        <term><option>--foreground</option></term>
320
 
        <listitem>
321
 
          <xi:include href="mandos-options.xml"
322
 
                      xpointer="foreground"/>
323
 
        </listitem>
324
 
      </varlistentry>
325
 
      
326
234
    </variablelist>
327
235
  </refsect1>
328
 
  
 
236
 
329
237
  <refsect1 id="overview">
330
238
    <title>OVERVIEW</title>
331
239
    <xi:include href="overview.xml"/>
332
240
    <para>
333
241
      This program is the server part.  It is a normal server program
334
242
      and will run in a normal system environment, not in an initial
335
 
      <acronym>RAM</acronym> disk environment.
 
243
      RAM disk environment.
336
244
    </para>
337
245
  </refsect1>
338
 
  
 
246
 
339
247
  <refsect1 id="protocol">
340
248
    <title>NETWORK PROTOCOL</title>
341
249
    <para>
393
301
      </row>
394
302
    </tbody></tgroup></table>
395
303
  </refsect1>
396
 
  
 
304
 
397
305
  <refsect1 id="checking">
398
306
    <title>CHECKING</title>
399
307
    <para>
400
308
      The server will, by default, continually check that the clients
401
309
      are still up.  If a client has not been confirmed as being up
402
310
      for some time, the client is assumed to be compromised and is no
403
 
      longer eligible to receive the encrypted password.  (Manual
404
 
      intervention is required to re-enable a client.)  The timeout,
405
 
      extended timeout, checker program, and interval between checks
406
 
      can be configured both globally and per client; see
407
 
      <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>
408
315
      <manvolnum>5</manvolnum></citerefentry>.
409
316
    </para>
410
317
  </refsect1>
411
 
  
412
 
  <refsect1 id="approval">
413
 
    <title>APPROVAL</title>
414
 
    <para>
415
 
      The server can be configured to require manual approval for a
416
 
      client before it is sent its secret.  The delay to wait for such
417
 
      approval and the default action (approve or deny) can be
418
 
      configured both globally and per client; see <citerefentry>
419
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
420
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
421
 
      will be approved immediately without delay.
422
 
    </para>
423
 
    <para>
424
 
      This can be used to deny a client its secret if not manually
425
 
      approved within a specified time.  It can also be used to make
426
 
      the server delay before giving a client its secret, allowing
427
 
      optional manual denying of this specific client.
428
 
    </para>
429
 
    
430
 
  </refsect1>
431
 
  
 
318
 
432
319
  <refsect1 id="logging">
433
320
    <title>LOGGING</title>
434
321
    <para>
435
322
      The server will send log message with various severity levels to
436
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
323
      <filename>/dev/log</filename>.  With the
437
324
      <option>--debug</option> option, it will log even more messages,
438
325
      and also show them on the console.
439
326
    </para>
440
327
  </refsect1>
441
 
  
442
 
  <refsect1 id="persistent_state">
443
 
    <title>PERSISTENT STATE</title>
444
 
    <para>
445
 
      Client settings, initially read from
446
 
      <filename>clients.conf</filename>, are persistent across
447
 
      restarts, and run-time changes will override settings in
448
 
      <filename>clients.conf</filename>.  However, if a setting is
449
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
450
 
      <filename>clients.conf</filename>, this will take precedence.
451
 
    </para>
452
 
  </refsect1>
453
 
  
454
 
  <refsect1 id="dbus_interface">
455
 
    <title>D-BUS INTERFACE</title>
456
 
    <para>
457
 
      The server will by default provide a D-Bus system bus interface.
458
 
      This interface will only be accessible by the root user or a
459
 
      Mandos-specific user, if such a user exists.  For documentation
460
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
461
 
    </para>
462
 
  </refsect1>
463
 
  
 
328
 
464
329
  <refsect1 id="exit_status">
465
330
    <title>EXIT STATUS</title>
466
331
    <para>
468
333
      critical error is encountered.
469
334
    </para>
470
335
  </refsect1>
471
 
  
 
336
 
472
337
  <refsect1 id="environment">
473
338
    <title>ENVIRONMENT</title>
474
339
    <variablelist>
488
353
      </varlistentry>
489
354
    </variablelist>
490
355
  </refsect1>
491
 
  
492
 
  <refsect1 id="files">
 
356
 
 
357
  <refsect1 id="file">
493
358
    <title>FILES</title>
494
359
    <para>
495
360
      Use the <option>--configdir</option> option to change where
518
383
        </listitem>
519
384
      </varlistentry>
520
385
      <varlistentry>
521
 
        <term><filename>/run/mandos.pid</filename></term>
522
 
        <listitem>
523
 
          <para>
524
 
            The file containing the process id of the
525
 
            <command>&COMMANDNAME;</command> process started last.
526
 
            <emphasis >Note:</emphasis> If the <filename
527
 
            class="directory">/run</filename> directory does not
528
 
            exist, <filename>/var/run/mandos.pid</filename> will be
529
 
            used instead.
530
 
          </para>
531
 
        </listitem>
532
 
      </varlistentry>
533
 
      <varlistentry>
534
 
        <term><filename class="devicefile">/dev/log</filename></term>
535
 
      </varlistentry>
536
 
      <varlistentry>
537
 
        <term><filename
538
 
        class="directory">/var/lib/mandos</filename></term>
539
 
        <listitem>
540
 
          <para>
541
 
            Directory where persistent state will be saved.  Change
542
 
            this with the <option>--statedir</option> option.  See
543
 
            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>.
544
391
          </para>
545
392
        </listitem>
546
393
      </varlistentry>
574
421
      backtrace.  This could be considered a feature.
575
422
    </para>
576
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>
577
435
      There is no fine-grained control over logging and debug output.
578
436
    </para>
579
437
    <para>
580
 
      This server does not check the expire time of clients’ OpenPGP
581
 
      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.
582
442
    </para>
583
443
  </refsect1>
584
444
  
595
455
    <informalexample>
596
456
      <para>
597
457
        Run the server in debug mode, read configuration files from
598
 
        the <filename class="directory">~/mandos</filename> directory,
599
 
        and use the Zeroconf service name <quote>Test</quote> to not
600
 
        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:
601
461
      </para>
602
462
      <para>
603
463
 
619
479
      </para>
620
480
    </informalexample>
621
481
  </refsect1>
622
 
  
 
482
 
623
483
  <refsect1 id="security">
624
484
    <title>SECURITY</title>
625
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
626
486
      <title>SERVER</title>
627
487
      <para>
628
488
        Running this <command>&COMMANDNAME;</command> server program
629
489
        should not in itself present any security risk to the host
630
 
        computer running it.  The program switches to a non-root user
631
 
        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.
632
492
      </para>
633
493
    </refsect2>
634
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
635
495
      <title>CLIENTS</title>
636
496
      <para>
637
497
        The server only gives out its stored data to clients which
644
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
505
        <manvolnum>5</manvolnum></citerefentry>)
646
506
        <emphasis>must</emphasis> be made non-readable by anyone
647
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
648
508
      </para>
649
509
      <para>
650
510
        As detailed in <xref linkend="checking"/>, the status of all
652
512
        compromised if they are gone for too long.
653
513
      </para>
654
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 RAM image of the client host.  What should be done in
 
525
        that case (if restarting the server program really is
 
526
        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>
655
531
        For more details on client-side security, see
656
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
657
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
658
534
      </para>
659
535
    </refsect2>
660
536
  </refsect1>
661
 
  
 
537
 
662
538
  <refsect1 id="see_also">
663
539
    <title>SEE ALSO</title>
664
540
    <para>
665
 
      <citerefentry><refentrytitle>intro</refentrytitle>
666
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
667
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
668
 
      <manvolnum>5</manvolnum></citerefentry>,
669
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
670
 
      <manvolnum>5</manvolnum></citerefentry>,
671
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
672
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
673
 
      <citerefentry><refentrytitle>sh</refentrytitle>
674
 
      <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>
675
550
    </para>
676
551
    <variablelist>
677
552
      <varlistentry>