/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

* debian/mandos.dirs: Added "etc/dbus-1/system.d".

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-11">
 
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>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </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>
 
39
    <xi:include href="legalnotice.xml"/>
60
40
  </refentryinfo>
61
 
 
 
41
  
62
42
  <refmeta>
63
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
44
    <manvolnum>8</manvolnum>
70
50
      Gives encrypted passwords to authenticated Mandos clients
71
51
    </refpurpose>
72
52
  </refnamediv>
73
 
 
 
53
  
74
54
  <refsynopsisdiv>
75
55
    <cmdsynopsis>
76
56
      <command>&COMMANDNAME;</command>
105
85
      <replaceable>DIRECTORY</replaceable></option></arg>
106
86
      <sbr/>
107
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
108
92
    </cmdsynopsis>
109
93
    <cmdsynopsis>
110
94
      <command>&COMMANDNAME;</command>
122
106
      <arg choice="plain"><option>--check</option></arg>
123
107
    </cmdsynopsis>
124
108
  </refsynopsisdiv>
125
 
 
 
109
  
126
110
  <refsect1 id="description">
127
111
    <title>DESCRIPTION</title>
128
112
    <para>
137
121
      Any authenticated client is then given the stored pre-encrypted
138
122
      password for that specific client.
139
123
    </para>
140
 
 
141
124
  </refsect1>
142
125
  
143
126
  <refsect1 id="purpose">
144
127
    <title>PURPOSE</title>
145
 
 
146
128
    <para>
147
129
      The purpose of this is to enable <emphasis>remote and unattended
148
130
      rebooting</emphasis> of client host computer with an
149
131
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
132
      linkend="overview"/> for details.
151
133
    </para>
152
 
 
153
134
  </refsect1>
154
135
  
155
136
  <refsect1 id="options">
156
137
    <title>OPTIONS</title>
157
 
 
158
138
    <variablelist>
159
139
      <varlistentry>
 
140
        <term><option>--help</option></term>
160
141
        <term><option>-h</option></term>
161
 
        <term><option>--help</option></term>
162
142
        <listitem>
163
143
          <para>
164
144
            Show a help message and exit
165
145
          </para>
166
146
        </listitem>
167
147
      </varlistentry>
168
 
 
 
148
      
169
149
      <varlistentry>
 
150
        <term><option>--interface</option>
 
151
        <replaceable>NAME</replaceable></term>
170
152
        <term><option>-i</option>
171
153
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>--interface</option>
173
 
        <replaceable>NAME</replaceable></term>
174
154
        <listitem>
175
155
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
156
        </listitem>
177
157
      </varlistentry>
178
 
 
 
158
      
179
159
      <varlistentry>
180
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
181
 
        ADDRESS</replaceable></literal></term>
 
160
        <term><option>--address
 
161
        <replaceable>ADDRESS</replaceable></option></term>
 
162
        <term><option>-a
 
163
        <replaceable>ADDRESS</replaceable></option></term>
182
164
        <listitem>
183
165
          <xi:include href="mandos-options.xml" xpointer="address"/>
184
166
        </listitem>
185
167
      </varlistentry>
186
 
 
 
168
      
187
169
      <varlistentry>
188
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
189
 
        PORT</replaceable></literal></term>
 
170
        <term><option>--port
 
171
        <replaceable>PORT</replaceable></option></term>
 
172
        <term><option>-p
 
173
        <replaceable>PORT</replaceable></option></term>
190
174
        <listitem>
191
175
          <xi:include href="mandos-options.xml" xpointer="port"/>
192
176
        </listitem>
193
177
      </varlistentry>
194
 
 
 
178
      
195
179
      <varlistentry>
196
 
        <term><literal>--check</literal></term>
 
180
        <term><option>--check</option></term>
197
181
        <listitem>
198
182
          <para>
199
183
            Run the server’s self-tests.  This includes any unit
201
185
          </para>
202
186
        </listitem>
203
187
      </varlistentry>
204
 
 
 
188
      
205
189
      <varlistentry>
206
 
        <term><literal>--debug</literal></term>
 
190
        <term><option>--debug</option></term>
207
191
        <listitem>
208
192
          <xi:include href="mandos-options.xml" xpointer="debug"/>
209
193
        </listitem>
210
194
      </varlistentry>
211
 
 
 
195
      
212
196
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        PRIORITY</replaceable></literal></term>
 
197
        <term><option>--priority <replaceable>
 
198
        PRIORITY</replaceable></option></term>
215
199
        <listitem>
216
200
          <xi:include href="mandos-options.xml" xpointer="priority"/>
217
201
        </listitem>
