/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: 2009-05-17 00:50:09 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090517005009-c0iptxampo6nf177
* initramfs-tools-hook-conf: Security bug fix: Add code to handle
                             being called by "mkinitramfs-kpkg"
                             instead of "update-initramfs".

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