/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-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-26">
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
 
      <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>
51
70
      Gives 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>
 
146
        <term><option>-h</option></term>
144
147
        <term><option>--help</option></term>
145
 
        <term><option>-h</option></term>
146
148
        <listitem>
147
149
          <para>
148
150
            Show a help message and exit
149
151
          </para>
150
152
        </listitem>
151
153
      </varlistentry>
152
 
      
 
154
 
153
155
      <varlistentry>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
154
158
        <term><option>--interface</option>
155
159
        <replaceable>NAME</replaceable></term>
156
 
        <term><option>-i</option>
157
 
        <replaceable>NAME</replaceable></term>
158
160
        <listitem>
159
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
160
162
        </listitem>
161
163
      </varlistentry>
162
 
      
 
164
 
163
165
      <varlistentry>
164
 
        <term><option>--address
165
 
        <replaceable>ADDRESS</replaceable></option></term>
166
 
        <term><option>-a
167
 
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
167
        ADDRESS</replaceable></literal></term>
168
168
        <listitem>
169
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
170
        </listitem>
171
171
      </varlistentry>
172
 
      
 
172
 
173
173
      <varlistentry>
174
 
        <term><option>--port
175
 
        <replaceable>PORT</replaceable></option></term>
176
 
        <term><option>-p
177
 
        <replaceable>PORT</replaceable></option></term>
 
174
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
175
        PORT</replaceable></literal></term>
178
176
        <listitem>
179
177
          <xi:include href="mandos-options.xml" xpointer="port"/>
180
178
        </listitem>
181
179
      </varlistentry>
182
 
      
 
180
 
183
181
      <varlistentry>
184
 
        <term><option>--check</option></term>
 
182
        <term><literal>--check</literal></term>
185
183
        <listitem>
186
184
          <para>
187
185
            Run the server’s self-tests.  This includes any unit
189
187
          </para>
190
188
        </listitem>
191
189
      </varlistentry>
192
 
      
 
190
 
193
191
      <varlistentry>
194
 
        <term><option>--debug</option></term>
 
192
        <term><literal>--debug</literal></term>
195
193
        <listitem>
196
194
          <xi:include href="mandos-options.xml" xpointer="debug"/>
197
195
        </listitem>
198
196
      </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>
 
197
 
 
198
      <varlistentry>
 
199
        <term><literal>--priority <replaceable>
 
200
        PRIORITY</replaceable></literal></term>
221
201
        <listitem>
222
202
          <xi:include href="mandos-options.xml" xpointer="priority"/>
223
203
        </listitem>
224
204
      </varlistentry>
225
 
      
 
205
 
226
206
      <varlistentry>
227
 
        <term><option>--servicename
228
 
        <replaceable>NAME</replaceable></option></term>
 
207
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
208
        </literal></term>
229
209
        <listitem>
230
210
          <xi:include href="mandos-options.xml"
231
211
                      xpointer="servicename"/>
232
212
        </listitem>
233
213
      </varlistentry>
234
 
      
 
214
 
235
215
      <varlistentry>
236
 
        <term><option>--configdir
237
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
216
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
217
        </literal></term>
238
218
        <listitem>
239
219
          <para>
240
220
            Directory to search for configuration files.  Default is
246
226
          </para>
247
227
        </listitem>
248
228
      </varlistentry>
249
 
      
 
229
 
250
230
      <varlistentry>
251
 
        <term><option>--version</option></term>
 
231
        <term><literal>--version</literal></term>
252
232
        <listitem>
253
233
          <para>
254
234
            Prints the program version and exit.
255
235
          </para>
256
236
        </listitem>
257
237
      </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
238
    </variablelist>
276
239
  </refsect1>
277
 
  
 
240
 
278
241
  <refsect1 id="overview">
279
242
    <title>OVERVIEW</title>
280
243
    <xi:include href="overview.xml"/>
281
244
    <para>
282
245
      This program is the server part.  It is a normal server program
283
246
      and will run in a normal system environment, not in an initial
284
 
      <acronym>RAM</acronym> disk environment.
 
247
      RAM disk environment.
285
248
    </para>
286
249
  </refsect1>
287
 
  
 
250
 
288
251
  <refsect1 id="protocol">
289
252
    <title>NETWORK PROTOCOL</title>
290
253
    <para>
342
305
      </row>
343
306
    </tbody></tgroup></table>
