/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-31 12:23:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831122333-qgppahxb4d4b0coc
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
                                            the ones in the SYNOPSIS.
                                            Split <term> tags into one
                                            for each option.  Use
                                            <option> tags instead of
                                            <literal>.  Moved long
                                            options before short.

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-31">
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>
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>
149
160
        <term><option>--help</option></term>
201
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
202
213
        </listitem>
203
214
      </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
 
      
 
215
 
223
216
      <varlistentry>
224
217
        <term><option>--priority <replaceable>
225
218
        PRIORITY</replaceable></option></term>
227
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
228
221
        </listitem>
229
222
      </varlistentry>
230
 
      
 
223
 
231
224
      <varlistentry>
232
225
        <term><option>--servicename
233
226
        <replaceable>NAME</replaceable></option></term>
236
229
                      xpointer="servicename"/>
237
230
        </listitem>
238
231
      </varlistentry>
239
 
      
 
232
 
240
233
      <varlistentry>
241
234
        <term><option>--configdir
242
235
        <replaceable>DIRECTORY</replaceable></option></term>
251
244
          </para>
252
245
        </listitem>
253
246
      </varlistentry>
254
 
      
 
247
 
255
248
      <varlistentry>
256
249
        <term><option>--version</option></term>
257
250
        <listitem>
260
253
          </para>
261
254
        </listitem>
262
255
      </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
256
    </variablelist>
288
257
  </refsect1>
289
 
  
 
258
 
290
259
  <refsect1 id="overview">
291
260
    <title>OVERVIEW</title>
292
261
    <xi:include href="overview.xml"/>
293
262
    <para>
294
263
      This program is the server part.  It is a normal server program
295
264
      and will run in a normal system environment, not in an initial
296
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
297
266
    </para>
298
267
  </refsect1>
299
 
  
 
268
 
300
269
  <refsect1 id="protocol">
301
270
    <title>NETWORK PROTOCOL</title>
302
271
    <para>
354
323
      </row>
355
324
    </tbody></tgroup></table>
356
325
  </refsect1>
357
 
  
 
326
 
358
327
  <refsect1 id="checking">
359
328
    <title>CHECKING</title>
360
329
    <para>
361
330
      The server will, by default, continually check that the clients
362
331
      are still up.  If a client has not been confirmed as being up
363
332
      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>
 
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>
382
336
      <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
 
    
 
337
      <manvolnum>5</manvolnum></citerefentry>.
 
338
    </para>
393
339
  </refsect1>
394
 
  
 
340
 
395
341
  <refsect1 id="logging">
396
342
    <title>LOGGING</title>
397
343
    <para>
401
347
      and also show them on the console.
402
348
    </para>
403
349
  </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
 
  
 
350
 
415
351
  <refsect1 id="exit_status">
416
352
    <title>EXIT STATUS</title>
417
353
    <para>
419
355
      critical error is encountered.
420
356
    </para>
421
357
  </refsect1>
422
 
  
 
358
 
423
359
  <refsect1 id="environment">
424
360
    <title>ENVIRONMENT</title>
425
361
    <variablelist>
439
375
      </varlistentry>
440
376
    </variablelist>
441
377
  </refsect1>
442
 
  
443
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
444
380
    <title>FILES</title>
445
381
    <para>
446
382
      Use the <option>--configdir</option> option to change where
469
405
        </listitem>
470
406
      </varlistentry>
471
407
      <varlistentry>
472
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
408
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
473
409
        <listitem>
474
410
          <para>
475
 
            The file containing the process id of the
476
 
            <command>&COMMANDNAME;</command> process started last.
 
411
            The file containing the process id of
 
412
            <command>&COMMANDNAME;</command>.
477
413
          </para>
478
414
        </listitem>
479
415
      </varlistentry>
507
443
      backtrace.  This could be considered a feature.
508
444
    </para>
509
445
    <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"/>.
 
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.
513
455
    </para>
514
456
    <para>
515
457
      There is no fine-grained control over logging and debug output.
518
460
      Debug mode is conflated with running in the foreground.
519
461
    </para>
520
462
    <para>
521
 
      This server does not check the expire time of clients’ OpenPGP
522
 
      keys.
 
463
      The console log messages does not show a timestamp.
523
464
    </para>
524
465
  </refsect1>
525
466
  
560
501
      </para>
561
502
    </informalexample>
562
503
  </refsect1>
563
 
  
 
504
 
564
505
  <refsect1 id="security">
565
506
    <title>SECURITY</title>
566
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
567
508
      <title>SERVER</title>
568
509
      <para>
569
510
        Running this <command>&COMMANDNAME;</command> server program
570
511
        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.
 
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.
573
514
      </para>
574
515
    </refsect2>
575
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
576
517
      <title>CLIENTS</title>
577
518
      <para>
578
519
        The server only gives out its stored data to clients which
585
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
586
527
        <manvolnum>5</manvolnum></citerefentry>)
587
528
        <emphasis>must</emphasis> be made non-readable by anyone
588
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
589
530
      </para>
590
531
      <para>
591
532
        As detailed in <xref linkend="checking"/>, the status of all
594
535
      </para>
595
536
      <para>
596
537
        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.
 
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.
609
551
      </para>
610
552
      <para>
611
553
        For more details on client-side security, see
612
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
613
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
614
556
      </para>
615
557
    </refsect2>
616
558
  </refsect1>
617
 
  
 
559
 
618
560
  <refsect1 id="see_also">
619
561
    <title>SEE ALSO</title>
620
562
    <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>
 
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>
631
572
    </para>
632
573
    <variablelist>
633
574
      <varlistentry>