/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 09:26:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831092612-atz9uzia38h1ijy5
* mandos.xml (OPTIONS): Moved long options before short.  Use <option>
                        tags instead of <literal>.

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-03">
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
108
    </cmdsynopsis>
98
109
    <cmdsynopsis>
99
110
      <command>&COMMANDNAME;</command>
111
122
      <arg choice="plain"><option>--check</option></arg>
112
123
    </cmdsynopsis>
113
124
  </refsynopsisdiv>
114
 
  
 
125
 
115
126
  <refsect1 id="description">
116
127
    <title>DESCRIPTION</title>
117
128
    <para>
118
129
      <command>&COMMANDNAME;</command> is a server daemon which
119
130
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
130
139
    </para>
 
140
 
131
141
  </refsect1>
132
142
  
133
143
  <refsect1 id="purpose">
134
144
    <title>PURPOSE</title>
 
145
 
135
146
    <para>
136
147
      The purpose of this is to enable <emphasis>remote and unattended
137
148
      rebooting</emphasis> of client host computer with an
138
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
139
150
      linkend="overview"/> for details.
140
151
    </para>
 
152
    
141
153
  </refsect1>
142
154
  
143
155
  <refsect1 id="options">
144
156
    <title>OPTIONS</title>
 
157
    
145
158
    <variablelist>
146
159
      <varlistentry>
147
160
        <term><option>--help</option></term>
199
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
200
213
        </listitem>
201
214
      </varlistentry>
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
 
      
 
215
 
221
216
      <varlistentry>
222
217
        <term><option>--priority <replaceable>
223
218
        PRIORITY</replaceable></option></term>
225
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
226
221
        </listitem>
227
222
      </varlistentry>
228
 
      
 
223
 
229
224
      <varlistentry>
230
225
        <term><option>--servicename
231
226
        <replaceable>NAME</replaceable></option></term>
234
229
                      xpointer="servicename"/>
235
230
        </listitem>
236
231
      </varlistentry>
237
 
      
 
232
 
238
233
      <varlistentry>
239
234
        <term><option>--configdir
240
235
        <replaceable>DIRECTORY</replaceable></option></term>
249
244
          </para>
250
245
        </listitem>
251
246
      </varlistentry>
252
 
      
 
247
 
253
248
      <varlistentry>
254
249
        <term><option>--version</option></term>
255
250
        <listitem>
258
253
          </para>
259
254
        </listitem>
260
255
      </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>
278
256
    </variablelist>
279
257
  </refsect1>
280
 
  
 
258
 
281
259
  <refsect1 id="overview">
282
260
    <title>OVERVIEW</title>
283
261
    <xi:include href="overview.xml"/>
284
262
    <para>
285
263
      This program is the server part.  It is a normal server program
286
264
      and will run in a normal system environment, not in an initial
287
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
288
266
    </para>
289
267
  </refsect1>
290
 
  
 
268
 
291
269
  <refsect1 id="protocol">
292
270
    <title>NETWORK PROTOCOL</title>
293
271
    <para>
345
323
      </row>
346
324
    </tbody></tgroup></table>
347
325
  </refsect1>
348
 
  
 
326
 
349
327
  <refsect1 id="checking">
350
328
    <title>CHECKING</title>
351
329
    <para>
352
330
      The server will, by default, continually check that the clients
353
331
      are still up.  If a client has not been confirmed as being up
354
332
      for some time, the client is assumed to be compromised and is no
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>
 
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>
373
336
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
 
337
      <manvolnum>5</manvolnum></citerefentry>.
 
338
    </para>
384
339
  </refsect1>
385
 
  
 
340
 
386
341
  <refsect1 id="logging">
387
342
    <title>LOGGING</title>
388
343
    <para>
392
347
      and also show them on the console.
393
348
    </para>
394
349
  </refsect1>
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
 
  
 
350
 
406
351
  <refsect1 id="exit_status">
407
352
    <title>EXIT STATUS</title>
408
353
    <para>
410
355
      critical error is encountered.
411
356
    </para>
412
357
  </refsect1>
413
 
  
 
358
 
414
359
  <refsect1 id="environment">
415
360
    <title>ENVIRONMENT</title>
416
361
    <variablelist>
430
375
      </varlistentry>
431
376
    </variablelist>
432
377
  </refsect1>
433
 
  
434
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
435
380
    <title>FILES</title>
436
381
    <para>
437
382
      Use the <option>--configdir</option> option to change where
460
405
        </listitem>
461
406
      </varlistentry>
462
407
      <varlistentry>
463
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
408
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
464
409
        <listitem>
465
410
          <para>
466
 
            The file containing the process id of the
467
 
            <command>&COMMANDNAME;</command> process started last.
 
411
            The file containing the process id of
 
412
            <command>&COMMANDNAME;</command>.
468
413
          </para>
469
414
        </listitem>
470
415
      </varlistentry>
498
443
      backtrace.  This could be considered a feature.
499
444
    </para>
500
445
    <para>
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"/>.
 
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.
504
455
    </para>
505
456
    <para>
506
457
      There is no fine-grained control over logging and debug output.
509
460
      Debug mode is conflated with running in the foreground.
510
461
    </para>
511
462
    <para>
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.
 
463
      The console log messages does not show a timestamp.
517
464
    </para>
518
465
  </refsect1>
519
466
  
554
501
      </para>
555
502
    </informalexample>
556
503
  </refsect1>
557
 
  
 
504
 
558
505
  <refsect1 id="security">
559
506
    <title>SECURITY</title>
560
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
561
508
      <title>SERVER</title>
562
509
      <para>
563
510
        Running this <command>&COMMANDNAME;</command> server program
564
511
        should not in itself present any security risk to the host
565
 
        computer running it.  The program switches to a non-root user
566
 
        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.
567
514
      </para>
568
515
    </refsect2>
569
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
570
517
      <title>CLIENTS</title>
571
518
      <para>
572
519
        The server only gives out its stored data to clients which
579
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
580
527
        <manvolnum>5</manvolnum></citerefentry>)
581
528
        <emphasis>must</emphasis> be made non-readable by anyone
582
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
583
530
      </para>
584
531
      <para>
585
532
        As detailed in <xref linkend="checking"/>, the status of all
588
535
      </para>
589
536
      <para>
590
537
        If a client is compromised, its downtime should be duly noted
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.
 
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.
603
551
      </para>
604
552
      <para>
605
553
        For more details on client-side security, see
606
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
607
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
608
556
      </para>
609
557
    </refsect2>
610
558
  </refsect1>
611
 
  
 
559
 
612
560
  <refsect1 id="see_also">
613
561
    <title>SEE ALSO</title>
614
562
    <para>
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>
 
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>
625
572
    </para>
626
573
    <variablelist>
627
574
      <varlistentry>