/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 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-11-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>
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
 
      <sbr/>
100
 
      <arg><option>--statedir
101
 
      <replaceable>DIRECTORY</replaceable></option></arg>
102
108
    </cmdsynopsis>
103
109
    <cmdsynopsis>
104
110
      <command>&COMMANDNAME;</command>
105
111
      <group choice="req">
 
112
        <arg choice="plain"><option>-h</option></arg>
106
113
        <arg choice="plain"><option>--help</option></arg>
107
 
        <arg choice="plain"><option>-h</option></arg>
108
114
      </group>
109
115
    </cmdsynopsis>
110
116
    <cmdsynopsis>
116
122
      <arg choice="plain"><option>--check</option></arg>
117
123
    </cmdsynopsis>
118
124
  </refsynopsisdiv>
119
 
  
 
125
 
120
126
  <refsect1 id="description">
121
127
    <title>DESCRIPTION</title>
122
128
    <para>
123
129
      <command>&COMMANDNAME;</command> is a server daemon which
124
130
      handles incoming request for passwords for a pre-defined list of
125
 
      client host computers. For an introduction, see
126
 
      <citerefentry><refentrytitle>intro</refentrytitle>
127
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
128
 
      uses Zeroconf to announce itself on the local network, and uses
129
 
      TLS to communicate securely with and to authenticate the
130
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
131
 
      use IPv6 link-local addresses, since the clients will probably
132
 
      not have any other addresses configured (see <xref
133
 
      linkend="overview"/>).  Any authenticated client is then given
134
 
      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.
135
139
    </para>
 
140
 
136
141
  </refsect1>
137
142
  
138
143
  <refsect1 id="purpose">
139
144
    <title>PURPOSE</title>
 
145
 
140
146
    <para>
141
147
      The purpose of this is to enable <emphasis>remote and unattended
142
148
      rebooting</emphasis> of client host computer with an
143
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
144
150
      linkend="overview"/> for details.
145
151
    </para>
 
152
 
146
153
  </refsect1>
147
154
  
148
155
  <refsect1 id="options">
149
156
    <title>OPTIONS</title>
 
157
 
150
158
    <variablelist>
151
159
      <varlistentry>
 
160
        <term><option>-h</option></term>
152
161
        <term><option>--help</option></term>
153
 
        <term><option>-h</option></term>
154
162
        <listitem>
155
163
          <para>
156
164
            Show a help message and exit
157
165
          </para>
158
166
        </listitem>
159
167
      </varlistentry>
160
 
      
 
168
 
161
169
      <varlistentry>
 
170
        <term><option>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
162
172
        <term><option>--interface</option>
163
173
        <replaceable>NAME</replaceable></term>
164
 
        <term><option>-i</option>
165
 
        <replaceable>NAME</replaceable></term>
166
174
        <listitem>
167
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
168
176
        </listitem>
169
177
      </varlistentry>
170
 
      
 
178
 
171
179
      <varlistentry>
172
 
        <term><option>--address
173
 
        <replaceable>ADDRESS</replaceable></option></term>
174
 
        <term><option>-a
175
 
        <replaceable>ADDRESS</replaceable></option></term>
 
180
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
181
        ADDRESS</replaceable></literal></term>
176
182
        <listitem>
177
183
          <xi:include href="mandos-options.xml" xpointer="address"/>
178
184
        </listitem>
179
185
      </varlistentry>
180
 
      
 
186
 
181
187
      <varlistentry>
182
 
        <term><option>--port
183
 
        <replaceable>PORT</replaceable></option></term>
184
 
        <term><option>-p
185
 
        <replaceable>PORT</replaceable></option></term>
 
188
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
189
        PORT</replaceable></literal></term>
186
190
        <listitem>
187
191
          <xi:include href="mandos-options.xml" xpointer="port"/>
188
192
        </listitem>
189
193
      </varlistentry>
190
 
      
 
194
 
191
195
      <varlistentry>
192
 
        <term><option>--check</option></term>
 
