/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 "2015-07-20">
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
 
      <year>2012</year>
39
 
      <year>2013</year>
40
34
      <holder>Teddy Hogeborn</holder>
41
35
      <holder>Björn Påhlsson</holder>
42
36
    </copyright>
43
 
    <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>
44
60
  </refentryinfo>
45
 
  
 
61
 
46
62
  <refmeta>
47
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
48
64
    <manvolnum>8</manvolnum>
54
70
      Gives encrypted passwords to authenticated Mandos clients
55
71
    </refpurpose>
56
72
  </refnamediv>
57
 
  
 
73
 
58
74
  <refsynopsisdiv>
59
75
    <cmdsynopsis>
60
76
      <command>&COMMANDNAME;</command>
89
105
      <replaceable>DIRECTORY</replaceable></option></arg>
90
106
      <sbr/>
91
107
      <arg><option>--debug</option></arg>
92
 
      <sbr/>
93
 
      <arg><option>--debuglevel
94
 
      <replaceable>LEVEL</replaceable></option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--no-dbus</option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--no-ipv6</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--no-restore</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--statedir
103
 
      <replaceable>DIRECTORY</replaceable></option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--socket
106
 
      <replaceable>FD</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--foreground</option></arg>
109
 
      <sbr/>
110
 
      <arg><option>--no-zeroconf</option></arg>
111
108
    </cmdsynopsis>
112
109
    <cmdsynopsis>
113
110
      <command>&COMMANDNAME;</command>
125
122
      <arg choice="plain"><option>--check</option></arg>
126
123
    </cmdsynopsis>
127
124
  </refsynopsisdiv>
128
 
  
 
125
 
129
126
  <refsect1 id="description">
130
127
    <title>DESCRIPTION</title>
131
128
    <para>
132
129
      <command>&COMMANDNAME;</command> is a server daemon which
133
130
      handles incoming request for passwords for a pre-defined list of
134
 
      client host computers. For an introduction, see
135
 
      <citerefentry><refentrytitle>intro</refentrytitle>
136
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
 
      uses Zeroconf to announce itself on the local network, and uses
138
 
      TLS to communicate securely with and to authenticate the
139
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
140
 
      use IPv6 link-local addresses, since the clients will probably
141
 
      not have any other addresses configured (see <xref
142
 
      linkend="overview"/>).  Any authenticated client is then given
143
 
      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.
144
139
    </para>
 
140
 
145
141
  </refsect1>
146
142
  
147
143
  <refsect1 id="purpose">
148
144
    <title>PURPOSE</title>
 
145
 
149
146
    <para>
150
147
      The purpose of this is to enable <emphasis>remote and unattended
151
148
      rebooting</emphasis> of client host computer with an
152
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
153
150
      linkend="overview"/> for details.
154
151
    </para>
 
152
    
155
153
  </refsect1>
156
154
  
157
155
  <refsect1 id="options">
158
156
    <title>OPTIONS</title>
 
157
    
159
158
    <variablelist>
160
159
      <varlistentry>
161
160
        <term><option>--help</option></term>
213
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
213
        </listitem>
215
214
      </varlistentry>
216
 
      
217
 
      <varlistentry>
218
 
        <term><option>--debuglevel
219
 
        <replaceable>LEVEL</replaceable></option></term>
220
 
        <listitem>
221
 
          <para>
222
 
            Set the debugging log level.
223
 
            <replaceable>LEVEL</replaceable> is a string, one of
224
 
            <quote><literal>CRITICAL</literal></quote>,
225
 
            <quote><literal>ERROR</literal></quote>,
226
 
            <quote><literal>WARNING</literal></quote>,
227
 
            <quote><literal>INFO</literal></quote>, or
228
 
            <quote><literal>DEBUG</literal></quote>, in order of
229
 
            increasing verbosity.  The default level is
230
 
            <quote><literal>WARNING</literal></quote>.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
      
 
215
 
235
216
      <varlistentry>
236
217
        <term><option>--priority <replaceable>
237
218
        PRIORITY</replaceable></option></term>
239
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
240
221
        </listitem>
241
222
      </varlistentry>
242
 
      
 
223
 
243
224
      <varlistentry>
244
225
        <term><option>--servicename
245
226
        <replaceable>NAME</replaceable></option></term>
248
229
                      xpointer="servicename"/>
249
230
        </listitem>
250
231
      </varlistentry>
251
 
      
 
232
 
252
233
      <varlistentry>
253
234
        <term><option>--configdir
254
235
        <replaceable>DIRECTORY</replaceable></option></term>
263
244
          </para>
264
245
        </listitem>
265
246
      </varlistentry>
266
 
      
 
247
 
267
248
      <varlistentry>
268
249
        <term><option>--version</option></term>
269
250
        <listitem>
272
253
          </para>
273
254
        </listitem>
274
255
      </varlistentry>
275
 
      
276
 
      <varlistentry>
277
 
        <term><option>--no-dbus</option></term>
278
 
        <listitem>
279
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
280
 
          <para>
281
 
            See also <xref linkend="dbus_interface"/>.
282
 
          </para>
283
 
        </listitem>
