/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 10:44:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831104432-9hzi47foc7tlmade
* plugins.d/password-prompt.xml (OPTIONS): Move <replaceable> tags to
                                           inside <option> tags.
                                           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-05-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
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
108
    </cmdsynopsis>
107
109
    <cmdsynopsis>
108
110
      <command>&COMMANDNAME;</command>
120
122
      <arg choice="plain"><option>--check</option></arg>
121
123
    </cmdsynopsis>
122
124
  </refsynopsisdiv>
123
 
  
 
125
 
124
126
  <refsect1 id="description">
125
127
    <title>DESCRIPTION</title>
126
128
    <para>
127
129
      <command>&COMMANDNAME;</command> is a server daemon which
128
130
      handles incoming request for passwords for a pre-defined list of
129
 
      client host computers. For an introduction, see
130
 
      <citerefentry><refentrytitle>intro</refentrytitle>
131
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
132
 
      uses Zeroconf to announce itself on the local network, and uses
133
 
      TLS to communicate securely with and to authenticate the
134
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
135
 
      use IPv6 link-local addresses, since the clients will probably
136
 
      not have any other addresses configured (see <xref
137
 
      linkend="overview"/>).  Any authenticated client is then given
138
 
      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.
139
139
    </para>
 
140
 
140
141
  </refsect1>
141
142
  
142
143
  <refsect1 id="purpose">
143
144
    <title>PURPOSE</title>
 
145
 
144
146
    <para>
145
147
      The purpose of this is to enable <emphasis>remote and unattended
146
148
      rebooting</emphasis> of client host computer with an
147
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
148
150
      linkend="overview"/> for details.
149
151
    </para>
 
152
    
150
153
  </refsect1>
151
154
  
152
155
  <refsect1 id="options">
153
156
    <title>OPTIONS</title>
 
157
    
154
158
    <variablelist>
155
159
      <varlistentry>
156
160
        <term><option>--help</option></term>
208
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
209
213
        </listitem>
210
214
      </varlistentry>
211
 
      
212
 
      <varlistentry>
213
 
        <term><option>--debuglevel
214
 
        <replaceable>LEVEL</replaceable></option></term>
215
 
        <listitem>
216
 
          <para>
217
 
            Set the debugging log level.
218
 
            <replaceable>LEVEL</replaceable> is a string, one of
219
 
            <quote><literal>CRITICAL</literal></quote>,
220
 
            <quote><literal>ERROR</literal></quote>,
221
 
            <quote><literal>WARNING</literal></quote>,
222
 
            <quote><literal>INFO</literal></quote>, or
223
 
            <quote><literal>DEBUG</literal></quote>, in order of
224
 
            increasing verbosity.  The default level is
225
 
            <quote><literal>WARNING</literal></quote>.
226
 
          </para>
227
 
        </listitem>
228
 
      </varlistentry>
229
 
      
 
215
 
230
216
      <varlistentry>
231
217
        <term><option>--priority <replaceable>
232
218
        PRIORITY</replaceable></option></term>
234
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
235
221
        </listitem>
236
222
      </varlistentry>
237
 
      
 
223
 
238
224
      <varlistentry>
239
225
        <term><option>--servicename
240
226
        <replaceable>NAME</replaceable></option></term>
243
229
                      xpointer="servicename"/>
244
230
        </listitem>
245
231
      </varlistentry>
246
 
      
 
232
 
247
233
      <varlistentry>
248
234
        <term><option>--configdir
249
235
        <replaceable>DIRECTORY</replaceable></option></term>
258
244
          </para>
259
245
        </listitem>
260
246
      </varlistentry>
261
 
      
 
247
 
262
248
      <varlistentry>
263
249
        <term><option>--version</option></term>
264
250
        <listitem>
267
253
          </para>
268
254
        </listitem>
269
255
      </varlistentry>
270
 
      
271
 
      <varlistentry>
272
 
        <term><option>--no-dbus</option></term>
273
 
        <listitem>
274
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
275
 
          <para>
276
 
            See also <xref linkend="dbus_interface"/>.
277
 
          </para>
278
 
        </listitem>
279
 
      </varlistentry>
280
 
      
281
 
      <varlistentry>
282
 
        <term><option>--no-ipv6</option></term>
