/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 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long 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-10-22">
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>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </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>
52
70
      Gives 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>
87
105
      <replaceable>DIRECTORY</replaceable></option></arg>
88
106
      <sbr/>
89
107
      <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>
97
 
      <sbr/>
98
 
      <arg><option>--no-restore</option></arg>
99
108
    </cmdsynopsis>
100
109
    <cmdsynopsis>
101
110
      <command>&COMMANDNAME;</command>
102
111
      <group choice="req">
 
112
        <arg choice="plain"><option>-h</option></arg>
103
113
        <arg choice="plain"><option>--help</option></arg>
104
 
        <arg choice="plain"><option>-h</option></arg>
105
114
      </group>
106
115
    </cmdsynopsis>
107
116
    <cmdsynopsis>
113
122
      <arg choice="plain"><option>--check</option></arg>
114
123
    </cmdsynopsis>
115
124
  </refsynopsisdiv>
116
 
  
 
125
 
117
126
  <refsect1 id="description">
118
127
    <title>DESCRIPTION</title>
119
128
    <para>
120
129
      <command>&COMMANDNAME;</command> is a server daemon which
121
130
      handles incoming request for passwords for a pre-defined list of
122
 
      client host computers. For an introduction, see
123
 
      <citerefentry><refentrytitle>intro</refentrytitle>
124
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
125
 
      uses Zeroconf to announce itself on the local network, and uses
126
 
      TLS to communicate securely with and to authenticate the
127
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
128
 
      use IPv6 link-local addresses, since the clients will probably
129
 
      not have any other addresses configured (see <xref
130
 
      linkend="overview"/>).  Any authenticated client is then given
131
 
      the stored pre-encrypted password for that specific client.
 
131
      client host computers.  The Mandos server uses Zeroconf to
 
132
      announce itself on the local network, and uses TLS to
 
133
      communicate securely with and to authenticate the clients.  The
 
134
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
135
      link-local addresses, since the clients will probably not have
 
136
      any other addresses configured (see <xref linkend="overview"/>).
 
137
      Any authenticated client is then given the stored pre-encrypted
 
138
      password for that specific client.
132
139
    </para>
 
140
 
133
141
  </refsect1>
134
142
  
135
143
  <refsect1 id="purpose">
136
144
    <title>PURPOSE</title>
 
145
 
137
146
    <para>
138
147
      The purpose of this is to enable <emphasis>remote and unattended
139
148
      rebooting</emphasis> of client host computer with an
140
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
141
150
      linkend="overview"/> for details.
142
151
    </para>
 
152
 
143
153
  </refsect1>
144
154
  
145
155
  <refsect1 id="options">
146
156
    <title>OPTIONS</title>
 
157
 
147
158
    <variablelist>
148
159
      <varlistentry>
 
160
        <term><option>-h</option></term>
149
161
        <term><option>--help</option></term>
150
 
        <term><option>-h</option></term>
151
162
        <listitem>
152
163
          <para>
153
164
            Show a help message and exit
154
165
          </para>
155
166
        </listitem>
156
167
      </varlistentry>
157
 
      
 
168
 
158
169
      <varlistentry>
 
170
        <term><option>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
159
172
        <term><option>--interface</option>
160
173
        <replaceable>NAME</replaceable></term>
161
 
        <term><option>-i</option>
162
 
        <replaceable>NAME</replaceable></term>
163
174
        <listitem>
164
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
165
176
        </listitem>
166
177
      </varlistentry>
167
 
      
 
178
 
168
179
      <varlistentry>
169
 
        <term><option>--address
170
 
        <replaceable>ADDRESS</replaceable></option></term>
171
 
        <term><option>-a
172
 
        <replaceable>ADDRESS</replaceable></option></term>
 
180
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
181
        ADDRESS</replaceable></literal></term>
173
182
        <listitem>
174
183
          <xi:include href="mandos-options.xml" xpointer="address"/>
175
184
        </listitem>
176
185
      </varlistentry>
177
 
      
 
186
 
178
187
      <varlistentry>
179
 
        <term><option>--port
180
 
        <replaceable>PORT</replaceable></option></term>
181
 
        <term><option>-p
182
 
        <replaceable>PORT</replaceable></option></term>
 
188
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
189
        PORT</replaceable></literal></term>
183
190
        <listitem>
184
191
          <xi:include href="mandos-options.xml" xpointer="port"/>
185
192
        </listitem>
186
193
      </varlistentry>
187
 
      
 
194
 
