/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 "2013-10-23">
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
108
    </cmdsynopsis>
110
109
    <cmdsynopsis>
111
110
      <command>&COMMANDNAME;</command>
123
122
      <arg choice="plain"><option>--check</option></arg>
124
123
    </cmdsynopsis>
125
124
  </refsynopsisdiv>
126
 
  
 
125
 
127
126
  <refsect1 id="description">
128
127
    <title>DESCRIPTION</title>
129
128
    <para>
130
129
      <command>&COMMANDNAME;</command> is a server daemon which
131
130
      handles incoming request for passwords for a pre-defined list of
132
 
      client host computers. For an introduction, see
133
 
      <citerefentry><refentrytitle>intro</refentrytitle>
134
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
 
      uses Zeroconf to announce itself on the local network, and uses
136
 
      TLS to communicate securely with and to authenticate the
137
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
138
 
      use IPv6 link-local addresses, since the clients will probably
139
 
      not have any other addresses configured (see <xref
140
 
      linkend="overview"/>).  Any authenticated client is then given
141
 
      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.
142
139
    </para>
 
140
 
143
141
  </refsect1>
144
142
  
145
143
  <refsect1 id="purpose">
146
144
    <title>PURPOSE</title>
 
145
 
147
146
    <para>
148
147
      The purpose of this is to enable <emphasis>remote and unattended
149
148
      rebooting</emphasis> of client host computer with an
150
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
151
150
      linkend="overview"/> for details.
152
151
    </para>
 
152
    
153
153
  </refsect1>
154
154
  
155
155
  <refsect1 id="options">
156
156
    <title>OPTIONS</title>
 
157
    
157
158
    <variablelist>
158
159
      <varlistentry>
159
160
        <term><option>--help</option></term>
211
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
212
213
        </listitem>
213
214
      </varlistentry>
214
 
      
215
 
      <varlistentry>
216
 
        <term><option>--debuglevel
217
 
        <replaceable>LEVEL</replaceable></option></term>
218
 
        <listitem>
219
 
          <para>
220
 
            Set the debugging log level.
221
 
            <replaceable>LEVEL</replaceable> is a string, one of
222
 
            <quote><literal>CRITICAL</literal></quote>,
223
 
            <quote><literal>ERROR</literal></quote>,
224
 
            <quote><literal>WARNING</literal></quote>,
225
 
            <quote><literal>INFO</literal></quote>, or
226
 
            <quote><literal>DEBUG</literal></quote>, in order of
227
 
            increasing verbosity.  The default level is
228
 
            <quote><literal>WARNING</literal></quote>.
229
 
          </para>
230
 
        </listitem>
231
 
      </varlistentry>
232
 
      
 
215
 
233
216
      <varlistentry>
234
217
        <term><option>--priority <replaceable>
235
218
        PRIORITY</replaceable></option></term>
236
219
        <listitem>
237
 
          <xi:include href="mandos-options.xml"
238
 
                      xpointer="priority_compat"/>
 
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
239
221
        </listitem>
240
222
      </varlistentry>
241
 
      
 
223
 
242
224
      <varlistentry>
243
225
        <term><option>--servicename
244
226
        <replaceable>NAME</replaceable></option></term>
247
229
                      xpointer="servicename"/>
248
230
        </listitem>
249
231
      </varlistentry>
250
 
      
 
232
 
251
233
      <varlistentry>
252
234
        <term><option>--configdir
253
235
        <replaceable>DIRECTORY</replaceable></option></term>
262
244
          </para>
263
245
        </listitem>
264
246
      </varlistentry>
265
 
      
 
247
 
266
248
      <varlistentry>
267
249
        <term><option>--version</option></term>
268
250
        <listitem>
271
253
          </para>
272
254
        </listitem>
273
255
      </varlistentry>
274
 
      
275
 
      <varlistentry>
276
 
        <term><option>--no-dbus</option></term>
277
 
        <listitem>
278
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
279
 
          <para>
280
 
            See also <xref linkend="dbus_interface"/>.
281
 
          </para>
282
 
        </listitem>
283
 
      </varlistentry>
284
 
      
285
 
      <varlistentry>
286
 
        <term><option>--no-ipv6</option></term>
287
 
        <listitem>
288
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
289
 
        </listitem>
