/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 14:02:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140237-oz9knd88esz8cj4y
* plugin-runner.xml: Removed <?xml-stylesheet>.
* 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 "2011-11-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
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
 
    <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>
42
60
  </refentryinfo>
43
 
  
 
61
 
44
62
  <refmeta>
45
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
64
    <manvolnum>8</manvolnum>
52
70
      Gives encrypted passwords to authenticated Mandos clients
53
71
    </refpurpose>
54
72
  </refnamediv>
55
 
  
 
73
 
56
74
  <refsynopsisdiv>
57
75
    <cmdsynopsis>
58
76
      <command>&COMMANDNAME;</command>
87
105
      <replaceable>DIRECTORY</replaceable></option></arg>
88
106
      <sbr/>
89
107
      <arg><option>--debug</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--debuglevel
92
 
      <replaceable>LEVEL</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <arg><option>--no-dbus</option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--no-ipv6</option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--no-restore</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--statedir
101
 
      <replaceable>DIRECTORY</replaceable></option></arg>
102
108
    </cmdsynopsis>
103
109
    <cmdsynopsis>
104
110
      <command>&COMMANDNAME;</command>
116
122
      <arg choice="plain"><option>--check</option></arg>
117
123
    </cmdsynopsis>
118
124
  </refsynopsisdiv>
119
 
  
 
125
 
120
126
  <refsect1 id="description">
121
127
    <title>DESCRIPTION</title>
122
128
    <para>
123
129
      <command>&COMMANDNAME;</command> is a server daemon which
124
130
      handles incoming request for passwords for a pre-defined list of
125
 
      client host computers. For an introduction, see
126
 
      <citerefentry><refentrytitle>intro</refentrytitle>
127
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
128
 
      uses Zeroconf to announce itself on the local network, and uses
129
 
      TLS to communicate securely with and to authenticate the
130
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
131
 
      use IPv6 link-local addresses, since the clients will probably
132
 
      not have any other addresses configured (see <xref
133
 
      linkend="overview"/>).  Any authenticated client is then given
134
 
      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.
135
139
    </para>
 
140
 
136
141
  </refsect1>
137
142
  
138
143
  <refsect1 id="purpose">
139
144
    <title>PURPOSE</title>
 
145
 
140
146
    <para>
141
147
      The purpose of this is to enable <emphasis>remote and unattended
142
148
      rebooting</emphasis> of client host computer with an
143
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
144
150
      linkend="overview"/> for details.
145
151
    </para>
 
152
    
146
153
  </refsect1>
147
154
  
148
155
  <refsect1 id="options">
149
156
    <title>OPTIONS</title>
 
157
    
150
158
    <variablelist>
151
159
      <varlistentry>
152
160
        <term><option>--help</option></term>
204
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
205
213
        </listitem>
206
214
      </varlistentry>
207
 
      
208
 
      <varlistentry>
209
 
        <term><option>--debuglevel
210
 
        <replaceable>LEVEL</replaceable></option></term>
211
 
        <listitem>
212
 
          <para>
213
 
            Set the debugging log level.
214
 
            <replaceable>LEVEL</replaceable> is a string, one of
215
 
            <quote><literal>CRITICAL</literal></quote>,
216
 
            <quote><literal>ERROR</literal></quote>,
217
 
            <quote><literal>WARNING</literal></quote>,
218
 
            <quote><literal>INFO</literal></quote>, or
219
 
            <quote><literal>DEBUG</literal></quote>, in order of
220
 
            increasing verbosity.  The default level is
221
 
            <quote><literal>WARNING</literal></quote>.
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
      
 
215
 
226
216
      <varlistentry>
227
217
        <term><option>--priority <replaceable>
228
218
        PRIORITY</replaceable></option></term>
230
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
231
221
        </listitem>
232
222
      </varlistentry>
233
 
      
 
223
 
234
224
      <varlistentry>
235
225
        <term><option>--servicename
236
226
        <replaceable>NAME</replaceable></option></term>
239
229
                      xpointer="servicename"/>
240
230
        </listitem>
241
231
      </varlistentry>
242
 
      
 
232
 
243
233
      <varlistentry>
