/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: 2014-06-15 02:48:49 UTC
  • Revision ID: teddy@recompile.se-20140615024849-68x3q8g4yzadl33s
mandos: New "--no-zeroconf" option.  Also make "--socket=0" work.

* mandos (main): New "--no-zeroconf" option.  Also do not interpret
                 socket=0 as no socket.
* mandos-options.xml (zeroconf): New.
* mandos.conf (socket, zeroconf): New.
* mandos.xml (SYNOPSIS, OPTIONS): Added "--no-zeroconf".

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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-09-01">
 
5
<!ENTITY TIMESTAMP "2014-06-15">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
34
40
      <holder>Teddy Hogeborn</holder>
35
41
      <holder>Björn Påhlsson</holder>
36
42
    </copyright>
37
43
    <xi:include href="legalnotice.xml"/>
38
44
  </refentryinfo>
39
 
 
 
45
  
40
46
  <refmeta>
41
47
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
48
    <manvolnum>8</manvolnum>
48
54
      Gives encrypted passwords to authenticated Mandos clients
49
55
    </refpurpose>
50
56
  </refnamediv>
51
 
 
 
57
  
52
58
  <refsynopsisdiv>
53
59
    <cmdsynopsis>
54
60
      <command>&COMMANDNAME;</command>
83
89
      <replaceable>DIRECTORY</replaceable></option></arg>
84
90
      <sbr/>
85
91
      <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
      <sbr/>
 
110
      <arg><option>--no-zeroconf</option></arg>
86
111
    </cmdsynopsis>
87
112
    <cmdsynopsis>
88
113
      <command>&COMMANDNAME;</command>
100
125
      <arg choice="plain"><option>--check</option></arg>
101
126
    </cmdsynopsis>
102
127
  </refsynopsisdiv>
103
 
 
 
128
  
104
129
  <refsect1 id="description">
105
130
    <title>DESCRIPTION</title>
106
131
    <para>
107
132
      <command>&COMMANDNAME;</command> is a server daemon which
108
133
      handles incoming request for passwords for a pre-defined list of
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.
 
134
      client host computers. For an introduction, see
 
135
      <citerefentry><refentrytitle>intro</refentrytitle>
 
136
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
137
      uses Zeroconf to announce itself on the local network, and uses
 
138
      TLS to communicate securely with and to authenticate the
 
139
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
140
      use IPv6 link-local addresses, since the clients will probably
 
141
      not have any other addresses configured (see <xref
 
142
      linkend="overview"/>).  Any authenticated client is then given
 
143
      the stored pre-encrypted password for that specific client.
117
144
    </para>
118
 
 
119
145
  </refsect1>
120
146
  
121
147
  <refsect1 id="purpose">
122
148
    <title>PURPOSE</title>
123
 
 
124
149
    <para>
125
150
      The purpose of this is to enable <emphasis>remote and unattended
126
151
      rebooting</emphasis> of client host computer with an
127
152
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
153
      linkend="overview"/> for details.
129
154
    </para>
130
 
    
131
155
  </refsect1>
132
156
  
133
157
  <refsect1 id="options">
134
158
    <title>OPTIONS</title>
135
 
    
136
159
    <variablelist>
137
160
      <varlistentry>
138
161
        <term><option>--help</option></term>
190
213
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
214
        </listitem>
192
215
      </varlistentry>
193
 
 
 
216
      
 
217
      <varlistentry>
 
218
        <term><option>--debuglevel
 
219
        <replaceable>LEVEL</replaceable></option></term>
 
220
        <listitem>
 
221
          <para>
 
222
            Set the debugging log level.
 
223
            <replaceable>LEVEL</replaceable> is a string, one of
 
224
            <quote><literal>CRITICAL</literal></quote>,
 
225
            <quote><literal>ERROR</literal></quote>,
 
226
            <quote><literal>WARNING</literal></quote>,
 
227
            <quote><literal>INFO</literal></quote>, or
 
228
            <quote><literal>DEBUG</literal></quote>, in order of
 
229
            increasing verbosity.  The default level is
 
230
            <quote><literal>WARNING</literal></quote>.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>
 
234
      
194
235
      <varlistentry>
195
236
        <term><option>--priority <replaceable>
196
237
        PRIORITY</replaceable></option></term>
197
238
        <listitem>
198
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
239
          <xi:include href="mandos-options.xml"
 
240
                      xpointer="priority_compat"/>
199
241
        </listitem>
200
242
      </varlistentry>
201
 
 
 
243
      
202
244
      <varlistentry>
203
245
        <term><option>--servicename
204
246
        <replaceable>NAME</replaceable></option></term>
207
249
                      xpointer="servicename"/>
208
250
        </listitem>
209
251
      </varlistentry>
210
 
 
 
252
      
211
253
      <varlistentry>
