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