/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 at bsnet
  • Date: 2010-09-27 16:27:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927162713-jucnyd63612ximvw
* mandos-monitor: Change key for removing a client from "r" to "R".

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>--no-dbus</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--no-ipv6</option></arg>
108
93
    </cmdsynopsis>
109
94
    <cmdsynopsis>
110
95
      <command>&COMMANDNAME;</command>
122
107
      <arg choice="plain"><option>--check</option></arg>
123
108
    </cmdsynopsis>
124
109
  </refsynopsisdiv>
125
 
 
 
110
  
126
111
  <refsect1 id="description">
127
112
    <title>DESCRIPTION</title>
128
113
    <para>
137
122
      Any authenticated client is then given the stored pre-encrypted
138
123
      password for that specific client.
139
124
    </para>
140
 
 
141
125
  </refsect1>
142
126
  
143
127
  <refsect1 id="purpose">
144
128
    <title>PURPOSE</title>
145
 
 
146
129
    <para>
147
130
      The purpose of this is to enable <emphasis>remote and unattended
148
131
      rebooting</emphasis> of client host computer with an
149
132
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
133
      linkend="overview"/> for details.
151
134
    </para>
152
 
 
153
135
  </refsect1>
154
136
  
155
137
  <refsect1 id="options">
156
138
    <title>OPTIONS</title>
157
 
 
158
139
    <variablelist>
159
140
      <varlistentry>
 
141
        <term><option>--help</option></term>
160
142
        <term><option>-h</option></term>
161
 
        <term><option>--help</option></term>
162
143
        <listitem>
163
144
          <para>
164
145
            Show a help message and exit
165
146
          </para>
166
147
        </listitem>
167
148
      </varlistentry>
168
 
 
 
149
      
169
150
      <varlistentry>
 
151
        <term><option>--interface</option>
 
152
        <replaceable>NAME</replaceable></term>
170
153
        <term><option>-i</option>
171
154
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>--interface</option>
173
 
        <replaceable>NAME</replaceable></term>
174
155
        <listitem>
175
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
157
        </listitem>
177
158
      </varlistentry>
178
 
 
 
159
      
179
160
      <varlistentry>
180
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
181
 
        ADDRESS</replaceable></literal></term>
 
161
        <term><option>--address
 
162
        <replaceable>ADDRESS</replaceable></option></term>
 
163
        <term><option>-a
 
164
        <replaceable>ADDRESS</replaceable></option></term>
182
165
        <listitem>
183
166
          <xi:include href="mandos-options.xml" xpointer="address"/>
184
167
        </listitem>
185
168
      </varlistentry>
186
 
 
 
169
      
187
170
      <varlistentry>
188
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
189
 
        PORT</replaceable></literal></term>
 
171
        <term><option>--port
 
172
        <replaceable>PORT</replaceable></option></term>
 
173
        <term><option>-p
 
174
        <replaceable>PORT</replaceable></option></term>
190
175
        <listitem>
191
176
          <xi:include href="mandos-options.xml" xpointer="port"/>
192
177
        </listitem>
193
178
      </varlistentry>
194
 
 
 
179
      
195
180
      <varlistentry>
196
 
        <term><literal>--check</literal></term>
 
181
        <term><option>--check</option></term>
197
182
        <listitem>
198
183
          <para>
199
184
            Run the server’s self-tests.  This includes any unit
201
186
          </para>
202
187
        </listitem>
203
188
      </varlistentry>
204
 
 
 
189
      
205
190
      <varlistentry>
206
 
        <term><literal>--debug</literal></term>
 
191
        <term><option>--debug</option></term>
207
192
        <listitem>
208
193
          <xi:include href="mandos-options.xml" xpointer="debug"/>
209
194
        </listitem>
210
195
      </varlistentry>
211
 
 
 
196
      
212
197
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        PRIORITY</replaceable></literal></term>
 
198
        <term><option>--priority <replaceable>
 
199
        PRIORITY</replaceable></option></term>
215
200
        <listitem>
216
201
          <xi:include href="mandos-options.xml" xpointer="priority"/>
217
202
        </listitem>
218
203
      </varlistentry>
219
 
 
 
204
      
220
205
      <varlistentry>
221
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
222
 
        </literal></term>
 
206
        <term><option>--servicename
 
207
        <replaceable>NAME</replaceable></option></term>
223
208
        <listitem>
224
209
          <xi:include href="mandos-options.xml"
225
210
                      xpointer="servicename"/>
226
211
        </listitem>
227
212
      </varlistentry>
228
 
 
 
213
      
229
214
      <varlistentry>
230
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
231
 
        </literal></term>
 
215
        <term><option>--configdir
 
216
        <replaceable>DIRECTORY</replaceable></option></term>
232
217
        <listitem>
233
218
          <para>
234
219
            Directory to search for configuration files.  Default is
240
225
          </para>
241
226
        </listitem>
242
227
      </varlistentry>
243
 
 
 
228
      
244
229
      <varlistentry>
245
 
        <term><literal>--version</literal></term>
 
230
        <term><option>--version</option></term>
246
231
        <listitem>
247
232
          <para>
