/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: 2010-09-26 21:27:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100926212728-ej205k5037nfhz2g
Update copyright year to "2010" wherever appropriate.

* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -

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-08-31">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
 
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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
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>
 
40
    <xi:include href="legalnotice.xml"/>
60
41
  </refentryinfo>
61
 
 
 
42
  
62
43
  <refmeta>
63
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
45
    <manvolnum>8</manvolnum>
70
51
      Gives encrypted passwords to authenticated Mandos clients
71
52
    </refpurpose>
72
53
  </refnamediv>
73
 
 
 
54
  
74
55
  <refsynopsisdiv>
75
56
    <cmdsynopsis>
76
57
      <command>&COMMANDNAME;</command>
105
86
      <replaceable>DIRECTORY</replaceable></option></arg>
106
87
      <sbr/>
107
88
      <arg><option>--debug</option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--no-dbus</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--no-ipv6</option></arg>
108
93
    </cmdsynopsis>
109
94
    <cmdsynopsis>
110
95
      <command>&COMMANDNAME;</command>
122
107
      <arg choice="plain"><option>--check</option></arg>
123
108
    </cmdsynopsis>
124
109
  </refsynopsisdiv>
125
 
 
 
110
  
126
111
  <refsect1 id="description">
127
112
    <title>DESCRIPTION</title>
128
113
    <para>
137
122
      Any authenticated client is then given the stored pre-encrypted
138
123
      password for that specific client.
139
124
    </para>
140
 
 
141
125
  </refsect1>
142
126
  
143
127
  <refsect1 id="purpose">
144
128
    <title>PURPOSE</title>
145
 
 
146
129
    <para>
147
130
      The purpose of this is to enable <emphasis>remote and unattended
148
131
      rebooting</emphasis> of client host computer with an
149
132
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
133
      linkend="overview"/> for details.
151
134
    </para>
152
 
    
153
135
  </refsect1>
154
136
  
155
137
  <refsect1 id="options">
156
138
    <title>OPTIONS</title>
157
 
    
158
139
    <variablelist>
159
140
      <varlistentry>
160
141
        <term><option>--help</option></term>
212
193
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
194
        </listitem>
214
195
      </varlistentry>
215
 
 
 
196
      
216
197
      <varlistentry>
217
198
        <term><option>--priority <replaceable>
218
199
        PRIORITY</replaceable></option></term>
220
201
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
202
        </listitem>
222
203
      </varlistentry>
223
 
 
 
204
      
224
205
      <varlistentry>
225
206
        <term><option>--servicename
226
207
        <replaceable>NAME</replaceable></option></term>
229
210
                      xpointer="servicename"/>
230
211
        </listitem>
231
212
      </varlistentry>
232
 
 
 
213
      
233
214
      <varlistentry>
234
215
        <term><option>--configdir
235
216
        <replaceable>DIRECTORY</replaceable></option></term>
244
225
          </para>
245
226
        </listitem>
246
227
      </varlistentry>
247
 
 
 
228
      
248
229
      <varlistentry>
249
230
        <term><option>--version</option></term>
250
231
        <listitem>
253
234
          </para>
254
235
        </listitem>
255
236
      </varlistentry>
 
237
      
 
238
      <varlistentry>
 
239
        <term><option>--no-dbus</option></term>
 
240
        <listitem>
 
241
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
242
          <para>
 
243
            See also <xref linkend="dbus_interface"/>.
 
244
          </para>
 
245
        </listitem>
 
246
      </varlistentry>
 
247
      
 
248
      <varlistentry>
 
249
        <term><option>--no-ipv6</option></term>
 
250
        <listitem>
 
251
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
252
        </listitem>
 
253
      </varlistentry>
256
254
    </variablelist>
257
255
  </refsect1>
258
 
 
 
256
  
259
257
  <refsect1 id="overview">
260
258
    <title>OVERVIEW</title>
261
259
    <xi:include href="overview.xml"/>
262
260
    <para>
263
261
      This program is the server part.  It is a normal server program
264
262
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
263
      <acronym>RAM</acronym> disk environment.
266
264
    </para>
267
265
  </refsect1>
268
 
 
 
266
  
269
267
  <refsect1 id="protocol">
270
268
    <title>NETWORK PROTOCOL</title>
271
269
    <para>
323
321
      </row>
324
322
    </tbody></tgroup></table>
325
323
  </refsect1>
326
 
 
 
324
  
327
325
  <refsect1 id="checking">
328
326
    <title>CHECKING</title>
329
327
    <para>
330
328
      The server will, by default, continually check that the clients
331
329
      are still up.  If a client has not been confirmed as being up
332
330
      for some time, the client is assumed to be compromised and is no
333
 
      longer eligible to receive the encrypted password.  The timeout,
 
331
      longer eligible to receive the encrypted password.  (Manual
 
332
      intervention is required to re-enable a client.)  The timeout,
334
333
      checker program, and interval between checks can be configured
335
334
      both globally and per client; see <citerefentry>
336
335
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
 
      <manvolnum>5</manvolnum></citerefentry>.
338
 
    </para>
339
 
  </refsect1>
340
 
 
 
336
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
337
      receiving its password will also be treated as a successful
 
338
      checker run.
 
339
    </para>
 
340
  </refsect1>
 
341
  
 
342
  <refsect1 id="approval">
 
