/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

Merge from trunk.  Make it lintian clean, for real this time.

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>--debuglevel
 
91
      <replaceable>LEVEL</replaceable></option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--no-dbus</option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--no-ipv6</option></arg>
108
96
    </cmdsynopsis>
109
97
    <cmdsynopsis>
110
98
      <command>&COMMANDNAME;</command>
122
110
      <arg choice="plain"><option>--check</option></arg>
123
111
    </cmdsynopsis>
124
112
  </refsynopsisdiv>
125
 
 
 
113
  
126
114
  <refsect1 id="description">
127
115
    <title>DESCRIPTION</title>
128
116
    <para>
137
125
      Any authenticated client is then given the stored pre-encrypted
138
126
      password for that specific client.
139
127
    </para>
140
 
 
141
128
  </refsect1>
142
129
  
143
130
  <refsect1 id="purpose">
144
131
    <title>PURPOSE</title>
145
 
 
146
132
    <para>
147
133
      The purpose of this is to enable <emphasis>remote and unattended
148
134
      rebooting</emphasis> of client host computer with an
149
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
136
      linkend="overview"/> for details.
151
137
    </para>
152
 
    
153
138
  </refsect1>
154
139
  
155
140
  <refsect1 id="options">
156
141
    <title>OPTIONS</title>
157
 
    
158
142
    <variablelist>
159
143
      <varlistentry>
160
144
        <term><option>--help</option></term>
212
196
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
197
        </listitem>
214
198
      </varlistentry>
215
 
 
 
199
      
 
200
      <varlistentry>
 
201
        <term><option>--debuglevel
 
202
        <replaceable>LEVEL</replaceable></option></term>
 
203
        <listitem>
 
204
          <para>
 
205
            Set the debugging log level.
 
206
            <replaceable>LEVEL</replaceable> is a string, one of
 
207
            <quote><literal>CRITICAL</literal></quote>,
 
208
            <quote><literal>ERROR</literal></quote>,
 
209
            <quote><literal>WARNING</literal></quote>,
 
210
            <quote><literal>INFO</literal></quote>, or
 
211
            <quote><literal>DEBUG</literal></quote>, in order of
 
212
            increasing verbosity.  The default level is
 
213
            <quote><literal>WARNING</literal></quote>.
 
214
          </para>
 
215
        </listitem>
 
216
      </varlistentry>
 
217
      
216
218
      <varlistentry>
217
219
        <term><option>--priority <replaceable>
218
220
        PRIORITY</replaceable></option></term>
220
222
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
223
        </listitem>
222
224
      </varlistentry>
223
 
 
 
225
      
224
226
      <varlistentry>
225
227
        <term><option>--servicename
226
228
        <replaceable>NAME</replaceable></option></term>
229
231
                      xpointer="servicename"/>
230
232
        </listitem>
231
233
      </varlistentry>
232
 
 
 
234
      
233
235
      <varlistentry>
234
236
        <term><option>--configdir
235
237
        <replaceable>DIRECTORY</replaceable></option></term>
244
246
          </para>
245
247
        </listitem>
246
248
      </varlistentry>
247
 
 
 
249
      
248
250
      <varlistentry>
249
251
        <term><option>--version</option></term>
250
252
        <listitem>
253
255
          </para>
254
256
        </listitem>
255
257
      </varlistentry>
 
258
      
 
259
      <varlistentry>
 
260
        <term><option>--no-dbus</option></term>
 
261
        <listitem>
 
262
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
263
          <para>
 
264
            See also <xref linkend="dbus_interface"/>.
 
265
          </para>
 
266
        </listitem>
 
267
      </varlistentry>
 
268
      
 
269
      <varlistentry>
 
270
        <term><option>--no-ipv6</option></term>
 
271
        <listitem>
 
272
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
273
        </listitem>
 
274
      </varlistentry>
256
275
    </variablelist>
257
276
  </refsect1>
258
 
 
 
277
  
259
278
  <refsect1 id="overview">
260
279
    <title>OVERVIEW</title>
261
280
    <xi:include href="overview.xml"/>
262
281
    <para>
263
282
      This program is the server part.  It is a normal server program
264
283
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
284
      <acronym>RAM</acronym> disk environment.
266
285
    </para>
267
286
  </refsect1>
268
 
 
 
287
  
269
288
  <refsect1 id="protocol">
270
289
    <title>NETWORK PROTOCOL</title>
271
290
    <para>
323
342
      </row>
324
343
    </tbody></tgroup></table>
325
344
  </refsect1>
326
 
 
 
345
  
327
346
  <refsect1 id="checking">
328
347
    <title>CHECKING</title>
329
348
    <para>
330
349
      The server will, by default, continually check that the clients
331
350
      are still up.  If a client has not been confirmed as being up
332
351
      for some time, the client is assumed to be compromised and is no
333
 
      longer eligible to receive the encrypted password.  The timeout,
 
352
      longer eligible to receive the encrypted password.  (Manual
 
353
      intervention is required to re-enable a client.)  The timeout,
334
354
      checker program, and interval between checks can be configured
335
355
      both globally and per client; see <citerefentry>
336
356
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
 
      <manvolnum>5</manvolnum></citerefentry>.
338
 
    </para>
339
 
  </refsect1>
340
 
 
 
357
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
358
      receiving its password will also be treated as a successful
 
359
      checker run.
 
360
    </para>
 
361
  </refsect1>
 
