/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 at bsnet
  • Date: 2011-11-12 18:14:55 UTC
  • mto: This revision was merged to the branch mainline in revision 522.
  • Revision ID: teddy@fukt.bsnet.se-20111112181455-8m6z4qrrib33bl2c
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
                                                 "--network-hook-dir"
                                                 option.

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-31">
 
5
<!ENTITY TIMESTAMP "2011-10-22">
 
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>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </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>
 
41
    <xi:include href="legalnotice.xml"/>
60
42
  </refentryinfo>
61
 
 
 
43
  
62
44
  <refmeta>
63
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
    <manvolnum>8</manvolnum>
70
52
      Gives encrypted passwords to authenticated Mandos clients
71
53
    </refpurpose>
72
54
  </refnamediv>
73
 
 
 
55
  
74
56
  <refsynopsisdiv>
75
57
    <cmdsynopsis>
76
58
      <command>&COMMANDNAME;</command>
105
87
      <replaceable>DIRECTORY</replaceable></option></arg>
106
88
      <sbr/>
107
89
      <arg><option>--debug</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--debuglevel
 
92
      <replaceable>LEVEL</replaceable></option></arg>
 
93
      <sbr/>
 
94
      <arg><option>--no-dbus</option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-ipv6</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-restore</option></arg>
108
99
    </cmdsynopsis>
109
100
    <cmdsynopsis>
110
101
      <command>&COMMANDNAME;</command>
122
113
      <arg choice="plain"><option>--check</option></arg>
123
114
    </cmdsynopsis>
124
115
  </refsynopsisdiv>
125
 
 
 
116
  
126
117
  <refsect1 id="description">
127
118
    <title>DESCRIPTION</title>
128
119
    <para>
129
120
      <command>&COMMANDNAME;</command> is a server daemon which
130
121
      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.
 
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.
139
132
    </para>
140
 
 
141
133
  </refsect1>
142
134
  
143
135
  <refsect1 id="purpose">
144
136
    <title>PURPOSE</title>
145
 
 
146
137
    <para>
147
138
      The purpose of this is to enable <emphasis>remote and unattended
148
139
      rebooting</emphasis> of client host computer with an
149
140
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
141
      linkend="overview"/> for details.
151
142
    </para>
152
 
    
153
143
  </refsect1>
154
144
  
155
145
  <refsect1 id="options">
156
146
    <title>OPTIONS</title>
157
 
    
158
147
    <variablelist>
159
148
      <varlistentry>
160
149
        <term><option>--help</option></term>
212
201
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
202
        </listitem>
214
203
      </varlistentry>
215
 
 
 
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
      
216
223
      <varlistentry>
217
224
        <term><option>--priority <replaceable>
218
225
        PRIORITY</replaceable></option></term>
220
227
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
228
        </listitem>
222
229
      </varlistentry>
223
 
 
 
230
      
224
231
      <varlistentry>
225
232
        <term><option>--servicename
226
233
        <replaceable>NAME</replaceable></option></term>
229
236
                      xpointer="servicename"/>
230
237
        </listitem>
231
238
      </varlistentry>
232
 
 
 
239
      
233
240
      <varlistentry>
234
241
        <term><option>--configdir
235
242
        <replaceable>DIRECTORY</replaceable></option></term>
244
251
          </para>
245
252
        </listitem>
246
253
      </varlistentry>
247
 
 
 
254
      
248
255
      <varlistentry>
249
256
        <term><option>--version</option></term>
250
257
        <listitem>
253
260
          </para>
254
261
        </listitem>
255
262
      </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>
256
287
    </variablelist>
257
288
  </refsect1>
258
 
 
 
289
  
259
290
  <refsect1 id="overview">
260
291
    <title>OVERVIEW</title>
261
292
    <xi:include href="overview.xml"/>
262
293
    <para>
263
294
      This program is the server part.  It is a normal server program
264
295
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
296
      <acronym>RAM</acronym> disk environment.
266
297
    </para>
267
298
  </refsect1>
268
 
 
 
299
  
269
300
  <refsect1 id="protocol">
270
301
    <title>NETWORK PROTOCOL</title>
271
302
    <para>
323
354
      </row>
324
355
    </tbody></tgroup></table>
325
356
  </refsect1>
326
 
 
 
357
  
327
358
  <refsect1 id="checking">
328
359
    <title>CHECKING</title>
329
360
    <para>
330
361
      The server will, by default, continually check that the clients
331
362
      are still up.  If a client has not been confirmed as being up
332
363
      for some time, the client is assumed to be compromised and is no
333
 
      longer eligible to receive the encrypted password.  The timeout,
334
 
      checker program, and interval between checks can be configured
335
 
      both globally and per client; see <citerefentry>
 
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>
336
382
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
 
      <manvolnum>5</manvolnum></citerefentry>.
338
 
    </para>
 
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
    
339
393
  </refsect1>
340
 
 
 
394
  
341
395
  <refsect1 id="logging">
342
396
    <title>LOGGING</title>
343
397
    <para>
344
398
      The server will send log message with various severity levels to