248
233
            Prints the program version and exit.
249
234
          </para>
250
235
        </listitem>
251
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>
252
254
    </variablelist>
253
255
  </refsect1>
254
 
 
 
256
  
255
257
  <refsect1 id="overview">
256
258
    <title>OVERVIEW</title>
257
259
    <xi:include href="overview.xml"/>
258
260
    <para>
259
261
      This program is the server part.  It is a normal server program
260
262
      and will run in a normal system environment, not in an initial
261
 
      RAM disk environment.
 
263
      <acronym>RAM</acronym> disk environment.
262
264
    </para>
263
265
  </refsect1>
264
 
 
 
266
  
265
267
  <refsect1 id="protocol">
266
268
    <title>NETWORK PROTOCOL</title>
267
269
    <para>
319
321
      </row>
320
322
    </tbody></tgroup></table>
321
323
  </refsect1>
322
 
 
 
324
  
323
325
  <refsect1 id="checking">
324
326
    <title>CHECKING</title>
325
327
    <para>
326
328
      The server will, by default, continually check that the clients
327
329
      are still up.  If a client has not been confirmed as being up
328
330
      for some time, the client is assumed to be compromised and is no
329
 
      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,
330
333
      checker program, and interval between checks can be configured
331
334
      both globally and per client; see <citerefentry>
332
335
      <refentrytitle>mandos-clients.conf</refentrytitle>
333
 
      <manvolnum>5</manvolnum></citerefentry>.
334
 
    </para>
335
 
  </refsect1>
336
 
 
 
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
362
  <refsect1 id="logging">
338
363
    <title>LOGGING</title>
339
364
    <para>
343
368
      and also show them on the console.
344
369
    </para>
345
370
  </refsect1>
346
 
 
 
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
  
347
382
  <refsect1 id="exit_status">
348
383
    <title>EXIT STATUS</title>
349
384
    <para>
351
386
      critical error is encountered.
352
387
    </para>
353
388
  </refsect1>
354
 
 
 
389
  
355
390
  <refsect1 id="environment">
356
391
    <title>ENVIRONMENT</title>
357
392
    <variablelist>
371
406
      </varlistentry>
372
407
    </variablelist>
373
408
  </refsect1>
374
 
 
375
 
  <refsect1 id="file">
 
409
  
 
410
  <refsect1 id="files">
376
411
    <title>FILES</title>
377
412
    <para>
378
413
      Use the <option>--configdir</option> option to change where
401
436
        </listitem>
402
437
      </varlistentry>
403
438
      <varlistentry>
404
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
439
        <term><filename>/var/run/mandos.pid</filename></term>
405
440
        <listitem>
406
441
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
 
442
            The file containing the process id of the
 
443
            <command>&COMMANDNAME;</command> process started last.
409
444
          </para>
410
445
        </listitem>
411
446
      </varlistentry>
439
474
      backtrace.  This could be considered a feature.
440
475
    </para>
441
476
    <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.
 
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"/>.
451
480
    </para>
452
481
    <para>
453
482
      There is no fine-grained control over logging and debug output.
456
485
      Debug mode is conflated with running in the foreground.
457
486
    </para>
458
487
    <para>
459
 
      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.
460
493
    </para>
461
494
  </refsect1>
462
495
  
497
530
      </para>
498
531
    </informalexample>
499
532
  </refsect1>
500
 
 
 
533
  
501
534
  <refsect1 id="security">
502
535
    <title>SECURITY</title>
503
 
    <refsect2 id="SERVER">
 
536
    <refsect2 id="server">
504
537
      <title>SERVER</title>
505
538
      <para>
506
539
        Running this <command>&COMMANDNAME;</command> server program
507
540
        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.
 
541
        computer running it.  The program switches to a non-root user
 
542
        soon after startup.
510
543
      </para>
511
544
    </refsect2>
512
 
    <refsect2 id="CLIENTS">
 
545
    <refsect2 id="clients">
513
546
      <title>CLIENTS</title>
514
547
      <para>
515
548
        The server only gives out its stored data to clients which
522
555
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
523
556
        <manvolnum>5</manvolnum></citerefentry>)
524
557
        <emphasis>must</emphasis> be made non-readable by anyone
525
 
        except the user running the server.
 
558
        except the user starting the server (usually root).
526
559
      </para>
527
560
      <para>
528
561
        As detailed in <xref linkend="checking"/>, the status of all
531
564
      </para>
532
565
      <para>
533
566
        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.
 
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.
547
579
      </para>
548
580
      <para>
549
581
        For more details on client-side security, see
550
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
582
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
551
583
        <manvolnum>8mandos</manvolnum></citerefentry>.
552
584
      </para>
553
585
    </refsect2>
554
586
  </refsect1>
555
 
 
 
587
  
556
588
  <refsect1 id="see_also">
557
589
    <title>SEE ALSO</title>
558
590
    <para>
561
593
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
594
        <refentrytitle>mandos.conf</refentrytitle>
563
595
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
 
        <refentrytitle>password-request</refentrytitle>
 
596
        <refentrytitle>mandos-client</refentrytitle>
565
597
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
598
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
567
599
      </citerefentry>