362
  
 
363
  <refsect1 id="approval">
 
364
    <title>APPROVAL</title>
 
365
    <para>
 
366
      The server can be configured to require manual approval for a
 
367
      client before it is sent its secret.  The delay to wait for such
 
368
      approval and the default action (approve or deny) can be
 
369
      configured both globally and per client; see <citerefentry>
 
370
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
371
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
372
      will be approved immediately without delay.
 
373
    </para>
 
374
    <para>
 
375
      This can be used to deny a client its secret if not manually
 
376
      approved within a specified time.  It can also be used to make
 
377
      the server delay before giving a client its secret, allowing
 
378
      optional manual denying of this specific client.
 
379
    </para>
 
380
    
 
381
  </refsect1>
 
382
  
341
383
  <refsect1 id="logging">
342
384
    <title>LOGGING</title>
343
385
    <para>
347
389
      and also show them on the console.
348
390
    </para>
349
391
  </refsect1>
350
 
 
 
392
  
 
393
  <refsect1 id="dbus_interface">
 
394
    <title>D-BUS INTERFACE</title>
 
395
    <para>
 
396
      The server will by default provide a D-Bus system bus interface.
 
397
      This interface will only be accessible by the root user or a
 
398
      Mandos-specific user, if such a user exists.  For documentation
 
399
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
400
    </para>
 
401
  </refsect1>
 
402
  
351
403
  <refsect1 id="exit_status">
352
404
    <title>EXIT STATUS</title>
353
405
    <para>
355
407
      critical error is encountered.
356
408
    </para>
357
409
  </refsect1>
358
 
 
 
410
  
359
411
  <refsect1 id="environment">
360
412
    <title>ENVIRONMENT</title>
361
413
    <variablelist>
375
427
      </varlistentry>
376
428
    </variablelist>
377
429
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
430
  
 
431
  <refsect1 id="files">
380
432
    <title>FILES</title>
381
433
    <para>
382
434
      Use the <option>--configdir</option> option to change where
405
457
        </listitem>
406
458
      </varlistentry>
407
459
      <varlistentry>
408
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
460
        <term><filename>/var/run/mandos.pid</filename></term>
409
461
        <listitem>
410
462
          <para>
411
 
            The file containing the process id of
412
 
            <command>&COMMANDNAME;</command>.
 
463
            The file containing the process id of the
 
464
            <command>&COMMANDNAME;</command> process started last.
413
465
          </para>
414
466
        </listitem>
415
467
      </varlistentry>
443
495
      backtrace.  This could be considered a feature.
444
496
    </para>
445
497
    <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.
 
498
      Currently, if a client is disabled due to having timed out, the
 
499
      server does not record this fact onto permanent storage.  This
 
500
      has some security implications, see <xref linkend="clients"/>.
455
501
    </para>
456
502
    <para>
457
503
      There is no fine-grained control over logging and debug output.
460
506
      Debug mode is conflated with running in the foreground.
461
507
    </para>
462
508
    <para>
463
 
      The console log messages does not show a timestamp.
 
509
      The console log messages do not show a time stamp.
 
510
    </para>
 
511
    <para>
 
512
      This server does not check the expire time of clients’ OpenPGP
 
513
      keys.
464
514
    </para>
465
515
  </refsect1>
466
516
  
501
551
      </para>
502
552
    </informalexample>
503
553
  </refsect1>
504
 
 
 
554
  
505
555
  <refsect1 id="security">
506
556
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
557
    <refsect2 id="server">
508
558
      <title>SERVER</title>
509
559
      <para>
510
560
        Running this <command>&COMMANDNAME;</command> server program
511
561
        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.
 
562
        computer running it.  The program switches to a non-root user
 
563
        soon after startup.
514
564
      </para>
515
565
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
566
    <refsect2 id="clients">
517
567
      <title>CLIENTS</title>
518
568
      <para>
519
569
        The server only gives out its stored data to clients which
526
576
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
577
        <manvolnum>5</manvolnum></citerefentry>)
528
578
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
579
        except the user starting the server (usually root).
530
580
      </para>
531
581
      <para>
532
582
        As detailed in <xref linkend="checking"/>, the status of all
535
585
      </para>
536
586
      <para>
537
587
        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.
 
588
        by the server which would therefore disable the client.  But
 
589
        if the server was ever restarted, it would re-read its client
 
590
        list from its configuration file and again regard all clients
 
591
        therein as enabled, and hence eligible to receive their
 
592
        passwords.  Therefore, be careful when restarting servers if
 
593
        it is suspected that a client has, in fact, been compromised
 
594
        by parties who may now be running a fake Mandos client with
 
595
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
596
        image of the client host.  What should be done in that case
 
597
        (if restarting the server program really is necessary) is to
 
598
        stop the server program, edit the configuration file to omit
 
599
        any suspect clients, and restart the server program.
551
600
      </para>
552
601
      <para>
553
602
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
603
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
604
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
605
      </para>
557
606
    </refsect2>
558
607
  </refsect1>
559
 
 
 
608
  
560
609
  <refsect1 id="see_also">
561
610
    <title>SEE ALSO</title>
562
611
    <para>
565
614
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
615
        <refentrytitle>mandos.conf</refentrytitle>
567
616
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>password-request</refentrytitle>
 
617
        <refentrytitle>mandos-client</refentrytitle>
569
618
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
619
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
620
      </citerefentry>