284
 
      </varlistentry>
285
 
      
286
 
      <varlistentry>
287
 
        <term><option>--no-ipv6</option></term>
288
 
        <listitem>
289
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
290
 
        </listitem>
291
 
      </varlistentry>
292
 
      
293
 
      <varlistentry>
294
 
        <term><option>--no-restore</option></term>
295
 
        <listitem>
296
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
297
 
          <para>
298
 
            See also <xref linkend="persistent_state"/>.
299
 
          </para>
300
 
        </listitem>
301
 
      </varlistentry>
302
 
      
303
 
      <varlistentry>
304
 
        <term><option>--statedir
305
 
        <replaceable>DIRECTORY</replaceable></option></term>
306
 
        <listitem>
307
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
308
 
        </listitem>
309
 
      </varlistentry>
310
 
      
311
 
      <varlistentry>
312
 
        <term><option>--socket
313
 
        <replaceable>FD</replaceable></option></term>
314
 
        <listitem>
315
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
316
 
        </listitem>
317
 
      </varlistentry>
318
 
      
319
 
      <varlistentry>
320
 
        <term><option>--foreground</option></term>
321
 
        <listitem>
322
 
          <xi:include href="mandos-options.xml"
323
 
                      xpointer="foreground"/>
324
 
        </listitem>
325
 
      </varlistentry>
326
 
      
327
 
      <varlistentry>
328
 
        <term><option>--no-zeroconf</option></term>
329
 
        <listitem>
330
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
331
 
        </listitem>
332
 
      </varlistentry>
333
 
      
334
256
    </variablelist>
335
257
  </refsect1>
336
 
  
 
258
 
337
259
  <refsect1 id="overview">
338
260
    <title>OVERVIEW</title>
339
261
    <xi:include href="overview.xml"/>
340
262
    <para>
341
263
      This program is the server part.  It is a normal server program
342
264
      and will run in a normal system environment, not in an initial
343
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
344
266
    </para>
345
267
  </refsect1>
346
 
  
 
268
 
347
269
  <refsect1 id="protocol">
348
270
    <title>NETWORK PROTOCOL</title>
349
271
    <para>
401
323
      </row>
402
324
    </tbody></tgroup></table>
403
325
  </refsect1>
404
 
  
 
326
 
405
327
  <refsect1 id="checking">
406
328
    <title>CHECKING</title>
407
329
    <para>
408
330
      The server will, by default, continually check that the clients
409
331
      are still up.  If a client has not been confirmed as being up
410
332
      for some time, the client is assumed to be compromised and is no
411
 
      longer eligible to receive the encrypted password.  (Manual
412
 
      intervention is required to re-enable a client.)  The timeout,
413
 
      extended timeout, checker program, and interval between checks
414
 
      can be configured both globally and per client; see
415
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
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>
 
336
      <refentrytitle>mandos-clients.conf</refentrytitle>
416
337
      <manvolnum>5</manvolnum></citerefentry>.
417
338
    </para>
418
339
  </refsect1>
419
 
  
420
 
  <refsect1 id="approval">
421
 
    <title>APPROVAL</title>
422
 
    <para>
423
 
      The server can be configured to require manual approval for a
424
 
      client before it is sent its secret.  The delay to wait for such
425
 
      approval and the default action (approve or deny) can be
426
 
      configured both globally and per client; see <citerefentry>
427
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
428
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
429
 
      will be approved immediately without delay.
430
 
    </para>
431
 
    <para>
432
 
      This can be used to deny a client its secret if not manually
433
 
      approved within a specified time.  It can also be used to make
434
 
      the server delay before giving a client its secret, allowing
435
 
      optional manual denying of this specific client.
436
 
    </para>
437
 
    
438
 
  </refsect1>
439
 
  
 
340
 
440
341
  <refsect1 id="logging">
441
342
    <title>LOGGING</title>
442
343
    <para>
443
344
      The server will send log message with various severity levels to
444
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
345
      <filename>/dev/log</filename>.  With the
445
346
      <option>--debug</option> option, it will log even more messages,
446
347
      and also show them on the console.
447
348
    </para>
448
349
  </refsect1>
449
 
  
450
 
  <refsect1 id="persistent_state">
451
 
    <title>PERSISTENT STATE</title>
452
 
    <para>
453
 
      Client settings, initially read from
454
 
      <filename>clients.conf</filename>, are persistent across
455
 
      restarts, and run-time changes will override settings in
456
 
      <filename>clients.conf</filename>.  However, if a setting is
457
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
458
 
      <filename>clients.conf</filename>, this will take precedence.
459
 
    </para>
460
 
  </refsect1>
461
 
  
462
 
  <refsect1 id="dbus_interface">
463
 
    <title>D-BUS INTERFACE</title>
464
 
    <para>
465
 
      The server will by default provide a D-Bus system bus interface.
466
 
      This interface will only be accessible by the root user or a
467
 
      Mandos-specific user, if such a user exists.  For documentation
468
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
469
 
    </para>
470
 
  </refsect1>
471
 
  
 
350
 
472
351
  <refsect1 id="exit_status">
473
352
    <title>EXIT STATUS</title>
