/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-25 10:41:16 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825104116-cjd54qqs535kpdxq
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
                                syntax by name.

* mandos.conf.xml (SEE ALSO): Also refer to gnutls_priority_init(3),
                              RFC 4291, and Zeroconf.

* mandos.xml (SEE ALSO): Also refer to sections 2.2 and 2.5.5.2 of RFC
                         4291.  Stop using <citation> 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 "2009-12-09">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
6
]>
9
7
 
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
  <refentryinfo>
 
10
    <title>&COMMANDNAME;</title>
13
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
12
    <productname>&COMMANDNAME;</productname>
 
13
    <productnumber>&VERSION;</productnumber>
17
14
    <authorgroup>
18
15
      <author>
19
16
        <firstname>Björn</firstname>
32
29
    </authorgroup>
33
30
    <copyright>
34
31
      <year>2008</year>
35
 
      <year>2009</year>
36
32
      <holder>Teddy Hogeborn</holder>
37
33
      <holder>Björn Påhlsson</holder>
38
34
    </copyright>
39
 
    <xi:include href="legalnotice.xml"/>
 
35
    <legalnotice>
 
36
      <para>
 
37
        This manual page is free software: you can redistribute it
 
38
        and/or modify it under the terms of the GNU General Public
 
39
        License as published by the Free Software Foundation,
 
40
        either version 3 of the License, or (at your option) any
 
41
        later version.
 
42
      </para>
 
43
 
 
44
      <para>
 
45
        This manual page is distributed in the hope that it will
 
46
        be useful, but WITHOUT ANY WARRANTY; without even the
 
47
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
48
        PARTICULAR PURPOSE.  See the GNU General Public License
 
49
        for more details.
 
50
      </para>
 
51
 
 
52
      <para>
 
53
        You should have received a copy of the GNU General Public
 
54
        License along with this program; If not, see
 
55
        <ulink url="http://www.gnu.org/licenses/"/>.
 
56
      </para>
 
57
    </legalnotice>
40
58
  </refentryinfo>
41
 
  
 
59
 
42
60
  <refmeta>
43
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
62
    <manvolnum>8</manvolnum>
47
65
  <refnamediv>
48
66
    <refname><command>&COMMANDNAME;</command></refname>
49
67
    <refpurpose>
50
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
51
69
    </refpurpose>
52
70
  </refnamediv>
53
 
  
 
71
 
54
72
  <refsynopsisdiv>
55
73
    <cmdsynopsis>
56
74
      <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>
 
75
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
79
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
80
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
81
      <arg>--debug</arg>
 
82
    </cmdsynopsis>
 
83
    <cmdsynopsis>
 
84
      <command>&COMMANDNAME;</command>
 
85
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
89
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
90
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
91
      <arg>--debug</arg>
92
92
    </cmdsynopsis>
93
93
    <cmdsynopsis>
94
94
      <command>&COMMANDNAME;</command>
95
95
      <group choice="req">
96
 
        <arg choice="plain"><option>--help</option></arg>
97
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
98
98
      </group>
99
99
    </cmdsynopsis>
100
100
    <cmdsynopsis>
101
101
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
103
103
    </cmdsynopsis>
104
104
    <cmdsynopsis>
105
105
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
107
107
    </cmdsynopsis>
108
108
  </refsynopsisdiv>
109
 
  
 
109
 
110
110
  <refsect1 id="description">
111
111
    <title>DESCRIPTION</title>
112
112
    <para>
121
121
      Any authenticated client is then given the stored pre-encrypted
122
122
      password for that specific client.
123
123
    </para>
 
124
 
124
125
  </refsect1>
125
126
  
126
127
  <refsect1 id="purpose">
127
128
    <title>PURPOSE</title>
 
129
 
128
130
    <para>
129
131
      The purpose of this is to enable <emphasis>remote and unattended
130
132
      rebooting</emphasis> of client host computer with an
131
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
132
134
      linkend="overview"/> for details.
133
135
    </para>
 
136
 
134
137
  </refsect1>
135
138
  
136
139
  <refsect1 id="options">
137
140
    <title>OPTIONS</title>
 
141
 
138
142
    <variablelist>
139
143
      <varlistentry>
140
 
        <term><option>--help</option></term>
141
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
142
145
        <listitem>
143
146
          <para>
144
147
            Show a help message and exit
145
148
          </para>
146
149
        </listitem>
147
150
      </varlistentry>
148
 
      
 
151
 
149
152
      <varlistentry>
150
 
        <term><option>--interface</option>
151
 
        <replaceable>NAME</replaceable></term>
152
 
        <term><option>-i</option>
153
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
154
        >NAME</replaceable></literal></term>
154
155
        <listitem>