283
 
        <listitem>
284
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
285
 
        </listitem>
286
 
      </varlistentry>
287
 
      
288
 
      <varlistentry>
289
 
        <term><option>--no-restore</option></term>
290
 
        <listitem>
291
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
292
 
          <para>
293
 
            See also <xref linkend="persistent_state"/>.
294
 
          </para>
295
 
        </listitem>
296
 
      </varlistentry>
297
 
      
298
 
      <varlistentry>
299
 
        <term><option>--statedir
300
 
        <replaceable>DIRECTORY</replaceable></option></term>
301
 
        <listitem>
302
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
303
 
        </listitem>
304
 
      </varlistentry>
305
 
      
306
 
      <varlistentry>
307
 
        <term><option>--socket
308
 
        <replaceable>FD</replaceable></option></term>
309
 
        <listitem>
310
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
311
 
        </listitem>
312
 
      </varlistentry>
313
 
      
314
256
    </variablelist>
315
257
  </refsect1>
316
 
  
 
258
 
317
259
  <refsect1 id="overview">
318
260
    <title>OVERVIEW</title>
319
261
    <xi:include href="overview.xml"/>
320
262
    <para>
321
263
      This program is the server part.  It is a normal server program
322
264
      and will run in a normal system environment, not in an initial
323
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
324
266
    </para>
325
267
  </refsect1>
326
 
  
 
268
 
327
269
  <refsect1 id="protocol">
328
270
    <title>NETWORK PROTOCOL</title>
329
271
    <para>
381
323
      </row>
382
324
    </tbody></tgroup></table>
383
325
  </refsect1>
384
 
  
 
326
 
385
327
  <refsect1 id="checking">
386
328
    <title>CHECKING</title>
387
329
    <para>
388
330
      The server will, by default, continually check that the clients
389
331
      are still up.  If a client has not been confirmed as being up
390
332
      for some time, the client is assumed to be compromised and is no
391
 
      longer eligible to receive the encrypted password.  (Manual
392
 
      intervention is required to re-enable a client.)  The timeout,
393
 
      extended timeout, checker program, and interval between checks
394
 
      can be configured both globally and per client; see
395
 
      <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>
396
337
      <manvolnum>5</manvolnum></citerefentry>.
397
338
    </para>
398
339
  </refsect1>
399
 
  
400
 
  <refsect1 id="approval">
401
 
    <title>APPROVAL</title>
402
 
    <para>
403
 
      The server can be configured to require manual approval for a
404
 
      client before it is sent its secret.  The delay to wait for such
405
 
      approval and the default action (approve or deny) can be
406
 
      configured both globally and per client; see <citerefentry>
407
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
408
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
409
 
      will be approved immediately without delay.
410
 
    </para>
411
 
    <para>
412
 
      This can be used to deny a client its secret if not manually
413
 
      approved within a specified time.  It can also be used to make
414
 
      the server delay before giving a client its secret, allowing
415
 
      optional manual denying of this specific client.
416
 
    </para>
417
 
    
418
 
  </refsect1>
419
 
  
 
340
 
420
341
  <refsect1 id="logging">
421
342
    <title>LOGGING</title>
422
343
    <para>
423
344
      The server will send log message with various severity levels to
424
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
345
      <filename>/dev/log</filename>.  With the
425
346
      <option>--debug</option> option, it will log even more messages,
426
347
      and also show them on the console.
427
348
    </para>
428
349
  </refsect1>
429
 
  
430
 
  <refsect1 id="persistent_state">
431
 
    <title>PERSISTENT STATE</title>
432
 
    <para>
433
 
      Client settings, initially read from
434
 
      <filename>clients.conf</filename>, are persistent across
435
 
      restarts, and run-time changes will override settings in
436
 
      <filename>clients.conf</filename>.  However, if a setting is
437
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
438
 
      <filename>clients.conf</filename>, this will take precedence.
439
 
    </para>
440
 
  </refsect1>
441
 
  
442
 
  <refsect1 id="dbus_interface">
443
 
    <title>D-BUS INTERFACE</title>
444
 
    <para>
445
 
      The server will by default provide a D-Bus system bus interface.
446
 
      This interface will only be accessible by the root user or a
