/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: 2011-03-08 19:09:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110308190903-j499ebtb9bpk31ar
* INSTALL: Updated.

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-29">
 
5
<!ENTITY TIMESTAMP "2011-02-27">
 
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>
 
37
      <year>2011</year>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </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>
 
41
    <xi:include href="legalnotice.xml"/>
60
42
  </refentryinfo>
61
 
 
 
43
  
62
44
  <refmeta>
63
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
    <manvolnum>8</manvolnum>
67
49
  <refnamediv>
68
50
    <refname><command>&COMMANDNAME;</command></refname>
69
51
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
52
      Gives encrypted passwords to authenticated Mandos clients
71
53
    </refpurpose>
72
54
  </refnamediv>
73
 
 
 
55
  
74
56
  <refsynopsisdiv>
75
57
    <cmdsynopsis>
76
58
      <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>
 
59
      <group>
 
60
        <arg choice="plain"><option>--interface
 
61
        <replaceable>NAME</replaceable></option></arg>
 
62
        <arg choice="plain"><option>-i
 
63
        <replaceable>NAME</replaceable></option></arg>
 
64
      </group>
 
65
      <sbr/>
 
66
      <group>
 
67
        <arg choice="plain"><option>--address
 
68
        <replaceable>ADDRESS</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-a
 
70
        <replaceable>ADDRESS</replaceable></option></arg>
 
71
      </group>
 
72
      <sbr/>
 
73
      <group>
 
74
        <arg choice="plain"><option>--port
 
75
        <replaceable>PORT</replaceable></option></arg>
 
76
        <arg choice="plain"><option>-p
 
77
        <replaceable>PORT</replaceable></option></arg>
 
78
      </group>
 
79
      <sbr/>
 
80
      <arg><option>--priority
 
81
      <replaceable>PRIORITY</replaceable></option></arg>
 
82
      <sbr/>
 
83
      <arg><option>--servicename
 
84
      <replaceable>NAME</replaceable></option></arg>
 
85
      <sbr/>
 
86
      <arg><option>--configdir
 
87
      <replaceable>DIRECTORY</replaceable></option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--debug</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--debuglevel
 
92
      <replaceable>LEVEL</replaceable></option></arg>
 
93
      <sbr/>
 
94
      <arg><option>--no-dbus</option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-ipv6</option></arg>
94
97
    </cmdsynopsis>
95
98
    <cmdsynopsis>
96
99
      <command>&COMMANDNAME;</command>
97
100
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
101
        <arg choice="plain"><option>--help</option></arg>
 
102
        <arg choice="plain"><option>-h</option></arg>
100
103
      </group>
101
104
    </cmdsynopsis>
102
105
    <cmdsynopsis>
103
106
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
107
      <arg choice="plain"><option>--version</option></arg>
105
108
    </cmdsynopsis>
106
109
    <cmdsynopsis>
107
110
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
111
      <arg choice="plain"><option>--check</option></arg>
109
112
    </cmdsynopsis>
110
113
  </refsynopsisdiv>
111
 
 
 
114
  
112
115
  <refsect1 id="description">
113
116
    <title>DESCRIPTION</title>
114
117
    <para>
123
126
      Any authenticated client is then given the stored pre-encrypted
124
127
      password for that specific client.
125
128
    </para>
126
 
 
127
129
  </refsect1>
128
130
  
129
131
  <refsect1 id="purpose">
130
132
    <title>PURPOSE</title>
131
 
 
132
133
    <para>
133
134
      The purpose of this is to enable <emphasis>remote and unattended
134
135
      rebooting</emphasis> of client host computer with an
135
136
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
137
      linkend="overview"/> for details.
137
138
    </para>
138
 
 
139
139
  </refsect1>
140
140
  
141
141
  <refsect1 id="options">
142
142
    <title>OPTIONS</title>
143
 
 
144
143
    <variablelist>
145
144
      <varlistentry>
 
145
        <term><option>--help</option></term>
146
146
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
148
147
        <listitem>
149
148
          <para>
150
149
            Show a help message and exit
151
150
          </para>
152
151
        </listitem>
153
152
      </varlistentry>
154
 
 
 
153
      
155
154
      <varlistentry>
 