196
        <term><literal>--check</literal></term>
193
197
        <listitem>
194
198
          <para>
195
199
            Run the server’s self-tests.  This includes any unit
197
201
          </para>
198
202
        </listitem>
199
203
      </varlistentry>
200
 
      
 
204
 
201
205
      <varlistentry>
202
 
        <term><option>--debug</option></term>
 
206
        <term><literal>--debug</literal></term>
203
207
        <listitem>
204
208
          <xi:include href="mandos-options.xml" xpointer="debug"/>
205
209
        </listitem>
206
210
      </varlistentry>
207
 
      
208
 
      <varlistentry>
209
 
        <term><option>--debuglevel
210
 
        <replaceable>LEVEL</replaceable></option></term>
211
 
        <listitem>
212
 
          <para>
213
 
            Set the debugging log level.
214
 
            <replaceable>LEVEL</replaceable> is a string, one of
215
 
            <quote><literal>CRITICAL</literal></quote>,
216
 
            <quote><literal>ERROR</literal></quote>,
217
 
            <quote><literal>WARNING</literal></quote>,
218
 
            <quote><literal>INFO</literal></quote>, or
219
 
            <quote><literal>DEBUG</literal></quote>, in order of
220
 
            increasing verbosity.  The default level is
221
 
            <quote><literal>WARNING</literal></quote>.
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
      
226
 
      <varlistentry>
227
 
        <term><option>--priority <replaceable>
228
 
        PRIORITY</replaceable></option></term>
 
211
 
 
212
      <varlistentry>
 
213
        <term><literal>--priority <replaceable>
 
214
        PRIORITY</replaceable></literal></term>
229
215
        <listitem>
230
216
          <xi:include href="mandos-options.xml" xpointer="priority"/>
231
217
        </listitem>
232
218
      </varlistentry>
233
 
      
 
219
 
234
220
      <varlistentry>
235
 
        <term><option>--servicename
236
 
        <replaceable>NAME</replaceable></option></term>
 
221
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
222
        </literal></term>
237
223
        <listitem>
238
224
          <xi:include href="mandos-options.xml"
239
225
                      xpointer="servicename"/>
240
226
        </listitem>
241
227
      </varlistentry>
242
 
      
 
228
 
243
229
      <varlistentry>
244
 
        <term><option>--configdir
245
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
230
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
231
        </literal></term>
246
232
        <listitem>
247
233
          <para>
248
234
            Directory to search for configuration files.  Default is
254
240
          </para>
255
241
        </listitem>
256
242
      </varlistentry>
257
 
      
 
243
 
258
244
      <varlistentry>
259
 
        <term><option>--version</option></term>
 
245
        <term><literal>--version</literal></term>
260
246
        <listitem>
261
247
          <para>
262
248
            Prints the program version and exit.
263
249
          </para>
264
250
        </listitem>
265
251
      </varlistentry>
266
 
      
267
 
      <varlistentry>
268
 
        <term><option>--no-dbus</option></term>
269
 
        <listitem>
270
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
271
 
          <para>
272
 
            See also <xref linkend="dbus_interface"/>.
273
 
          </para>
274
 
        </listitem>
275
 
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--no-ipv6</option></term>
279
 
        <listitem>
280
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
281
 
        </listitem>
282
 
      </varlistentry>
283
 
      
284
 
      <varlistentry>
285
 
        <term><option>--no-restore</option></term>
286
 
        <listitem>
287
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
288
 
        </listitem>
289
 
      </varlistentry>
290
 
      
291
 
      <varlistentry>
292
 
        <term><option>--statedir
293
 
        <replaceable>DIRECTORY</replaceable></option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
 
        </listitem>
297
 
      </varlistentry>
298
252
    </variablelist>
299
253
  </refsect1>
300
 
  
 
254
 
301
255
  <refsect1 id="overview">
302
256
    <title>OVERVIEW</title>
303
257
    <xi:include href="overview.xml"/>
