/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-30 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.

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-11">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-30">
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
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
39
 
    <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>
40
60
  </refentryinfo>
41
 
  
 
61
 
42
62
  <refmeta>
43
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
64
    <manvolnum>8</manvolnum>
50
70
      Gives encrypted passwords to authenticated Mandos clients
51
71
    </refpurpose>
52
72
  </refnamediv>
53
 
  
 
73
 
54
74
  <refsynopsisdiv>
55
75
    <cmdsynopsis>
56
76
      <command>&COMMANDNAME;</command>
57
 
      <group>
58
 
        <arg choice="plain"><option>--interface
59
 
        <replaceable>NAME</replaceable></option></arg>
60
 
        <arg choice="plain"><option>-i
61
 
        <replaceable>NAME</replaceable></option></arg>
62
 
      </group>
63
 
      <sbr/>
64
 
      <group>
65
 
        <arg choice="plain"><option>--address
66
 
        <replaceable>ADDRESS</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-a
68
 
        <replaceable>ADDRESS</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--port
73
 
        <replaceable>PORT</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-p
75
 
        <replaceable>PORT</replaceable></option></arg>
76
 
      </group>
77
 
      <sbr/>
78
 
      <arg><option>--priority
79
 
      <replaceable>PRIORITY</replaceable></option></arg>
80
 
      <sbr/>
81
 
      <arg><option>--servicename
82
 
      <replaceable>NAME</replaceable></option></arg>
83
 
      <sbr/>
84
 
      <arg><option>--configdir
85
 
      <replaceable>DIRECTORY</replaceable></option></arg>
86
 
      <sbr/>
87
 
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <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>
92
94
    </cmdsynopsis>
93
95
    <cmdsynopsis>
94
96
      <command>&COMMANDNAME;</command>
95
97
      <group choice="req">
96
 
        <arg choice="plain"><option>--help</option></arg>
97
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
98
100
      </group>
99
101
    </cmdsynopsis>
100
102
    <cmdsynopsis>
101
103
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
103
105
    </cmdsynopsis>
104
106
    <cmdsynopsis>
105
107
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
107
109
    </cmdsynopsis>
108
110
  </refsynopsisdiv>
109
 
  
 
111
 
110
112
  <refsect1 id="description">
111
113
    <title>DESCRIPTION</title>
112
114
    <para>
121
123
      Any authenticated client is then given the stored pre-encrypted
122
124
      password for that specific client.
123
125
    </para>
 
126
 
124
127
  </refsect1>
125
128
  
126
129
  <refsect1 id="purpose">
127
130
    <title>PURPOSE</title>
 
131
 
128
132
    <para>
129
133
      The purpose of this is to enable <emphasis>remote and unattended
130
134
      rebooting</emphasis> of client host computer with an
131
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
132
136
      linkend="overview"/> for details.
133
137
    </para>
 
138
 
134
139
  </refsect1>
135
140
  
136
141
  <refsect1 id="options">
137
142
    <title>OPTIONS</title>
 
143
 
138
144
    <variablelist>
139
145
      <varlistentry>
 
146
        <term><option>-h</option></term>
140
147
        <term><option>--help</option></term>
141
 
        <term><option>-h</option></term>
142
148
        <listitem>
143
149
          <para>
144
150
            Show a help message and exit
145
151
          </para>
146
152
        </listitem>
147
153
      </varlistentry>
148
 
      
 
154
 
149
155
      <varlistentry>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
150
158
        <term><option>--interface</option>
151
159
        <replaceable>NAME</replaceable></term>
152
 
        <term><option>-i</option>
153
 
        <replaceable>NAME</replaceable></term>
154
160
        <listitem>
155
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
156
162
        </listitem>
157
163
      </varlistentry>
158
 
      
 
164
 
159
165
      <varlistentry>
160
 
        <term><option>--address
161
 
        <replaceable>ADDRESS</replaceable></option></term>
162
 
        <term><option>-a
163
 
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
167
        ADDRESS</replaceable></literal></term>
164
168
        <listitem>
165
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
166
170
        </listitem>
167
171
      </varlistentry>
168
 
      
 
172
 
169
173
      <varlistentry>
170
 
        <term><option>--port
171
 
        <replaceable>PORT</replaceable></option></term>
172
 
        <term><option>-p
173
 
        <replaceable>PORT</replaceable></option></term>
 
174
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
175
        PORT</replaceable></literal></term>
174
176
        <listitem>
175
177
          <xi:include href="mandos-options.xml" xpointer="port"/>
176
178
        </listitem>
177
179
      </varlistentry>