345
 
      <filename>/dev/log</filename>.  With the
 
399
      <filename class="devicefile">/dev/log</filename>.  With the
346
400
      <option>--debug</option> option, it will log even more messages,
347
401
      and also show them on the console.
348
402
    </para>
349
403
  </refsect1>
350
 
 
 
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
  
351
415
  <refsect1 id="exit_status">
352
416
    <title>EXIT STATUS</title>
353
417
    <para>
355
419
      critical error is encountered.
356
420
    </para>
357
421
  </refsect1>
358
 
 
 
422
  
359
423
  <refsect1 id="environment">
360
424
    <title>ENVIRONMENT</title>
361
425
    <variablelist>
375
439
      </varlistentry>
376
440
    </variablelist>
377
441
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
442
  
 
443
  <refsect1 id="files">
380
444
    <title>FILES</title>
381
445
    <para>
382
446
      Use the <option>--configdir</option> option to change where
405
469
        </listitem>
406
470
      </varlistentry>
407
471
      <varlistentry>
408
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
472
        <term><filename>/var/run/mandos.pid</filename></term>
409
473
        <listitem>
410
474
          <para>
411
 
            The file containing the process id of
412
 
            <command>&COMMANDNAME;</command>.
 
475
            The file containing the process id of the
 
476
            <command>&COMMANDNAME;</command> process started last.
413
477
          </para>
414
478
        </listitem>
415
479
      </varlistentry>
416
480
      <varlistentry>
417
 
        <term><filename>/dev/log</filename></term>
 
481
        <term><filename class="devicefile">/dev/log</filename></term>
418
482
        <listitem>
419
483
          <para>
420
484
            The Unix domain socket to where local syslog messages are
443
507
      backtrace.  This could be considered a feature.
444
508
    </para>
445
509
    <para>
446
 
      Currently, if a client is declared <quote>invalid</quote> due to
447
 
      having timed out, the server does not record this fact onto
448
 
      permanent storage.  This has some security implications, see
449
 
      <xref linkend="CLIENTS"/>.
450
 
    </para>
451
 
    <para>
452
 
      There is currently no way of querying the server of the current
453
 
      status of clients, other than analyzing its <systemitem
454
 
      class="service">syslog</systemitem> output.
 
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"/>.
455
513
    </para>
456
514
    <para>
457
515
      There is no fine-grained control over logging and debug output.
460
518
      Debug mode is conflated with running in the foreground.
461
519
    </para>
462
520
    <para>
463
 
      The console log messages does not show a timestamp.
 
521
      This server does not check the expire time of clients’ OpenPGP
 
522
      keys.
464
523
    </para>
465
524
  </refsect1>
466
525
  
501
560
      </para>
502
561
    </informalexample>
503
562
  </refsect1>
504
 
 
 
563
  
505
564
  <refsect1 id="security">
506
565
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
566
    <refsect2 id="server">
508
567
      <title>SERVER</title>
509
568
      <para>
510
569
        Running this <command>&COMMANDNAME;</command> server program
511
570
        should not in itself present any security risk to the host
512
 
        computer running it.  The program does not need any special
513
 
        privileges to run, and is designed to run as a non-root user.
 
571
        computer running it.  The program switches to a non-root user
 
572
        soon after startup.
514
573
      </para>
515
574
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
575
    <refsect2 id="clients">
517
576
      <title>CLIENTS</title>
518
577
      <para>
519
578
        The server only gives out its stored data to clients which
526
585
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
586
        <manvolnum>5</manvolnum></citerefentry>)
528
587
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
588
        except the user starting the server (usually root).
530
589
      </para>
531
590
      <para>
532
591
        As detailed in <xref linkend="checking"/>, the status of all
535
594
      </para>
536
595
      <para>
537
596
        If a client is compromised, its downtime should be duly noted
538
 
        by the server which would therefore declare the client
539
 
        invalid.  But if the server was ever restarted, it would
540
 
        re-read its client list from its configuration file and again
541
 
        regard all clients therein as valid, and hence eligible to
542
 
        receive their passwords.  Therefore, be careful when
543
 
        restarting servers if it is suspected that a client has, in
544
 
        fact, been compromised by parties who may now be running a
545
 
        fake Mandos client with the keys from the non-encrypted
546
 
        initial RAM image of the client host.  What should be done in
547
 
        that case (if restarting the server program really is
548
 
        necessary) is to stop the server program, edit the
549
 
        configuration file to omit any suspect clients, and restart
550
 
        the server program.
 
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.
551
609
      </para>
552
610
      <para>
553
611
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
612
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
613
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
614
      </para>
557
615
    </refsect2>
558
616
  </refsect1>
559
 
 
 
617
  
560
618
  <refsect1 id="see_also">
561
619
    <title>SEE ALSO</title>
562
620
    <para>
563
 
      <citerefentry>
564
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
565
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>mandos.conf</refentrytitle>
567
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>password-request</refentrytitle>
569
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
 
      </citerefentry>
 
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>
572
631
    </para>
573
632
    <variablelist>
574
633
      <varlistentry>