/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.  Just a minor release to make it lintian clean.

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-30">
 
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>
77
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
78
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
80
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
81
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
82
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
83
 
      <arg>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
88
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
90
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
91
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
92
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
93
 
      <arg>--debug</arg>
 
58
      <group>
 
59
        <arg choice="plain"><option>--interface
 
60
        <replaceable>NAME</replaceable></option></arg>
 
61
        <arg choice="plain"><option>-i
 
62
        <replaceable>NAME</replaceable></option></arg>
 
63
      </group>
 
64
      <sbr/>
 
65
      <group>
 
66
        <arg choice="plain"><option>--address
 
67
        <replaceable>ADDRESS</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-a
 
69
        <replaceable>ADDRESS</replaceable></option></arg>
 
70
      </group>
 
71
      <sbr/>
 
72
      <group>
 
73
        <arg choice="plain"><option>--port
 
74
        <replaceable>PORT</replaceable></option></arg>
 
75
        <arg choice="plain"><option>-p
 
76
        <replaceable>PORT</replaceable></option></arg>
 
77
      </group>
 
78
      <sbr/>
 
79
      <arg><option>--priority
 
80
      <replaceable>PRIORITY</replaceable></option></arg>
 
81
      <sbr/>
 
82
      <arg><option>--servicename
 
83
      <replaceable>NAME</replaceable></option></arg>
 
84
      <sbr/>
 
85
      <arg><option>--configdir
 
86
      <replaceable>DIRECTORY</replaceable></option></arg>
 
87
      <sbr/>
 
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>
94
96
    </cmdsynopsis>
95
97
    <cmdsynopsis>
96
98
      <command>&COMMANDNAME;</command>
97
99
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
100
        <arg choice="plain"><option>--help</option></arg>
 
101
        <arg choice="plain"><option>-h</option></arg>
100
102
      </group>
101
103
    </cmdsynopsis>
102
104
    <cmdsynopsis>
103
105
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
106
      <arg choice="plain"><option>--version</option></arg>
105
107
    </cmdsynopsis>
106
108
    <cmdsynopsis>
107
109
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
110
      <arg choice="plain"><option>--check</option></arg>
109
111
    </cmdsynopsis>
110
112
  </refsynopsisdiv>
111
 
 
 
113
  
112
114
  <refsect1 id="description">
113
115
    <title>DESCRIPTION</title>
114
116
    <para>
123
125
      Any authenticated client is then given the stored pre-encrypted
124
126
      password for that specific client.
125
127
    </para>
126
 
 
127
128
  </refsect1>
128
129
  
129
130
  <refsect1 id="purpose">
130
131
    <title>PURPOSE</title>
131
 
 
132
132
    <para>
133
133
      The purpose of this is to enable <emphasis>remote and unattended
134
134
      rebooting</emphasis> of client host computer with an
135
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
136
      linkend="overview"/> for details.
137
137
    </para>
138
 
 
139
138
  </refsect1>
140
139
  
141
140
  <refsect1 id="options">
142
141
    <title>OPTIONS</title>
143
 
 
144
142
    <variablelist>
145
143
      <varlistentry>
 
144
        <term><option>--help</option></term>
146
145
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
148
146
        <listitem>
149
147
          <para>
150
148
            Show a help message and exit
151
149
          </para>
152
150
        </listitem>
153
151
      </varlistentry>
154
 
 
 
152
      
155
153
      <varlistentry>
 
154
        <term><option>--interface</option>
 
155
        <replaceable>NAME</replaceable></term>
156
156
        <term><option>-i</option>
157
157
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
160
158
        <listitem>
161
159
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
160
        </listitem>
163
161
      </varlistentry>
164
 
 
 
162
      
165
163
      <varlistentry>
166
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
167
 
        ADDRESS</replaceable></literal></term>
 
164
        <term><option>--address
 
165
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><option>-a
 
167
        <replaceable>ADDRESS</replaceable></option></term>
168
168
        <listitem>
169
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
170
        </listitem>
171
171
      </varlistentry>
172
 
 
 
172
      
173
173
      <varlistentry>
174
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
175
 
        PORT</replaceable></literal></term>
 
174
        <term><option>--port
 
175
        <replaceable>PORT</replaceable></option></term>
 
176
        <term><option>-p
 