290
 
      </varlistentry>
291
 
      
292
 
      <varlistentry>
293
 
        <term><option>--no-restore</option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
296
 
          <para>
297
 
            See also <xref linkend="persistent_state"/>.
298
 
          </para>
299
 
        </listitem>
300
 
      </varlistentry>
301
 
      
302
 
      <varlistentry>
303
 
        <term><option>--statedir
304
 
        <replaceable>DIRECTORY</replaceable></option></term>
305
 
        <listitem>
306
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
307
 
        </listitem>
308
 
      </varlistentry>
309
 
      
310
 
      <varlistentry>
311
 
        <term><option>--socket
312
 
        <replaceable>FD</replaceable></option></term>
313
 
        <listitem>
314
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
315
 
        </listitem>
316
 
      </varlistentry>
317
 
      
318
 
      <varlistentry>
319
 
        <term><option>--foreground</option></term>
320
 
        <listitem>
321
 
          <xi:include href="mandos-options.xml"
322
 
                      xpointer="foreground"/>
323
 
        </listitem>
324
 
      </varlistentry>
325
 
      
326
256
    </variablelist>
327
257
  </refsect1>
328
 
  
 
258
 
329
259
  <refsect1 id="overview">
330
260
    <title>OVERVIEW</title>
331
261
    <xi:include href="overview.xml"/>
332
262
    <para>
333
263
      This program is the server part.  It is a normal server program
334
264
      and will run in a normal system environment, not in an initial
335
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
336
266
    </para>
337
267
  </refsect1>
338
 
  
 
268
 
339
269
  <refsect1 id="protocol">
340
270
    <title>NETWORK PROTOCOL</title>
341
271
    <para>
393
323
      </row>
394
324
    </tbody></tgroup></table>
395
325
  </refsect1>
396
 
  
 
326
 
397
327
  <refsect1 id="checking">
398
328
    <title>CHECKING</title>
399
329
    <para>
400
330
      The server will, by default, continually check that the clients
401
331
      are still up.  If a client has not been confirmed as being up
402
332
      for some time, the client is assumed to be compromised and is no
403
 
      longer eligible to receive the encrypted password.  (Manual
404
 
      intervention is required to re-enable a client.)  The timeout,
405
 
      extended timeout, checker program, and interval between checks
406
 
      can be configured both globally and per client; see
407
 
      <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>
408
337
      <manvolnum>5</manvolnum></citerefentry>.
409
338
    </para>
410
339
  </refsect1>
411
 
  
412
 
  <refsect1 id="approval">
413
 
    <title>APPROVAL</title>
414
 
    <para>
415
 
      The server can be configured to require manual approval for a
416
 
      client before it is sent its secret.  The delay to wait for such
417
 
      approval and the default action (approve or deny) can be
418
 
      configured both globally and per client; see <citerefentry>
419
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
420
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
421
 
      will be approved immediately without delay.
422
 
    </para>
423
 
    <para>
424
 
      This can be used to deny a client its secret if not manually
425
 
      approved within a specified time.  It can also be used to make
426
 
      the server delay before giving a client its secret, allowing
427
 
      optional manual denying of this specific client.
428
 
    </para>
429
 
    
430
 
  </refsect1>
431
 
  
 
340
 
432
341
  <refsect1 id="logging">
433
342
    <title>LOGGING</title>
434
343
    <para>
435
344
      The server will send log message with various severity levels to
436
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
345
      <filename>/dev/log</filename>.  With the
437
346
      <option>--debug</option> option, it will log even more messages,
438
347
      and also show them on the console.
439
348
    </para>
440
349
  </refsect1>
441
 
  
442
 
  <refsect1 id="persistent_state">
443
 
    <title>PERSISTENT STATE</title>
444
 
    <para>
445
 
      Client settings, initially read from
446
 
      <filename>clients.conf</filename>, are persistent across
447
 
      restarts, and run-time changes will override settings in
448
 
      <filename>clients.conf</filename>.  However, if a setting is
449
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
450
 
      <filename>clients.conf</filename>, this will take precedence.
451
 
    </para>
452
 
  </refsect1>
453
 
  
454
 
  <refsect1 id="dbus_interface">
455
 
    <title>D-BUS INTERFACE</title>
