/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

Merge.

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 "2008-12-28">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
6
]>
9
7
 
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
  <refentryinfo>
 
10
    <title>&COMMANDNAME;</title>
13
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
12
    <productname>&COMMANDNAME;</productname>
 
13
    <productnumber>&VERSION;</productnumber>
17
14
    <authorgroup>
18
15
      <author>
19
16
        <firstname>Björn</firstname>
35
32
      <holder>Teddy Hogeborn</holder>
36
33
      <holder>Björn Påhlsson</holder>
37
34
    </copyright>
38
 
    <xi:include href="legalnotice.xml"/>
 
35
    <legalnotice>
 
36
      <para>
 
37
        This manual page is free software: you can redistribute it
 
38
        and/or modify it under the terms of the GNU General Public
 
39
        License as published by the Free Software Foundation,
 
40
        either version 3 of the License, or (at your option) any
 
41
        later version.
 
42
      </para>
 
43
 
 
44
      <para>
 
45
        This manual page is distributed in the hope that it will
 
46
        be useful, but WITHOUT ANY WARRANTY; without even the
 
47
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
48
        PARTICULAR PURPOSE.  See the GNU General Public License
 
49
        for more details.
 
50
      </para>
 
51
 
 
52
      <para>
 
53
        You should have received a copy of the GNU General Public
 
54
        License along with this program; If not, see
 
55
        <ulink url="http://www.gnu.org/licenses/"/>.
 
56
      </para>
 
57
    </legalnotice>
39
58
  </refentryinfo>
40
 
  
 
59
 
41
60
  <refmeta>
42
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
62
    <manvolnum>8</manvolnum>
46
65
  <refnamediv>
47
66
    <refname><command>&COMMANDNAME;</command></refname>
48
67
    <refpurpose>
49
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
50
69
    </refpurpose>
51
70
  </refnamediv>
52
 
  
 
71
 
53
72
  <refsynopsisdiv>
54
73
    <cmdsynopsis>
55
74
      <command>&COMMANDNAME;</command>
56
 
      <group>
57
 
        <arg choice="plain"><option>--interface
58
 
        <replaceable>NAME</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-i
60
 
        <replaceable>NAME</replaceable></option></arg>
61
 
      </group>
62
 
      <sbr/>
63
 
      <group>
64
 
        <arg choice="plain"><option>--address
65
 
        <replaceable>ADDRESS</replaceable></option></arg>
66
 
        <arg choice="plain"><option>-a
67
 
        <replaceable>ADDRESS</replaceable></option></arg>
68
 
      </group>
69
 
      <sbr/>
70
 
      <group>
71
 
        <arg choice="plain"><option>--port
72
 
        <replaceable>PORT</replaceable></option></arg>
73
 
        <arg choice="plain"><option>-p
74
 
        <replaceable>PORT</replaceable></option></arg>
75
 
      </group>
76
 
      <sbr/>
77
 
      <arg><option>--priority
78
 
      <replaceable>PRIORITY</replaceable></option></arg>
79
 
      <sbr/>
80
 
      <arg><option>--servicename
81
 
      <replaceable>NAME</replaceable></option></arg>
82
 
      <sbr/>
83
 
      <arg><option>--configdir
84
 
      <replaceable>DIRECTORY</replaceable></option></arg>
85
 
      <sbr/>
86
 
      <arg><option>--debug</option></arg>
87
 
      <sbr/>
88
 
      <arg><option>--no-dbus</option></arg>
 
75
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
79
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
80
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
81
      <arg>--debug</arg>
 
82
    </cmdsynopsis>
 
83
    <cmdsynopsis>
 
84
      <command>&COMMANDNAME;</command>
 
85
      <arg>-i<arg choice="plain">IF</arg></arg>
 
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
89
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
90
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
91
      <arg>--debug</arg>
89
92
    </cmdsynopsis>
90
93
    <cmdsynopsis>
91
94
      <command>&COMMANDNAME;</command>
92
95
      <group choice="req">
93
 
        <arg choice="plain"><option>--help</option></arg>
94
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
95
98
      </group>
96
99
    </cmdsynopsis>
