/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 Hogeborn
  • Date: 2008-09-06 15:41:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906154127-oxfrwsrbu0inhljv
* plugin-runner.c (main): Bug fix: use built-in default value if
                          "--plugin-dir" was not used.

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 "2017-02-23">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-05">
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
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
34
      <holder>Teddy Hogeborn</holder>
45
35
      <holder>Björn Påhlsson</holder>
46
36
    </copyright>
47
37
    <xi:include href="legalnotice.xml"/>
48
38
  </refentryinfo>
49
 
  
 
39
 
50
40
  <refmeta>
51
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
52
42
    <manvolnum>8</manvolnum>
58
48
      Gives encrypted passwords to authenticated Mandos clients
59
49
    </refpurpose>
60
50
  </refnamediv>
61
 
  
 
51
 
62
52
  <refsynopsisdiv>
63
53
    <cmdsynopsis>
64
54
      <command>&COMMANDNAME;</command>
93
83
      <replaceable>DIRECTORY</replaceable></option></arg>
94
84
      <sbr/>
95
85
      <arg><option>--debug</option></arg>
96
 
      <sbr/>
97
 
      <arg><option>--debuglevel
98
 
      <replaceable>LEVEL</replaceable></option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--no-dbus</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--no-ipv6</option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--no-restore</option></arg>
105
 
      <sbr/>
106
 
      <arg><option>--statedir
107
 
      <replaceable>DIRECTORY</replaceable></option></arg>
108
 
      <sbr/>
109
 
      <arg><option>--socket
110
 
      <replaceable>FD</replaceable></option></arg>
111
 
      <sbr/>
112
 
      <arg><option>--foreground</option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--no-zeroconf</option></arg>
115
86
    </cmdsynopsis>
116
87
    <cmdsynopsis>
117
88
      <command>&COMMANDNAME;</command>
129
100
      <arg choice="plain"><option>--check</option></arg>
130
101
    </cmdsynopsis>
131
102
  </refsynopsisdiv>
132
 
  
 
103
 
133
104
  <refsect1 id="description">
134
105
    <title>DESCRIPTION</title>
135
106
    <para>
136
107
      <command>&COMMANDNAME;</command> is a server daemon which
137
108
      handles incoming request for passwords for a pre-defined list of
138
 
      client host computers. For an introduction, see
139
 
      <citerefentry><refentrytitle>intro</refentrytitle>
140
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
141
 
      uses Zeroconf to announce itself on the local network, and uses
142
 
      TLS to communicate securely with and to authenticate the
143
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
144
 
      use IPv6 link-local addresses, since the clients will probably
145
 
      not have any other addresses configured (see <xref
146
 
      linkend="overview"/>).  Any authenticated client is then given
147
 
      the stored pre-encrypted password for that specific client.
 
109
      client host computers.  The Mandos server uses Zeroconf to
 
110
      announce itself on the local network, and uses TLS to
 
111
      communicate securely with and to authenticate the clients.  The
 
112
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
113
      link-local addresses, since the clients will probably not have
 
114
      any other addresses configured (see <xref linkend="overview"/>).
 
115
      Any authenticated client is then given the stored pre-encrypted
 
116
      password for that specific client.
148
117
    </para>
149
118
  </refsect1>
150
119
  
217
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
218
187
        </listitem>
219
188
      </varlistentry>
220
 
      
221
 
      <varlistentry>
222
 
        <term><option>--debuglevel
223
 
        <replaceable>LEVEL</replaceable></option></term>
224
 
        <listitem>
225
 
          <para>
226
 
            Set the debugging log level.
227
 
            <replaceable>LEVEL</replaceable> is a string, one of
228
 
            <quote><literal>CRITICAL</literal></quote>,
229
 
            <quote><literal>ERROR</literal></quote>,
230
 
            <quote><literal>WARNING</literal></quote>,
231
 
            <quote><literal>INFO</literal></quote>, or
232
 
            <quote><literal>DEBUG</literal></quote>, in order of
233
 
            increasing verbosity.  The default level is
234
 
            <quote><literal>WARNING</literal></quote>.
235
 
          </para>
236
 
        </listitem>
237
 
      </varlistentry>
238
 
      
 
189
 
239
190
      <varlistentry>
240
191
        <term><option>--priority <replaceable>
241
192
        PRIORITY</replaceable></option></term>
243
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
244
195
        </listitem>
245
196
      </varlistentry>
246
 
      
 
197
 
247
198
      <varlistentry>
248
199
        <term><option>--servicename
