/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: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: (237.7.53 trunk)
  • mto: This revision was merged to the branch mainline in revision 286.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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 "2011-08-08">
 
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>
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>
108
97
    </cmdsynopsis>
109
98
    <cmdsynopsis>
110
99
      <command>&COMMANDNAME;</command>
111
100
      <group choice="req">
 
101
        <arg choice="plain"><option>--help</option></arg>
112
102
        <arg choice="plain"><option>-h</option></arg>
113
 
        <arg choice="plain"><option>--help</option></arg>
114
103
      </group>
115
104
    </cmdsynopsis>
116
105
    <cmdsynopsis>
122
111
      <arg choice="plain"><option>--check</option></arg>
123
112
    </cmdsynopsis>
124
113
  </refsynopsisdiv>
125
 
 
 
114
  
126
115
  <refsect1 id="description">
127
116
    <title>DESCRIPTION</title>
128
117
    <para>
129
118
      <command>&COMMANDNAME;</command> is a server daemon which
130
119
      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.
 
120
      client host computers. For an introduction, see
 
121
      <citerefentry><refentrytitle>intro</refentrytitle>
 
122
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
123
      uses Zeroconf to announce itself on the local network, and uses
 
124
      TLS to communicate securely with and to authenticate the
 
125
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
126
      use IPv6 link-local addresses, since the clients will probably
 
127
      not have any other addresses configured (see <xref
 
128
      linkend="overview"/>).  Any authenticated client is then given
 
129
      the stored pre-encrypted password for that specific client.
139
130
    </para>
140
 
 
141
131
  </refsect1>
142
132
  
143
133
  <refsect1 id="purpose">
144
134
    <title>PURPOSE</title>
145
 
 
146
135
    <para>
147
136
      The purpose of this is to enable <emphasis>remote and unattended
148
137
      rebooting</emphasis> of client host computer with an
149
138
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
139
      linkend="overview"/> for details.
151
140
    </para>
152
 
 
153
141
  </refsect1>
154
142
  
155
143
  <refsect1 id="options">
156
144
    <title>OPTIONS</title>
157
 
 
158
145
    <variablelist>
159
146
      <varlistentry>
 
147
        <term><option>--help</option></term>
160
148
        <term><option>-h</option></term>
161
 
        <term><option>--help</option></term>
162
149
        <listitem>
163
150
          <para>
164
151
            Show a help message and exit
165
152
          </para>
166
153
        </listitem>
167
154
      </varlistentry>
168
 
 
 
155
      
169
156
      <varlistentry>
 
157
        <term><option>--interface</option>
 
158
        <replaceable>NAME</replaceable></term>
170
159
        <term><option>-i</option>
171
160
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>--interface</option>
173
 
        <replaceable>NAME</replaceable></term>
174
161
        <listitem>
175
162
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
163
        </listitem>
177
164
      </varlistentry>
178
 
 
 
165
      
179
166
      <varlistentry>
180
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
181
 
        ADDRESS</replaceable></literal></term>
 
167
        <term><option>--address
 
168
        <replaceable>ADDRESS</replaceable></option></term>
 
169
        <term><option>-a
 
170
        <replaceable>ADDRESS</replaceable></option></term>
182
171
        <listitem>
183
172
          <xi:include href="mandos-options.xml" xpointer="address"/>
184
173
        </listitem>
185
174
      </varlistentry>
186
 
 
 
175
      
187
176
      <varlistentry>
188
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
189
 
        PORT</replaceable></literal></term>
 
177
        <term><option>--port
 
178
        <replaceable>PORT</replaceable></option></term>
 
179
        <term><option>-p
 
180
        <replaceable>PORT</replaceable></option></term>
190
181
        <listitem>
191
182
          <xi:include href="mandos-options.xml" xpointer="port"/>
192
183
        </listitem>
193
184
      </varlistentry>
194
 
 
 
185
      
195
186
      <varlistentry>
196
 
        <term><literal>--check</literal></term>
 
187
        <term><option>--check</option></term>
197
188
        <listitem>
198
189
          <para>
199
190
            Run the server’s self-tests.  This includes any unit
201
192
          </para>
202
193
        </listitem>
203
194
      </varlistentry>
204
 
 
 
195
      
205
196
      <varlistentry>
206
 
        <term><literal>--debug</literal></term>
 
197
        <term><option>--debug</option></term>
207
198
        <listitem>
208
199
          <xi:include href="mandos-options.xml" xpointer="debug"/>
209
200
        </listitem>
210
201
      </varlistentry>
211
 
 
212
 
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        PRIORITY</replaceable></literal></term>
 
202
      
 
203
      <varlistentry>
 
204
        <term><option>--debuglevel
 
205
        <replaceable>LEVEL</replaceable></option></term>
 
206
        <listitem>
 
207
          <para>
 
208
            Set the debugging log level.
 
209
            <replaceable>LEVEL</replaceable> is a string, one of
 
210
            <quote><literal>CRITICAL</literal></quote>,
 
