/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-02 17:42:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902174253-p3wxrq7z6ccnv7fs
* plugins.d/password-request.c (main): Change default GnuTLS priority
                                       string to
                             "SECURE256":!CTYPE-X.509:+CTYPE-OPENPGP".

* plugins.d/password-request.xml (DESCRIPTION): Improve wording.
  (PURPOSE, OVERVIEW): New sections.
  (OPTIONS): Improved wording.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Commented out.

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-01-25">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-02">
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
37
    <xi:include href="legalnotice.xml"/>
44
38
  </refentryinfo>
45
 
  
 
39
 
46
40
  <refmeta>
47
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
48
42
    <manvolnum>8</manvolnum>
54
48
      Gives encrypted passwords to authenticated Mandos clients
55
49
    </refpurpose>
56
50
  </refnamediv>
57
 
  
 
51
 
58
52
  <refsynopsisdiv>
59
53
    <cmdsynopsis>
60
54
      <command>&COMMANDNAME;</command>
89
83
      <replaceable>DIRECTORY</replaceable></option></arg>
90
84
      <sbr/>
91
85
      <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
86
    </cmdsynopsis>
112
87
    <cmdsynopsis>
113
88
      <command>&COMMANDNAME;</command>
125
100
      <arg choice="plain"><option>--check</option></arg>
126
101
    </cmdsynopsis>
127
102
  </refsynopsisdiv>
128
 
  
 
103
 
129
104
  <refsect1 id="description">
130
105
    <title>DESCRIPTION</title>
131
106
    <para>
132
107
      <command>&COMMANDNAME;</command> is a server daemon which
133
108
      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.
 
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.
144
117
    </para>
145
118
  </refsect1>
146
119
  
213
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
187
        </listitem>
215
188
      </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
 
      
 
189
 
235
190
      <varlistentry>
236
191
        <term><option>--priority <replaceable>
237
192
        PRIORITY</replaceable></option></term>
238
193
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="priority_compat"/>
 
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
241
195
        </listitem>
242
196
      </varlistentry>
243
 
      
 
197
 
244
198
      <varlistentry>
245
199
        <term><option>--servicename
246
200
        <replaceable>NAME</replaceable></option></term>
249
203
                      xpointer="servicename"/>
250
204
        </listitem>
251
205
      </varlistentry>
252
 
      
 
206
 
253
207
      <varlistentry>
254
208
        <term><option>--configdir
255
209
        <replaceable>DIRECTORY</replaceable></option></term>
264
218
          </para>
265
219
        </listitem>
266
220
      </varlistentry>
267
 
      
 
221
 
268
222
      <varlistentry>
269
223
        <term><option>--version</option></term>
270
224
        <listitem>
273
227
          </para>
274
228
        </listitem>
275
229
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--no-dbus</option></term>
279
 
        <listitem>
280
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
281
 
          <para>
282
 
            See also <xref linkend="dbus_interface"/>.
283
 
          </para>
284
 
        </listitem>
285
 
      </varlistentry>
286
 
      
287
 
      <varlistentry>
288
 
        <term><option>--no-ipv6</option></term>
289
 
        <listitem>
290
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
291
 
        </listitem>
292
 
      </varlistentry>
293
 
      
294
 
      <varlistentry>
295
 
        <term><option>--no-restore</option></term>
296
 
        <listitem>
297
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
298
 
          <para>
299
 
            See also <xref linkend="persistent_state"/>.
300
 
          </para>
301
 
        </listitem>
302
 
      </varlistentry>
303
 
      
304
 
      <varlistentry>
305
 
        <term><option>--statedir
306
 
        <replaceable>DIRECTORY</replaceable></option></term>
307
 
        <listitem>
308
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
309
 
        </listitem>
310
 
      </varlistentry>
311
 
      
312
 
      <varlistentry>
313
 
        <term><option>--socket
314
 
        <replaceable>FD</replaceable></option></term>
315
 
        <listitem>
316
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
317
 
        </listitem>
318
 
      </varlistentry>
319
 
      
320
 
      <varlistentry>
321
 
        <term><option>--foreground</option></term>
322
 
        <listitem>
323
 
          <xi:include href="mandos-options.xml"
324
 
                      xpointer="foreground"/>
325
 
        </listitem>
326
 
      </varlistentry>
327
 
      
328
 
      <varlistentry>
329
 
        <term><option>--no-zeroconf</option></term>
330
 
        <listitem>
331
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
332
 
        </listitem>
333
 
      </varlistentry>
334
 
      
335
230
    </variablelist>
336
231
  </refsect1>
337
 
  
 
232
 
338
233
  <refsect1 id="overview">
339
234
    <title>OVERVIEW</title>
340
235
    <xi:include href="overview.xml"/>
344
239
      <acronym>RAM</acronym> disk environment.
345
240
    </para>
346
241
  </refsect1>
347
 
  
 
242
 
348
243
  <refsect1 id="protocol">