244
234
        <term><option>--configdir
245
235
        <replaceable>DIRECTORY</replaceable></option></term>
254
244
          </para>
255
245
        </listitem>
256
246
      </varlistentry>
257
 
      
 
247
 
258
248
      <varlistentry>
259
249
        <term><option>--version</option></term>
260
250
        <listitem>
263
253
          </para>
264
254
        </listitem>
265
255
      </varlistentry>
266
 
      
267
 
      <varlistentry>
268
 
        <term><option>--no-dbus</option></term>
269
 
        <listitem>
270
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
271
 
          <para>
272
 
            See also <xref linkend="dbus_interface"/>.
273
 
          </para>
274
 
        </listitem>
275
 
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--no-ipv6</option></term>
279
 
        <listitem>
280
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
281
 
        </listitem>
282
 
      </varlistentry>
283
 
      
284
 
      <varlistentry>
285
 
        <term><option>--no-restore</option></term>
286
 
        <listitem>
287
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
288
 
        </listitem>
289
 
      </varlistentry>
290
 
      
291
 
      <varlistentry>
292
 
        <term><option>--statedir
293
 
        <replaceable>DIRECTORY</replaceable></option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
 
        </listitem>
297
 
      </varlistentry>
298
256
    </variablelist>
299
257
  </refsect1>
300
 
  
 
258
 
301
259
  <refsect1 id="overview">
302
260
    <title>OVERVIEW</title>
303
261
    <xi:include href="overview.xml"/>
304
262
    <para>
305
263
      This program is the server part.  It is a normal server program
306
264
      and will run in a normal system environment, not in an initial
307
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
308
266
    </para>
309
267
  </refsect1>
310
 
  
 
268
 
311
269
  <refsect1 id="protocol">
312
270
    <title>NETWORK PROTOCOL</title>
313
271
    <para>
365
323
      </row>
366
324
    </tbody></tgroup></table>
367
325
  </refsect1>
368
 
  
 
326
 
369
327
  <refsect1 id="checking">
370
328
    <title>CHECKING</title>
371
329
    <para>
372
330
      The server will, by default, continually check that the clients
373
331
      are still up.  If a client has not been confirmed as being up
374
332
      for some time, the client is assumed to be compromised and is no
375
 
      longer eligible to receive the encrypted password.  (Manual
376
 
      intervention is required to re-enable a client.)  The timeout,
377
 
      extended timeout, checker program, and interval between checks
378
 
      can be configured both globally and per client; see
379
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
383
 
    </para>
384
 
  </refsect1>
385
 
  
386
 
  <refsect1 id="approval">
387
 
    <title>APPROVAL</title>
388
 
    <para>
389
 
      The server can be configured to require manual approval for a
390
 
      client before it is sent its secret.  The delay to wait for such
391
 
      approval and the default action (approve or deny) can be
392
 
      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>
393
336
      <refentrytitle>mandos-clients.conf</refentrytitle>
394
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
395
 
      will be approved immediately without delay.
396
 
    </para>
397
 
    <para>
398
 
      This can be used to deny a client its secret if not manually
399
 
      approved within a specified time.  It can also be used to make
400
 
      the server delay before giving a client its secret, allowing
401
 
      optional manual denying of this specific client.
402
 
    </para>
403
 
    
 
337
      <manvolnum>5</manvolnum></citerefentry>.
 
338
    </para>
404
339
  </refsect1>
405
 
  
 
340
 
406
341
  <refsect1 id="logging">
407
342
    <title>LOGGING</title>
408
343
    <para>
409
344
      The server will send log message with various severity levels to
410
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
345
      <filename>/dev/log</filename>.  With the
411
346
      <option>--debug</option> option, it will log even more messages,
412
347
      and also show them on the console.
413
348
    </para>
414
349
  </refsect1>
415
 
  
416
 
  <refsect1 id="dbus_interface">
417
 
    <title>D-BUS INTERFACE</title>
418
 
    <para>
419
 
      The server will by default provide a D-Bus system bus interface.
420
 
      This interface will only be accessible by the root user or a
421
 
      Mandos-specific user, if such a user exists.  For documentation