218
202
      </varlistentry>
219
 
 
 
203
      
220
204
      <varlistentry>
221
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
222
 
        </literal></term>
 
205
        <term><option>--servicename
 
206
        <replaceable>NAME</replaceable></option></term>
223
207
        <listitem>
224
208
          <xi:include href="mandos-options.xml"
225
209
                      xpointer="servicename"/>
226
210
        </listitem>
227
211
      </varlistentry>
228
 
 
 
212
      
229
213
      <varlistentry>
230
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
231
 
        </literal></term>
 
214
        <term><option>--configdir
 
215
        <replaceable>DIRECTORY</replaceable></option></term>
232
216
        <listitem>
233
217
          <para>
234
218
            Directory to search for configuration files.  Default is
240
224
          </para>
241
225
        </listitem>
242
226
      </varlistentry>
243
 
 
 
227
      
244
228
      <varlistentry>
245
 
        <term><literal>--version</literal></term>
 
229
        <term><option>--version</option></term>
246
230
        <listitem>
247
231
          <para>
248
232
            Prints the program version and exit.
249
233
          </para>
250
234
        </listitem>
251
235
      </varlistentry>
 
236
      
 
237
      <varlistentry>
 
238
        <term><option>--no-dbus</option></term>
 
239
        <listitem>
 
240
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
241
          <para>
 
242
            See also <xref linkend="dbus_interface"/>.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
 
248
        <term><option>--no-ipv6</option></term>
 
249
        <listitem>
 
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
251
        </listitem>
 
252
      </varlistentry>
252
253
    </variablelist>
253
254
  </refsect1>
254
 
 
 
255
  
255
256
  <refsect1 id="overview">
256
257
    <title>OVERVIEW</title>
257
258
    <xi:include href="overview.xml"/>
258
259
    <para>
259
260
      This program is the server part.  It is a normal server program
260
261
      and will run in a normal system environment, not in an initial
261
 
      RAM disk environment.
 
262
      <acronym>RAM</acronym> disk environment.
262
263
    </para>
263
264
  </refsect1>
264
 
 
 
265
  
265
266
  <refsect1 id="protocol">
266
267
    <title>NETWORK PROTOCOL</title>
267
268
    <para>
319
320
      </row>
320
321
    </tbody></tgroup></table>
321
322
  </refsect1>
322
 
 
 
323
  
323
324
  <refsect1 id="checking">
324
325
    <title>CHECKING</title>
325
326
    <para>
326
327
      The server will, by default, continually check that the clients
327
328
      are still up.  If a client has not been confirmed as being up
328
329
      for some time, the client is assumed to be compromised and is no
329
 
      longer eligible to receive the encrypted password.  The timeout,
 
330
      longer eligible to receive the encrypted password.  (Manual
 
331
      intervention is required to re-enable a client.)  The timeout,
330
332
      checker program, and interval between checks can be configured
331
333
      both globally and per client; see <citerefentry>
332
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
333
 
      <manvolnum>5</manvolnum></citerefentry>.
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
334
338
    </para>
335
339
  </refsect1>
336
 
 
 
340
  
337
341
  <refsect1 id="logging">
338
342
    <title>LOGGING</title>
339
343
    <para>
343
347
      and also show them on the console.
344
348
    </para>
345
349
  </refsect1>
346
 
 
 
350
  
 
351
  <refsect1 id="dbus_interface">
 
352
    <title>D-BUS INTERFACE</title>
 
353
    <para>
 
354
      The server will by default provide a D-Bus system bus interface.
 
355
      This interface will only be accessible by the root user or a
 
356
      Mandos-specific user, if such a user exists.  For documentation
 
357
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
358
    </para>
 
359
  </refsect1>
 
360
  
347
361
  <refsect1 id="exit_status">
348
362
    <title>EXIT STATUS</title>
349
363
    <para>
351
365
      critical error is encountered.
352
366
    </para>
353
367
  </refsect1>
354
 
 
 
368
  
355
369
  <refsect1 id="environment">
356
370
    <title>ENVIRONMENT</title>
357
371
    <variablelist>
371
385
      </varlistentry>
372
386
    </variablelist>
373
387
  </refsect1>
374
 
 
375
 
  <refsect1 id="file">
 
388
  
 
389
  <refsect1 id="files">
376
390
    <title>FILES</title>
377
391
    <para>
378
392
      Use the <option>--configdir</option> option to change where
401
415
        </listitem>
402
416
      </varlistentry>
403
417
      <varlistentry>
404
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
418
        <term><filename>/var/run/mandos.pid</filename></term>
405
419
        <listitem>