188
195
      <varlistentry>
189
 
        <term><option>--check</option></term>
 
196
        <term><literal>--check</literal></term>
190
197
        <listitem>
191
198
          <para>
192
199
            Run the server’s self-tests.  This includes any unit
194
201
          </para>
195
202
        </listitem>
196
203
      </varlistentry>
197
 
      
 
204
 
198
205
      <varlistentry>
199
 
        <term><option>--debug</option></term>
 
206
        <term><literal>--debug</literal></term>
200
207
        <listitem>
201
208
          <xi:include href="mandos-options.xml" xpointer="debug"/>
202
209
        </listitem>
203
210
      </varlistentry>
204
 
      
205
 
      <varlistentry>
206
 
        <term><option>--debuglevel
207
 
        <replaceable>LEVEL</replaceable></option></term>
208
 
        <listitem>
209
 
          <para>
210
 
            Set the debugging log level.
211
 
            <replaceable>LEVEL</replaceable> is a string, one of
212
 
            <quote><literal>CRITICAL</literal></quote>,
213
 
            <quote><literal>ERROR</literal></quote>,
214
 
            <quote><literal>WARNING</literal></quote>,
215
 
            <quote><literal>INFO</literal></quote>, or
216
 
            <quote><literal>DEBUG</literal></quote>, in order of
217
 
            increasing verbosity.  The default level is
218
 
            <quote><literal>WARNING</literal></quote>.
219
 
          </para>
220
 
        </listitem>
221
 
      </varlistentry>
222
 
      
223
 
      <varlistentry>
224
 
        <term><option>--priority <replaceable>
225
 
        PRIORITY</replaceable></option></term>
 
211
 
 
212
      <varlistentry>
 
213
        <term><literal>--priority <replaceable>
 
214
        PRIORITY</replaceable></literal></term>
226
215
        <listitem>
227
216
          <xi:include href="mandos-options.xml" xpointer="priority"/>
228
217
        </listitem>
229
218
      </varlistentry>
230
 
      
 
219
 
231
220
      <varlistentry>
232
 
        <term><option>--servicename
233
 
        <replaceable>NAME</replaceable></option></term>
 
221
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
222
        </literal></term>
234
223
        <listitem>
235
224
          <xi:include href="mandos-options.xml"
236
225
                      xpointer="servicename"/>
237
226
        </listitem>
238
227
      </varlistentry>
239
 
      
 
228
 
240
229
      <varlistentry>
241
 
        <term><option>--configdir
242
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
230
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
231
        </literal></term>
243
232
        <listitem>
244
233
          <para>
245
234
            Directory to search for configuration files.  Default is
251
240
          </para>
252
241
        </listitem>
253
242
      </varlistentry>
254
 
      
 
243
 
255
244
      <varlistentry>
256
 
        <term><option>--version</option></term>
 
245
        <term><literal>--version</literal></term>
257
246
        <listitem>
258
247
          <para>
259
248
            Prints the program version and exit.
260
249
          </para>
261
250
        </listitem>
262
251
      </varlistentry>
263
 
      
264
 
      <varlistentry>
265
 
        <term><option>--no-dbus</option></term>
266
 
        <listitem>
267
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
268
 
          <para>
269
 
            See also <xref linkend="dbus_interface"/>.
270
 
          </para>
271
 
        </listitem>
272
 
      </varlistentry>
273
 
      
274
 
      <varlistentry>
275
 
        <term><option>--no-ipv6</option></term>
276
 
        <listitem>
277
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
278
 
        </listitem>
279
 
      </varlistentry>
280
 
      
281
 
      <varlistentry>
282
 
        <term><option>--no-restore</option></term>
283
 
        <listitem>
284
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
285
 
        </listitem>
286
 
      </varlistentry>
287
252
    </variablelist>
288
253
  </refsect1>
289
 
  
 
254
 
290
255
  <refsect1 id="overview">
291
256
    <title>OVERVIEW</title>
292
257
    <xi:include href="overview.xml"/>
293
258
    <para>
294
259
      This program is the server part.  It is a normal server program
295
260
      and will run in a normal system environment, not in an initial
296
 
      <acronym>RAM</acronym> disk environment.
 
261
      RAM disk environment.
297
262
    </para>
298
263
  </refsect1>
299
 
  
 
264
 
300
265
  <refsect1 id="protocol">
301
266
    <title>NETWORK PROTOCOL</title>
302
267
    <para>
354
319
      </row>
355
320
    </tbody></tgroup></table>
