/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 16:53:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829165341-xzrp0xxxfrua5kzq
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
                         "--interface" options.

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