/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 at recompile
  • Date: 2012-02-26 11:47:19 UTC
  • mto: (237.7.109 trunk)
  • mto: This revision was merged to the branch mainline in revision 300.
  • Revision ID: teddy@recompile.se-20120226114719-m3odq4s34ebt6hg8
Add facilities for D-Bus interface annotations and use them to mark
the old D-Bus interfaces as deprecated.

* mandos (dbus_interface_annotations): New decorator.
  (DBusObjectWithProperties._is_dbus_property): Removed.  All callers
                                                changed.
  (DBusObjectWithProperties._is_dbus_thing): New; generalized version
                                             of "_is_dbus_property".
  (DBusObjectWithProperties._get_all_dbus_properties): Removed.  All
                                                       callers
                                                       changed.
  (DBusObjectWithProperties._get_all_dbus_things): New; generalized
                                                   version of
                                                   "_get_all_dbus_properties".
  (DBusObjectWithProperties.Introspect): Also add interface
                                         annotation tags.
  (AlternateDBusNamesMetaclass.__new__): Also copy interface
                                         annotations.  Add
                                         "deprecated" annotation on
                                         old interface.
  (ClientDBus._foo): New interface annotation to mark non-compliance
                     with the standard property change signal
                     interface.
  (MandosDBusService): Inherit from DBusObjectWithProperties to get
                       interface annotation support.
  (MandosDBusService._foo): New interface annotation to mark
                            non-compliance with the standard property
                            change signal interface.

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 "2012-01-15">
 
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>
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>
160
153
        <term><option>--help</option></term>
212
205
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
206
        </listitem>
214
207
      </varlistentry>
215
 
 
 
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
      
216
227
      <varlistentry>
217
228
        <term><option>--priority <replaceable>
218
229
        PRIORITY</replaceable></option></term>
220
231
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
232
        </listitem>
222
233
      </varlistentry>
223
 
 
 
234
      
224
235
      <varlistentry>
225
236
        <term><option>--servicename
226
237
        <replaceable>NAME</replaceable></option></term>
229
240
                      xpointer="servicename"/>
230
241
        </listitem>
231
242
      </varlistentry>
232
 
 
 
243
      
233
244
      <varlistentry>
234
245
        <term><option>--configdir
235
246
        <replaceable>DIRECTORY</replaceable></option></term>
244
255
          </para>
245
256
        </listitem>
246
257
      </varlistentry>
247
 
 
 
258
      
248
259
      <varlistentry>
249
260
        <term><option>--version</option></term>
250
261
        <listitem>
253
264
          </para>
254
265
        </listitem>
255
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
          <para>
 
290
            See also <xref linkend="persistent_state"/>.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--statedir
 
297
        <replaceable>DIRECTORY</replaceable></option></term>
 
298
        <listitem>
 
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
300
        </listitem>
 
301
      </varlistentry>
256
302
    </variablelist>
257
303
  </refsect1>
258
 
 
 
304
  
259
305
  <refsect1 id="overview">
260
306
    <title>OVERVIEW</title>
261
307
    <xi:include href="overview.xml"/>
262
308
    <para>
263
309
      This program is the server part.  It is a normal server program
264
310
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
311
      <acronym>RAM</acronym> disk environment.
266
312
    </para>
267
313
  </refsect1>
268
 
 
 
314
  
269
315
  <refsect1 id="protocol">
270
316
    <title>NETWORK PROTOCOL</title>
271
317
    <para>
323
369
      </row>
324
370
    </tbody></tgroup></table>
325
371
  </refsect1>
326
 
 
 
372
  
327
373
  <refsect1 id="checking">
328
374
    <title>CHECKING</title>
329
375
    <para>
330
376
      The server will, by default, continually check that the clients
331
377
      are still up.  If a client has not been confirmed as being up
332
378
      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>
 
379
      longer eligible to receive the encrypted password.  (Manual
 
380
      intervention is required to re-enable a client.)  The timeout,
 
381
      extended timeout, checker program, and interval between checks
 
382
      can be configured both globally and per client; see
 
383
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
384
      <manvolnum>5</manvolnum></citerefentry>.
 
385
    </para>
 
386
  </refsect1>
 
387
  
 
388
  <refsect1 id="approval">
 
389
    <title>APPROVAL</title>
 
390
    <para>
 
391
      The server can be configured to require manual approval for a
 
392
      client before it is sent its secret.  The delay to wait for such
 
393
      approval and the default action (approve or deny) can be
 
394
      configured both globally and per client; see <citerefentry>
336
395
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
 
      <manvolnum>5</manvolnum></citerefentry>.
338
 
    </para>
 
396
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
397
      will be approved immediately without delay.
 
398
    </para>
 
399
    <para>
 
400
      This can be used to deny a client its secret if not manually
 
401
      approved within a specified time.  It can also be used to make
 
402
      the server delay before giving a client its secret, allowing
 
403
      optional manual denying of this specific client.
 
404
    </para>
 
405
    
339
406
  </refsect1>
340
 
 
 
407
  
341
408
  <refsect1 id="logging">
342
409
    <title>LOGGING</title>
343
410
    <para>
344
411
      The server will send log message with various severity levels to
345
 
      <filename>/dev/log</filename>.  With the
 
412
      <filename class="devicefile">/dev/log</filename>.  With the
346
413
      <option>--debug</option> option, it will log even more messages,
347
414
      and also show them on the console.
348
415
    </para>
349
416
  </refsect1>