249
200
        <replaceable>NAME</replaceable></option></term>
252
203
                      xpointer="servicename"/>
253
204
        </listitem>
254
205
      </varlistentry>
255
 
      
 
206
 
256
207
      <varlistentry>
257
208
        <term><option>--configdir
258
209
        <replaceable>DIRECTORY</replaceable></option></term>
267
218
          </para>
268
219
        </listitem>
269
220
      </varlistentry>
270
 
      
 
221
 
271
222
      <varlistentry>
272
223
        <term><option>--version</option></term>
273
224
        <listitem>
276
227
          </para>
277
228
        </listitem>
278
229
      </varlistentry>
279
 
      
280
 
      <varlistentry>
281
 
        <term><option>--no-dbus</option></term>
282
 
        <listitem>
283
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
284
 
          <para>
285
 
            See also <xref linkend="dbus_interface"/>.
286
 
          </para>
287
 
        </listitem>
288
 
      </varlistentry>
289
 
      
290
 
      <varlistentry>
291
 
        <term><option>--no-ipv6</option></term>
292
 
        <listitem>
293
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
294
 
        </listitem>
295
 
      </varlistentry>
296
 
      
297
 
      <varlistentry>
298
 
        <term><option>--no-restore</option></term>
299
 
        <listitem>
300
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
301
 
          <para>
302
 
            See also <xref linkend="persistent_state"/>.
303
 
          </para>
304
 
        </listitem>
305
 
      </varlistentry>
306
 
      
307
 
      <varlistentry>
308
 
        <term><option>--statedir
309
 
        <replaceable>DIRECTORY</replaceable></option></term>
310
 
        <listitem>
311
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
312
 
        </listitem>
313
 
      </varlistentry>
314
 
      
315
 
      <varlistentry>
316
 
        <term><option>--socket
317
 
        <replaceable>FD</replaceable></option></term>
318
 
        <listitem>
319
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
320
 
        </listitem>
321
 
      </varlistentry>
322
 
      
323
 
      <varlistentry>
324
 
        <term><option>--foreground</option></term>
325
 
        <listitem>
326
 
          <xi:include href="mandos-options.xml"
327
 
                      xpointer="foreground"/>
328
 
        </listitem>
329
 
      </varlistentry>
330
 
      
331
 
      <varlistentry>
332
 
        <term><option>--no-zeroconf</option></term>
333
 
        <listitem>
334
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
335
 
        </listitem>
336
 
      </varlistentry>
337
 
      
338
230
    </variablelist>
339
231
  </refsect1>
340
 
  
 
232
 
341
233
  <refsect1 id="overview">
342
234
    <title>OVERVIEW</title>
343
235
    <xi:include href="overview.xml"/>
347
239
      <acronym>RAM</acronym> disk environment.
348
240
    </para>
349
241
  </refsect1>
350
 
  
 
242
 
351
243
  <refsect1 id="protocol">
352
244
    <title>NETWORK PROTOCOL</title>
353
245
    <para>
405
297
      </row>
406
298
    </tbody></tgroup></table>
407
299
  </refsect1>
408
 
  
 
300
 
409
301
  <refsect1 id="checking">
410
302
    <title>CHECKING</title>
411
303
    <para>
412
304
      The server will, by default, continually check that the clients
413
305
      are still up.  If a client has not been confirmed as being up
414
306
      for some time, the client is assumed to be compromised and is no
415
 
      longer eligible to receive the encrypted password.  (Manual
416
 
      intervention is required to re-enable a client.)  The timeout,
417
 
      extended timeout, checker program, and interval between checks
418
 
      can be configured both globally and per client; see
419
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
307
      longer eligible to receive the encrypted password.  The timeout,
 
308
      checker program, and interval between checks can be configured
 
309
      both globally and per client; see <citerefentry>
 
310
      <refentrytitle>mandos-clients.conf</refentrytitle>
420
311
      <manvolnum>5</manvolnum></citerefentry>.
421
312
    </para>
422
313
  </refsect1>
423
 
  
424
 
  <refsect1 id="approval">
425
 
    <title>APPROVAL</title>
426
 
    <para>
427
 
      The server can be configured to require manual approval for a
428
 
      client before it is sent its secret.  The delay to wait for such
429
 
      approval and the default action (approve or deny) can be
430
 
      configured both globally and per client; see <citerefentry>
431
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
432
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
433
 
      will be approved immediately without delay.
434
 
    </para>
435
 
    <para>
436
 
      This can be used to deny a client its secret if not manually
437
 
      approved within a specified time.  It can also be used to make