447
 
      Mandos-specific user, if such a user exists.  For documentation
448
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
449
 
    </para>
450
 
  </refsect1>
451
 
  
 
350
 
452
351
  <refsect1 id="exit_status">
453
352
    <title>EXIT STATUS</title>
454
353
    <para>
456
355
      critical error is encountered.
457
356
    </para>
458
357
  </refsect1>
459
 
  
 
358
 
460
359
  <refsect1 id="environment">
461
360
    <title>ENVIRONMENT</title>
462
361
    <variablelist>
476
375
      </varlistentry>
477
376
    </variablelist>
478
377
  </refsect1>
479
 
  
480
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
481
380
    <title>FILES</title>
482
381
    <para>
483
382
      Use the <option>--configdir</option> option to change where
506
405
        </listitem>
507
406
      </varlistentry>
508
407
      <varlistentry>
509
 
        <term><filename>/var/run/mandos.pid</filename></term>
510
 
        <listitem>
511
 
          <para>
512
 
            The file containing the process id of the
513
 
            <command>&COMMANDNAME;</command> process started last.
514
 
          </para>
515
 
        </listitem>
516
 
      </varlistentry>
517
 
      <varlistentry>
518
 
        <term><filename class="devicefile">/dev/log</filename></term>
519
 
      </varlistentry>
520
 
      <varlistentry>
521
 
        <term><filename
522
 
        class="directory">/var/lib/mandos</filename></term>
523
 
        <listitem>
524
 
          <para>
525
 
            Directory where persistent state will be saved.  Change
526
 
            this with the <option>--statedir</option> option.  See
527
 
            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>.
528
413
          </para>
529
414
        </listitem>
530
415
      </varlistentry>
558
443
      backtrace.  This could be considered a feature.
559
444
    </para>
560
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>
561
457
      There is no fine-grained control over logging and debug output.
562
458
    </para>
563
459
    <para>
564
460
      Debug mode is conflated with running in the foreground.
565
461
    </para>
566
462
    <para>
567
 
      This server does not check the expire time of clients’ OpenPGP
568
 
      keys.
 
463
      The console log messages does not show a timestamp.
569
464
    </para>
570
465
  </refsect1>
571
466
  
582
477
    <informalexample>
583
478
      <para>
584
479
        Run the server in debug mode, read configuration files from
585
 
        the <filename class="directory">~/mandos</filename> directory,
586
 
        and use the Zeroconf service name <quote>Test</quote> to not
587
 
        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:
588
483
      </para>
589
484
      <para>
590
485
 
606
501
      </para>
607
502
    </informalexample>
608
503
  </refsect1>
609
 
  
 
504
 
610
505
  <refsect1 id="security">
611
506
    <title>SECURITY</title>
612
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
613
508
      <title>SERVER</title>
614
509
      <para>
615
510
        Running this <command>&COMMANDNAME;</command> server program
616
511
        should not in itself present any security risk to the host
617
 
        computer running it.  The program switches to a non-root user
618
 
        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.
619
514
      </para>
620
515
    </refsect2>
621
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
622
517
      <title>CLIENTS</title>
623
518
      <para>
624
519
        The server only gives out its stored data to clients which
631
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
632
527
        <manvolnum>5</manvolnum></citerefentry>)
633
528
        <emphasis>must</emphasis> be made non-readable by anyone
634
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
635
530
      </para>
636
531
      <para>
637
532
        As detailed in <xref linkend="checking"/>, the status of all
639
534
        compromised if they are gone for too long.
640
535
      </para>
641
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>
642
553
        For more details on client-side security, see
643
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
644
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
645
556
      </para>
646
557
    </refsect2>
647
558
  </refsect1>
648
 
  
 
559
 
649
560
  <refsect1 id="see_also">
650
561
    <title>SEE ALSO</title>
651
562
    <para>
652
 
      <citerefentry><refentrytitle>intro</refentrytitle>
653
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
654
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
 
      <manvolnum>5</manvolnum></citerefentry>,
656
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
657
 
      <manvolnum>5</manvolnum></citerefentry>,
658
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
659
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
660
 
      <citerefentry><refentrytitle>sh</refentrytitle>
661
 
      <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>
662
572
    </para>
663
573
    <variablelist>
664
574
      <varlistentry>