97
100
    <cmdsynopsis>
98
101
      <command>&COMMANDNAME;</command>
99
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
100
103
    </cmdsynopsis>
101
104
    <cmdsynopsis>
102
105
      <command>&COMMANDNAME;</command>
103
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
104
107
    </cmdsynopsis>
105
108
  </refsynopsisdiv>
106
 
  
 
109
 
107
110
  <refsect1 id="description">
108
111
    <title>DESCRIPTION</title>
109
112
    <para>
118
121
      Any authenticated client is then given the stored pre-encrypted
119
122
      password for that specific client.
120
123
    </para>
 
124
 
121
125
  </refsect1>
122
126
  
123
127
  <refsect1 id="purpose">
124
128
    <title>PURPOSE</title>
 
129
 
125
130
    <para>
126
131
      The purpose of this is to enable <emphasis>remote and unattended
127
132
      rebooting</emphasis> of client host computer with an
128
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
129
134
      linkend="overview"/> for details.
130
135
    </para>
 
136
 
131
137
  </refsect1>
132
138
  
133
139
  <refsect1 id="options">
134
140
    <title>OPTIONS</title>
 
141
 
135
142
    <variablelist>
136
143
      <varlistentry>
137
 
        <term><option>--help</option></term>
138
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
139
145
        <listitem>
140
146
          <para>
141
147
            Show a help message and exit
142
148
          </para>
143
149
        </listitem>
144
150
      </varlistentry>
145
 
      
 
151
 
146
152
      <varlistentry>
147
 
        <term><option>--interface</option>
148
 
        <replaceable>NAME</replaceable></term>
149
 
        <term><option>-i</option>
150
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
151
155
        <listitem>
152
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
153
157
        </listitem>
154
158
      </varlistentry>
155
 
      
 
159
 
156
160
      <varlistentry>
157
 
        <term><option>--address
158
 
        <replaceable>ADDRESS</replaceable></option></term>
159
 
        <term><option>-a
160
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
161
163
        <listitem>
162
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
163
165
        </listitem>
164
166
      </varlistentry>
165
 
      
 
167
 
166
168
      <varlistentry>
167
 
        <term><option>--port
168
 
        <replaceable>PORT</replaceable></option></term>
169
 
        <term><option>-p
170
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
171
171
        <listitem>
172
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
173
        </listitem>
174
174
      </varlistentry>
175
 
      
 
175
 
176
176
      <varlistentry>
177
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
178
178
        <listitem>
179
179
          <para>
180
180
            Run the server’s self-tests.  This includes any unit
182
182
          </para>
183
183
        </listitem>
184
184
      </varlistentry>
185
 
      
 
185
 
186
186
      <varlistentry>
187
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
188
188
        <listitem>
189
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
190
        </listitem>
191
191
      </varlistentry>
192
 
      
 
192
 
193
193
      <varlistentry>
194
 
        <term><option>--priority <replaceable>
195
 
        PRIORITY</replaceable></option></term>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
196
196
        <listitem>
197
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
198
        </listitem>
199
199
      </varlistentry>
200
 
      
 
200
 
201
201
      <varlistentry>
202
 
        <term><option>--servicename
203
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
204
204
        <listitem>
205
205
          <xi:include href="mandos-options.xml"
206
206
                      xpointer="servicename"/>
207
207
        </listitem>
208
208
      </varlistentry>
209
 
      
 
209
 
210
210
      <varlistentry>
211
 
        <term><option>--configdir
212
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
213
213
        <listitem>
214
214
          <para>
215
215
            Directory to search for configuration files.  Default is
221
221
          </para>
222
222
        </listitem>
223
223
      </varlistentry>
224
 
      
 
224
 
225
225
      <varlistentry>
226
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
227
227
        <listitem>
228
228
          <para>
229
229
            Prints the program version and exit.
230
230
          </para>
231
231
        </listitem>
232
232
      </varlistentry>
233
 
      
234
 
      <varlistentry>
235
 
        <term><option>--no-dbus</option></term>
236
 
        <listitem>
237
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
238
 
          <para>
239
 
            See also <xref linkend="dbus"/>.