343
    <title>APPROVAL</title>
 
344
    <para>
 
345
      The server can be configured to require manual approval for a
 
346
      client before it is sent its secret.  The delay to wait for such
 
347
      approval and the default action (approve or deny) can be
 
348
      configured both globally and per client; see <citerefentry>
 
349
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
350
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
351
      will be approved immediately without delay.
 
352
    </para>
 
353
    <para>
 
354
      This can be used to deny a client its secret if not manually
 
355
      approved within a specified time.  It can also be used to make
 
356
      the server delay before giving a client its secret, allowing
 
357
      optional manual denying of this specific client.
 
358
    </para>
 
359
    
 
360
  </refsect1>
 
361
  
341
362
  <refsect1 id="logging">
342
363
    <title>LOGGING</title>
343
364
    <para>
347
368
      and also show them on the console.
348
369
    </para>
349
370
  </refsect1>
350
 
 
 
371
  
 
372
  <refsect1 id="dbus_interface">
 
373
    <title>D-BUS INTERFACE</title>
 
374
    <para>
 
375
      The server will by default provide a D-Bus system bus interface.
 
376
      This interface will only be accessible by the root user or a
 
377
      Mandos-specific user, if such a user exists.  For documentation
 
378
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
379
    </para>
 
380
  </refsect1>
 
381
  
351
382
  <refsect1 id="exit_status">
352
383
    <title>EXIT STATUS</title>
353
384
    <para>
355
386
      critical error is encountered.
356
387
    </para>
357
388
  </refsect1>
358
 
 
 
389
  
359
390
  <refsect1 id="environment">
360
391
    <title>ENVIRONMENT</title>
361
392
    <variablelist>
375
406
      </varlistentry>
376
407
    </variablelist>
377
408
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
409
  
 
410
  <refsect1 id="files">
380
411
    <title>FILES</title>
381
412
    <para>
382
413
      Use the <option>--configdir</option> option to change where
405
436
        </listitem>
406
437
      </varlistentry>
407
438
      <varlistentry>
408
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
439
        <term><filename>/var/run/mandos.pid</filename></term>
409
440
        <listitem>
410
441
          <para>
411
 
            The file containing the process id of
412
 
            <command>&COMMANDNAME;</command>.
 
442
            The file containing the process id of the
 
443
            <command>&COMMANDNAME;</command> process started last.
413
444
          </para>
414
445
        </listitem>
415
446
      </varlistentry>
443
474
      backtrace.  This could be considered a feature.
444
475
    </para>
445
476
    <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.
 
477
      Currently, if a client is disabled due to having timed out, the
 
478
      server does not record this fact onto permanent storage.  This
 
479
      has some security implications, see <xref linkend="clients"/>.
455
480
    </para>
456
481
    <para>
457
482
      There is no fine-grained control over logging and debug output.
460
485
      Debug mode is conflated with running in the foreground.
461
486
    </para>
462
487
    <para>
463
 
      The console log messages does not show a timestamp.
 
488
      The console log messages do not show a time stamp.
 
489
    </para>
 
490
    <para>
 
491
      This server does not check the expire time of clients’ OpenPGP
 
492
      keys.
464
493
    </para>
465
494
  </refsect1>
466
495
  
501
530
      </para>
502
531
    </informalexample>
503
532
  </refsect1>
504
 
 
 
533
  
505
534
  <refsect1 id="security">
506
535
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
536
    <refsect2 id="server">
508
537
      <title>SERVER</title>
509
538
      <para>
510
539
        Running this <command>&COMMANDNAME;</command> server program
511
540
        should not in itself present any security risk to the host
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.
 
541
        computer running it.  The program switches to a non-root user
 
542
        soon after startup.
514
543
      </para>
515
544
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
545
    <refsect2 id="clients">
517
546
      <title>CLIENTS</title>
518
547
      <para>
519
548
        The server only gives out its stored data to clients which
526
555
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
556
        <manvolnum>5</manvolnum></citerefentry>)
528
557
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
558
        except the user starting the server (usually root).
530
559
      </para>
531
560
      <para>
532
561
        As detailed in <xref linkend="checking"/>, the status of all
535
564
      </para>
536
565
      <para>
537
566
        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.
 
567
        by the server which would therefore disable the client.  But
 
568
        if the server was ever restarted, it would re-read its client
 
569
        list from its configuration file and again regard all clients
 
570
        therein as enabled, and hence eligible to receive their
 
571
        passwords.  Therefore, be careful when restarting servers if
 
572
        it is suspected that a client has, in fact, been compromised
 
573
        by parties who may now be running a fake Mandos client with
 
574
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
575
        image of the client host.  What should be done in that case
 
576
        (if restarting the server program really is necessary) is to
 
577
        stop the server program, edit the configuration file to omit
 
578
        any suspect clients, and restart the server program.
551
579
      </para>
552
580
      <para>
553
581
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
582
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
583
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
584
      </para>
557
585
    </refsect2>
558
586
  </refsect1>
559
 
 
 
587
  
560
588
  <refsect1 id="see_also">
561
589
    <title>SEE ALSO</title>
562
590
    <para>
565
593
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
594
        <refentrytitle>mandos.conf</refentrytitle>
567
595
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>password-request</refentrytitle>
 
596
        <refentrytitle>mandos-client</refentrytitle>
569
597
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
598
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
599
      </citerefentry>