177
        <replaceable>PORT</replaceable></option></term>
176
178
        <listitem>
177
179
          <xi:include href="mandos-options.xml" xpointer="port"/>
178
180
        </listitem>
179
181
      </varlistentry>
180
 
 
 
182
      
181
183
      <varlistentry>
182
 
        <term><literal>--check</literal></term>
 
184
        <term><option>--check</option></term>
183
185
        <listitem>
184
186
          <para>
185
187
            Run the server’s self-tests.  This includes any unit
187
189
          </para>
188
190
        </listitem>
189
191
      </varlistentry>
190
 
 
 
192
      
191
193
      <varlistentry>
192
 
        <term><literal>--debug</literal></term>
 
194
        <term><option>--debug</option></term>
193
195
        <listitem>
194
196
          <xi:include href="mandos-options.xml" xpointer="debug"/>
195
197
        </listitem>
196
198
      </varlistentry>
197
 
 
198
 
      <varlistentry>
199
 
        <term><literal>--priority <replaceable>
200
 
        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>
201
221
        <listitem>
202
222
          <xi:include href="mandos-options.xml" xpointer="priority"/>
203
223
        </listitem>
204
224
      </varlistentry>
205
 
 
 
225
      
206
226
      <varlistentry>
207
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
208
 
        </literal></term>
 
227
        <term><option>--servicename
 
228
        <replaceable>NAME</replaceable></option></term>
209
229
        <listitem>
210
230
          <xi:include href="mandos-options.xml"
211
231
                      xpointer="servicename"/>
212
232
        </listitem>
213
233
      </varlistentry>
214
 
 
 
234
      
215
235
      <varlistentry>
216
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
217
 
        </literal></term>
 
236
        <term><option>--configdir
 
237
        <replaceable>DIRECTORY</replaceable></option></term>
218
238
        <listitem>
219
239
          <para>
220
240
            Directory to search for configuration files.  Default is
226
246
          </para>
227
247
        </listitem>
228
248
      </varlistentry>
229
 
 
 
249
      
230
250
      <varlistentry>
231
 
        <term><literal>--version</literal></term>
 
251
        <term><option>--version</option></term>
232
252
        <listitem>
233
253
          <para>
234
254
            Prints the program version and exit.
235
255
          </para>
236
256
        </listitem>
237
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>
238
275
    </variablelist>
239
276
  </refsect1>
240
 
 
 
277
  
241
278
  <refsect1 id="overview">
242
279
    <title>OVERVIEW</title>
243
280
    <xi:include href="overview.xml"/>
244
281
    <para>
245
282
      This program is the server part.  It is a normal server program
246
283
      and will run in a normal system environment, not in an initial
247
 
      RAM disk environment.
 
284
      <acronym>RAM</acronym> disk environment.
248
285
    </para>
249
286
  </refsect1>
250
 
 
 
287
  
251
288
  <refsect1 id="protocol">
252
289
    <title>NETWORK PROTOCOL</title>
253
290
    <para>
305
342
      </row>
306
343
    </tbody></tgroup></table>
307
344
  </refsect1>
308
 
 
 
345
  
309
346
  <refsect1 id="checking">
310
347
    <title>CHECKING</title>
311
348
    <para>
312
349
      The server will, by default, continually check that the clients
313
350
      are still up.  If a client has not been confirmed as being up
314
351
      for some time, the client is assumed to be compromised and is no
315
 
      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,
316
354
      checker program, and interval between checks can be configured
317
355
      both globally and per client; see <citerefentry>
318
356
      <refentrytitle>mandos-clients.conf</refentrytitle>
319
 
      <manvolnum>5</manvolnum></citerefentry>.
320
 
    </para>
321
 
  </refsect1>
322
 
 
 
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
  
323
383
  <refsect1 id="logging">
324
384
    <title>LOGGING</title>
325
385
    <para>
329
389
      and also show them on the console.
330
390
    </para>
331
391
  </refsect1>
332
 
 
 
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
  
333
403
  <refsect1 id="exit_status">
334
404
    <title>EXIT STATUS</title>
335
405
    <para>
337
407
      critical error is encountered.
338
408
    </para>
339
409
  </refsect1>
340
 
 
 
410
  
341
411
  <refsect1 id="environment">
342
412
    <title>ENVIRONMENT</title>
