/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

Updated year in copyright notices.

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