/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: 2008-08-29 06:38:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829063827-hbjl6t92tyjl5305
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New.  Automatically
                                              updated by Emacs
                                              time-stamp by using
                                              Emacs local variables.
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2010-09-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-29">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
10
  <refentryinfo>
 
11
    <title>&COMMANDNAME;</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
13
    <productname>&COMMANDNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
 
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
60
  </refentryinfo>
42
 
  
 
61
 
43
62
  <refmeta>
44
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
64
    <manvolnum>8</manvolnum>
48
67
  <refnamediv>
49
68
    <refname><command>&COMMANDNAME;</command></refname>
50
69
    <refpurpose>
51
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
52
71
    </refpurpose>
53
72
  </refnamediv>
54
 
  
 
73
 
55
74
  <refsynopsisdiv>
56
75
    <cmdsynopsis>
57
76
      <command>&COMMANDNAME;</command>
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>
 
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>
96
94
    </cmdsynopsis>
97
95
    <cmdsynopsis>
98
96
      <command>&COMMANDNAME;</command>
99
97
      <group choice="req">
100
 
        <arg choice="plain"><option>--help</option></arg>
101
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
102
100
      </group>
103
101
    </cmdsynopsis>
104
102
    <cmdsynopsis>
105
103
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
107
105
    </cmdsynopsis>
108
106
    <cmdsynopsis>
109
107
      <command>&COMMANDNAME;</command>
110
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
111
109
    </cmdsynopsis>
112
110
  </refsynopsisdiv>
113
 
  
 
111
 
114
112
  <refsect1 id="description">
115
113
    <title>DESCRIPTION</title>
116
114
    <para>
125
123
      Any authenticated client is then given the stored pre-encrypted
126
124
      password for that specific client.
127
125
    </para>
 
126
 
128
127
  </refsect1>
129
128
  
130
129
  <refsect1 id="purpose">
131
130
    <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
 
138
139
  </refsect1>
139
140
  
140
141
  <refsect1 id="options">
141
142
    <title>OPTIONS</title>
 
143
 
142
144
    <variablelist>
143
145
      <varlistentry>
144
 
        <term><option>--help</option></term>
145
 
        <term><option>-h</option></term>
 
146
        <term><literal>-h</literal>, <literal>--help</literal></term>
146
147
        <listitem>
147
148
          <para>
148
149
            Show a help message and exit
149
150
          </para>
150
151
        </listitem>
151
152
      </varlistentry>
152
 
      
 
153
 
153
154
      <varlistentry>
154
 
        <term><option>--interface</option>
155
 
        <replaceable>NAME</replaceable></term>
156
 
        <term><option>-i</option>
157
 
        <replaceable>NAME</replaceable></term>
 
155
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
156
        >NAME</replaceable></literal></term>
158
157
        <listitem>
159
158
          <xi:include href="mandos-options.xml" xpointer="interface"/>
160
159
        </listitem>
161
160
      </varlistentry>
162
 
      
 
161
 
163
162
      <varlistentry>
164
 
        <term><option>--address
165
 
        <replaceable>ADDRESS</replaceable></option></term>
166
 
        <term><option>-a
167
 
        <replaceable>ADDRESS</replaceable></option></term>
 
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
164
        ADDRESS</replaceable></literal></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><option>--port
175
 
        <replaceable>PORT</replaceable></option></term>
176
 
        <term><option>-p
177
 
        <replaceable>PORT</replaceable></option></term>
 
171
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
172
        PORT</replaceable></literal></term>
178
173
        <listitem>
179
174
          <xi:include href="mandos-options.xml" xpointer="port"/>
180
175
        </listitem>
181
176
      </varlistentry>
182
 
      
 
177
 
183
178
      <varlistentry>
184
 
        <term><option>--check</option></term>
 
179
        <term><literal>--check</literal></term>
185
180
        <listitem>
186
181
          <para>
187
182
            Run the server’s self-tests.  This includes any unit
189
184
          </para>
190
185
        </listitem>
191
186
      </varlistentry>
192
 
      
 
187
 
193
188
      <varlistentry>
194
 
        <term><option>--debug</option></term>
 
189
        <term><literal>--debug</literal></term>