406
420
          <para>
407
421
            The file containing the process id of
439
453
      backtrace.  This could be considered a feature.
440
454
    </para>
441
455
    <para>
442
 
      Currently, if a client is declared <quote>invalid</quote> due to
443
 
      having timed out, the server does not record this fact onto
444
 
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="CLIENTS"/>.
446
 
    </para>
447
 
    <para>
448
 
      There is currently no way of querying the server of the current
449
 
      status of clients, other than analyzing its <systemitem
450
 
      class="service">syslog</systemitem> output.
 
456
      Currently, if a client is disabled due to having timed out, the
 
457
      server does not record this fact onto permanent storage.  This
 
458
      has some security implications, see <xref linkend="clients"/>.
451
459
    </para>
452
460
    <para>
453
461
      There is no fine-grained control over logging and debug output.
456
464
      Debug mode is conflated with running in the foreground.
457
465
    </para>
458
466
    <para>
459
 
      The console log messages does not show a timestamp.
 
467
      The console log messages do not show a time stamp.
 
468
    </para>
 
469
    <para>
 
470
      This server does not check the expire time of clients’ OpenPGP
 
471
      keys.
460
472
    </para>
461
473
  </refsect1>
462
474
  
497
509
      </para>
498
510
    </informalexample>
499
511
  </refsect1>
500
 
 
 
512
  
501
513
  <refsect1 id="security">
502
514
    <title>SECURITY</title>
503
 
    <refsect2 id="SERVER">
 
515
    <refsect2 id="server">
504
516
      <title>SERVER</title>
505
517
      <para>
506
518
        Running this <command>&COMMANDNAME;</command> server program
507
519
        should not in itself present any security risk to the host
508
 
        computer running it.  The program does not need any special
509
 
        privileges to run, and is designed to run as a non-root user.
 
520
        computer running it.  The program switches to a non-root user
 
521
        soon after startup.
510
522
      </para>
511
523
    </refsect2>
512
 
    <refsect2 id="CLIENTS">
 
524
    <refsect2 id="clients">
513
525
      <title>CLIENTS</title>
514
526
      <para>
515
527
        The server only gives out its stored data to clients which
522
534
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
523
535
        <manvolnum>5</manvolnum></citerefentry>)
524
536
        <emphasis>must</emphasis> be made non-readable by anyone
525
 
        except the user running the server.
 
537
        except the user starting the server (usually root).
526
538
      </para>
527
539
      <para>
528
540
        As detailed in <xref linkend="checking"/>, the status of all
531
543
      </para>
532
544
      <para>
533
545
        If a client is compromised, its downtime should be duly noted
534
 
        by the server which would therefore declare the client
535
 
        invalid.  But if the server was ever restarted, it would
536
 
        re-read its client list from its configuration file and again
537
 
        regard all clients therein as valid, and hence eligible to
538
 
        receive their passwords.  Therefore, be careful when
539
 
        restarting servers if it is suspected that a client has, in
540
 
        fact, been compromised by parties who may now be running a
541
 
        fake Mandos client with the keys from the non-encrypted
542
 
        initial RAM image of the client host.  What should be done in
543
 
        that case (if restarting the server program really is
544
 
        necessary) is to stop the server program, edit the
545
 
        configuration file to omit any suspect clients, and restart
546
 
        the server program.
 
546
        by the server which would therefore disable the client.  But
 
547
        if the server was ever restarted, it would re-read its client
 
548
        list from its configuration file and again regard all clients
 
549
        therein as enabled, and hence eligible to receive their
 
550
        passwords.  Therefore, be careful when restarting servers if
 
551
        it is suspected that a client has, in fact, been compromised
 
552
        by parties who may now be running a fake Mandos client with
 
553
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
554
        image of the client host.  What should be done in that case
 
555
        (if restarting the server program really is necessary) is to
 
556
        stop the server program, edit the configuration file to omit
 
557
        any suspect clients, and restart the server program.
547
558
      </para>
548
559
      <para>
549
560
        For more details on client-side security, see
550
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
561
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
551
562
        <manvolnum>8mandos</manvolnum></citerefentry>.
552
563
      </para>
553
564
    </refsect2>
554
565
  </refsect1>
555
 
 
 
566
  
556
567
  <refsect1 id="see_also">
557
568
    <title>SEE ALSO</title>
558
569
    <para>
561
572
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
573
        <refentrytitle>mandos.conf</refentrytitle>
563
574
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
 
        <refentrytitle>password-request</refentrytitle>
 
575
        <refentrytitle>mandos-client</refentrytitle>
565
576
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
577
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
567
578
      </citerefentry>