178
 
      
 
180
 
179
181
      <varlistentry>
180
 
        <term><option>--check</option></term>
 
182
        <term><literal>--check</literal></term>
181
183
        <listitem>
182
184
          <para>
183
185
            Run the server’s self-tests.  This includes any unit
185
187
          </para>
186
188
        </listitem>
187
189
      </varlistentry>
188
 
      
 
190
 
189
191
      <varlistentry>
190
 
        <term><option>--debug</option></term>
 
192
        <term><literal>--debug</literal></term>
191
193
        <listitem>
192
194
          <xi:include href="mandos-options.xml" xpointer="debug"/>
193
195
        </listitem>
194
196
      </varlistentry>
195
 
      
 
197
 
196
198
      <varlistentry>
197
 
        <term><option>--priority <replaceable>
198
 
        PRIORITY</replaceable></option></term>
 
199
        <term><literal>--priority <replaceable>
 
200
        PRIORITY</replaceable></literal></term>
199
201
        <listitem>
200
202
          <xi:include href="mandos-options.xml" xpointer="priority"/>
201
203
        </listitem>
202
204
      </varlistentry>
203
 
      
 
205
 
204
206
      <varlistentry>
205
 
        <term><option>--servicename
206
 
        <replaceable>NAME</replaceable></option></term>
 
207
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
208
        </literal></term>
207
209
        <listitem>
208
210
          <xi:include href="mandos-options.xml"
209
211
                      xpointer="servicename"/>
210
212
        </listitem>
211
213
      </varlistentry>
212
 
      
 
214
 
213
215
      <varlistentry>
214
 
        <term><option>--configdir
215
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
216
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
217
        </literal></term>
216
218
        <listitem>
217
219
          <para>
218
220
            Directory to search for configuration files.  Default is
224
226
          </para>
225
227
        </listitem>
226
228
      </varlistentry>
227
 
      
 
229
 
228
230
      <varlistentry>
229
 
        <term><option>--version</option></term>
 
231
        <term><literal>--version</literal></term>
230
232
        <listitem>
231
233
          <para>
232
234
            Prints the program version and exit.
233
235
          </para>
234
236
        </listitem>
235
237
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
 
        <term><option>--no-dbus</option></term>
239
 
        <listitem>
240
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
241
 
          <para>
242
 
            See also <xref linkend="dbus_interface"/>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--no-ipv6</option></term>
249
 
        <listitem>
250
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
 
        </listitem>
252
 
      </varlistentry>
253
238
    </variablelist>
254
239
  </refsect1>
255
 
  
 
240
 
256
241
  <refsect1 id="overview">
257
242
    <title>OVERVIEW</title>
258
243
    <xi:include href="overview.xml"/>
259
244
    <para>
260
245
      This program is the server part.  It is a normal server program
261
246
      and will run in a normal system environment, not in an initial
262
 
      <acronym>RAM</acronym> disk environment.
 
247
      RAM disk environment.
263
248
    </para>
264
249
  </refsect1>
265
 
  
 
250
 
266
251
  <refsect1 id="protocol">
267
252
    <title>NETWORK PROTOCOL</title>
268
253
    <para>
320
305
      </row>
321
306
    </tbody></tgroup></table>
322
307
  </refsect1>
323
 
  
 
308
 
324
309
  <refsect1 id="checking">
325
310
    <title>CHECKING</title>
326
311
    <para>
327
312
      The server will, by default, continually check that the clients
328
313
      are still up.  If a client has not been confirmed as being up
329
314
      for some time, the client is assumed to be compromised and is no
330
 
      longer eligible to receive the encrypted password.  (Manual
331
 
      intervention is required to re-enable a client.)  The timeout,
 
315
      longer eligible to receive the encrypted password.  The timeout,
332
316
      checker program, and interval between checks can be configured
333
317
      both globally and per client; see <citerefentry>
334
318
      <refentrytitle>mandos-clients.conf</refentrytitle>
335
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
336
 
      receiving its password will also be treated as a successful
337
 
      checker run.
 
319
      <manvolnum>5</manvolnum></citerefentry>.
338
320
    </para>
339
321
  </refsect1>
340
 
  
 
322
 
341
323
  <refsect1 id="logging">
342
324
    <title>LOGGING</title>
343
325
    <para>
347
329
      and also show them on the console.
348
330
    </para>
349
331
  </refsect1>
350
 
  
351
 
  <refsect1 id="dbus_interface">
352
 
    <title>D-BUS INTERFACE</title>
353
 
    <para>
354
 
      The server will by default provide a D-Bus system bus interface.
