/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">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
34
35
      <holder>Teddy Hogeborn</holder>
35
36
      <holder>Björn Påhlsson</holder>
36
37
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
38
    <xi:include href="legalnotice.xml"/>
60
39
  </refentryinfo>
61
 
 
 
40
  
62
41
  <refmeta>
63
42
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
43
    <manvolnum>8</manvolnum>
70
49
      Gives encrypted passwords to authenticated Mandos clients
71
50
    </refpurpose>
72
51
  </refnamediv>
73
 
 
 
52
  
74
53
  <refsynopsisdiv>
75
54
    <cmdsynopsis>
76
55
      <command>&COMMANDNAME;</command>
105
84
      <replaceable>DIRECTORY</replaceable></option></arg>
106
85
      <sbr/>
107
86
      <arg><option>--debug</option></arg>
 
87
      <sbr/>
 
88
      <arg><option>--no-dbus</option></arg>
108
89
    </cmdsynopsis>
109
90
    <cmdsynopsis>
110
91
      <command>&COMMANDNAME;</command>
122
103
      <arg choice="plain"><option>--check</option></arg>
123
104
    </cmdsynopsis>
124
105
  </refsynopsisdiv>
125
 
 
 
106
  
126
107
  <refsect1 id="description">
127
108
    <title>DESCRIPTION</title>
128
109
    <para>
137
118
      Any authenticated client is then given the stored pre-encrypted
138
119
      password for that specific client.
139
120
    </para>
140
 
 
141
121
  </refsect1>
142
122
  
143
123
  <refsect1 id="purpose">
144
124
    <title>PURPOSE</title>
145
 
 
146
125
    <para>
147
126
      The purpose of this is to enable <emphasis>remote and unattended
148
127
      rebooting</emphasis> of client host computer with an
149
128
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
129
      linkend="overview"/> for details.
151
130
    </para>
152
 
    
153
131
  </refsect1>
154
132
  
155
133
  <refsect1 id="options">
156
134
    <title>OPTIONS</title>
157
 
    
158
135
    <variablelist>
159
136
      <varlistentry>
160
137
        <term><option>--help</option></term>
212
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
190
        </listitem>
214
191
      </varlistentry>
215
 
 
 
192
      
216
193
      <varlistentry>
217
194
        <term><option>--priority <replaceable>
218
195
        PRIORITY</replaceable></option></term>
220
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
198
        </listitem>
222
199
      </varlistentry>
223
 
 
 
200
      
224
201
      <varlistentry>
225
202
        <term><option>--servicename
226
203
        <replaceable>NAME</replaceable></option></term>
229
206
                      xpointer="servicename"/>
230
207
        </listitem>
231
208
      </varlistentry>
232
 
 
 
209
      
233
210
      <varlistentry>
234
211
        <term><option>--configdir
235
212
        <replaceable>DIRECTORY</replaceable></option></term>
244
221
          </para>
245
222
        </listitem>
246
223
      </varlistentry>
247
 
 
 
224
      
248
225
      <varlistentry>
249
226
        <term><option>--version</option></term>
250
227
        <listitem>
253
230
          </para>
254
231
        </listitem>
255
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>
256
243
    </variablelist>
257
244
  </refsect1>
258
 
 
 
245
  
259
246
  <refsect1 id="overview">
260
247
    <title>OVERVIEW</title>
261
248
    <xi:include href="overview.xml"/>
262
249
    <para>
263
250
      This program is the server part.  It is a normal server program
264
251
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
252
      <acronym>RAM</acronym> disk environment.
266
253
    </para>
267
254
  </refsect1>
268
 
 
 
255
  
269
256
  <refsect1 id="protocol">
270
257
    <title>NETWORK PROTOCOL</title>
271
258
    <para>
323
310
      </row>
324
311
    </tbody></tgroup></table>
325
312
  </refsect1>
326
 
 
 
313
  
327
314
  <refsect1 id="checking">
328
315
    <title>CHECKING</title>
329
316
    <para>
337
324
      <manvolnum>5</manvolnum></citerefentry>.
338
325
    </para>
339
326
  </refsect1>
340
 
 
 
327
  
341
328
  <refsect1 id="logging">
342
329
    <title>LOGGING</title>
343
330
    <para>
347
334
      and also show them on the console.
348
335
    </para>
349
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>
350
347
 
351
348
  <refsect1 id="exit_status">
352
349
    <title>EXIT STATUS</title>
355
352
      critical error is encountered.
356
353
    </para>
357
354
  </refsect1>
358
 
 
 
355
  
359
356
  <refsect1 id="environment">
360
357
    <title>ENVIRONMENT</title>
361
358
    <variablelist>
375
372
      </varlistentry>
376
373
    </variablelist>
377
374
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
375
  
 
376
  <refsect1 id="files">
380
377
    <title>FILES</title>
381
378
    <para>
382
379
      Use the <option>--configdir</option> option to change where
405
402
        </listitem>
406
403
      </varlistentry>
407
404
      <varlistentry>
408
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
405
        <term><filename>/var/run/mandos.pid</filename></term>
409
406
        <listitem>
410
407
          <para>
411
408
            The file containing the process id of
446
443
      Currently, if a client is declared <quote>invalid</quote> due to
447
444
      having timed out, the server does not record this fact onto
448
445
      permanent storage.  This has some security implications, see
449
 
      <xref linkend="CLIENTS"/>.
 
446
      <xref linkend="clients"/>.
450
447
    </para>
451
448
    <para>
452
449
      There is currently no way of querying the server of the current
460
457
      Debug mode is conflated with running in the foreground.
461
458
    </para>
462
459
    <para>
463
 
      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.
464
465
    </para>
465
466
  </refsect1>
466
467
  
501
502
      </para>
502
503
    </informalexample>
503
504
  </refsect1>
504
 
 
 
505
  
505
506
  <refsect1 id="security">
506
507
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
508
    <refsect2 id="server">
508
509
      <title>SERVER</title>
509
510
      <para>
510
511
        Running this <command>&COMMANDNAME;</command> server program
511
512
        should not in itself present any security risk to the host
512
 
        computer running it.  The program does not need any special
513
 
        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.
514
515
      </para>
515
516
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
517
    <refsect2 id="clients">
517
518
      <title>CLIENTS</title>
518
519
      <para>
519
520
        The server only gives out its stored data to clients which
526
527
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
528
        <manvolnum>5</manvolnum></citerefentry>)
528
529
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
530
        except the user starting the server (usually root).
530
531
      </para>
531
532
      <para>
532
533
        As detailed in <xref linkend="checking"/>, the status of all
543
544
        restarting servers if it is suspected that a client has, in
544
545
        fact, been compromised by parties who may now be running a
545
546
        fake Mandos client with the keys from the non-encrypted
546
 
        initial RAM image of the client host.  What should be done in
547
 
        that case (if restarting the server program really is
548
 
        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
549
550
        configuration file to omit any suspect clients, and restart
550
551
        the server program.
551
552
      </para>
552
553
      <para>
553
554
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
555
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
556
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
557
      </para>
557
558
    </refsect2>
558
559
  </refsect1>
559
 
 
 
560
  
560
561
  <refsect1 id="see_also">
561
562
    <title>SEE ALSO</title>
562
563
    <para>
565
566
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
567
        <refentrytitle>mandos.conf</refentrytitle>
567
568
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>password-request</refentrytitle>
 
569
        <refentrytitle>mandos-client</refentrytitle>
569
570
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
571
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
572
      </citerefentry>