344
307
  </refsect1>
345
 
  
 
308
 
346
309
  <refsect1 id="checking">
347
310
    <title>CHECKING</title>
348
311
    <para>
349
312
      The server will, by default, continually check that the clients
350
313
      are still up.  If a client has not been confirmed as being up
351
314
      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,
 
315
      longer eligible to receive the encrypted password.  The timeout,
354
316
      checker program, and interval between checks can be configured
355
317
      both globally and per client; see <citerefentry>
356
318
      <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
 
  
 
319
      <manvolnum>5</manvolnum></citerefentry>.
 
320
    </para>
 
321
  </refsect1>
 
322
 
383
323
  <refsect1 id="logging">
384
324
    <title>LOGGING</title>
385
325
    <para>
389
329
      and also show them on the console.
390
330
    </para>
391
331
  </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
 
  
 
332
 
403
333
  <refsect1 id="exit_status">
404
334
    <title>EXIT STATUS</title>
405
335
    <para>
407
337
      critical error is encountered.
408
338
    </para>
409
339
  </refsect1>
410
 
  
 
340
 
411
341
  <refsect1 id="environment">
412
342
    <title>ENVIRONMENT</title>
413
343
    <variablelist>
427
357
      </varlistentry>
428
358
    </variablelist>
429
359
  </refsect1>
430
 
  
431
 
  <refsect1 id="files">
 
360
 
 
361
  <refsect1 id="file">
432
362
    <title>FILES</title>
433
363
    <para>
434
364
      Use the <option>--configdir</option> option to change where
457
387
        </listitem>
458
388
      </varlistentry>
459
389
      <varlistentry>
460
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
390
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
461
391
        <listitem>
462
392
          <para>
463
 
            The file containing the process id of the
464
 
            <command>&COMMANDNAME;</command> process started last.
 
393
            The file containing the process id of
 
394
            <command>&COMMANDNAME;</command>.
465
395
          </para>
466
396
        </listitem>
467
397
      </varlistentry>
495
425
      backtrace.  This could be considered a feature.
496
426
    </para>
497
427
    <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"/>.
 
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.
501
437
    </para>
502
438
    <para>
503
439
      There is no fine-grained control over logging and debug output.
506
442
      Debug mode is conflated with running in the foreground.
507
443
    </para>
508
444
    <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.
 
445
      The console log messages does not show a timestamp.
514
446
    </para>
515
447
  </refsect1>
516
448
  
551
483
      </para>
552
484
    </informalexample>
553
485
  </refsect1>
554
 
  
 
486
 
555
487
  <refsect1 id="security">
556
488
    <title>SECURITY</title>
557
 
    <refsect2 id="server">
 
489
    <refsect2 id="SERVER">
558
490
      <title>SERVER</title>
559
491
      <para>
560
492
        Running this <command>&COMMANDNAME;</command> server program
561
493
        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.
 
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.
564
496
      </para>
565
497
    </refsect2>
566
 
    <refsect2 id="clients">
 
498
    <refsect2 id="CLIENTS">
567
499
      <title>CLIENTS</title>
568
500
      <para>
569
501
        The server only gives out its stored data to clients which
576
508
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
577
509
        <manvolnum>5</manvolnum></citerefentry>)
578
510
        <emphasis>must</emphasis> be made non-readable by anyone
579
 
        except the user starting the server (usually root).
 
511
        except the user running the server.
580
512
      </para>
581
513
      <para>
582
514
        As detailed in <xref linkend="checking"/>, the status of all
585
517
      </para>
586
518
      <para>
587
519
        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.
 
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.
600
533
      </para>
601
534
      <para>
602
535
        For more details on client-side security, see
603
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
536
        <citerefentry><refentrytitle>password-request</refentrytitle>
604
537
        <manvolnum>8mandos</manvolnum></citerefentry>.
605
538
      </para>
606
539
    </refsect2>
607
540
  </refsect1>
608
 
  
 
541
 
609
542
  <refsect1 id="see_also">
610
543
    <title>SEE ALSO</title>
611
544
    <para>
614
547
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
548
        <refentrytitle>mandos.conf</refentrytitle>
616
549
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
 
        <refentrytitle>mandos-client</refentrytitle>
 
550
        <refentrytitle>password-request</refentrytitle>
618
551
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
552
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
620
553
      </citerefentry>