/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

* debian/control (Build-Depends): Bug fix: Added "docbook-xml".

* mandos (main): Keep running even if no clients are defined.

* mandos.xml (OPTIONS): Bug fix: Close unclosed <para> tag.
  (D-BUS INTERFACE): Changed id to "dbus_interface".  All references
                     changed.

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-01-04">
 
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>
32
35
      <holder>Teddy Hogeborn</holder>
33
36
      <holder>Björn Påhlsson</holder>
34
37
    </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>
 
38
    <xi:include href="legalnotice.xml"/>
58
39
  </refentryinfo>
59
 
 
 
40
  
60
41
  <refmeta>
61
42
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
43
    <manvolnum>8</manvolnum>
65
46
  <refnamediv>
66
47
    <refname><command>&COMMANDNAME;</command></refname>
67
48
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
49
      Gives encrypted passwords to authenticated Mandos clients
69
50
    </refpurpose>
70
51
  </refnamediv>
71
 
 
 
52
  
72
53
  <refsynopsisdiv>
73
54
    <cmdsynopsis>
74
55
      <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>
 
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>
92
89
    </cmdsynopsis>
93
90
    <cmdsynopsis>
94
91
      <command>&COMMANDNAME;</command>
95
92
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
93
        <arg choice="plain"><option>--help</option></arg>
 
94
        <arg choice="plain"><option>-h</option></arg>
98
95
      </group>
99
96
    </cmdsynopsis>
100
97
    <cmdsynopsis>
101
98
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
99
      <arg choice="plain"><option>--version</option></arg>
103
100
    </cmdsynopsis>
104
101
    <cmdsynopsis>
105
102
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
103
      <arg choice="plain"><option>--check</option></arg>
107
104
    </cmdsynopsis>
108
105
  </refsynopsisdiv>
109
 
 
 
106
  
110
107
  <refsect1 id="description">
111
108
    <title>DESCRIPTION</title>
112
109
    <para>
121
118
      Any authenticated client is then given the stored pre-encrypted
122
119
      password for that specific client.
123
120
    </para>
124
 
 
125
121
  </refsect1>
126
122
  
127
123
  <refsect1 id="purpose">
128
124
    <title>PURPOSE</title>
129
 
 
130
125
    <para>
131
126
      The purpose of this is to enable <emphasis>remote and unattended
132
127
      rebooting</emphasis> of client host computer with an
133
128
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
129
      linkend="overview"/> for details.
135
130
    </para>
136
 
 
137
131
  </refsect1>
138
132
  
139
133
  <refsect1 id="options">
140
134
    <title>OPTIONS</title>
141
 
 
142
135
    <variablelist>
143
136
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
137
        <term><option>--help</option></term>
 
138
        <term><option>-h</option></term>
145
139
        <listitem>
146
140
          <para>
147
141
            Show a help message and exit
148
142
          </para>
149
143
        </listitem>
150
144
      </varlistentry>
151
 
 
 
145
      
152
146
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
147
        <term><option>--interface</option>
 
148
        <replaceable>NAME</replaceable></term>
 
149
        <term><option>-i</option>
 
150
        <replaceable>NAME</replaceable></term>
155
151
        <listitem>
156
152
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
153
        </listitem>
158
154
      </varlistentry>
159
 
 
 
155
      
160
156
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
157
        <term><option>--address
 
158
        <replaceable>ADDRESS</replaceable></option></term>
 
159
        <term><option>-a
 
160
        <replaceable>ADDRESS</replaceable></option></term>
163
161
        <listitem>
164
162
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
163
        </listitem>
166
164
      </varlistentry>
167
 
 
 
165
      
168
166
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
167
        <term><option>--port
 
168
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><option>-p
 
170
        <replaceable>PORT</replaceable></option></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><literal>--check</literal></term>
 
177
        <term><option>--check</option></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><literal>--debug</literal></term>
 
187
        <term><option>--debug</option></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><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
194
        <term><option>--priority <replaceable>
 
195
        PRIORITY</replaceable></option></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><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
202
        <term><option>--servicename
 
203
        <replaceable>NAME</replaceable></option></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><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
211
        <term><option>--configdir
 
212
        <replaceable>DIRECTORY</replaceable></option></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><literal>--version</literal></term>
 
226
        <term><option>--version</option></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_interface"/>.
 
240
          </para>
 
241
        </listitem>
 
242
      </varlistentry>
233
243
    </variablelist>
234
244
  </refsect1>
235
 
 
 
245
  
236
246
  <refsect1 id="overview">
237
247
    <title>OVERVIEW</title>
238
248
    <xi:include href="overview.xml"/>
239
249
    <para>
240
250
      This program is the server part.  It is a normal server program
241
251
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
252
      <acronym>RAM</acronym> disk environment.
243
253
    </para>
244
254
  </refsect1>
245
 
 
 
255
  
246
256
  <refsect1 id="protocol">
247
257
    <title>NETWORK PROTOCOL</title>
248
258
    <para>
300
310
      </row>
301
311
    </tbody></tgroup></table>
302
312
  </refsect1>
303
 
 
 
313
  
304
314
  <refsect1 id="checking">
305
315
    <title>CHECKING</title>
