/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

  • Committer: teddy at bsnet
  • Date: 2010-08-16 19:00:59 UTC
  • mto: This revision was merged to the branch mainline in revision 420.
  • Revision ID: teddy@fukt.bsnet.se-20100816190059-69vvi27up95cgbbl
* Makefile (run-server, run-client): Add notices about harmless error
                                     messages.

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-09-17">
 
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>
307
315
      The server will, by default, continually check that the clients
308
316
      are still up.  If a client has not been confirmed as being up
309
317
      for some time, the client is assumed to be compromised and is no
310
 
      longer eligible to receive the encrypted password.  The timeout,
 
318
      longer eligible to receive the encrypted password.  (Manual
 
319
      intervention is required to re-enable a client.)  The timeout,
311
320
      checker program, and interval between checks can be configured
312
321
      both globally and per client; see <citerefentry>
313
322
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
 
323
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
324
      receiving its password will also be treated as a successful
 
325
      checker run.
315
326
    </para>
316
327
  </refsect1>
317
 
 
 
328
  
318
329
  <refsect1 id="logging">
319
330
    <title>LOGGING</title>
320
331
    <para>
324
335
      and also show them on the console.
325
336
    </para>
326
337
  </refsect1>
327
 
 
 
338
  
328
339
  <refsect1 id="exit_status">
329
340
    <title>EXIT STATUS</title>
330
341
    <para>
332
343
      critical error is encountered.
333
344
    </para>
334
345
  </refsect1>
335
 
 
 
346
  
336
347
  <refsect1 id="environment">
337
348
    <title>ENVIRONMENT</title>
338
349
    <variablelist>
339
350
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
351
        <term><envar>PATH</envar></term>
341
352
        <listitem>
342
353
          <para>
343
354
            To start the configured checker (see <xref
352
363
      </varlistentry>
353
364
    </variablelist>
354
365
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
366
  
 
367
  <refsect1 id="files">
357
368
    <title>FILES</title>
358
369
    <para>
359
370
      Use the <option>--configdir</option> option to change where
382
393
        </listitem>
383
394
      </varlistentry>
384
395
      <varlistentry>
385
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
396
        <term><filename>/var/run/mandos.pid</filename></term>
386
397
        <listitem>
387
398
          <para>
388
399
            The file containing the process id of
423
434
      Currently, if a client is declared <quote>invalid</quote> due to
424
435
      having timed out, the server does not record this fact onto
425
436
      permanent storage.  This has some security implications, see
426
 
      <xref linkend="CLIENTS"/>.
 
437
      <xref linkend="clients"/>.
427
438
    </para>
428
439
    <para>
429
440
      There is currently no way of querying the server of the current
437
448
      Debug mode is conflated with running in the foreground.
438
449
    </para>
439
450
    <para>
440
 
      The console log messages does not show a timestamp.
 
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.
441
456
    </para>
442
457
  </refsect1>
443
458
  
448
463
        Normal invocation needs no options:
449
464
      </para>
450
465
      <para>
451
 
        <userinput>mandos</userinput>
 
466
        <userinput>&COMMANDNAME;</userinput>
452
467
      </para>
453
468
    </informalexample>
454
469
    <informalexample>
461
476
      <para>
462
477
 
463
478
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
479
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
480
 
466
481
      </para>
467
482
    </informalexample>
473
488
      <para>
474
489
 
475
490
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
491
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
492
 
478
493
      </para>
479
494
    </informalexample>
480
495
  </refsect1>
481
 
 
 
496
  
482
497
  <refsect1 id="security">
483
498
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
499
    <refsect2 id="server">
485
500
      <title>SERVER</title>
486
501
      <para>
487
502
        Running this <command>&COMMANDNAME;</command> server program
488
503
        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.
 
504
        computer running it.  The program switches to a non-root user
 
505
        soon after startup.
491
506
      </para>
492
507
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
508
    <refsect2 id="clients">
494
509
      <title>CLIENTS</title>
495
510
      <para>
496
511
        The server only gives out its stored data to clients which
503
518
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
519
        <manvolnum>5</manvolnum></citerefentry>)
505
520
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
521
        except the user starting the server (usually root).
507
522
      </para>
508
523
      <para>
509
524
        As detailed in <xref linkend="checking"/>, the status of all
520
535
        restarting servers if it is suspected that a client has, in
521
536
        fact, been compromised by parties who may now be running a
522
537
        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
 
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
526
541
        configuration file to omit any suspect clients, and restart
527
542
        the server program.
528
543
      </para>
529
544
      <para>
530
545
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
546
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
547
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
548
      </para>
534
549
    </refsect2>
535
550
  </refsect1>
536
 
 
 
551
  
537
552
  <refsect1 id="see_also">
538
553
    <title>SEE ALSO</title>
539
554
    <para>
540
555
      <citerefentry>
 
556
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
557
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
541
558
        <refentrytitle>mandos.conf</refentrytitle>
542
559
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
 
560
        <refentrytitle>mandos-client</refentrytitle>
546
561
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
562
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
563
      </citerefentry>
651
666
    </variablelist>
652
667
  </refsect1>
653
668
</refentry>
 
669
<!-- Local Variables: -->
 
670
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
671
<!-- time-stamp-end: "[\"']>" -->
 
672
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
673
<!-- End: -->