456
 
    <para>
457
 
      The server will by default provide a D-Bus system bus interface.
458
 
      This interface will only be accessible by the root user or a
459
 
      Mandos-specific user, if such a user exists.  For documentation
460
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
461
 
    </para>
462
 
  </refsect1>
463
 
  
 
350
 
464
351
  <refsect1 id="exit_status">
465
352
    <title>EXIT STATUS</title>
466
353
    <para>
468
355
      critical error is encountered.
469
356
    </para>
470
357
  </refsect1>
471
 
  
 
358
 
472
359
  <refsect1 id="environment">
473
360
    <title>ENVIRONMENT</title>
474
361
    <variablelist>
488
375
      </varlistentry>
489
376
    </variablelist>
490
377
  </refsect1>
491
 
  
492
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
493
380
    <title>FILES</title>
494
381
    <para>
495
382
      Use the <option>--configdir</option> option to change where
518
405
        </listitem>
519
406
      </varlistentry>
520
407
      <varlistentry>
521
 
        <term><filename>/run/mandos.pid</filename></term>
522
 
        <listitem>
523
 
          <para>
524
 
            The file containing the process id of the
525
 
            <command>&COMMANDNAME;</command> process started last.
526
 
          </para>
527
 
        </listitem>
528
 
      </varlistentry>
529
 
      <varlistentry>
530
 
        <term><filename class="devicefile">/dev/log</filename></term>
531
 
      </varlistentry>
532
 
      <varlistentry>
533
 
        <term><filename
534
 
        class="directory">/var/lib/mandos</filename></term>
535
 
        <listitem>
536
 
          <para>
537
 
            Directory where persistent state will be saved.  Change
538
 
            this with the <option>--statedir</option> option.  See
539
 
            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>.
540
413
          </para>
541
414
        </listitem>
542
415
      </varlistentry>
570
443
      backtrace.  This could be considered a feature.
571
444
    </para>
572
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>
573
457
      There is no fine-grained control over logging and debug output.
574
458
    </para>
575
459
    <para>
576
 
      This server does not check the expire time of clients’ OpenPGP
577
 
      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.
578
464
    </para>
579
465
  </refsect1>
580
466
  
591
477
    <informalexample>
592
478
      <para>
593
479
        Run the server in debug mode, read configuration files from
594
 
        the <filename class="directory">~/mandos</filename> directory,
595
 
        and use the Zeroconf service name <quote>Test</quote> to not
596
 
        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:
597
483
      </para>
598
484
      <para>
599
485
 
615
501
      </para>
616
502
    </informalexample>
617
503
  </refsect1>
618
 
  
 
504
 
619
505
  <refsect1 id="security">
620
506
    <title>SECURITY</title>
621
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
622
508
      <title>SERVER</title>
623
509
      <para>
624
510
        Running this <command>&COMMANDNAME;</command> server program
625
511
        should not in itself present any security risk to the host
626
 
        computer running it.  The program switches to a non-root user
627
 
        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.
628
514
      </para>
629
515
    </refsect2>
630
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
631
517
      <title>CLIENTS</title>
632
518
      <para>
633
519
        The server only gives out its stored data to clients which
640
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
641
527
        <manvolnum>5</manvolnum></citerefentry>)
642
528
        <emphasis>must</emphasis> be made non-readable by anyone
643
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
644
530
      </para>
645
531
      <para>
646
532
        As detailed in <xref linkend="checking"/>, the status of all
648
534
        compromised if they are gone for too long.
649
535
      </para>
650
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>
651
553
        For more details on client-side security, see
652
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
653
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
654
556
      </para>
655
557
    </refsect2>
656
558
  </refsect1>
657
 
  
 
559
 
658
560
  <refsect1 id="see_also">
659
561
    <title>SEE ALSO</title>
660
562
    <para>
661
 
      <citerefentry><refentrytitle>intro</refentrytitle>
662
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
663
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
664
 
      <manvolnum>5</manvolnum></citerefentry>,
665
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
666
 
      <manvolnum>5</manvolnum></citerefentry>,
667
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
668
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
669
 
      <citerefentry><refentrytitle>sh</refentrytitle>
670
 
      <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>
671
572
    </para>
672
573
    <variablelist>
673
574
      <varlistentry>