155
        <term><option>--interface</option>
 
156
        <replaceable>NAME</replaceable></term>
156
157
        <term><option>-i</option>
157
158
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
160
159
        <listitem>
161
160
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
161
        </listitem>
163
162
      </varlistentry>
164
 
 
 
163
      
165
164
      <varlistentry>
166
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
167
 
        ADDRESS</replaceable></literal></term>
 
165
        <term><option>--address
 
166
        <replaceable>ADDRESS</replaceable></option></term>
 
167
        <term><option>-a
 
168
        <replaceable>ADDRESS</replaceable></option></term>
168
169
        <listitem>
169
170
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
171
        </listitem>
171
172
      </varlistentry>
172
 
 
 
173
      
173
174
      <varlistentry>
174
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
175
 
        PORT</replaceable></literal></term>
 
175
        <term><option>--port
 
176
        <replaceable>PORT</replaceable></option></term>
 
177
        <term><option>-p
 
178
        <replaceable>PORT</replaceable></option></term>
176
179
        <listitem>
177
180
          <xi:include href="mandos-options.xml" xpointer="port"/>
178
181
        </listitem>
179
182
      </varlistentry>
180
 
 
 
183
      
181
184
      <varlistentry>
182
 
        <term><literal>--check</literal></term>
 
185
        <term><option>--check</option></term>
183
186
        <listitem>
184
187
          <para>
185
188
            Run the server’s self-tests.  This includes any unit
187
190
          </para>
188
191
        </listitem>
189
192
      </varlistentry>
190
 
 
 
193
      
191
194
      <varlistentry>
192
 
        <term><literal>--debug</literal></term>
 
195
        <term><option>--debug</option></term>
193
196
        <listitem>
194
197
          <xi:include href="mandos-options.xml" xpointer="debug"/>
195
198
        </listitem>
196
199
      </varlistentry>
197
 
 
198
 
      <varlistentry>
199
 
        <term><literal>--priority <replaceable>
200
 
        PRIORITY</replaceable></literal></term>
 
200
      
 
201
      <varlistentry>
 
202
        <term><option>--debuglevel
 
203
        <replaceable>LEVEL</replaceable></option></term>
 
204
        <listitem>
 
205
          <para>
 
206
            Set the debugging log level.
 
207
            <replaceable>LEVEL</replaceable> is a string, one of
 
208
            <quote><literal>CRITICAL</literal></quote>,
 
209
            <quote><literal>ERROR</literal></quote>,
 
210
            <quote><literal>WARNING</literal></quote>,
 
211
            <quote><literal>INFO</literal></quote>, or
 
212
            <quote><literal>DEBUG</literal></quote>, in order of
 
213
            increasing verbosity.  The default level is
 
214
            <quote><literal>WARNING</literal></quote>.
 
215
          </para>
 
216
        </listitem>
 
217
      </varlistentry>
 
218
      
 
219
      <varlistentry>
 
220
        <term><option>--priority <replaceable>
 
221
        PRIORITY</replaceable></option></term>
201
222
        <listitem>
202
223
          <xi:include href="mandos-options.xml" xpointer="priority"/>
203
224
        </listitem>
204
225
      </varlistentry>
205
 
 
 
226
      
206
227
      <varlistentry>
207
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
208
 
        </literal></term>
 
228
        <term><option>--servicename
 
229
        <replaceable>NAME</replaceable></option></term>
209
230
        <listitem>
210
231
          <xi:include href="mandos-options.xml"
211
232
                      xpointer="servicename"/>
212
233
        </listitem>
213
234
      </varlistentry>
214
 
 
 
235
      
215
236
      <varlistentry>
216
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
217
 
        </literal></term>
 
237
        <term><option>--configdir
 
238
        <replaceable>DIRECTORY</replaceable></option></term>
218
239
        <listitem>
219
240
          <para>
220
241
            Directory to search for configuration files.  Default is
226
247
          </para>
227
248
        </listitem>
228
249
      </varlistentry>
229
 
 
 
250
      
230
251
      <varlistentry>
231
 
        <term><literal>--version</literal></term>
 
252
        <term><option>--version</option></term>
232
253
        <listitem>
233
254
          <para>
234
255
            Prints the program version and exit.
235
256
          </para>
