/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

Update copyright year to "2010" wherever appropriate.

* DBUS-API: Added copyright and license statement.
* README: Mention new "plymouth" plugin.
* debian/control: Depend on python-2.6 or python-multiprocessing.
* debian/mandos-client.README.Debian: Update info about DEVICE setting
                                      of initramfs.conf.
* mandos-ctl: Added copyright and license statement.
* mandos-monitor: - '' -
* plugins.d/plymouth.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">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
6
8
]>
7
9
 
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
 
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
11
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
13
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
14
17
    <authorgroup>
15
18
      <author>
16
19
        <firstname>Björn</firstname>
29
32
    </authorgroup>
30
33
    <copyright>
31
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
32
37
      <holder>Teddy Hogeborn</holder>
33
38
      <holder>Björn Påhlsson</holder>
34
39
    </copyright>
35
 
    <legalnotice>
36
 
      <para>
37
 
        This manual page is free software: you can redistribute it
38
 
        and/or modify it under the terms of the GNU General Public
39
 
        License as published by the Free Software Foundation,
40
 
        either version 3 of the License, or (at your option) any
41
 
        later version.
42
 
      </para>
43
 
 
44
 
      <para>
45
 
        This manual page is distributed in the hope that it will
46
 
        be useful, but WITHOUT ANY WARRANTY; without even the
47
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
48
 
        PARTICULAR PURPOSE.  See the GNU General Public License
49
 
        for more details.
50
 
      </para>
51
 
 
52
 
      <para>
53
 
        You should have received a copy of the GNU General Public
54
 
        License along with this program; If not, see
55
 
        <ulink url="http://www.gnu.org/licenses/"/>.
56
 
      </para>
57
 
    </legalnotice>
 
40
    <xi:include href="legalnotice.xml"/>
58
41
  </refentryinfo>
59
 
 
 
42
  
60
43
  <refmeta>
61
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
45
    <manvolnum>8</manvolnum>
65
48
  <refnamediv>
66
49
    <refname><command>&COMMANDNAME;</command></refname>
67
50
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
51
      Gives encrypted passwords to authenticated Mandos clients
69
52
    </refpurpose>
70
53
  </refnamediv>
71
 
 
 
54
  
72
55
  <refsynopsisdiv>
73
56
    <cmdsynopsis>
74
57
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
76
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
80
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
81
 
      <arg>--debug</arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
86
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
90
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
91
 
      <arg>--debug</arg>
 
58
      <group>
 
59
        <arg choice="plain"><option>--interface
 
60
        <replaceable>NAME</replaceable></option></arg>
 
61
        <arg choice="plain"><option>-i
 
62
        <replaceable>NAME</replaceable></option></arg>
 
63
      </group>
 
64
      <sbr/>
 
65
      <group>
 
66
        <arg choice="plain"><option>--address
 
67
        <replaceable>ADDRESS</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-a
 
69
        <replaceable>ADDRESS</replaceable></option></arg>
 
70
      </group>
 
71
      <sbr/>
 
72
      <group>
 
73
        <arg choice="plain"><option>--port
 
74
        <replaceable>PORT</replaceable></option></arg>
 
75
        <arg choice="plain"><option>-p
 
76
        <replaceable>PORT</replaceable></option></arg>
 
77
      </group>
 
78
      <sbr/>
 
79
      <arg><option>--priority
 
80
      <replaceable>PRIORITY</replaceable></option></arg>
 
81
      <sbr/>
 
82
      <arg><option>--servicename
 
83
      <replaceable>NAME</replaceable></option></arg>
 
84
      <sbr/>
 
85
      <arg><option>--configdir
 
86
      <replaceable>DIRECTORY</replaceable></option></arg>
 
87
      <sbr/>
 
88
      <arg><option>--debug</option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--no-dbus</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--no-ipv6</option></arg>
92
93
    </cmdsynopsis>
93
94
    <cmdsynopsis>
94
95
      <command>&COMMANDNAME;</command>
95
96
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
97
        <arg choice="plain"><option>--help</option></arg>
 
98
        <arg choice="plain"><option>-h</option></arg>
98
99
      </group>
99
100
    </cmdsynopsis>
100
101
    <cmdsynopsis>
101
102
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
103
      <arg choice="plain"><option>--version</option></arg>
103
104
    </cmdsynopsis>
104
105
    <cmdsynopsis>
105
106
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
107
      <arg choice="plain"><option>--check</option></arg>
107
108
    </cmdsynopsis>
108
109
  </refsynopsisdiv>
109
 
 
 
110
  
110
111
  <refsect1 id="description">
111
112
    <title>DESCRIPTION</title>
112
113
    <para>
121
122
      Any authenticated client is then given the stored pre-encrypted
122
123
      password for that specific client.