349
244
    <title>NETWORK PROTOCOL</title>
350
245
    <para>
402
297
      </row>
403
298
    </tbody></tgroup></table>
404
299
  </refsect1>
405
 
  
 
300
 
406
301
  <refsect1 id="checking">
407
302
    <title>CHECKING</title>
408
303
    <para>
409
304
      The server will, by default, continually check that the clients
410
305
      are still up.  If a client has not been confirmed as being up
411
306
      for some time, the client is assumed to be compromised and is no
412
 
      longer eligible to receive the encrypted password.  (Manual
413
 
      intervention is required to re-enable a client.)  The timeout,
414
 
      extended timeout, checker program, and interval between checks
415
 
      can be configured both globally and per client; see
416
 
      <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>
417
311
      <manvolnum>5</manvolnum></citerefentry>.
418
312
    </para>
419
313
  </refsect1>
420
 
  
421
 
  <refsect1 id="approval">
422
 
    <title>APPROVAL</title>
423
 
    <para>
424
 
      The server can be configured to require manual approval for a
425
 
      client before it is sent its secret.  The delay to wait for such
426
 
      approval and the default action (approve or deny) can be
427
 
      configured both globally and per client; see <citerefentry>
428
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
429
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
430
 
      will be approved immediately without delay.
431
 
    </para>
432
 
    <para>
433
 
      This can be used to deny a client its secret if not manually
434
 
      approved within a specified time.  It can also be used to make
435
 
      the server delay before giving a client its secret, allowing
436
 
      optional manual denying of this specific client.
437
 
    </para>
438
 
    
439
 
  </refsect1>
440
 
  
 
314
 
441
315
  <refsect1 id="logging">
442
316
    <title>LOGGING</title>
443
317
    <para>
444
318
      The server will send log message with various severity levels to
445
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
319
      <filename>/dev/log</filename>.  With the
446
320
      <option>--debug</option> option, it will log even more messages,
447
321
      and also show them on the console.
448
322
    </para>
449
323
  </refsect1>
450
 
  
451
 
  <refsect1 id="persistent_state">
452
 
    <title>PERSISTENT STATE</title>
453
 
    <para>
454
 
      Client settings, initially read from
455
 
      <filename>clients.conf</filename>, are persistent across
456
 
      restarts, and run-time changes will override settings in
457
 
      <filename>clients.conf</filename>.  However, if a setting is
458
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
459
 
      <filename>clients.conf</filename>, this will take precedence.
460
 
    </para>
461
 
  </refsect1>
462
 
  
463
 
  <refsect1 id="dbus_interface">
464
 
    <title>D-BUS INTERFACE</title>
465
 
    <para>
466
 
      The server will by default provide a D-Bus system bus interface.
467
 
      This interface will only be accessible by the root user or a
468
 
      Mandos-specific user, if such a user exists.  For documentation
469
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
470
 
    </para>
471
 
  </refsect1>
472
 
  
 
324
 
473
325
  <refsect1 id="exit_status">
474
326
    <title>EXIT STATUS</title>
475
327
    <para>
477
329
      critical error is encountered.
478
330
    </para>
479
331
  </refsect1>
480
 
  
 
332
 
481
333
  <refsect1 id="environment">
482
334
    <title>ENVIRONMENT</title>
483
335
    <variablelist>
497
349
      </varlistentry>
498
350
    </variablelist>
499
351
  </refsect1>
500
 
  
501
 
  <refsect1 id="files">
 
352
 
 
353
  <refsect1 id="file">
502
354
    <title>FILES</title>
503
355
    <para>
504
356
      Use the <option>--configdir</option> option to change where
527
379
        </listitem>
528
380
      </varlistentry>
529
381
      <varlistentry>
530
 
        <term><filename>/run/mandos.pid</filename></term>
531
 
        <listitem>
532
 
          <para>
533
 
            The file containing the process id of the
534
 
            <command>&COMMANDNAME;</command> process started last.
535
 
            <emphasis >Note:</emphasis> If the <filename
536
 
            class="directory">/run</filename> directory does not
537
 
            exist, <filename>/var/run/mandos.pid</filename> will be
538
 
            used instead.
539
 
          </para>
540
 
        </listitem>
541
 
      </varlistentry>
542
 
      <varlistentry>
543
 
        <term><filename class="devicefile">/dev/log</filename></term>
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.
 
382
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
383
        <listitem>
 
384
          <para>
 
385
            The file containing the process id of
 
386
            <command>&COMMANDNAME;</command>.
553
387
          </para>
554
388
        </listitem>
555
389
      </varlistentry>
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>
589
 
      This server does not check the expire time of clients’ OpenPGP
590
 
      keys.
 
434
      Debug mode is conflated with running in the foreground.
 
435
    </para>
 
436
    <para>
 
437
      The console log messages does not show a timestamp.
591
438
    </para>
592
439
  </refsect1>
593
440
  