236
257
        </listitem>
237
258
      </varlistentry>
 
259
      
 
260
      <varlistentry>
 
261
        <term><option>--no-dbus</option></term>
 
262
        <listitem>
 
263
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
264
          <para>
 
265
            See also <xref linkend="dbus_interface"/>.
 
266
          </para>
 
267
        </listitem>
 
268
      </varlistentry>
 
269
      
 
270
      <varlistentry>
 
271
        <term><option>--no-ipv6</option></term>
 
272
        <listitem>
 
273
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
274
        </listitem>
 
275
      </varlistentry>
238
276
    </variablelist>
239
277
  </refsect1>
240
 
 
 
278
  
241
279
  <refsect1 id="overview">
242
280
    <title>OVERVIEW</title>
243
281
    <xi:include href="overview.xml"/>
244
282
    <para>
245
283
      This program is the server part.  It is a normal server program
246
284
      and will run in a normal system environment, not in an initial
247
 
      RAM disk environment.
 
285
      <acronym>RAM</acronym> disk environment.
248
286
    </para>
249
287
  </refsect1>
250
 
 
 
288
  
251
289
  <refsect1 id="protocol">
252
290
    <title>NETWORK PROTOCOL</title>
253
291
    <para>
305
343
      </row>
306
344
    </tbody></tgroup></table>
307
345
  </refsect1>
308
 
 
 
346
  
309
347
  <refsect1 id="checking">
310
348
    <title>CHECKING</title>
311
349
    <para>
312
350
      The server will, by default, continually check that the clients
313
351
      are still up.  If a client has not been confirmed as being up
314
352
      for some time, the client is assumed to be compromised and is no
315
 
      longer eligible to receive the encrypted password.  The timeout,
 
353
      longer eligible to receive the encrypted password.  (Manual
 
354
      intervention is required to re-enable a client.)  The timeout,
316
355
      checker program, and interval between checks can be configured
317
356
      both globally and per client; see <citerefentry>
318
357
      <refentrytitle>mandos-clients.conf</refentrytitle>
319
 
      <manvolnum>5</manvolnum></citerefentry>.
320
 
    </para>
321
 
  </refsect1>
322
 
 
 
358
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
359
      receiving its password will also be treated as a successful
 
360
      checker run.
 
361
    </para>
 
362
  </refsect1>
 
363
  
 
364
  <refsect1 id="approval">
 
365
    <title>APPROVAL</title>
 
366
    <para>
 
367
      The server can be configured to require manual approval for a
 
368
      client before it is sent its secret.  The delay to wait for such
 
369
      approval and the default action (approve or deny) can be
 
370
      configured both globally and per client; see <citerefentry>
 
371
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
372
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
373
      will be approved immediately without delay.
 
374
    </para>
 
375
    <para>
 
376
      This can be used to deny a client its secret if not manually
 
377
      approved within a specified time.  It can also be used to make
 
378
      the server delay before giving a client its secret, allowing
 
379
      optional manual denying of this specific client.
 
380
    </para>
 
381
    
 
382
  </refsect1>
 
383
  
323
384
  <refsect1 id="logging">
324
385
    <title>LOGGING</title>
325
386
    <para>
329
390
      and also show them on the console.
330
391
    </para>
331
392
  </refsect1>
332
 
 
 
393
  
 
394
  <refsect1 id="dbus_interface">
 
395
    <title>D-BUS INTERFACE</title>
 
396
    <para>
 
397
      The server will by default provide a D-Bus system bus interface.
 
398
      This interface will only be accessible by the root user or a
 
399
      Mandos-specific user, if such a user exists.  For documentation
 
400
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
401
    </para>
 
402
  </refsect1>
 
403
  
333
404
  <refsect1 id="exit_status">
334
405
    <title>EXIT STATUS</title>
335
406
    <para>
337
408
      critical error is encountered.
338
409
    </para>
339
410
  </refsect1>
340
 
 
 
411
  
341
412
  <refsect1 id="environment">
342
413
    <title>ENVIRONMENT</title>
343
414
    <variablelist>
344
415
      <varlistentry>
345
 
        <term><varname>PATH</varname></term>
 
416
        <term><envar>PATH</envar></term>
346
417
        <listitem>