212
254
        <term><option>--configdir
213
255
        <replaceable>DIRECTORY</replaceable></option></term>
222
264
          </para>
223
265
        </listitem>
224
266
      </varlistentry>
225
 
 
 
267
      
226
268
      <varlistentry>
227
269
        <term><option>--version</option></term>
228
270
        <listitem>
231
273
          </para>
232
274
        </listitem>
233
275
      </varlistentry>
 
276
      
 
277
      <varlistentry>
 
278
        <term><option>--no-dbus</option></term>
 
279
        <listitem>
 
280
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
281
          <para>
 
282
            See also <xref linkend="dbus_interface"/>.
 
283
          </para>
 
284
        </listitem>
 
285
      </varlistentry>
 
286
      
 
287
      <varlistentry>
 
288
        <term><option>--no-ipv6</option></term>
 
289
        <listitem>
 
290
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
291
        </listitem>
 
292
      </varlistentry>
 
293
      
 
294
      <varlistentry>
 
295
        <term><option>--no-restore</option></term>
 
296
        <listitem>
 
297
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
298
          <para>
 
299
            See also <xref linkend="persistent_state"/>.
 
300
          </para>
 
301
        </listitem>
 
302
      </varlistentry>
 
303
      
 
304
      <varlistentry>
 
305
        <term><option>--statedir
 
306
        <replaceable>DIRECTORY</replaceable></option></term>
 
307
        <listitem>
 
308
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
309
        </listitem>
 
310
      </varlistentry>
 
311
      
 
312
      <varlistentry>
 
313
        <term><option>--socket
 
314
        <replaceable>FD</replaceable></option></term>
 
315
        <listitem>
 
316
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      
 
320
      <varlistentry>
 
321
        <term><option>--foreground</option></term>
 
322
        <listitem>
 
323
          <xi:include href="mandos-options.xml"
 
324
                      xpointer="foreground"/>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
      
 
328
      <varlistentry>
 
329
        <term><option>--no-zeroconf</option></term>
 
330
        <listitem>
 
331
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
332
        </listitem>
 
333
      </varlistentry>
 
334
      
234
335
    </variablelist>
235
336
  </refsect1>
236
 
 
 
337
  
237
338
  <refsect1 id="overview">
238
339
    <title>OVERVIEW</title>
239
340
    <xi:include href="overview.xml"/>
243
344
      <acronym>RAM</acronym> disk environment.
244
345
    </para>
245
346
  </refsect1>
246
 
 
 
347
  
247
348
  <refsect1 id="protocol">
248
349
    <title>NETWORK PROTOCOL</title>
249
350
    <para>
301
402
      </row>
302
403
    </tbody></tgroup></table>
303
404
  </refsect1>
304
 
 
 
405
  
305
406
  <refsect1 id="checking">
306
407
    <title>CHECKING</title>
307
408
    <para>
308
409
      The server will, by default, continually check that the clients
309
410
      are still up.  If a client has not been confirmed as being up
310
411
      for some time, the client is assumed to be compromised and is no
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>
 
412
      longer eligible to receive the encrypted password.  (Manual
 
413
      intervention is required to re-enable a client.)  The timeout,
 
414
      extended timeout, checker program, and interval between checks
 
415
      can be configured both globally and per client; see
 
416
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
417
      <manvolnum>5</manvolnum></citerefentry>.
 
418
    </para>
 
419
  </refsect1>
 
420
  
 
421
  <refsect1 id="approval">
 
422
    <title>APPROVAL</title>
 
423
    <para>
 
424
      The server can be configured to require manual approval for a
 
425
      client before it is sent its secret.  The delay to wait for such
 
426
      approval and the default action (approve or deny) can be
 
427
      configured both globally and per client; see <citerefentry>
314
428
      <refentrytitle>mandos-clients.conf</refentrytitle>
315
 
      <manvolnum>5</manvolnum></citerefentry>.
316
 
    </para>
 
429
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
430
      will be approved immediately without delay.
 
431
    </para>
 
432
    <para>
 
433
      This can be used to deny a client its secret if not manually
 
434
      approved within a specified time.  It can also be used to make
 
435
      the server delay before giving a client its secret, allowing
 
436
      optional manual denying of this specific client.
 
437
    </para>
 
438
    
317
439
  </refsect1>
318
 
 
 
440
  
319
441
  <refsect1 id="logging">
320
442
    <title>LOGGING</title>
321
443
    <para>
322
444
      The server will send log message with various severity levels to
323
 
      <filename>/dev/log</filename>.  With the
 
445
      <filename class="devicefile">/dev/log</filename>.  With the
324
446
      <option>--debug</option> option, it will log even more messages,
325
447
      and also show them on the console.
326
448
    </para>
327
449
  </refsect1>
328
 
 
 