211
            <quote><literal>ERROR</literal></quote>,
 
212
            <quote><literal>WARNING</literal></quote>,
 
213
            <quote><literal>INFO</literal></quote>, or
 
214
            <quote><literal>DEBUG</literal></quote>, in order of
 
215
            increasing verbosity.  The default level is
 
216
            <quote><literal>WARNING</literal></quote>.
 
217
          </para>
 
218
        </listitem>
 
219
      </varlistentry>
 
220
      
 
221
      <varlistentry>
 
222
        <term><option>--priority <replaceable>
 
223
        PRIORITY</replaceable></option></term>
215
224
        <listitem>
216
225
          <xi:include href="mandos-options.xml" xpointer="priority"/>
217
226
        </listitem>
218
227
      </varlistentry>
219
 
 
 
228
      
220
229
      <varlistentry>
221
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
222
 
        </literal></term>
 
230
        <term><option>--servicename
 
231
        <replaceable>NAME</replaceable></option></term>
223
232
        <listitem>
224
233
          <xi:include href="mandos-options.xml"
225
234
                      xpointer="servicename"/>
226
235
        </listitem>
227
236
      </varlistentry>
228
 
 
 
237
      
229
238
      <varlistentry>
230
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
231
 
        </literal></term>
 
239
        <term><option>--configdir
 
240
        <replaceable>DIRECTORY</replaceable></option></term>
232
241
        <listitem>
233
242
          <para>
234
243
            Directory to search for configuration files.  Default is
240
249
          </para>
241
250
        </listitem>
242
251
      </varlistentry>
243
 
 
 
252
      
244
253
      <varlistentry>
245
 
        <term><literal>--version</literal></term>
 
254
        <term><option>--version</option></term>
246
255
        <listitem>
247
256
          <para>
248
257
            Prints the program version and exit.
249
258
          </para>
250
259
        </listitem>
251
260
      </varlistentry>
 
261
      
 
262
      <varlistentry>
 
263
        <term><option>--no-dbus</option></term>
 
264
        <listitem>
 
265
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
266
          <para>
 
267
            See also <xref linkend="dbus_interface"/>.
 
268
          </para>
 
269
        </listitem>
 
270
      </varlistentry>
 
271
      
 
272
      <varlistentry>
 
273
        <term><option>--no-ipv6</option></term>
 
274
        <listitem>
 
275
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
276
        </listitem>
 
277
      </varlistentry>
252
278
    </variablelist>
253
279
  </refsect1>
254
 
 
 
280
  
255
281
  <refsect1 id="overview">
256
282
    <title>OVERVIEW</title>
257
283
    <xi:include href="overview.xml"/>
258
284
    <para>
259
285
      This program is the server part.  It is a normal server program
260
286
      and will run in a normal system environment, not in an initial
261
 
      RAM disk environment.
 
287
      <acronym>RAM</acronym> disk environment.
262
288
    </para>
263
289
  </refsect1>
264
 
 
 
290
  
265
291
  <refsect1 id="protocol">
266
292
    <title>NETWORK PROTOCOL</title>
267
293
    <para>
319
345
      </row>
320
346
    </tbody></tgroup></table>
321
347
  </refsect1>
322
 
 
 
348
  
323
349
  <refsect1 id="checking">
324
350
    <title>CHECKING</title>
325
351
    <para>
326
352
      The server will, by default, continually check that the clients
327
353
      are still up.  If a client has not been confirmed as being up
328
354
      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>
 
355
      longer eligible to receive the encrypted password.  (Manual
 
356
      intervention is required to re-enable a client.)  The timeout,
 
357
      extended timeout, checker program, and interval between checks
 
358
      can be configured both globally and per client; see
 
359
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
360
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
361
      receiving its password will also be treated as a successful
 
362
      checker run.
 
363
    </para>
 
364
  </refsect1>
 
365
  
 
366
  <refsect1 id="approval">
 
367
    <title>APPROVAL</title>
 
368
    <para>
 
369
      The server can be configured to require manual approval for a
 
370
      client before it is sent its secret.  The delay to wait for such
 
371
      approval and the default action (approve or deny) can be
 
372
      configured both globally and per client; see <citerefentry>
332
373
      <refentrytitle>mandos-clients.conf</refentrytitle>
333
 
      <manvolnum>5</manvolnum></citerefentry>.
334
 
    </para>
 
374
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
375
      will be approved immediately without delay.
 
376
    </para>
 
377
    <para>
 
378
      This can be used to deny a client its secret if not manually
 
379
      approved within a specified time.  It can also be used to make
 
380
      the server delay before giving a client its secret, allowing
 
381
      optional manual denying of this specific client.
 
382
    </para>
 
383
    
335
384
  </refsect1>
336
 
 
 
385
  
337
386
  <refsect1 id="logging">
338
387
    <title>LOGGING</title>
339
388
    <para>
343
392
      and also show them on the console.
344
393
    </para>
345
394
  </refsect1>
346
 
 
 