155
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
156
157
        </listitem>
157
158
      </varlistentry>
158
 
      
 
159
 
159
160
      <varlistentry>
160
 
        <term><option>--address
161
 
        <replaceable>ADDRESS</replaceable></option></term>
162
 
        <term><option>-a
163
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
164
163
        <listitem>
165
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
166
165
        </listitem>
167
166
      </varlistentry>
168
 
      
 
167
 
169
168
      <varlistentry>
170
 
        <term><option>--port
171
 
        <replaceable>PORT</replaceable></option></term>
172
 
        <term><option>-p
173
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
174
171
        <listitem>
175
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
176
173
        </listitem>
177
174
      </varlistentry>
178
 
      
 
175
 
179
176
      <varlistentry>
180
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
181
178
        <listitem>
182
179
          <para>
183
180
            Run the server’s self-tests.  This includes any unit
185
182
          </para>
186
183
        </listitem>
187
184
      </varlistentry>
188
 
      
 
185
 
189
186
      <varlistentry>
190
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
191
188
        <listitem>
192
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
193
190
        </listitem>
194
191
      </varlistentry>
195
 
      
 
192
 
196
193
      <varlistentry>
197
 
        <term><option>--priority <replaceable>
198
 
        PRIORITY</replaceable></option></term>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
199
196
        <listitem>
200
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
201
198
        </listitem>
202
199
      </varlistentry>
203
 
      
 
200
 
204
201
      <varlistentry>
205
 
        <term><option>--servicename
206
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
207
204
        <listitem>
208
205
          <xi:include href="mandos-options.xml"
209
206
                      xpointer="servicename"/>
210
207
        </listitem>
211
208
      </varlistentry>
212
 
      
 
209
 
213
210
      <varlistentry>
214
 
        <term><option>--configdir
215
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
216
213
        <listitem>
217
214
          <para>
218
215
            Directory to search for configuration files.  Default is
224
221
          </para>
225
222
        </listitem>
226
223
      </varlistentry>
227
 
      
 
224
 
228
225
      <varlistentry>
229
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
230
227
        <listitem>
231
228
          <para>
232
229
            Prints the program version and exit.
233
230
          </para>
234
231
        </listitem>
235
232
      </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
233
    </variablelist>
254
234
  </refsect1>
255
 
  
 
235
 
256
236
  <refsect1 id="overview">
257
237
    <title>OVERVIEW</title>
258
238
    <xi:include href="overview.xml"/>
259
239
    <para>
260
240
      This program is the server part.  It is a normal server program
261
241
      and will run in a normal system environment, not in an initial
262
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
263
243
    </para>
264
244
  </refsect1>
265
 
  
 
245
 
266
246
  <refsect1 id="protocol">
267
247
    <title>NETWORK PROTOCOL</title>
268
248
    <para>
320
300
      </row>
321
301
    </tbody></tgroup></table>
322
302
  </refsect1>
323
 
  
 
303
 
324
304
  <refsect1 id="checking">
325
305
    <title>CHECKING</title>
326
306
    <para>
327
307
      The server will, by default, continually check that the clients
328
308
      are still up.  If a client has not been confirmed as being up
329
309
      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,
 
310
      longer eligible to receive the encrypted password.  The timeout,
332
311
      checker program, and interval between checks can be configured
333
312
      both globally and per client; see <citerefentry>
334
313
      <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.
 
314
      <manvolnum>5</manvolnum></citerefentry>.
338
315
    </para>
339
316
  </refsect1>
340
 
  
 
317
 
341
318
  <refsect1 id="logging">
342
319
    <title>LOGGING</title>
343
320
    <para>
347
324
      and also show them on the console.
348
325
    </para>
349
326
  </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.
357
 
      <!-- XXX -->
358
 
    </para>
359
 
  </refsect1>
360
 
  
 
327
 
361
328
  <refsect1 id="exit_status">
362
329
    <title>EXIT STATUS</title>
363
330
    <para>
365
332
      critical error is encountered.
366
333
    </para>
367
334
  </refsect1>
368
 
  
 
335
 
369
336
  <refsect1 id="environment">
370
337
    <title>ENVIRONMENT</title>
371
338
    <variablelist>
372
339
      <varlistentry>
373
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
374
341
        <listitem>
375
342
          <para>