422
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
423
 
    </para>
424
 
  </refsect1>
425
 
  
 
350
 
426
351
  <refsect1 id="exit_status">
427
352
    <title>EXIT STATUS</title>
428
353
    <para>
430
355
      critical error is encountered.
431
356
    </para>
432
357
  </refsect1>
433
 
  
 
358
 
434
359
  <refsect1 id="environment">
435
360
    <title>ENVIRONMENT</title>
436
361
    <variablelist>
450
375
      </varlistentry>
451
376
    </variablelist>
452
377
  </refsect1>
453
 
  
454
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
455
380
    <title>FILES</title>
456
381
    <para>
457
382
      Use the <option>--configdir</option> option to change where
480
405
        </listitem>
481
406
      </varlistentry>
482
407
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
484
 
        <listitem>
485
 
          <para>
486
 
            The file containing the process id of the
487
 
            <command>&COMMANDNAME;</command> process started last.
488
 
          </para>
489
 
        </listitem>
490
 
      </varlistentry>
491
 
      <varlistentry>
492
 
        <term><filename class="devicefile">/dev/log</filename></term>
493
 
      </varlistentry>
494
 
      <varlistentry>
495
 
        <term><filename
496
 
        class="directory">/var/lib/mandos</filename></term>
497
 
        <listitem>
498
 
          <para>
499
 
            Directory where persistent state will be saved.  Change
500
 
            this with the <option>--statedir</option> option.  See
501
 
            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>.
502
413
          </para>
503
414
        </listitem>
504
415
      </varlistentry>
532
443
      backtrace.  This could be considered a feature.
533
444
    </para>
534
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>
535
457
      There is no fine-grained control over logging and debug output.
536
458
    </para>
537
459
    <para>
538
460
      Debug mode is conflated with running in the foreground.
539
461
    </para>
540
462
    <para>
541
 
      This server does not check the expire time of clients’ OpenPGP
542
 
      keys.
 
463
      The console log messages does not show a timestamp.
543
464
    </para>
544
465
  </refsect1>
545
466
  
556
477
    <informalexample>
557
478
      <para>
558
479
        Run the server in debug mode, read configuration files from
559
 
        the <filename class="directory">~/mandos</filename> directory,
560
 
        and use the Zeroconf service name <quote>Test</quote> to not
561
 
        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:
562
483
      </para>
563
484
      <para>
564
485
 
580
501
      </para>
581
502
    </informalexample>
582
503
  </refsect1>
583
 
  
 
504
 
584
505
  <refsect1 id="security">
585
506
    <title>SECURITY</title>
586
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
587
508
      <title>SERVER</title>
588
509
      <para>
589
510
        Running this <command>&COMMANDNAME;</command> server program
590
511
        should not in itself present any security risk to the host
591
 
        computer running it.  The program switches to a non-root user
592
 
        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.
593
514
      </para>
594
515
    </refsect2>
595
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
596
517
      <title>CLIENTS</title>
597
518
      <para>
598
519
        The server only gives out its stored data to clients which
605
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
606
527
        <manvolnum>5</manvolnum></citerefentry>)
607
528
        <emphasis>must</emphasis> be made non-readable by anyone
608
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
609
530
      </para>
610
531
      <para>
611
532
        As detailed in <xref linkend="checking"/>, the status of all
613
534
        compromised if they are gone for too long.
614
535
      </para>
615
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>
616
553
        For more details on client-side security, see
617
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
618
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
619
556
      </para>
620
557
    </refsect2>
621
558
  </refsect1>
622
 
  
 
559
 
623
560
  <refsect1 id="see_also">
624
561
    <title>SEE ALSO</title>
625
562
    <para>
626
 
      <citerefentry><refentrytitle>intro</refentrytitle>
627
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
628
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
629
 
      <manvolnum>5</manvolnum></citerefentry>,
630
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
631
 
      <manvolnum>5</manvolnum></citerefentry>,
632
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
633
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
634
 
      <citerefentry><refentrytitle>sh</refentrytitle>
635
 
      <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>
636
572
    </para>
637
573
    <variablelist>
638
574
      <varlistentry>