347
418
          <para>
348
419
            To start the configured checker (see <xref
357
428
      </varlistentry>
358
429
    </variablelist>
359
430
  </refsect1>
360
 
 
361
 
  <refsect1 id="file">
 
431
  
 
432
  <refsect1 id="files">
362
433
    <title>FILES</title>
363
434
    <para>
364
435
      Use the <option>--configdir</option> option to change where
387
458
        </listitem>
388
459
      </varlistentry>
389
460
      <varlistentry>
390
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
461
        <term><filename>/var/run/mandos.pid</filename></term>
391
462
        <listitem>
392
463
          <para>
393
 
            The file containing the process id of
394
 
            <command>&COMMANDNAME;</command>.
 
464
            The file containing the process id of the
 
465
            <command>&COMMANDNAME;</command> process started last.
395
466
          </para>
396
467
        </listitem>
397
468
      </varlistentry>
425
496
      backtrace.  This could be considered a feature.
426
497
    </para>
427
498
    <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.
 
499
      Currently, if a client is disabled due to having timed out, the
 
500
      server does not record this fact onto permanent storage.  This
 
501
      has some security implications, see <xref linkend="clients"/>.
437
502
    </para>
438
503
    <para>
439
504
      There is no fine-grained control over logging and debug output.
442
507
      Debug mode is conflated with running in the foreground.
443
508
    </para>
444
509
    <para>
445
 
      The console log messages does not show a timestamp.
 
510
      The console log messages do not show a time stamp.
 
511
    </para>
 
512
    <para>
 
513
      This server does not check the expire time of clients’ OpenPGP
 
514
      keys.
446
515
    </para>
447
516
  </refsect1>
448
517
  
483
552
      </para>
484
553
    </informalexample>
485
554
  </refsect1>
486
 
 
 
555
  
487
556
  <refsect1 id="security">
488
557
    <title>SECURITY</title>
489
 
    <refsect2 id="SERVER">
 
558
    <refsect2 id="server">
490
559
      <title>SERVER</title>
491
560
      <para>
492
561
        Running this <command>&COMMANDNAME;</command> server program
493
562
        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.
 
563
        computer running it.  The program switches to a non-root user
 
564
        soon after startup.
496
565
      </para>
497
566
    </refsect2>
498
 
    <refsect2 id="CLIENTS">
 
567
    <refsect2 id="clients">
499
568
      <title>CLIENTS</title>
500
569
      <para>
501
570
        The server only gives out its stored data to clients which
508
577
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
509
578
        <manvolnum>5</manvolnum></citerefentry>)
510
579
        <emphasis>must</emphasis> be made non-readable by anyone
511
 
        except the user running the server.
 
580
        except the user starting the server (usually root).
512
581
      </para>
513
582
      <para>
514
583
        As detailed in <xref linkend="checking"/>, the status of all
517
586
      </para>
518
587
      <para>
519
588
        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.
 
589
        by the server which would therefore disable the client.  But
 
590
        if the server was ever restarted, it would re-read its client
 
591
        list from its configuration file and again regard all clients
 
592
        therein as enabled, and hence eligible to receive their
 
593
        passwords.  Therefore, be careful when restarting servers if
 
594
        it is suspected that a client has, in fact, been compromised
 
595
        by parties who may now be running a fake Mandos client with
 
596
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
597
        image of the client host.  What should be done in that case
 
598
        (if restarting the server program really is necessary) is to
 
599
        stop the server program, edit the configuration file to omit
 
600
        any suspect clients, and restart the server program.
533
601
      </para>
534
602
      <para>
535
603
        For more details on client-side security, see
536
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
604
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
537
605
        <manvolnum>8mandos</manvolnum></citerefentry>.
538
606
      </para>
539
607
    </refsect2>
540
608
  </refsect1>
541
 
 
 
609
  
542
610
  <refsect1 id="see_also">
543
611
    <title>SEE ALSO</title>
544
612
    <para>
547
615
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
616
        <refentrytitle>mandos.conf</refentrytitle>
549
617
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
 
        <refentrytitle>password-request</refentrytitle>
 
618
        <refentrytitle>mandos-client</refentrytitle>
551
619
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
620
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
553
621
      </citerefentry>