474
353
    <para>
476
355
      critical error is encountered.
477
356
    </para>
478
357
  </refsect1>
479
 
  
 
358
 
480
359
  <refsect1 id="environment">
481
360
    <title>ENVIRONMENT</title>
482
361
    <variablelist>
496
375
      </varlistentry>
497
376
    </variablelist>
498
377
  </refsect1>
499
 
  
500
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
501
380
    <title>FILES</title>
502
381
    <para>
503
382
      Use the <option>--configdir</option> option to change where
526
405
        </listitem>
527
406
      </varlistentry>
528
407
      <varlistentry>
529
 
        <term><filename>/run/mandos.pid</filename></term>
530
 
        <listitem>
531
 
          <para>
532
 
            The file containing the process id of the
533
 
            <command>&COMMANDNAME;</command> process started last.
534
 
            <emphasis >Note:</emphasis> If the <filename
535
 
            class="directory">/run</filename> directory does not
536
 
            exist, <filename>/var/run/mandos.pid</filename> will be
537
 
            used instead.
538
 
          </para>
539
 
        </listitem>
540
 
      </varlistentry>
541
 
      <varlistentry>
542
 
        <term><filename class="devicefile">/dev/log</filename></term>
543
 
      </varlistentry>
544
 
      <varlistentry>
545
 
        <term><filename
546
 
        class="directory">/var/lib/mandos</filename></term>
547
 
        <listitem>
548
 
          <para>
549
 
            Directory where persistent state will be saved.  Change
550
 
            this with the <option>--statedir</option> option.  See
551
 
            also the <option>--no-restore</option> option.
 
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>.
552
413
          </para>
553
414
        </listitem>
554
415
      </varlistentry>
582
443
      backtrace.  This could be considered a feature.
583
444
    </para>
584
445
    <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>
585
457
      There is no fine-grained control over logging and debug output.
586
458
    </para>
587
459
    <para>
588
 
      This server does not check the expire time of clients’ OpenPGP
589
 
      keys.
 
460
      Debug mode is conflated with running in the foreground.
 
461
    </para>
 
462
    <para>
 
463
      The console log messages does not show a timestamp.
590
464
    </para>
591
465
  </refsect1>
592
466
  
603
477
    <informalexample>
604
478
      <para>
605
479
        Run the server in debug mode, read configuration files from
606
 
        the <filename class="directory">~/mandos</filename> directory,
607
 
        and use the Zeroconf service name <quote>Test</quote> to not
608
 
        collide with any other official Mandos server on this host:
 
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:
609
483
      </para>
610
484
      <para>
611
485
 
627
501
      </para>
628
502
    </informalexample>
629
503
  </refsect1>
630
 
  
 
504
 
631
505
  <refsect1 id="security">
632
506
    <title>SECURITY</title>
633
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
634
508
      <title>SERVER</title>
635
509
      <para>
636
510
        Running this <command>&COMMANDNAME;</command> server program
637
511
        should not in itself present any security risk to the host
638
 
        computer running it.  The program switches to a non-root user
639
 
        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.
640
514
      </para>
641
515
    </refsect2>
642
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
643
517
      <title>CLIENTS</title>
644
518
      <para>
645
519
        The server only gives out its stored data to clients which
652
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
527
        <manvolnum>5</manvolnum></citerefentry>)
654
528
        <emphasis>must</emphasis> be made non-readable by anyone
655
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
656
530
      </para>
657
531
      <para>
658
532
        As detailed in <xref linkend="checking"/>, the status of all
660
534
        compromised if they are gone for too long.
661
535
      </para>
662
536
      <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>
663
553
        For more details on client-side security, see
664
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
665
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
666
556
      </para>
667
557
    </refsect2>
668
558
  </refsect1>
669
 
  
 
559
 
670
560
  <refsect1 id="see_also">
671
561
    <title>SEE ALSO</title>
672
562
    <para>
673
 
      <citerefentry><refentrytitle>intro</refentrytitle>
674
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
675
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
 
      <manvolnum>5</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
680
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
681
 
      <citerefentry><refentrytitle>sh</refentrytitle>
682
 
      <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>
683
572
    </para>
684
573
    <variablelist>
685
574
      <varlistentry>
706
595
      </varlistentry>
707
596
      <varlistentry>
708
597
        <term>
709
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
598
          <ulink url="http://www.gnu.org/software/gnutls/"
 
599
          >GnuTLS</ulink>
710
600
        </term>
711
601
      <listitem>
712
602
        <para>
750
640
      </varlistentry>
751
641
      <varlistentry>
752
642
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
643
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
644
          Protocol Version 1.1</citetitle>
755
645
        </term>
756
646
      <listitem>
757
647
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
648
          TLS 1.1 is the protocol implemented by GnuTLS.
759
649
        </para>
760
650
      </listitem>
761
651
      </varlistentry>
771
661
      </varlistentry>
772
662
      <varlistentry>
773
663
        <term>
774
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
775
 
          Security (TLS) Authentication</citetitle>
 
664
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
665
          Security</citetitle>
776
666
        </term>
777
667
      <listitem>
778
668
        <para>