/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 07:30:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829073017-tvryowganbf75zp5
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
                                      man-pages(7).
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml (SEE ALSO): Changed from an
                                             <itemizedlist> to a
                                             <para>, as per
                                             man-pages(7).  Also
                                             alphabetize.

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