/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: 2008-08-31 12:23:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831122333-qgppahxb4d4b0coc
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
                                            the ones in the SYNOPSIS.
                                            Split <term> tags into one
                                            for each option.  Use
                                            <option> tags instead of
                                            <literal>.  Moved long
                                            options before short.

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