304
258
    <para>
305
259
      This program is the server part.  It is a normal server program
306
260
      and will run in a normal system environment, not in an initial
307
 
      <acronym>RAM</acronym> disk environment.
 
261
      RAM disk environment.
308
262
    </para>
309
263
  </refsect1>
310
 
  
 
264
 
311
265
  <refsect1 id="protocol">
312
266
    <title>NETWORK PROTOCOL</title>
313
267
    <para>
365
319
      </row>
366
320
    </tbody></tgroup></table>
367
321
  </refsect1>
368
 
  
 
322
 
369
323
  <refsect1 id="checking">
370
324
    <title>CHECKING</title>
371
325
    <para>
372
326
      The server will, by default, continually check that the clients
373
327
      are still up.  If a client has not been confirmed as being up
374
328
      for some time, the client is assumed to be compromised and is no
375
 
      longer eligible to receive the encrypted password.  (Manual
376
 
      intervention is required to re-enable a client.)  The timeout,
377
 
      extended timeout, checker program, and interval between checks
378
 
      can be configured both globally and per client; see
379
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
383
 
    </para>
384
 
  </refsect1>
385
 
  
386
 
  <refsect1 id="approval">
387
 
    <title>APPROVAL</title>
388
 
    <para>
389
 
      The server can be configured to require manual approval for a
390
 
      client before it is sent its secret.  The delay to wait for such
391
 
      approval and the default action (approve or deny) can be
392
 
      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>
393
332
      <refentrytitle>mandos-clients.conf</refentrytitle>
394
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
395
 
      will be approved immediately without delay.
396
 
    </para>
397
 
    <para>
398
 
      This can be used to deny a client its secret if not manually
399
 
      approved within a specified time.  It can also be used to make
400
 
      the server delay before giving a client its secret, allowing
401
 
      optional manual denying of this specific client.
402
 
    </para>
403
 
    
 
333
      <manvolnum>5</manvolnum></citerefentry>.
 
334
    </para>
404
335
  </refsect1>
405
 
  
 
336
 
406
337
  <refsect1 id="logging">
407
338
    <title>LOGGING</title>
408
339
    <para>
409
340
      The server will send log message with various severity levels to
410
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
341
      <filename>/dev/log</filename>.  With the
411
342
      <option>--debug</option> option, it will log even more messages,
412
343
      and also show them on the console.
413
344
    </para>
414
345
  </refsect1>
415
 
  
416
 
  <refsect1 id="dbus_interface">
417
 
    <title>D-BUS INTERFACE</title>
418
 
    <para>
419
 
      The server will by default provide a D-Bus system bus interface.
420
 
      This interface will only be accessible by the root user or a
421
 
      Mandos-specific user, if such a user exists.  For documentation
422
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
423
 
    </para>
424
 
  </refsect1>
425
 
  
 
346
 
426
347
  <refsect1 id="exit_status">
427
348
    <title>EXIT STATUS</title>
428
349
    <para>
430
351
      critical error is encountered.
431
352
    </para>
432
353
  </refsect1>
433
 
  
 
354
 
434
355
  <refsect1 id="environment">
435
356
    <title>ENVIRONMENT</title>
436
357
    <variablelist>
450
371
      </varlistentry>
451
372
    </variablelist>
452
373
  </refsect1>
453
 
  
454
 
  <refsect1 id="files">
 
374
 
 
375
  <refsect1 id="file">
455
376
    <title>FILES</title>
456
377
    <para>
457
378
      Use the <option>--configdir</option> option to change where
480
401
        </listitem>
481
402
      </varlistentry>
482
403
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
484
 
        <listitem>
485
 
          <para>
486
 
            The file containing the process id of the
487
 
            <command>&COMMANDNAME;</command> process started last.
488
 
          </para>
489
 
        </listitem>
490
 
      </varlistentry>
491
 
      <varlistentry>
492
 
        <term><filename class="devicefile">/dev/log</filename></term>
493
 
      </varlistentry>