356
321
  </refsect1>
357
 
  
 
322
 
358
323
  <refsect1 id="checking">
359
324
    <title>CHECKING</title>
360
325
    <para>
361
326
      The server will, by default, continually check that the clients
362
327
      are still up.  If a client has not been confirmed as being up
363
328
      for some time, the client is assumed to be compromised and is no
364
 
      longer eligible to receive the encrypted password.  (Manual
365
 
      intervention is required to re-enable a client.)  The timeout,
366
 
      extended timeout, checker program, and interval between checks
367
 
      can be configured both globally and per client; see
368
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
369
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
370
 
      receiving its password will also be treated as a successful
371
 
      checker run.
372
 
    </para>
373
 
  </refsect1>
374
 
  
375
 
  <refsect1 id="approval">
376
 
    <title>APPROVAL</title>
377
 
    <para>
378
 
      The server can be configured to require manual approval for a
379
 
      client before it is sent its secret.  The delay to wait for such
380
 
      approval and the default action (approve or deny) can be
381
 
      configured both globally and per client; see <citerefentry>
 
329
      longer eligible to receive the encrypted password.  The timeout,
 
330
      checker program, and interval between checks can be configured
 
331
      both globally and per client; see <citerefentry>
382
332
      <refentrytitle>mandos-clients.conf</refentrytitle>
383
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
384
 
      will be approved immediately without delay.
385
 
    </para>
386
 
    <para>
387
 
      This can be used to deny a client its secret if not manually
388
 
      approved within a specified time.  It can also be used to make
389
 
      the server delay before giving a client its secret, allowing
390
 
      optional manual denying of this specific client.
391
 
    </para>
392
 
    
 
333
      <manvolnum>5</manvolnum></citerefentry>.
 
334
    </para>
393
335
  </refsect1>
394
 
  
 
336
 
395
337
  <refsect1 id="logging">
396
338
    <title>LOGGING</title>
397
339
    <para>
398
340
      The server will send log message with various severity levels to
399
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
341
      <filename>/dev/log</filename>.  With the
400
342
      <option>--debug</option> option, it will log even more messages,
401
343
      and also show them on the console.
402
344
    </para>
403
345
  </refsect1>
404
 
  
405
 
  <refsect1 id="dbus_interface">
406
 
    <title>D-BUS INTERFACE</title>
407
 
    <para>
408
 
      The server will by default provide a D-Bus system bus interface.
409
 
      This interface will only be accessible by the root user or a
410
 
      Mandos-specific user, if such a user exists.  For documentation
411
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
412
 
    </para>
413
 
  </refsect1>
414
 
  
 
346
 
415
347
  <refsect1 id="exit_status">
416
348
    <title>EXIT STATUS</title>
417
349
    <para>
419
351
      critical error is encountered.
420
352
    </para>
421
353
  </refsect1>
422
 
  
 
354
 
423
355
  <refsect1 id="environment">
424
356
    <title>ENVIRONMENT</title>
425
357
    <variablelist>
439
371
      </varlistentry>
440
372
    </variablelist>
441
373
  </refsect1>
442
 
  
443
 
  <refsect1 id="files">
 
374
 
 
375
  <refsect1 id="file">
444
376
    <title>FILES</title>
445
377
    <para>
446
378
      Use the <option>--configdir</option> option to change where
469
401
        </listitem>
470
402
      </varlistentry>
471
403
      <varlistentry>
472
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
404
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
473
405
        <listitem>
474
406
          <para>
475
 
            The file containing the process id of the
476
 
            <command>&COMMANDNAME;</command> process started last.
 
407
            The file containing the process id of
 
408
            <command>&COMMANDNAME;</command>.
477
409
          </para>
478
410
        </listitem>
479
411
      </varlistentry>
480
412
      <varlistentry>
481
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
413
        <term><filename>/dev/log</filename></term>
482
414
        <listitem>
483
415
          <para>
484
416
            The Unix domain socket to where local syslog messages are
507
439
      backtrace.  This could be considered a feature.
508
440
    </para>
509
441
    <para>
510
 
      Currently, if a client is disabled due to having timed out, the
511
 
      server does not record this fact onto permanent storage.  This
512
 
      has some security implications, see <xref linkend="clients"/>.
 
442
      Currently, if a client is declared <quote>invalid</quote> due to
 
443
      having timed out, the server does not record this fact onto
 
444
      permanent storage.  This has some security implications, see
 
445
      <xref linkend="CLIENTS"/>.
 
