/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: 2010-10-02 17:41:05 UTC
  • mto: (24.1.169 mandos)
  • mto: This revision was merged to the branch mainline in revision 453.
  • Revision ID: teddy@fukt.bsnet.se-20101002174105-xfqa0j8y1puvedo3
* debian/source/format: New; contains "3.0 (quilt)".

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>
 
144
        <term><option>--help</option></term>
160
145
        <term><option>-h</option></term>
161
 
        <term><option>--help</option></term>
162
146
        <listitem>
163
147
          <para>
164
148
            Show a help message and exit
165
149
          </para>
166
150
        </listitem>
167
151
      </varlistentry>
168
 
 
 
152
      
169
153
      <varlistentry>
 
154
        <term><option>--interface</option>
 
155
        <replaceable>NAME</replaceable></term>
170
156
        <term><option>-i</option>
171
157
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>--interface</option>
173
 
        <replaceable>NAME</replaceable></term>
174
158
        <listitem>
175
159
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
160
        </listitem>
177
161
      </varlistentry>
178
 
 
 
162
      
179
163
      <varlistentry>
180
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
181
 
        ADDRESS</replaceable></literal></term>
 
164
        <term><option>--address
 
165
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><option>-a
 
167
        <replaceable>ADDRESS</replaceable></option></term>
182
168
        <listitem>
183
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
184
170
        </listitem>
185
171
      </varlistentry>
186
 
 
 
172
      
187
173
      <varlistentry>
188
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
189
 
        PORT</replaceable></literal></term>
 
174
        <term><option>--port
 
175
        <replaceable>PORT</replaceable></option></term>
 
176
        <term><option>-p
 
177
        <replaceable>PORT</replaceable></option></term>
190
178
        <listitem>
191
179
          <xi:include href="mandos-options.xml" xpointer="port"/>
192
180
        </listitem>
193
181
      </varlistentry>
194
 
 
 
182
      
195
183
      <varlistentry>
196
 
        <term><literal>--check</literal></term>
 
184
        <term><option>--check</option></term>
197
185
        <listitem>
198
186
          <para>
199
187
            Run the server’s self-tests.  This includes any unit
201
189
          </para>
202
190
        </listitem>
203
191
      </varlistentry>
204
 
 
 
192
      
205
193
      <varlistentry>
206
 
        <term><literal>--debug</literal></term>
 
194
        <term><option>--debug</option></term>
207
195
        <listitem>
208
196
          <xi:include href="mandos-options.xml" xpointer="debug"/>
209
197
        </listitem>
210
198
      </varlistentry>
211
 
 
212
 
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        PRIORITY</replaceable></literal></term>
 
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
      
 
218
      <varlistentry>
 
219
        <term><option>--priority <replaceable>
 
220
        PRIORITY</replaceable></option></term>
215
221
        <listitem>
216
222
          <xi:include href="mandos-options.xml" xpointer="priority"/>
217
223
        </listitem>
218
224
      </varlistentry>
219
 
 
 
225
      
220
226
      <varlistentry>
221
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
222
 
        </literal></term>
 
227
        <term><option>--servicename
 
228
        <replaceable>NAME</replaceable></option></term>
223
229
        <listitem>
224
230
          <xi:include href="mandos-options.xml"
225
231
                      xpointer="servicename"/>
226
232
        </listitem>
227
233
      </varlistentry>
228
 
 
 
234
      
229
235
      <varlistentry>
230
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
231
 
        </literal></term>
 
236
        <term><option>--configdir
 
237
        <replaceable>DIRECTORY</replaceable></option></term>
232
238
        <listitem>
233
239
          <para>
234
240
            Directory to search for configuration files.  Default is
240
246
          </para>
241
247
        </listitem>
242
248
      </varlistentry>
243
 
 
 
249
      
244
250
      <varlistentry>
245
 
        <term><literal>--version</literal></term>
 
251
        <term><option>--version</option></term>
246
252
        <listitem>
247
253
          <para>
248
254
            Prints the program version and exit.
249
255
          </para>
250
256
        </listitem>
251
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>
252
275
    </variablelist>
253
276
  </refsect1>
254
 
 
 
277
  
255
278
  <refsect1 id="overview">
256
279
    <title>OVERVIEW</title>
257
280
    <xi:include href="overview.xml"/>
258
281
    <para>
259
282
      This program is the server part.  It is a normal server program
260
283
      and will run in a normal system environment, not in an initial
261
 
      RAM disk environment.
 
284
      <acronym>RAM</acronym> disk environment.
262
285
    </para>
263
286
  </refsect1>