494
 
      <varlistentry>
495
 
        <term><filename
496
 
        class="directory">/var/lib/mandos</filename></term>
497
 
        <listitem>
498
 
          <para>
499
 
            Directory where persistent state will be saved.  Change
500
 
            this with the <option>--statedir</option> option.  See
501
 
            also the <option>--no-restore</option> option.
 
404
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
405
        <listitem>
 
406
          <para>
 
407
            The file containing the process id of
 
408
            <command>&COMMANDNAME;</command>.
502
409
          </para>
503
410
        </listitem>
504
411
      </varlistentry>
532
439
      backtrace.  This could be considered a feature.
533
440
    </para>
534
441
    <para>
 
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.
 
451
    </para>
 
452
    <para>
535
453
      There is no fine-grained control over logging and debug output.
536
454
    </para>
537
455
    <para>
538
456
      Debug mode is conflated with running in the foreground.
539
457
    </para>
540
458
    <para>
541
 
      This server does not check the expire time of clients’ OpenPGP
542
 
      keys.
 
459
      The console log messages does not show a timestamp.
543
460
    </para>
544
461
  </refsect1>
545
462
  
556
473
    <informalexample>
557
474
      <para>
558
475
        Run the server in debug mode, read configuration files from
559
 
        the <filename class="directory">~/mandos</filename> directory,
560
 
        and use the Zeroconf service name <quote>Test</quote> to not
561
 
        collide with any other official Mandos server on this host:
 
476
        the <filename>~/mandos</filename> directory, and use the
 
477
        Zeroconf service name <quote>Test</quote> to not collide with
 
478
        any other official Mandos server on this host:
562
479
      </para>
563
480
      <para>
564
481
 
580
497
      </para>
581
498
    </informalexample>
582
499
  </refsect1>
583
 
  
 
500
 
584
501
  <refsect1 id="security">
585
502
    <title>SECURITY</title>
586
 
    <refsect2 id="server">
 
503
    <refsect2 id="SERVER">
587
504
      <title>SERVER</title>
588
505
      <para>
589
506
        Running this <command>&COMMANDNAME;</command> server program
590
507
        should not in itself present any security risk to the host
591
 
        computer running it.  The program switches to a non-root user
592
 
        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.
593
510
      </para>
594
511
    </refsect2>
595
 
    <refsect2 id="clients">
 
512
    <refsect2 id="CLIENTS">
596
513
      <title>CLIENTS</title>
597
514
      <para>
598
515
        The server only gives out its stored data to clients which
605
522
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
606
523
        <manvolnum>5</manvolnum></citerefentry>)
607
524
        <emphasis>must</emphasis> be made non-readable by anyone
608
 
        except the user starting the server (usually root).
 
525
        except the user running the server.
609
526
      </para>
610
527
      <para>
611
528
        As detailed in <xref linkend="checking"/>, the status of all
613
530
        compromised if they are gone for too long.
614
531
      </para>
615
532
      <para>
 
533
        If a client is compromised, its downtime should be duly noted
 
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.
 
547
      </para>
 
548
      <para>
616
549
        For more details on client-side security, see
617
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
550
        <citerefentry><refentrytitle>password-request</refentrytitle>
618
551
        <manvolnum>8mandos</manvolnum></citerefentry>.
619
552
      </para>
620
553
    </refsect2>
621
554
  </refsect1>
622
 
  
 
555
 
623
556
  <refsect1 id="see_also">
624
557
    <title>SEE ALSO</title>
625
558
    <para>
626
 
      <citerefentry><refentrytitle>intro</refentrytitle>
627
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
628
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
629
 
      <manvolnum>5</manvolnum></citerefentry>,
630
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
631
 
      <manvolnum>5</manvolnum></citerefentry>,
632
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
633
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
634
 
      <citerefentry><refentrytitle>sh</refentrytitle>
635
 
      <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>
636
568
    </para>
637
569
    <variablelist>
638
570
      <varlistentry>