240
 
        </listitem>
241
 
      </varlistentry>
242
233
    </variablelist>
243
234
  </refsect1>
244
 
  
 
235
 
245
236
  <refsect1 id="overview">
246
237
    <title>OVERVIEW</title>
247
238
    <xi:include href="overview.xml"/>
248
239
    <para>
249
240
      This program is the server part.  It is a normal server program
250
241
      and will run in a normal system environment, not in an initial
251
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
252
243
    </para>
253
244
  </refsect1>
254
 
  
 
245
 
255
246
  <refsect1 id="protocol">
256
247
    <title>NETWORK PROTOCOL</title>
257
248
    <para>
309
300
      </row>
310
301
    </tbody></tgroup></table>
311
302
  </refsect1>
312
 
  
 
303
 
313
304
  <refsect1 id="checking">
314
305
    <title>CHECKING</title>
315
306
    <para>
323
314
      <manvolnum>5</manvolnum></citerefentry>.
324
315
    </para>
325
316
  </refsect1>
326
 
  
 
317
 
327
318
  <refsect1 id="logging">
328
319
    <title>LOGGING</title>
329
320
    <para>
333
324
      and also show them on the console.
334
325
    </para>
335
326
  </refsect1>
336
 
  
337
 
  <refsect1 id="dbus">
338
 
    <title>D-BUS INTERFACE</title>
339
 
    <para>
340
 
      The server will by default provide a D-Bus system bus interface.
341
 
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
344
 
    </para>
345
 
  </refsect1>
346
327
 
347
328
  <refsect1 id="exit_status">
348
329
    <title>EXIT STATUS</title>
351
332
      critical error is encountered.
352
333
    </para>
353
334
  </refsect1>
354
 
  
 
335
 
355
336
  <refsect1 id="environment">
356
337
    <title>ENVIRONMENT</title>
357
338
    <variablelist>
358
339
      <varlistentry>
359
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
360
341
        <listitem>
361
342
          <para>
362
343
            To start the configured checker (see <xref
371
352
      </varlistentry>
372
353
    </variablelist>
373
354
  </refsect1>
374
 
  
375
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
376
357
    <title>FILES</title>
377
358
    <para>
378
359
      Use the <option>--configdir</option> option to change where
401
382
        </listitem>
402
383
      </varlistentry>
403
384
      <varlistentry>
404
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
385
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
405
386
        <listitem>
406
387
          <para>
407
388
            The file containing the process id of
442
423
      Currently, if a client is declared <quote>invalid</quote> due to
443
424
      having timed out, the server does not record this fact onto
444
425
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="clients"/>.
 
426
      <xref linkend="CLIENTS"/>.
446
427
    </para>
447
428
    <para>
448
429
      There is currently no way of querying the server of the current
456
437
      Debug mode is conflated with running in the foreground.
457
438
    </para>
458
439
    <para>
459
 
      The console log messages does not show a time stamp.
460
 
    </para>
461
 
    <para>
462
 
      This server does not check the expire time of clients’ OpenPGP
463
 
      keys.
 
440
      The console log messages does not show a timestamp.
464
441
    </para>
465
442
  </refsect1>
466
443
  
471
448
        Normal invocation needs no options:
472
449
      </para>
473
450
      <para>
474
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
475
452
      </para>
476
453
    </informalexample>
477
454
    <informalexample>
484
461
      <para>
485
462
 
486
463
<!-- do not wrap this line -->
487
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
488
465
 
489
466
      </para>
490
467
    </informalexample>
496
473
      <para>
497
474
 
498
475
<!-- do not wrap this line -->
499
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
500
477
 
501
478
      </para>
502
479
    </informalexample>
503
480
  </refsect1>
504
 
  
 
481
 
505
482
  <refsect1 id="security">
506
483
    <title>SECURITY</title>
507
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
508
485
      <title>SERVER</title>
509
486
      <para>
510
487
        Running this <command>&COMMANDNAME;</command> server program
511
488
        should not in itself present any security risk to the host
512
 
        computer running it.  The program switches to a non-root user
513
 
        soon after startup.
 
489
        computer running it.  The program does not need any special
 
490
        privileges to run, and is designed to run as a non-root user.
514
491
      </para>
515
492
    </refsect2>
516
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
517
494
      <title>CLIENTS</title>
518
495
      <para>
519
496
        The server only gives out its stored data to clients which
526
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
504
        <manvolnum>5</manvolnum></citerefentry>)