264
 
 
 
287
  
265
288
  <refsect1 id="protocol">
266
289
    <title>NETWORK PROTOCOL</title>
267
290
    <para>
319
342
      </row>
320
343
    </tbody></tgroup></table>
321
344
  </refsect1>
322
 
 
 
345
  
323
346
  <refsect1 id="checking">
324
347
    <title>CHECKING</title>
325
348
    <para>
326
349
      The server will, by default, continually check that the clients
327
350
      are still up.  If a client has not been confirmed as being up
328
351
      for some time, the client is assumed to be compromised and is no
329
 
      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,
330
354
      checker program, and interval between checks can be configured
331
355
      both globally and per client; see <citerefentry>
332
356
      <refentrytitle>mandos-clients.conf</refentrytitle>
333
 
      <manvolnum>5</manvolnum></citerefentry>.
334
 
    </para>
335
 
  </refsect1>
336
 
 
 
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
  
337
383
  <refsect1 id="logging">
338
384
    <title>LOGGING</title>
339
385
    <para>
343
389
      and also show them on the console.
344
390
    </para>
345
391
  </refsect1>
346
 
 
 
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
  
347
403
  <refsect1 id="exit_status">
348
404
    <title>EXIT STATUS</title>
349
405
    <para>
351
407
      critical error is encountered.
352
408
    </para>
353
409
  </refsect1>
354
 
 
 
410
  
355
411
  <refsect1 id="environment">
356
412
    <title>ENVIRONMENT</title>
357
413
    <variablelist>
371
427
      </varlistentry>
372
428
    </variablelist>
373
429
  </refsect1>
374
 
 
375
 
  <refsect1 id="file">
 
430
  
 
431
  <refsect1 id="files">
376
432
    <title>FILES</title>
377
433
    <para>
378
434
      Use the <option>--configdir</option> option to change where
401
457
        </listitem>
402
458
      </varlistentry>
403
459
      <varlistentry>
404
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
460
        <term><filename>/var/run/mandos.pid</filename></term>
405
461
        <listitem>
406
462
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
 
463
            The file containing the process id of the
 
464
            <command>&COMMANDNAME;</command> process started last.
409
465
          </para>
410
466
        </listitem>
411
467
      </varlistentry>
439
495
      backtrace.  This could be considered a feature.
440
496
    </para>
441
497
    <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.
 
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"/>.
451
501
    </para>
452
502
    <para>
453
503
      There is no fine-grained control over logging and debug output.
456
506
      Debug mode is conflated with running in the foreground.
457
507
    </para>
458
508
    <para>
459
 
      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.
460
514
    </para>
461
515
  </refsect1>
462
516
  
497
551
      </para>
498
552
    </informalexample>
499
553
  </refsect1>
500
 
 
 
554
  
501
555
  <refsect1 id="security">
502
556
    <title>SECURITY</title>
503
 
    <refsect2 id="SERVER">
 
557
    <refsect2 id="server">
504
558
      <title>SERVER</title>
505
559
      <para>
506
560
        Running this <command>&COMMANDNAME;</command> server program
507
561
        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.
 
562
        computer running it.  The program switches to a non-root user
 
563
        soon after startup.
510
564
      </para>
511
565
    </refsect2>
512
 
    <refsect2 id="CLIENTS">
 
566
    <refsect2 id="clients">
513
567
      <title>CLIENTS</title>
514
568
      <para>
515
569
        The server only gives out its stored data to clients which
522
576
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
523
577
        <manvolnum>5</manvolnum></citerefentry>)
524
578
        <emphasis>must</emphasis> be made non-readable by anyone
525
 
        except the user running the server.
 
579
        except the user starting the server (usually root).
526
580
      </para>
527
581
      <para>
528
582
        As detailed in <xref linkend="checking"/>, the status of all
531
585
      </para>
532
586
      <para>
533
587
        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.
 
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.
547
600
      </para>
548
601
      <para>
549
602
        For more details on client-side security, see
550
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
603
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
551
604
        <manvolnum>8mandos</manvolnum></citerefentry>.
552
605
      </para>
553
606
    </refsect2>
554
607
  </refsect1>
555
 
 
 
608
  
556
609
  <refsect1 id="see_also">
557
610
    <title>SEE ALSO</title>
558
611
    <para>
561
614
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
615
        <refentrytitle>mandos.conf</refentrytitle>
563
616
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
 
        <refentrytitle>password-request</refentrytitle>
 
617
        <refentrytitle>mandos-client</refentrytitle>
565
618
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
619
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
567
620
      </citerefentry>