/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

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