528
505
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
530
507
      </para>
531
508
      <para>
532
509
        As detailed in <xref linkend="checking"/>, the status of all
543
520
        restarting servers if it is suspected that a client has, in
544
521
        fact, been compromised by parties who may now be running a
545
522
        fake Mandos client with the keys from the non-encrypted
546
 
        initial <acronym>RAM</acronym> image of the client host.  What
547
 
        should be done in that case (if restarting the server program
548
 
        really is necessary) is to stop the server program, edit the
 
523
        initial RAM image of the client host.  What should be done in
 
524
        that case (if restarting the server program really is
 
525
        necessary) is to stop the server program, edit the
549
526
        configuration file to omit any suspect clients, and restart
550
527
        the server program.
551
528
      </para>
552
529
      <para>
553
530
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
555
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
533
      </para>
557
534
    </refsect2>
558
535
  </refsect1>
559
 
  
 
536
 
560
537
  <refsect1 id="see_also">
561
538
    <title>SEE ALSO</title>
562
539
    <para>
563
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
565
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>mandos.conf</refentrytitle>
567
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>mandos-client</refentrytitle>
 
545
        <refentrytitle>password-request</refentrytitle>
569
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
548
      </citerefentry>
595
572
      </varlistentry>
596
573
      <varlistentry>
597
574
        <term>
598
 
          <ulink url="http://www.gnu.org/software/gnutls/"
599
 
          >GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
600
577
        </term>
601
578
      <listitem>
602
579
        <para>
608
585
      </varlistentry>
609
586
      <varlistentry>
610
587
        <term>
611
 
          RFC 4291: <citetitle>IP Version 6 Addressing
612
 
          Architecture</citetitle>
 
588
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
589
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
590
          Unicast Addresses</citation>
613
591
        </term>
614
592
        <listitem>
615
 
          <variablelist>
616
 
            <varlistentry>
617
 
              <term>Section 2.2: <citetitle>Text Representation of
618
 
              Addresses</citetitle></term>
619
 
              <listitem><para/></listitem>
620
 
            </varlistentry>
621
 
            <varlistentry>
622
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
623
 
              Address</citetitle></term>
624
 
              <listitem><para/></listitem>
625
 
            </varlistentry>
626
 
            <varlistentry>
627
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
628
 
            Addresses</citetitle></term>
629
 
            <listitem>
630
 
              <para>
631
 
                The clients use IPv6 link-local addresses, which are
632
 
                immediately usable since a link-local addresses is
633
 
                automatically assigned to a network interfaces when it
634
 
                is brought up.
635
 
              </para>
636
 
            </listitem>
637
 
            </varlistentry>
638
 
          </variablelist>
 
593
          <para>
 
594
            The clients use IPv6 link-local addresses, which are
 
595
            immediately usable since a link-local addresses is
 
596
            automatically assigned to a network interfaces when it is
 
597
            brought up.
 
598
          </para>
639
599
        </listitem>
640
600
      </varlistentry>
641
601
      <varlistentry>
642
602
        <term>
643
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
644
 
          Protocol Version 1.1</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
645
605
        </term>
646
606
      <listitem>
647
607
        <para>
651
611
      </varlistentry>
652
612
      <varlistentry>
653
613
        <term>
654
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
655
616
        </term>
656
617
      <listitem>
657
618
        <para>
661
622
      </varlistentry>
662
623
      <varlistentry>
663
624
        <term>
664
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
665
 
          Security</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
666
627
        </term>
667
628
      <listitem>
668
629
        <para>
674
635
    </variablelist>
675
636
  </refsect1>
676
637
</refentry>
677
 
<!-- Local Variables: -->
678
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
679
 
<!-- time-stamp-end: "[\"']>" -->
680
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
681
 
<!-- End: -->