123
124
    </para>
124
 
 
125
125
  </refsect1>
126
126
  
127
127
  <refsect1 id="purpose">
128
128
    <title>PURPOSE</title>
129
 
 
130
129
    <para>
131
130
      The purpose of this is to enable <emphasis>remote and unattended
132
131
      rebooting</emphasis> of client host computer with an
133
132
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
133
      linkend="overview"/> for details.
135
134
    </para>
136
 
 
137
135
  </refsect1>
138
136
  
139
137
  <refsect1 id="options">
140
138
    <title>OPTIONS</title>
141
 
 
142
139
    <variablelist>
143
140
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
141
        <term><option>--help</option></term>
 
142
        <term><option>-h</option></term>
145
143
        <listitem>
146
144
          <para>
147
145
            Show a help message and exit
148
146
          </para>
149
147
        </listitem>
150
148
      </varlistentry>
151
 
 
 
149
      
152
150
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
151
        <term><option>--interface</option>
 
152
        <replaceable>NAME</replaceable></term>
 
153
        <term><option>-i</option>
 
154
        <replaceable>NAME</replaceable></term>
155
155
        <listitem>
156
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
157
        </listitem>
158
158
      </varlistentry>
159
 
 
 
159
      
160
160
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
161
        <term><option>--address
 
162
        <replaceable>ADDRESS</replaceable></option></term>
 
163
        <term><option>-a
 
164
        <replaceable>ADDRESS</replaceable></option></term>
163
165
        <listitem>
164
166
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
167
        </listitem>
166
168
      </varlistentry>
167
 
 
 
169
      
168
170
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
171
        <term><option>--port
 
172
        <replaceable>PORT</replaceable></option></term>
 
173
        <term><option>-p
 
174
        <replaceable>PORT</replaceable></option></term>
171
175
        <listitem>
172
176
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
177
        </listitem>
174
178
      </varlistentry>
175
 
 
 
179
      
176
180
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
181
        <term><option>--check</option></term>
178
182
        <listitem>
179
183
          <para>
180
184
            Run the server’s self-tests.  This includes any unit
182
186
          </para>
183
187
        </listitem>
184
188
      </varlistentry>
185
 
 
 
189
      
186
190
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
191
        <term><option>--debug</option></term>
188
192
        <listitem>
189
193
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
194
        </listitem>
191
195
      </varlistentry>
192
 
 
 
196
      
193
197
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
198
        <term><option>--priority <replaceable>
 
199
        PRIORITY</replaceable></option></term>
196
200
        <listitem>
197
201
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
202
        </listitem>
199
203
      </varlistentry>
200
 
 
 
204
      
201
205
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
206
        <term><option>--servicename
 
207
        <replaceable>NAME</replaceable></option></term>
204
208
        <listitem>
205
209
          <xi:include href="mandos-options.xml"
206
210
                      xpointer="servicename"/>
207
211
        </listitem>
208
212
      </varlistentry>
209
 
 
 
213
      
210
214
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
215
        <term><option>--configdir
 
216
        <replaceable>DIRECTORY</replaceable></option></term>
213
217
        <listitem>
214
218
          <para>
215
219
            Directory to search for configuration files.  Default is
221
225
          </para>
222
226
        </listitem>
223
227
      </varlistentry>
224
 
 
 
228
      
225
229
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
230
        <term><option>--version</option></term>
227
231
        <listitem>
228
232
          <para>
229
233
            Prints the program version and exit.
230
234
          </para>
231
235
        </listitem>
232
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>
233
254
    </variablelist>
234
255
  </refsect1>
235
 
 
 
256
  
236
257
  <refsect1 id="overview">
237
258
    <title>OVERVIEW</title>
238
259
    <xi:include href="overview.xml"/>
239
260
    <para>
240
261
      This program is the server part.  It is a normal server program
241
262
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
263
      <acronym>RAM</acronym> disk environment.
243
264
    </para>
244
265
  </refsect1>
245
 
 
 
266
  
246
267
  <refsect1 id="protocol">
247
268
    <title>NETWORK PROTOCOL</title>
248
269
    <para>
300
321
      </row>
301
322
    </tbody></tgroup></table>
302
323
  </refsect1>
303
 
 
 
324
  
304
325
  <refsect1 id="checking">
305
326
    <title>CHECKING</title>
306
327
    <para>
307
328
      The server will, by default, continually check that the clients
308
329
      are still up.  If a client has not been confirmed as being up
309
330
      for some time, the client is assumed to be compromised and is no
310
 
      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,
311
333
      checker program, and interval between checks can be configured
312
334
      both globally and per client; see <citerefentry>
313
335
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
315
 
    </para>
316
 
  </refsect1>
317
 
 
 
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
  
318
362
  <refsect1 id="logging">