604
451
    <informalexample>
605
452
      <para>
606
453
        Run the server in debug mode, read configuration files from
607
 
        the <filename class="directory">~/mandos</filename> directory,
608
 
        and use the Zeroconf service name <quote>Test</quote> to not
609
 
        collide with any other official Mandos server on this host:
 
454
        the <filename>~/mandos</filename> directory, and use the
 
455
        Zeroconf service name <quote>Test</quote> to not collide with
 
456
        any other official Mandos server on this host:
610
457
      </para>
611
458
      <para>
612
459
 
628
475
      </para>
629
476
    </informalexample>
630
477
  </refsect1>
631
 
  
 
478
 
632
479
  <refsect1 id="security">
633
480
    <title>SECURITY</title>
634
 
    <refsect2 id="server">
 
481
    <refsect2 id="SERVER">
635
482
      <title>SERVER</title>
636
483
      <para>
637
484
        Running this <command>&COMMANDNAME;</command> server program
638
485
        should not in itself present any security risk to the host
639
 
        computer running it.  The program switches to a non-root user
640
 
        soon after startup.
 
486
        computer running it.  The program does not need any special
 
487
        privileges to run, and is designed to run as a non-root user.
641
488
      </para>
642
489
    </refsect2>
643
 
    <refsect2 id="clients">
 
490
    <refsect2 id="CLIENTS">
644
491
      <title>CLIENTS</title>
645
492
      <para>
646
493
        The server only gives out its stored data to clients which
653
500
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
654
501
        <manvolnum>5</manvolnum></citerefentry>)
655
502
        <emphasis>must</emphasis> be made non-readable by anyone
656
 
        except the user starting the server (usually root).
 
503
        except the user running the server.
657
504
      </para>
658
505
      <para>
659
506
        As detailed in <xref linkend="checking"/>, the status of all
661
508
        compromised if they are gone for too long.
662
509
      </para>
663
510
      <para>
 
511
        If a client is compromised, its downtime should be duly noted
 
512
        by the server which would therefore declare the client
 
513
        invalid.  But if the server was ever restarted, it would
 
514
        re-read its client list from its configuration file and again
 
515
        regard all clients therein as valid, and hence eligible to
 
516
        receive their passwords.  Therefore, be careful when
 
517
        restarting servers if it is suspected that a client has, in
 
518
        fact, been compromised by parties who may now be running a
 
519
        fake Mandos client with the keys from the non-encrypted
 
520
        initial <acronym>RAM</acronym> image of the client host.  What
 
521
        should be done in that case (if restarting the server program
 
522
        really is necessary) is to stop the server program, edit the
 
523
        configuration file to omit any suspect clients, and restart
 
524
        the server program.
 
525
      </para>
 
526
      <para>
664
527
        For more details on client-side security, see
665
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
528
        <citerefentry><refentrytitle>password-request</refentrytitle>
666
529
        <manvolnum>8mandos</manvolnum></citerefentry>.
667
530
      </para>
668
531
    </refsect2>
669
532
  </refsect1>
670
 
  
 
533
 
671
534
  <refsect1 id="see_also">
672
535
    <title>SEE ALSO</title>
673
536
    <para>
674
 
      <citerefentry><refentrytitle>intro</refentrytitle>
675
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
676
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
 
      <manvolnum>5</manvolnum></citerefentry>,
678
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
 
      <manvolnum>5</manvolnum></citerefentry>,
680
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
681
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
682
 
      <citerefentry><refentrytitle>sh</refentrytitle>
683
 
      <manvolnum>1</manvolnum></citerefentry>
 
537
      <citerefentry>
 
538
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
539
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
540
        <refentrytitle>mandos.conf</refentrytitle>
 
541
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
542
        <refentrytitle>password-request</refentrytitle>
 
543
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
544
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
545
      </citerefentry>
684
546
    </para>
685
547
    <variablelist>
686
548
      <varlistentry>
707
569
      </varlistentry>
708
570
      <varlistentry>
709
571
        <term>
710
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
572
          <ulink url="http://www.gnu.org/software/gnutls/"
 
573
          >GnuTLS</ulink>
711
574
        </term>
712
575
      <listitem>
713
576
        <para>
751
614
      </varlistentry>
752
615
      <varlistentry>
753
616
        <term>
754
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
 
          Protocol Version 1.2</citetitle>
 
617
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
618
          Protocol Version 1.1</citetitle>
756
619
        </term>
757
620
      <listitem>
758
621
        <para>
759
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
622
          TLS 1.1 is the protocol implemented by GnuTLS.
760
623
        </para>
761
624
      </listitem>
762
625
      </varlistentry>
772
635
      </varlistentry>
773
636
      <varlistentry>
774
637
        <term>
775
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
 
          Security (TLS) Authentication</citetitle>
 
638
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
639
          Security</citetitle>
777
640
        </term>
778
641
      <listitem>
779
642
        <para>