438
 
      the server delay before giving a client its secret, allowing
439
 
      optional manual denying of this specific client.
440
 
    </para>
441
 
    
442
 
  </refsect1>
443
 
  
 
314
 
444
315
  <refsect1 id="logging">
445
316
    <title>LOGGING</title>
446
317
    <para>
447
318
      The server will send log message with various severity levels to
448
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
319
      <filename>/dev/log</filename>.  With the
449
320
      <option>--debug</option> option, it will log even more messages,
450
321
      and also show them on the console.
451
322
    </para>
452
323
  </refsect1>
453
 
  
454
 
  <refsect1 id="persistent_state">
455
 
    <title>PERSISTENT STATE</title>
456
 
    <para>
457
 
      Client settings, initially read from
458
 
      <filename>clients.conf</filename>, are persistent across
459
 
      restarts, and run-time changes will override settings in
460
 
      <filename>clients.conf</filename>.  However, if a setting is
461
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
462
 
      <filename>clients.conf</filename>, this will take precedence.
463
 
    </para>
464
 
  </refsect1>
465
 
  
466
 
  <refsect1 id="dbus_interface">
467
 
    <title>D-BUS INTERFACE</title>
468
 
    <para>
469
 
      The server will by default provide a D-Bus system bus interface.
470
 
      This interface will only be accessible by the root user or a
471
 
      Mandos-specific user, if such a user exists.  For documentation
472
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
473
 
    </para>
474
 
  </refsect1>
475
 
  
 
324
 
476
325
  <refsect1 id="exit_status">
477
326
    <title>EXIT STATUS</title>
478
327
    <para>
480
329
      critical error is encountered.
481
330
    </para>
482
331
  </refsect1>
483
 
  
 
332
 
484
333
  <refsect1 id="environment">
485
334
    <title>ENVIRONMENT</title>
486
335
    <variablelist>
500
349
      </varlistentry>
501
350
    </variablelist>
502
351
  </refsect1>
503
 
  
504
 
  <refsect1 id="files">
 
352
 
 
353
  <refsect1 id="file">
505
354
    <title>FILES</title>
506
355
    <para>
507
356
      Use the <option>--configdir</option> option to change where
530
379
        </listitem>
531
380
      </varlistentry>
532
381
      <varlistentry>
533
 
        <term><filename>/run/mandos.pid</filename></term>
534
 
        <listitem>
535
 
          <para>
536
 
            The file containing the process id of the
537
 
            <command>&COMMANDNAME;</command> process started last.
538
 
            <emphasis >Note:</emphasis> If the <filename
539
 
            class="directory">/run</filename> directory does not
540
 
            exist, <filename>/var/run/mandos.pid</filename> will be
541
 
            used instead.
542
 
          </para>
543
 
        </listitem>
544
 
      </varlistentry>
545
 
      <varlistentry>
546
 
        <term><filename
547
 
        class="directory">/var/lib/mandos</filename></term>
548
 
        <listitem>
549
 
          <para>
550
 
            Directory where persistent state will be saved.  Change
551
 
            this with the <option>--statedir</option> option.  See
552
 
            also the <option>--no-restore</option> option.
553
 
          </para>
554
 
        </listitem>
555
 
      </varlistentry>
556
 
      <varlistentry>
557
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
382
        <term><filename>/var/run/mandos.pid</filename></term>
 
383
        <listitem>
 
384
          <para>
 
385
            The file containing the process id of
 
386
            <command>&COMMANDNAME;</command>.
 
387
          </para>
 
388
        </listitem>
 
389
      </varlistentry>
 
390
      <varlistentry>
 
391
        <term><filename>/dev/log</filename></term>
558
392
        <listitem>
559
393
          <para>
560
394
            The Unix domain socket to where local syslog messages are
583
417
      backtrace.  This could be considered a feature.
584
418
    </para>
585
419
    <para>
 
420
      Currently, if a client is declared <quote>invalid</quote> due to
 
421
      having timed out, the server does not record this fact onto
 
422
      permanent storage.  This has some security implications, see
 
423
      <xref linkend="CLIENTS"/>.
 
424
    </para>
 
425
    <para>
 
426
      There is currently no way of querying the server of the current
 
427
      status of clients, other than analyzing its <systemitem
 
428
      class="service">syslog</systemitem> output.
 
429
    </para>
 
430
    <para>
586
431
      There is no fine-grained control over logging and debug output.
587
432
    </para>
588
433
    <para>
 
434
      Debug mode is conflated with running in the foreground.
 
435
    </para>
 