446
    </para>
 
447
    <para>
 
448
      There is currently no way of querying the server of the current
 
449
      status of clients, other than analyzing its <systemitem
 
450
      class="service">syslog</systemitem> output.
513
451
    </para>
514
452
    <para>
515
453
      There is no fine-grained control over logging and debug output.
518
456
      Debug mode is conflated with running in the foreground.
519
457
    </para>
520
458
    <para>
521
 
      This server does not check the expire time of clients’ OpenPGP
522
 
      keys.
 
459
      The console log messages does not show a timestamp.
523
460
    </para>
524
461
  </refsect1>
525
462
  
560
497
      </para>
561
498
    </informalexample>
562
499
  </refsect1>
563
 
  
 
500
 
564
501
  <refsect1 id="security">
565
502
    <title>SECURITY</title>
566
 
    <refsect2 id="server">
 
503
    <refsect2 id="SERVER">
567
504
      <title>SERVER</title>
568
505
      <para>
569
506
        Running this <command>&COMMANDNAME;</command> server program
570
507
        should not in itself present any security risk to the host
571
 
        computer running it.  The program switches to a non-root user
572
 
        soon after startup.
 
508
        computer running it.  The program does not need any special
 
509
        privileges to run, and is designed to run as a non-root user.
573
510
      </para>
574
511
    </refsect2>
575
 
    <refsect2 id="clients">
 
512
    <refsect2 id="CLIENTS">
576
513
      <title>CLIENTS</title>
577
514
      <para>
578
515
        The server only gives out its stored data to clients which
585
522
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
586
523
        <manvolnum>5</manvolnum></citerefentry>)
587
524
        <emphasis>must</emphasis> be made non-readable by anyone
588
 
        except the user starting the server (usually root).
 
525
        except the user running the server.
589
526
      </para>
590
527
      <para>
591
528
        As detailed in <xref linkend="checking"/>, the status of all
594
531
      </para>
595
532
      <para>
596
533
        If a client is compromised, its downtime should be duly noted
597
 
        by the server which would therefore disable the client.  But
598
 
        if the server was ever restarted, it would re-read its client
599
 
        list from its configuration file and again regard all clients
600
 
        therein as enabled, and hence eligible to receive their
601
 
        passwords.  Therefore, be careful when restarting servers if
602
 
        it is suspected that a client has, in fact, been compromised
603
 
        by parties who may now be running a fake Mandos client with
604
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
605
 
        image of the client host.  What should be done in that case
606
 
        (if restarting the server program really is necessary) is to
607
 
        stop the server program, edit the configuration file to omit
608
 
        any suspect clients, and restart the server program.
 
534
        by the server which would therefore declare the client
 
535
        invalid.  But if the server was ever restarted, it would
 
536
        re-read its client list from its configuration file and again
 
537
        regard all clients therein as valid, and hence eligible to
 
538
        receive their passwords.  Therefore, be careful when
 
539
        restarting servers if it is suspected that a client has, in
 
540
        fact, been compromised by parties who may now be running a
 
541
        fake Mandos client with the keys from the non-encrypted
 
542
        initial RAM image of the client host.  What should be done in
 
543
        that case (if restarting the server program really is
 
544
        necessary) is to stop the server program, edit the
 
545
        configuration file to omit any suspect clients, and restart
 
546
        the server program.
609
547
      </para>
610
548
      <para>
611
549
        For more details on client-side security, see
612
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
550
        <citerefentry><refentrytitle>password-request</refentrytitle>
613
551
        <manvolnum>8mandos</manvolnum></citerefentry>.
614
552
      </para>
615
553
    </refsect2>
616
554
  </refsect1>
617
 
  
 
555
 
618
556
  <refsect1 id="see_also">
619
557
    <title>SEE ALSO</title>
620
558
    <para>
621
 
      <citerefentry><refentrytitle>intro</refentrytitle>
622
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
623
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
624
 
      <manvolnum>5</manvolnum></citerefentry>,
625
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
626
 
      <manvolnum>5</manvolnum></citerefentry>,
627
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
628
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>sh</refentrytitle>
630
 
      <manvolnum>1</manvolnum></citerefentry>
 
559
      <citerefentry>
 
560
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
561
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
562
        <refentrytitle>mandos.conf</refentrytitle>
 
563
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
564
        <refentrytitle>password-request</refentrytitle>
 
565
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
566
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
567
      </citerefentry>
631
568
    </para>
632
569
    <variablelist>
633
570
      <varlistentry>