376
343
            To start the configured checker (see <xref
385
352
      </varlistentry>
386
353
    </variablelist>
387
354
  </refsect1>
388
 
  
389
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
390
357
    <title>FILES</title>
391
358
    <para>
392
359
      Use the <option>--configdir</option> option to change where
415
382
        </listitem>
416
383
      </varlistentry>
417
384
      <varlistentry>
418
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
385
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
419
386
        <listitem>
420
387
          <para>
421
388
            The file containing the process id of
453
420
      backtrace.  This could be considered a feature.
454
421
    </para>
455
422
    <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"/>.
 
423
      Currently, if a client is declared <quote>invalid</quote> due to
 
424
      having timed out, the server does not record this fact onto
 
425
      permanent storage.  This has some security implications, see
 
426
      <xref linkend="CLIENTS"/>.
459
427
    </para>
460
428
    <para>
461
429
      There is currently no way of querying the server of the current
469
437
      Debug mode is conflated with running in the foreground.
470
438
    </para>
471
439
    <para>
472
 
      The console log messages do not show a time stamp.
473
 
    </para>
474
 
    <para>
475
 
      This server does not check the expire time of clients’ OpenPGP
476
 
      keys.
 
440
      The console log messages does not show a timestamp.
477
441
    </para>
478
442
  </refsect1>
479
443
  
484
448
        Normal invocation needs no options:
485
449
      </para>
486
450
      <para>
487
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
488
452
      </para>
489
453
    </informalexample>
490
454
    <informalexample>
497
461
      <para>
498
462
 
499
463
<!-- do not wrap this line -->
500
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
501
465
 
502
466
      </para>
503
467
    </informalexample>
509
473
      <para>
510
474
 
511
475
<!-- do not wrap this line -->
512
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
513
477
 
514
478
      </para>
515
479
    </informalexample>
516
480
  </refsect1>
517
 
  
 
481
 
518
482
  <refsect1 id="security">
519
483
    <title>SECURITY</title>
520
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
521
485
      <title>SERVER</title>
522
486
      <para>
523
487
        Running this <command>&COMMANDNAME;</command> server program
524
488
        should not in itself present any security risk to the host
525
 
        computer running it.  The program switches to a non-root user
526
 
        soon after startup.
 
489
        computer running it.  The program does not need any special
 
490
        privileges to run, and is designed to run as a non-root user.
527
491
      </para>
528
492
    </refsect2>
529
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
530
494
      <title>CLIENTS</title>
531
495
      <para>
532
496
        The server only gives out its stored data to clients which
539
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
540
504
        <manvolnum>5</manvolnum></citerefentry>)
541
505
        <emphasis>must</emphasis> be made non-readable by anyone
542
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
543
507
      </para>
544
508
      <para>
545
509
        As detailed in <xref linkend="checking"/>, the status of all
548
512
      </para>
549
513
      <para>
550
514
        If a client is compromised, its downtime should be duly noted
551
 
        by the server which would therefore disable the client.  But
552
 
        if the server was ever restarted, it would re-read its client
553
 
        list from its configuration file and again regard all clients
554
 
        therein as enabled, and hence eligible to receive their
555
 
        passwords.  Therefore, be careful when restarting servers if
556
 
        it is suspected that a client has, in fact, been compromised
557
 
        by parties who may now be running a fake Mandos client with
558
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
559
 
        image of the client host.  What should be done in that case
560
 
        (if restarting the server program really is necessary) is to
561
 
        stop the server program, edit the configuration file to omit
562
 
        any suspect clients, and restart the server program.
 
515
        by the server which would therefore declare the client
 
516
        invalid.  But if the server was ever restarted, it would
 
517
        re-read its client list from its configuration file and again
 
518
        regard all clients therein as valid, and hence eligible to
 
519
        receive their passwords.  Therefore, be careful when
 
520
        restarting servers if it is suspected that a client has, in
 
521
        fact, been compromised by parties who may now be running a
 
522
        fake Mandos client with the keys from the non-encrypted
 
523
        initial RAM image of the client host.  What should be done in
 
524
        that case (if restarting the server program really is
 
525
        necessary) is to stop the server program, edit the
 
526
        configuration file to omit any suspect clients, and restart
 
527
        the server program.
563
528
      </para>
564
529
      <para>
565
530
        For more details on client-side security, see
566
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
567
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
568
533
      </para>
569
534
    </refsect2>
570
535
  </refsect1>
571
 
  
 
536
 
572
537
  <refsect1 id="see_also">
573
538
    <title>SEE ALSO</title>
574
539
    <para>
575
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
576
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
577
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
578
 
        <refentrytitle>mandos.conf</refentrytitle>
579
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
 
        <refentrytitle>mandos-client</refentrytitle>
 
545
        <refentrytitle>password-request</refentrytitle>
581
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
582
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
583
548
      </citerefentry>
686
651
    </variablelist>
687
652
  </refsect1>
688
653
</refentry>
689
 
<!-- Local Variables: -->
690
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
691
 
<!-- time-stamp-end: "[\"']>" -->
692
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
693
 
<!-- End: -->