350
 
 
 
417
  
 
418
  <refsect1 id="persistent_state">
 
419
    <title>PERSISTENT STATE</title>
 
420
    <para>
 
421
      Client settings, initially read from
 
422
      <filename>clients.conf</filename>, are persistent across
 
423
      restarts, and run-time changes will override settings in
 
424
      <filename>clients.conf</filename>.  However, if a setting is
 
425
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
426
      <filename>clients.conf</filename>, this will take precedence.
 
427
    </para>
 
428
  </refsect1>
 
429
  
 
430
  <refsect1 id="dbus_interface">
 
431
    <title>D-BUS INTERFACE</title>
 
432
    <para>
 
433
      The server will by default provide a D-Bus system bus interface.
 
434
      This interface will only be accessible by the root user or a
 
435
      Mandos-specific user, if such a user exists.  For documentation
 
436
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
437
    </para>
 
438
  </refsect1>
 
439
  
351
440
  <refsect1 id="exit_status">
352
441
    <title>EXIT STATUS</title>
353
442
    <para>
355
444
      critical error is encountered.
356
445
    </para>
357
446
  </refsect1>
358
 
 
 
447
  
359
448
  <refsect1 id="environment">
360
449
    <title>ENVIRONMENT</title>
361
450
    <variablelist>
375
464
      </varlistentry>
376
465
    </variablelist>
377
466
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
467
  
 
468
  <refsect1 id="files">
380
469
    <title>FILES</title>
381
470
    <para>
382
471
      Use the <option>--configdir</option> option to change where
405
494
        </listitem>
406
495
      </varlistentry>
407
496
      <varlistentry>
408
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
409
 
        <listitem>
410
 
          <para>
411
 
            The file containing the process id of
412
 
            <command>&COMMANDNAME;</command>.
 
497
        <term><filename>/var/run/mandos.pid</filename></term>
 
498
        <listitem>
 
499
          <para>
 
500
            The file containing the process id of the
 
501
            <command>&COMMANDNAME;</command> process started last.
 
502
          </para>
 
503
        </listitem>
 
504
      </varlistentry>
 
505
      <varlistentry>
 
506
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
      </varlistentry>
 
508
      <varlistentry>
 
509
        <term><filename
 
510
        class="directory">/var/lib/mandos</filename></term>
 
511
        <listitem>
 
512
          <para>
 
513
            Directory where persistent state will be saved.  Change
 
514
            this with the <option>--statedir</option> option.  See
 
515
            also the <option>--no-restore</option> option.
413
516
          </para>
414
517
        </listitem>
415
518
      </varlistentry>
443
546
      backtrace.  This could be considered a feature.
444
547
    </para>
445
548
    <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.
455
 
    </para>
456
 
    <para>
457
549
      There is no fine-grained control over logging and debug output.
458
550
    </para>
459
551
    <para>
460
552
      Debug mode is conflated with running in the foreground.
461
553
    </para>
462
554
    <para>
463
 
      The console log messages does not show a timestamp.
 
555
      This server does not check the expire time of clients’ OpenPGP
 
556
      keys.
464
557
    </para>
465
558
  </refsect1>
466
559
  
477
570
    <informalexample>
478
571
      <para>
479
572
        Run the server in debug mode, read configuration files from
480
 
        the <filename>~/mandos</filename> directory, and use the
481
 
        Zeroconf service name <quote>Test</quote> to not collide with
482
 
        any other official Mandos server on this host:
 
573
        the <filename class="directory">~/mandos</filename> directory,
 
574
        and use the Zeroconf service name <quote>Test</quote> to not
 
575
        collide with any other official Mandos server on this host:
483
576
      </para>
484
577
      <para>
485
578
 
501
594
      </para>
502
595
    </informalexample>
503
596
  </refsect1>
504
 
 
 
597
  
505
598
  <refsect1 id="security">
506
599
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
600
    <refsect2 id="server">
508
601
      <title>SERVER</title>
509
602
      <para>
510
603
        Running this <command>&COMMANDNAME;</command> server program
511
604
        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.
 
605
        computer running it.  The program switches to a non-root user
 
606
        soon after startup.
514
607
      </para>
515
608
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
609
    <refsect2 id="clients">
517
610
      <title>CLIENTS</title>
518
611
      <para>
519
612
        The server only gives out its stored data to clients which
526
619
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
620
        <manvolnum>5</manvolnum></citerefentry>)
528
621
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
622
        except the user starting the server (usually root).
530
623
      </para>
531
624
      <para>
532
625
        As detailed in <xref linkend="checking"/>, the status of all
534
627
        compromised if they are gone for too long.
535
628
      </para>
536
629
      <para>
537
 
        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.
551
 
      </para>
552
 
      <para>
553
630
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
631
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
632
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
633
      </para>
557
634
    </refsect2>
558
635
  </refsect1>
559
 
 
 
636
  
560
637
  <refsect1 id="see_also">
561
638
    <title>SEE ALSO</title>
562
639
    <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>
 
640
      <citerefentry><refentrytitle>intro</refentrytitle>
 
641
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
642
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
643
      <manvolnum>5</manvolnum></citerefentry>,
 
644
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
645
      <manvolnum>5</manvolnum></citerefentry>,
 
646
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
647
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
648
      <citerefentry><refentrytitle>sh</refentrytitle>
 
649
      <manvolnum>1</manvolnum></citerefentry>
572
650
    </para>
573
651
    <variablelist>
574
652
      <varlistentry>