/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

* mandos: Do not write pid file if --debug is passed.
* mandos.xml (FILES): Pid file only records pid of latest server.

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-25">
 
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>
160
140
        <term><option>--help</option></term>
212
192
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
193
        </listitem>
214
194
      </varlistentry>
215
 
 
 
195
      
216
196
      <varlistentry>
217
197
        <term><option>--priority <replaceable>
218
198
        PRIORITY</replaceable></option></term>
220
200
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
201
        </listitem>
222
202
      </varlistentry>
223
 
 
 
203
      
224
204
      <varlistentry>
225
205
        <term><option>--servicename
226
206
        <replaceable>NAME</replaceable></option></term>
229
209
                      xpointer="servicename"/>
230
210
        </listitem>
231
211
      </varlistentry>
232
 
 
 
212
      
233
213
      <varlistentry>
234
214
        <term><option>--configdir
235
215
        <replaceable>DIRECTORY</replaceable></option></term>
244
224
          </para>
245
225
        </listitem>
246
226
      </varlistentry>
247
 
 
 
227
      
248
228
      <varlistentry>
249
229
        <term><option>--version</option></term>
250
230
        <listitem>
253
233
          </para>
254
234
        </listitem>
255
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>
256
253
    </variablelist>
257
254
  </refsect1>
258
 
 
 
255
  
259
256
  <refsect1 id="overview">
260
257
    <title>OVERVIEW</title>
261
258
    <xi:include href="overview.xml"/>
262
259
    <para>
263
260
      This program is the server part.  It is a normal server program
264
261
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
262
      <acronym>RAM</acronym> disk environment.
266
263
    </para>
267
264
  </refsect1>
268
 
 
 
265
  
269
266
  <refsect1 id="protocol">
270
267
    <title>NETWORK PROTOCOL</title>
271
268
    <para>
323
320
      </row>
324
321
    </tbody></tgroup></table>
325
322
  </refsect1>
326
 
 
 
323
  
327
324
  <refsect1 id="checking">
328
325
    <title>CHECKING</title>
329
326
    <para>
330
327
      The server will, by default, continually check that the clients
331
328
      are still up.  If a client has not been confirmed as being up
332
329
      for some time, the client is assumed to be compromised and is no
333
 
      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,
334
332
      checker program, and interval between checks can be configured
335
333
      both globally and per client; see <citerefentry>
336
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
 
      <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.
338
338
    </para>
339
339
  </refsect1>
340
 
 
 
340
  
341
341
  <refsect1 id="logging">
342
342
    <title>LOGGING</title>
343
343
    <para>
347
347
      and also show them on the console.
348
348
    </para>
349
349
  </refsect1>
350
 
 
 
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
  
351
361
  <refsect1 id="exit_status">
352
362
    <title>EXIT STATUS</title>
353
363
    <para>
355
365
      critical error is encountered.
356
366
    </para>
357
367
  </refsect1>
358
 
 
 
368
  
359
369
  <refsect1 id="environment">
360
370
    <title>ENVIRONMENT</title>
361
371
    <variablelist>
375
385
      </varlistentry>
376
386
    </variablelist>
377
387
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
388
  
 
389
  <refsect1 id="files">
380
390
    <title>FILES</title>
381
391
    <para>
382
392
      Use the <option>--configdir</option> option to change where
405
415
        </listitem>
406
416
      </varlistentry>
407
417
      <varlistentry>
408
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
418
        <term><filename>/var/run/mandos.pid</filename></term>
409
419
        <listitem>
410
420
          <para>
411
 
            The file containing the process id of
412
 
            <command>&COMMANDNAME;</command>.
 
421
            The file containing the process id of the
 
422
            <command>&COMMANDNAME;</command> process started last.
413
423
          </para>
414
424
        </listitem>
415
425
      </varlistentry>
443
453
      backtrace.  This could be considered a feature.
444
454
    </para>
445
455
    <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.
 
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"/>.
455
459
    </para>
456
460
    <para>
457
461
      There is no fine-grained control over logging and debug output.
460
464
      Debug mode is conflated with running in the foreground.
461
465
    </para>
462
466
    <para>
463
 
      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.
464
472
    </para>
465
473
  </refsect1>
466
474
  
501
509
      </para>
502
510
    </informalexample>
503
511
  </refsect1>
504
 
 
 
512
  
505
513
  <refsect1 id="security">
506
514
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
515
    <refsect2 id="server">
508
516
      <title>SERVER</title>
509
517
      <para>
510
518
        Running this <command>&COMMANDNAME;</command> server program
511
519
        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.
 
520
        computer running it.  The program switches to a non-root user
 
521
        soon after startup.
514
522
      </para>
515
523
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
524
    <refsect2 id="clients">
517
525
      <title>CLIENTS</title>
518
526
      <para>
519
527
        The server only gives out its stored data to clients which
526
534
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
535
        <manvolnum>5</manvolnum></citerefentry>)
528
536
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
537
        except the user starting the server (usually root).
530
538
      </para>
531
539
      <para>
532
540
        As detailed in <xref linkend="checking"/>, the status of all
535
543
      </para>
536
544
      <para>
537
545
        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.
 
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.
551
558
      </para>
552
559
      <para>
553
560
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
561
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
562
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
563
      </para>
557
564
    </refsect2>
558
565
  </refsect1>
559
 
 
 
566
  
560
567
  <refsect1 id="see_also">
561
568
    <title>SEE ALSO</title>
562
569
    <para>
565
572
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
573
        <refentrytitle>mandos.conf</refentrytitle>
567
574
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>password-request</refentrytitle>
 
575
        <refentrytitle>mandos-client</refentrytitle>
569
576
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
577
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
578
      </citerefentry>