306
316
    <para>
314
324
      <manvolnum>5</manvolnum></citerefentry>.
315
325
    </para>
316
326
  </refsect1>
317
 
 
 
327
  
318
328
  <refsect1 id="logging">
319
329
    <title>LOGGING</title>
320
330
    <para>
324
334
      and also show them on the console.
325
335
    </para>
326
336
  </refsect1>
 
337
  
 
338
  <refsect1 id="dbus_interface">
 
339
    <title>D-BUS INTERFACE</title>
 
340
    <para>
 
341
      The server will by default provide a D-Bus system bus interface.
 
342
      This interface will only be accessible by the root user or a
 
343
      Mandos-specific user, if such a user exists.
 
344
      <!-- XXX -->
 
345
    </para>
 
346
  </refsect1>
327
347
 
328
348
  <refsect1 id="exit_status">
329
349
    <title>EXIT STATUS</title>
332
352
      critical error is encountered.
333
353
    </para>
334
354
  </refsect1>
335
 
 
 
355
  
336
356
  <refsect1 id="environment">
337
357
    <title>ENVIRONMENT</title>
338
358
    <variablelist>
339
359
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
360
        <term><envar>PATH</envar></term>
341
361
        <listitem>
342
362
          <para>
343
363
            To start the configured checker (see <xref
352
372
      </varlistentry>
353
373
    </variablelist>
354
374
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
375
  
 
376
  <refsect1 id="files">
357
377
    <title>FILES</title>
358
378
    <para>
359
379
      Use the <option>--configdir</option> option to change where
382
402
        </listitem>
383
403
      </varlistentry>
384
404
      <varlistentry>
385
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
405
        <term><filename>/var/run/mandos.pid</filename></term>
386
406
        <listitem>
387
407
          <para>
388
408
            The file containing the process id of
423
443
      Currently, if a client is declared <quote>invalid</quote> due to
424
444
      having timed out, the server does not record this fact onto
425
445
      permanent storage.  This has some security implications, see
426
 
      <xref linkend="CLIENTS"/>.
 
446
      <xref linkend="clients"/>.
427
447
    </para>
428
448
    <para>
429
449
      There is currently no way of querying the server of the current
437
457
      Debug mode is conflated with running in the foreground.
438
458
    </para>
439
459
    <para>
440
 
      The console log messages does not show a timestamp.
 
460
      The console log messages does not show a time stamp.
 
461
    </para>
 
462
    <para>
 
463
      This server does not check the expire time of clients’ OpenPGP
 
464
      keys.
441
465
    </para>
442
466
  </refsect1>
443
467
  
448
472
        Normal invocation needs no options:
449
473
      </para>
450
474
      <para>
451
 
        <userinput>mandos</userinput>
 
475
        <userinput>&COMMANDNAME;</userinput>
452
476
      </para>
453
477
    </informalexample>
454
478
    <informalexample>
461
485
      <para>
462
486
 
463
487
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
488
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
489
 
466
490
      </para>
467
491
    </informalexample>
473
497
      <para>
474
498
 
475
499
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
500
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
501
 
478
502
      </para>
479
503
    </informalexample>
480
504
  </refsect1>
481
 
 
 
505
  
482
506
  <refsect1 id="security">
483
507
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
508
    <refsect2 id="server">
485
509
      <title>SERVER</title>
486
510
      <para>
487
511
        Running this <command>&COMMANDNAME;</command> server program
488
512
        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.
 
513
        computer running it.  The program switches to a non-root user
 
514
        soon after startup.
491
515
      </para>
492
516
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
517
    <refsect2 id="clients">
494
518
      <title>CLIENTS</title>
495
519
      <para>
496
520
        The server only gives out its stored data to clients which
503
527
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
528
        <manvolnum>5</manvolnum></citerefentry>)
505
529
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
530
        except the user starting the server (usually root).
507
531
      </para>
508
532
      <para>
509
533
        As detailed in <xref linkend="checking"/>, the status of all
520
544
        restarting servers if it is suspected that a client has, in
521
545
        fact, been compromised by parties who may now be running a
522
546
        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
 
547
        initial <acronym>RAM</acronym> image of the client host.  What
 
548
        should be done in that case (if restarting the server program
 
549
        really is necessary) is to stop the server program, edit the
526
550
        configuration file to omit any suspect clients, and restart
527
551
        the server program.
528
552
      </para>
529
553
      <para>
530
554
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
555
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
556
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
557
      </para>
534
558
    </refsect2>
535
559
  </refsect1>
536
 
 
 
560
  
537
561
  <refsect1 id="see_also">
538
562
    <title>SEE ALSO</title>
539
563
    <para>
540
564
      <citerefentry>
 
565
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
566
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
541
567
        <refentrytitle>mandos.conf</refentrytitle>
542
568
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
 
569
        <refentrytitle>mandos-client</refentrytitle>
546
570
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
571
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
572
      </citerefentry>
651
675
    </variablelist>
652
676
  </refsect1>
653
677
</refentry>
 
678
<!-- Local Variables: -->
 
679
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
680
<!-- time-stamp-end: "[\"']>" -->
 
681
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
682
<!-- End: -->