450
  
 
451
  <refsect1 id="persistent_state">
 
452
    <title>PERSISTENT STATE</title>
 
453
    <para>
 
454
      Client settings, initially read from
 
455
      <filename>clients.conf</filename>, are persistent across
 
456
      restarts, and run-time changes will override settings in
 
457
      <filename>clients.conf</filename>.  However, if a setting is
 
458
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
459
      <filename>clients.conf</filename>, this will take precedence.
 
460
    </para>
 
461
  </refsect1>
 
462
  
 
463
  <refsect1 id="dbus_interface">
 
464
    <title>D-BUS INTERFACE</title>
 
465
    <para>
 
466
      The server will by default provide a D-Bus system bus interface.
 
467
      This interface will only be accessible by the root user or a
 
468
      Mandos-specific user, if such a user exists.  For documentation
 
469
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
470
    </para>
 
471
  </refsect1>
 
472
  
329
473
  <refsect1 id="exit_status">
330
474
    <title>EXIT STATUS</title>
331
475
    <para>
333
477
      critical error is encountered.
334
478
    </para>
335
479
  </refsect1>
336
 
 
 
480
  
337
481
  <refsect1 id="environment">
338
482
    <title>ENVIRONMENT</title>
339
483
    <variablelist>
353
497
      </varlistentry>
354
498
    </variablelist>
355
499
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
500
  
 
501
  <refsect1 id="files">
358
502
    <title>FILES</title>
359
503
    <para>
360
504
      Use the <option>--configdir</option> option to change where
383
527
        </listitem>
384
528
      </varlistentry>
385
529
      <varlistentry>
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>.
 
530
        <term><filename>/run/mandos.pid</filename></term>
 
531
        <listitem>
 
532
          <para>
 
533
            The file containing the process id of the
 
534
            <command>&COMMANDNAME;</command> process started last.
 
535
            <emphasis >Note:</emphasis> If the <filename
 
536
            class="directory">/run</filename> directory does not
 
537
            exist, <filename>/var/run/mandos.pid</filename> will be
 
538
            used instead.
 
539
          </para>
 
540
        </listitem>
 
541
      </varlistentry>
 
542
      <varlistentry>
 
543
        <term><filename class="devicefile">/dev/log</filename></term>
 
544
      </varlistentry>
 
545
      <varlistentry>
 
546
        <term><filename
 
547
        class="directory">/var/lib/mandos</filename></term>
 
548
        <listitem>
 
549
          <para>
 
550
            Directory where persistent state will be saved.  Change
 
551
            this with the <option>--statedir</option> option.  See
 
552
            also the <option>--no-restore</option> option.
391
553
          </para>
392
554
        </listitem>
393
555
      </varlistentry>
421
583
      backtrace.  This could be considered a feature.
422
584
    </para>
423
585
    <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>
435
586
      There is no fine-grained control over logging and debug output.
436
587
    </para>
437
588
    <para>
438
 
      Debug mode is conflated with running in the foreground.
439
 
    </para>
440
 
    <para>
441
 
      The console log messages does not show a timestamp.
 
589
      This server does not check the expire time of clients’ OpenPGP
 
590
      keys.
442
591
    </para>
443
592
  </refsect1>
444
593
  
455
604
    <informalexample>
456
605
      <para>
457
606
        Run the server in debug mode, read configuration files from
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:
 
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:
461
610
      </para>
462
611
      <para>
463
612
 
479
628
      </para>
480
629
    </informalexample>
481
630
  </refsect1>
482
 
 
 
631
  
483
632
  <refsect1 id="security">
484
633
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
634
    <refsect2 id="server">
486
635
      <title>SERVER</title>
487
636
      <para>
488
637
        Running this <command>&COMMANDNAME;</command> server program
489
638
        should not in itself present any security risk to the host
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.
 
639
        computer running it.  The program switches to a non-root user
 
640
        soon after startup.
492
641
      </para>
493
642
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
643
    <refsect2 id="clients">
495
644
      <title>CLIENTS</title>
496
645
      <para>
497
646
        The server only gives out its stored data to clients which
504
653
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
654
        <manvolnum>5</manvolnum></citerefentry>)
506
655
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
656
        except the user starting the server (usually root).
508
657
      </para>
509
658
      <para>
510
659
        As detailed in <xref linkend="checking"/>, the status of all
512
661
        compromised if they are gone for too long.
513
662
      </para>
514
663
      <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>
531
664
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
665
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
666
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
667
      </para>
535
668
    </refsect2>
536
669
  </refsect1>
537
 
 
 
670
  
538
671
  <refsect1 id="see_also">
539
672
    <title>SEE ALSO</title>
540
673
    <para>
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>
 
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>
550
684
    </para>
551
685
    <variablelist>
552
686
      <varlistentry>