436
    <para>
 
437
      The console log messages does not show a time stamp.
 
438
    </para>
 
439
    <para>
589
440
      This server does not check the expire time of clients’ OpenPGP
590
441
      keys.
591
442
    </para>
592
 
    <xi:include href="bugs.xml"/>
593
443
  </refsect1>
594
444
  
595
445
  <refsect1 id="example">
605
455
    <informalexample>
606
456
      <para>
607
457
        Run the server in debug mode, read configuration files from
608
 
        the <filename class="directory">~/mandos</filename> directory,
609
 
        and use the Zeroconf service name <quote>Test</quote> to not
610
 
        collide with any other official Mandos server on this host:
 
458
        the <filename>~/mandos</filename> directory, and use the
 
459
        Zeroconf service name <quote>Test</quote> to not collide with
 
460
        any other official Mandos server on this host:
611
461
      </para>
612
462
      <para>
613
463
 
629
479
      </para>
630
480
    </informalexample>
631
481
  </refsect1>
632
 
  
 
482
 
633
483
  <refsect1 id="security">
634
484
    <title>SECURITY</title>
635
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
636
486
      <title>SERVER</title>
637
487
      <para>
638
488
        Running this <command>&COMMANDNAME;</command> server program
641
491
        soon after startup.
642
492
      </para>
643
493
    </refsect2>
644
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
645
495
      <title>CLIENTS</title>
646
496
      <para>
647
497
        The server only gives out its stored data to clients which
654
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
505
        <manvolnum>5</manvolnum></citerefentry>)
656
506
        <emphasis>must</emphasis> be made non-readable by anyone
657
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
658
508
      </para>
659
509
      <para>
660
510
        As detailed in <xref linkend="checking"/>, the status of all
662
512
        compromised if they are gone for too long.
663
513
      </para>
664
514
      <para>
 
515
        If a client is compromised, its downtime should be duly noted
 
516
        by the server which would therefore declare the client
 
517
        invalid.  But if the server was ever restarted, it would
 
518
        re-read its client list from its configuration file and again
 
519
        regard all clients therein as valid, and hence eligible to
 
520
        receive their passwords.  Therefore, be careful when
 
521
        restarting servers if it is suspected that a client has, in
 
522
        fact, been compromised by parties who may now be running a
 
523
        fake Mandos client with the keys from the non-encrypted
 
524
        initial <acronym>RAM</acronym> image of the client host.  What
 
525
        should be done in that case (if restarting the server program
 
526
        really is necessary) is to stop the server program, edit the
 
527
        configuration file to omit any suspect clients, and restart
 
528
        the server program.
 
529
      </para>
 
530
      <para>
665
531
        For more details on client-side security, see
666
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
667
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
668
534
      </para>
669
535
    </refsect2>
670
536
  </refsect1>
671
 
  
 
537
 
672
538
  <refsect1 id="see_also">
673
539
    <title>SEE ALSO</title>
674
540
    <para>
675
 
      <citerefentry><refentrytitle>intro</refentrytitle>
676
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
680
 
      <manvolnum>5</manvolnum></citerefentry>,
681
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
682
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
683
 
      <citerefentry><refentrytitle>sh</refentrytitle>
684
 
      <manvolnum>1</manvolnum></citerefentry>
 
541
      <citerefentry>
 
542
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
544
        <refentrytitle>mandos.conf</refentrytitle>
 
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
546
        <refentrytitle>password-request</refentrytitle>
 
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
549
      </citerefentry>
685
550
    </para>
686
551
    <variablelist>
687
552
      <varlistentry>
708
573
      </varlistentry>
709
574
      <varlistentry>
710
575
        <term>
711
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
576
          <ulink url="http://www.gnu.org/software/gnutls/"
 
577
          >GnuTLS</ulink>
712
578
        </term>
713
579
      <listitem>
714
580
        <para>
752
618
      </varlistentry>
753
619
      <varlistentry>
754
620
        <term>
755
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.2</citetitle>
 
621
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
622
          Protocol Version 1.1</citetitle>
757
623
        </term>
758
624
      <listitem>
759
625
        <para>
760
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
626
          TLS 1.1 is the protocol implemented by GnuTLS.
761
627
        </para>
762
628
      </listitem>
763
629
      </varlistentry>
773
639
      </varlistentry>
774
640
      <varlistentry>
775
641
        <term>
776
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security (TLS) Authentication</citetitle>
 
642
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
643
          Security</citetitle>
778
644
        </term>
779
645
      <listitem>
780
646
        <para>