195
190
        <listitem>
196
191
          <xi:include href="mandos-options.xml" xpointer="debug"/>
197
192
        </listitem>
198
193
      </varlistentry>
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>
 
194
 
 
195
      <varlistentry>
 
196
        <term><literal>--priority <replaceable>
 
197
        PRIORITY</replaceable></literal></term>
221
198
        <listitem>
222
199
          <xi:include href="mandos-options.xml" xpointer="priority"/>
223
200
        </listitem>
224
201
      </varlistentry>
225
 
      
 
202
 
226
203
      <varlistentry>
227
 
        <term><option>--servicename
228
 
        <replaceable>NAME</replaceable></option></term>
 
204
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
205
        </literal></term>
229
206
        <listitem>
230
207
          <xi:include href="mandos-options.xml"
231
208
                      xpointer="servicename"/>
232
209
        </listitem>
233
210
      </varlistentry>
234
 
      
 
211
 
235
212
      <varlistentry>
236
 
        <term><option>--configdir
237
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
213
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
214
        </literal></term>
238
215
        <listitem>
239
216
          <para>
240
217
            Directory to search for configuration files.  Default is
246
223
          </para>
247
224
        </listitem>
248
225
      </varlistentry>
249
 
      
 
226
 
250
227
      <varlistentry>
251
 
        <term><option>--version</option></term>
 
228
        <term><literal>--version</literal></term>
252
229
        <listitem>
253
230
          <para>
254
231
            Prints the program version and exit.
255
232
          </para>
256
233
        </listitem>
257
234
      </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>
275
235
    </variablelist>
276
236
  </refsect1>
277
 
  
 
237
 
278
238
  <refsect1 id="overview">
279
239
    <title>OVERVIEW</title>
280
240
    <xi:include href="overview.xml"/>
281
241
    <para>
282
242
      This program is the server part.  It is a normal server program
283
243
      and will run in a normal system environment, not in an initial
284
 
      <acronym>RAM</acronym> disk environment.
 
244
      RAM disk environment.
285
245
    </para>
286
246
  </refsect1>
287
 
  
 
247
 
288
248
  <refsect1 id="protocol">
289
249
    <title>NETWORK PROTOCOL</title>
290
250
    <para>
342
302
      </row>
343
303
    </tbody></tgroup></table>
344
304
  </refsect1>
345
 
  
 
305
 
346
306
  <refsect1 id="checking">
347
307
    <title>CHECKING</title>
348
308
    <para>
349
309
      The server will, by default, continually check that the clients
350
310
      are still up.  If a client has not been confirmed as being up
351
311
      for some time, the client is assumed to be compromised and is no
352
 
      longer eligible to receive the encrypted password.  (Manual
353
 
      intervention is required to re-enable a client.)  The timeout,
 
312
      longer eligible to receive the encrypted password.  The timeout,
354
313
      checker program, and interval between checks can be configured
355
314
      both globally and per client; see <citerefentry>
356
315
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
  
 
316
      <manvolnum>5</manvolnum></citerefentry>.
 
317
    </para>
 
318
  </refsect1>
 
319
 
383
320
  <refsect1 id="logging">
384
321
    <title>LOGGING</title>
385
322
    <para>
389
326
      and also show them on the console.
390
327
    </para>
391
328
  </refsect1>
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
 
  
 
329
 
403
330
  <refsect1 id="exit_status">
404
331
    <title>EXIT STATUS</title>
405
332
    <para>
407
334
      critical error is encountered.
408
335
    </para>
409
336
  </refsect1>
410
 
  
 
337
 
411
338
  <refsect1 id="environment">
412
339
    <title>ENVIRONMENT</title>
413
340
    <variablelist>
414
341
      <varlistentry>
415
 
        <term><envar>PATH</envar></term>
 
342
        <term><varname>PATH</varname></term>
416
343
        <listitem>
417
344
          <para>