395
  
 
396
  <refsect1 id="dbus_interface">
 
397
    <title>D-BUS INTERFACE</title>
 
398
    <para>
 
399
      The server will by default provide a D-Bus system bus interface.
 
400
      This interface will only be accessible by the root user or a
 
401
      Mandos-specific user, if such a user exists.  For documentation
 
402
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
403
    </para>
 
404
  </refsect1>
 
405
  
347
406
  <refsect1 id="exit_status">
348
407
    <title>EXIT STATUS</title>
349
408
    <para>
351
410
      critical error is encountered.
352
411
    </para>
353
412
  </refsect1>
354
 
 
 
413
  
355
414
  <refsect1 id="environment">
356
415
    <title>ENVIRONMENT</title>
357
416
    <variablelist>
371
430
      </varlistentry>
372
431
    </variablelist>
373
432
  </refsect1>
374
 
 
375
 
  <refsect1 id="file">
 
433
  
 
434
  <refsect1 id="files">
376
435
    <title>FILES</title>
377
436
    <para>
378
437
      Use the <option>--configdir</option> option to change where
401
460
        </listitem>
402
461
      </varlistentry>
403
462
      <varlistentry>
404
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
463
        <term><filename>/var/run/mandos.pid</filename></term>
405
464
        <listitem>
406
465
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
 
466
            The file containing the process id of the
 
467
            <command>&COMMANDNAME;</command> process started last.
409
468
          </para>
410
469
        </listitem>
411
470
      </varlistentry>
439
498
      backtrace.  This could be considered a feature.
440
499
    </para>
441
500
    <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.
 
501
      Currently, if a client is disabled due to having timed out, the
 
502
      server does not record this fact onto permanent storage.  This
 
503
      has some security implications, see <xref linkend="clients"/>.
451
504
    </para>
452
505
    <para>
453
506
      There is no fine-grained control over logging and debug output.
456
509
      Debug mode is conflated with running in the foreground.
457
510
    </para>
458
511
    <para>
459
 
      The console log messages does not show a timestamp.
 
512
      The console log messages do not show a time stamp.
 
513
    </para>
 
514
    <para>
 
515
      This server does not check the expire time of clients’ OpenPGP
 
516
      keys.
460
517
    </para>
461
518
  </refsect1>
462
519
  
497
554
      </para>
498
555
    </informalexample>
499
556
  </refsect1>
500
 
 
 
557
  
501
558
  <refsect1 id="security">
502
559
    <title>SECURITY</title>
503
 
    <refsect2 id="SERVER">
 
560
    <refsect2 id="server">
504
561
      <title>SERVER</title>
505
562
      <para>
506
563
        Running this <command>&COMMANDNAME;</command> server program
507
564
        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.
 
565
        computer running it.  The program switches to a non-root user
 
566
        soon after startup.
510
567
      </para>
511
568
    </refsect2>
512
 
    <refsect2 id="CLIENTS">
 
569
    <refsect2 id="clients">
513
570
      <title>CLIENTS</title>
514
571
      <para>
515
572
        The server only gives out its stored data to clients which
522
579
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
523
580
        <manvolnum>5</manvolnum></citerefentry>)
524
581
        <emphasis>must</emphasis> be made non-readable by anyone
525
 
        except the user running the server.
 
582
        except the user starting the server (usually root).
526
583
      </para>
527
584
      <para>
528
585
        As detailed in <xref linkend="checking"/>, the status of all
531
588
      </para>
532
589
      <para>
533
590
        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.
 
591
        by the server which would therefore disable the client.  But
 
592
        if the server was ever restarted, it would re-read its client
 
593
        list from its configuration file and again regard all clients
 
594
        therein as enabled, and hence eligible to receive their
 
595
        passwords.  Therefore, be careful when restarting servers if
 
596
        it is suspected that a client has, in fact, been compromised
 
597
        by parties who may now be running a fake Mandos client with
 
598
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
599
        image of the client host.  What should be done in that case
 
600
        (if restarting the server program really is necessary) is to
 
601
        stop the server program, edit the configuration file to omit
 
602
        any suspect clients, and restart the server program.
547
603
      </para>
548
604
      <para>
549
605
        For more details on client-side security, see
550
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
606
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
551
607
        <manvolnum>8mandos</manvolnum></citerefentry>.
552
608
      </para>
553
609
    </refsect2>
554
610
  </refsect1>
555
 
 
 
611
  
556
612
  <refsect1 id="see_also">
557
613
    <title>SEE ALSO</title>
558
614
    <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>
 
615
      <citerefentry><refentrytitle>intro</refentrytitle>
 
616
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
617
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
618
      <manvolnum>5</manvolnum></citerefentry>,
 
619
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
620
      <manvolnum>5</manvolnum></citerefentry>,
 
621
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
623
      <citerefentry><refentrytitle>sh</refentrytitle>
 
624
      <manvolnum>1</manvolnum></citerefentry>
568
625
    </para>
569
626
    <variablelist>
570
627
      <varlistentry>