319
363
    <title>LOGGING</title>
320
364
    <para>
324
368
      and also show them on the console.
325
369
    </para>
326
370
  </refsect1>
327
 
 
 
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
  
328
382
  <refsect1 id="exit_status">
329
383
    <title>EXIT STATUS</title>
330
384
    <para>
332
386
      critical error is encountered.
333
387
    </para>
334
388
  </refsect1>
335
 
 
 
389
  
336
390
  <refsect1 id="environment">
337
391
    <title>ENVIRONMENT</title>
338
392
    <variablelist>
339
393
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
394
        <term><envar>PATH</envar></term>
341
395
        <listitem>
342
396
          <para>
343
397
            To start the configured checker (see <xref
352
406
      </varlistentry>
353
407
    </variablelist>
354
408
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
409
  
 
410
  <refsect1 id="files">
357
411
    <title>FILES</title>
358
412
    <para>
359
413
      Use the <option>--configdir</option> option to change where
382
436
        </listitem>
383
437
      </varlistentry>
384
438
      <varlistentry>
385
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
439
        <term><filename>/var/run/mandos.pid</filename></term>
386
440
        <listitem>
387
441
          <para>
388
 
            The file containing the process id of
389
 
            <command>&COMMANDNAME;</command>.
 
442
            The file containing the process id of the
 
443
            <command>&COMMANDNAME;</command> process started last.
390
444
          </para>
391
445
        </listitem>
392
446
      </varlistentry>
420
474
      backtrace.  This could be considered a feature.
421
475
    </para>
422
476
    <para>
423
 
      Currently, if a client is declared <quote>invalid</quote> due to
424
 
      having timed out, the server does not record this fact onto
425
 
      permanent storage.  This has some security implications, see
426
 
      <xref linkend="CLIENTS"/>.
427
 
    </para>
428
 
    <para>
429
 
      There is currently no way of querying the server of the current
430
 
      status of clients, other than analyzing its <systemitem
431
 
      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"/>.
432
480
    </para>
433
481
    <para>
434
482
      There is no fine-grained control over logging and debug output.
437
485
      Debug mode is conflated with running in the foreground.
438
486
    </para>
439
487
    <para>
440
 
      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.
441
493
    </para>
442
494
  </refsect1>
443
495
  
478
530
      </para>
479
531
    </informalexample>
480
532
  </refsect1>
481
 
 
 
533
  
482
534
  <refsect1 id="security">
483
535
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
536
    <refsect2 id="server">
485
537
      <title>SERVER</title>
486
538
      <para>
487
539
        Running this <command>&COMMANDNAME;</command> server program
488
540
        should not in itself present any security risk to the host
489
 
        computer running it.  The program does not need any special
490
 
        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.
491
543
      </para>
492
544
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
545
    <refsect2 id="clients">
494
546
      <title>CLIENTS</title>
495
547
      <para>
496
548
        The server only gives out its stored data to clients which
503
555
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
556
        <manvolnum>5</manvolnum></citerefentry>)
505
557
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
558
        except the user starting the server (usually root).
507
559
      </para>
508
560
      <para>
509
561
        As detailed in <xref linkend="checking"/>, the status of all
512
564
      </para>
513
565
      <para>
514
566
        If a client is compromised, its downtime should be duly noted
515
 
        by the server which would therefore declare the client
516
 
        invalid.  But if the server was ever restarted, it would
517
 
        re-read its client list from its configuration file and again
518
 
        regard all clients therein as valid, and hence eligible to
519
 
        receive their passwords.  Therefore, be careful when
520
 
        restarting servers if it is suspected that a client has, in
521
 
        fact, been compromised by parties who may now be running a
522
 
        fake Mandos client with the keys from the non-encrypted
523
 
        initial RAM image of the client host.  What should be done in
524
 
        that case (if restarting the server program really is
525
 
        necessary) is to stop the server program, edit the
526
 
        configuration file to omit any suspect clients, and restart
527
 
        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.
528
579
      </para>
529
580
      <para>
530
581
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
582
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
583
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
584
      </para>
534
585
    </refsect2>
535
586
  </refsect1>
536
 
 
 
587
  
537
588
  <refsect1 id="see_also">
538
589
    <title>SEE ALSO</title>
539
590
    <para>
540
591
      <citerefentry>
 
592
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
593
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
541
594
        <refentrytitle>mandos.conf</refentrytitle>
542
595
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
 
596
        <refentrytitle>mandos-client</refentrytitle>
546
597
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
598
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
599
      </citerefentry>
651
702
    </variablelist>
652
703
  </refsect1>
653
704
</refentry>
 
705
<!-- Local Variables: -->
 
706
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
707
<!-- time-stamp-end: "[\"']>" -->
 
708
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
709
<!-- End: -->