418
345
            To start the configured checker (see <xref
427
354
      </varlistentry>
428
355
    </variablelist>
429
356
  </refsect1>
430
 
  
431
 
  <refsect1 id="files">
 
357
 
 
358
  <refsect1 id="file">
432
359
    <title>FILES</title>
433
360
    <para>
434
361
      Use the <option>--configdir</option> option to change where
457
384
        </listitem>
458
385
      </varlistentry>
459
386
      <varlistentry>
460
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
387
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
461
388
        <listitem>
462
389
          <para>
463
 
            The file containing the process id of the
464
 
            <command>&COMMANDNAME;</command> process started last.
 
390
            The file containing the process id of
 
391
            <command>&COMMANDNAME;</command>.
465
392
          </para>
466
393
        </listitem>
467
394
      </varlistentry>
495
422
      backtrace.  This could be considered a feature.
496
423
    </para>
497
424
    <para>
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"/>.
 
425
      Currently, if a client is declared <quote>invalid</quote> due to
 
426
      having timed out, the server does not record this fact onto
 
427
      permanent storage.  This has some security implications, see
 
428
      <xref linkend="CLIENTS"/>.
 
429
    </para>
 
430
    <para>
 
431
      There is currently no way of querying the server of the current
 
432
      status of clients, other than analyzing its <systemitem
 
433
      class="service">syslog</systemitem> output.
501
434
    </para>
502
435
    <para>
503
436
      There is no fine-grained control over logging and debug output.
506
439
      Debug mode is conflated with running in the foreground.
507
440
    </para>
508
441
    <para>
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.
 
442
      The console log messages does not show a timestamp.
514
443
    </para>
515
444
  </refsect1>
516
445
  
551
480
      </para>
552
481
    </informalexample>
553
482
  </refsect1>
554
 
  
 
483
 
555
484
  <refsect1 id="security">
556
485
    <title>SECURITY</title>
557
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
558
487
      <title>SERVER</title>
559
488
      <para>
560
489
        Running this <command>&COMMANDNAME;</command> server program
561
490
        should not in itself present any security risk to the host
562
 
        computer running it.  The program switches to a non-root user
563
 
        soon after startup.
 
491
        computer running it.  The program does not need any special
 
492
        privileges to run, and is designed to run as a non-root user.
564
493
      </para>
565
494
    </refsect2>
566
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
567
496
      <title>CLIENTS</title>
568
497
      <para>
569
498
        The server only gives out its stored data to clients which
576
505
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
577
506
        <manvolnum>5</manvolnum></citerefentry>)
578
507
        <emphasis>must</emphasis> be made non-readable by anyone
579
 
        except the user starting the server (usually root).
 
508
        except the user running the server.
580
509
      </para>
581
510
      <para>
582
511
        As detailed in <xref linkend="checking"/>, the status of all
585
514
      </para>
586
515
      <para>
587
516
        If a client is compromised, its downtime should be duly noted
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.
 
517
        by the server which would therefore declare the client
 
518
        invalid.  But if the server was ever restarted, it would
 
519
        re-read its client list from its configuration file and again
 
520
        regard all clients therein as valid, and hence eligible to
 
521
        receive their passwords.  Therefore, be careful when
 
522
        restarting servers if it is suspected that a client has, in
 
523
        fact, been compromised by parties who may now be running a
 
524
        fake Mandos client with the keys from the non-encrypted
 
525
        initial RAM image of the client host.  What should be done in
 
526
        that case (if restarting the server program really is
 
527
        necessary) is to stop the server program, edit the
 
528
        configuration file to omit any suspect clients, and restart
 
529
        the server program.
600
530
      </para>
601
531
      <para>
602
532
        For more details on client-side security, see
603
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
        <citerefentry><refentrytitle>password-request</refentrytitle>
604
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
605
535
      </para>
606
536
    </refsect2>
607
537
  </refsect1>
608
 
  
 
538
 
609
539
  <refsect1 id="see_also">
610
540
    <title>SEE ALSO</title>
611
541
    <para>
612
542
      <citerefentry>
 
543
        <refentrytitle>mandos.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
613
545
        <refentrytitle>mandos-clients.conf</refentrytitle>
614
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
 
        <refentrytitle>mandos.conf</refentrytitle>
616
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
 
        <refentrytitle>mandos-client</refentrytitle>
 
547
        <refentrytitle>password-request</refentrytitle>
618
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
620
550
      </citerefentry>