/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

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