355
 
      This interface will only be accessible by the root user or a
356
 
      Mandos-specific user, if such a user exists.  For documentation
357
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
358
 
    </para>
359
 
  </refsect1>
360
 
  
 
332
 
361
333
  <refsect1 id="exit_status">
362
334
    <title>EXIT STATUS</title>
363
335
    <para>
365
337
      critical error is encountered.
366
338
    </para>
367
339
  </refsect1>
368
 
  
 
340
 
369
341
  <refsect1 id="environment">
370
342
    <title>ENVIRONMENT</title>
371
343
    <variablelist>
385
357
      </varlistentry>
386
358
    </variablelist>
387
359
  </refsect1>
388
 
  
389
 
  <refsect1 id="files">
 
360
 
 
361
  <refsect1 id="file">
390
362
    <title>FILES</title>
391
363
    <para>
392
364
      Use the <option>--configdir</option> option to change where
415
387
        </listitem>
416
388
      </varlistentry>
417
389
      <varlistentry>
418
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
390
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
419
391
        <listitem>
420
392
          <para>
421
393
            The file containing the process id of
453
425
      backtrace.  This could be considered a feature.
454
426
    </para>
455
427
    <para>
456
 
      Currently, if a client is disabled due to having timed out, the
457
 
      server does not record this fact onto permanent storage.  This
458
 
      has some security implications, see <xref linkend="clients"/>.
 
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.
459
437
    </para>
460
438
    <para>
461
439
      There is no fine-grained control over logging and debug output.
464
442
      Debug mode is conflated with running in the foreground.
465
443
    </para>
466
444
    <para>
467
 
      The console log messages do not show a time stamp.
468
 
    </para>
469
 
    <para>
470
 
      This server does not check the expire time of clients’ OpenPGP
471
 
      keys.
 
445
      The console log messages does not show a timestamp.
472
446
    </para>
473
447
  </refsect1>
474
448
  
509
483
      </para>
510
484
    </informalexample>
511
485
  </refsect1>
512
 
  
 
486
 
513
487
  <refsect1 id="security">
514
488
    <title>SECURITY</title>
515
 
    <refsect2 id="server">
 
489
    <refsect2 id="SERVER">
516
490
      <title>SERVER</title>
517
491
      <para>
518
492
        Running this <command>&COMMANDNAME;</command> server program
519
493
        should not in itself present any security risk to the host
520
 
        computer running it.  The program switches to a non-root user
521
 
        soon after startup.
 
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.
522
496
      </para>
523
497
    </refsect2>
524
 
    <refsect2 id="clients">
 
498
    <refsect2 id="CLIENTS">
525
499
      <title>CLIENTS</title>
526
500
      <para>
527
501
        The server only gives out its stored data to clients which
534
508
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
535
509
        <manvolnum>5</manvolnum></citerefentry>)
536
510
        <emphasis>must</emphasis> be made non-readable by anyone
537
 
        except the user starting the server (usually root).
 
511
        except the user running the server.
538
512
      </para>
539
513
      <para>
540
514
        As detailed in <xref linkend="checking"/>, the status of all
543
517
      </para>
544
518
      <para>
545
519
        If a client is compromised, its downtime should be duly noted
546
 
        by the server which would therefore disable the client.  But
547
 
        if the server was ever restarted, it would re-read its client
548
 
        list from its configuration file and again regard all clients
549
 
        therein as enabled, and hence eligible to receive their
550
 
        passwords.  Therefore, be careful when restarting servers if
551
 
        it is suspected that a client has, in fact, been compromised
552
 
        by parties who may now be running a fake Mandos client with
553
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
554
 
        image of the client host.  What should be done in that case
555
 
        (if restarting the server program really is necessary) is to
556
 
        stop the server program, edit the configuration file to omit
557
 
        any suspect clients, and restart the server program.
 
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.
558
533
      </para>
559
534
      <para>
560
535
        For more details on client-side security, see
561
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
536
        <citerefentry><refentrytitle>password-request</refentrytitle>
562
537
        <manvolnum>8mandos</manvolnum></citerefentry>.
563
538
      </para>
564
539
    </refsect2>
565
540
  </refsect1>
566
 
  
 
541
 
567
542
  <refsect1 id="see_also">
568
543
    <title>SEE ALSO</title>
569
544
    <para>
572
547
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
573
548
        <refentrytitle>mandos.conf</refentrytitle>
574
549
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
575
 
        <refentrytitle>mandos-client</refentrytitle>
 
550
        <refentrytitle>password-request</refentrytitle>
576
551
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
577
552
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
578
553
      </citerefentry>