343
413
    <variablelist>
357
427
      </varlistentry>
358
428
    </variablelist>
359
429
  </refsect1>
360
 
 
361
 
  <refsect1 id="file">
 
430
  
 
431
  <refsect1 id="files">
362
432
    <title>FILES</title>
363
433
    <para>
364
434
      Use the <option>--configdir</option> option to change where
387
457
        </listitem>
388
458
      </varlistentry>
389
459
      <varlistentry>
390
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
460
        <term><filename>/var/run/mandos.pid</filename></term>
391
461
        <listitem>
392
462
          <para>
393
 
            The file containing the process id of
394
 
            <command>&COMMANDNAME;</command>.
 
463
            The file containing the process id of the
 
464
            <command>&COMMANDNAME;</command> process started last.
395
465
          </para>
396
466
        </listitem>
397
467
      </varlistentry>
425
495
      backtrace.  This could be considered a feature.
426
496
    </para>
427
497
    <para>
428
 
      Currently, if a client is declared <quote>invalid</quote> due to
429
 
      having timed out, the server does not record this fact onto
430
 
      permanent storage.  This has some security implications, see
431
 
      <xref linkend="CLIENTS"/>.
432
 
    </para>
433
 
    <para>
434
 
      There is currently no way of querying the server of the current
435
 
      status of clients, other than analyzing its <systemitem
436
 
      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"/>.
437
501
    </para>
438
502
    <para>
439
503
      There is no fine-grained control over logging and debug output.
442
506
      Debug mode is conflated with running in the foreground.
443
507
    </para>
444
508
    <para>
445
 
      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.
446
514
    </para>
447
515
  </refsect1>
448
516
  
483
551
      </para>
484
552
    </informalexample>
485
553
  </refsect1>
486
 
 
 
554
  
487
555
  <refsect1 id="security">
488
556
    <title>SECURITY</title>
489
 
    <refsect2 id="SERVER">
 
557
    <refsect2 id="server">
490
558
      <title>SERVER</title>
491
559
      <para>
492
560
        Running this <command>&COMMANDNAME;</command> server program
493
561
        should not in itself present any security risk to the host
494
 
        computer running it.  The program does not need any special
495
 
        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.
496
564
      </para>
497
565
    </refsect2>
498
 
    <refsect2 id="CLIENTS">
 
566
    <refsect2 id="clients">
499
567
      <title>CLIENTS</title>
500
568
      <para>
501
569
        The server only gives out its stored data to clients which
508
576
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
509
577
        <manvolnum>5</manvolnum></citerefentry>)
510
578
        <emphasis>must</emphasis> be made non-readable by anyone
511
 
        except the user running the server.
 
579
        except the user starting the server (usually root).
512
580
      </para>
513
581
      <para>
514
582
        As detailed in <xref linkend="checking"/>, the status of all
517
585
      </para>
518
586
      <para>
519
587
        If a client is compromised, its downtime should be duly noted
520
 
        by the server which would therefore declare the client
521
 
        invalid.  But if the server was ever restarted, it would
522
 
        re-read its client list from its configuration file and again
523
 
        regard all clients therein as valid, and hence eligible to
524
 
        receive their passwords.  Therefore, be careful when
525
 
        restarting servers if it is suspected that a client has, in
526
 
        fact, been compromised by parties who may now be running a
527
 
        fake Mandos client with the keys from the non-encrypted
528
 
        initial RAM image of the client host.  What should be done in
529
 
        that case (if restarting the server program really is
530
 
        necessary) is to stop the server program, edit the
531
 
        configuration file to omit any suspect clients, and restart
532
 
        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.
533
600
      </para>
534
601
      <para>
535
602
        For more details on client-side security, see
536
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
603
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
537
604
        <manvolnum>8mandos</manvolnum></citerefentry>.
538
605
      </para>
539
606
    </refsect2>
540
607
  </refsect1>
541
 
 
 
608
  
542
609
  <refsect1 id="see_also">
543
610
    <title>SEE ALSO</title>
544
611
    <para>
547
614
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
615
        <refentrytitle>mandos.conf</refentrytitle>
549
616
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
 
        <refentrytitle>password-request</refentrytitle>
 
617
        <refentrytitle>mandos-client</refentrytitle>
551
618
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
619
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
553
620
      </citerefentry>