/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: 2008-08-31 10:27:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831102733-2u083dacxul80ynp
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
                               <literal>.  Split <term> tags into one
                               for each option.  Moved long options
                               before short.

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;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
39
 
    <xi:include href="legalnotice.xml"/>
 
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>
40
60
  </refentryinfo>
41
 
  
 
61
 
42
62
  <refmeta>
43
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
64
    <manvolnum>8</manvolnum>
50
70
      Gives encrypted passwords to authenticated Mandos clients
51
71
    </refpurpose>
52
72
  </refnamediv>
53
 
  
 
73
 
54
74
  <refsynopsisdiv>
55
75
    <cmdsynopsis>
56
76
      <command>&COMMANDNAME;</command>
85
105
      <replaceable>DIRECTORY</replaceable></option></arg>
86
106
      <sbr/>
87
107
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--no-ipv6</option></arg>
92
108
    </cmdsynopsis>
93
109
    <cmdsynopsis>
94
110
      <command>&COMMANDNAME;</command>
106
122
      <arg choice="plain"><option>--check</option></arg>
107
123
    </cmdsynopsis>
108
124
  </refsynopsisdiv>
109
 
  
 
125
 
110
126
  <refsect1 id="description">
111
127
    <title>DESCRIPTION</title>
112
128
    <para>
121
137
      Any authenticated client is then given the stored pre-encrypted
122
138
      password for that specific client.
123
139
    </para>
 
140
 
124
141
  </refsect1>
125
142
  
126
143
  <refsect1 id="purpose">
127
144
    <title>PURPOSE</title>
 
145
 
128
146
    <para>
129
147
      The purpose of this is to enable <emphasis>remote and unattended
130
148
      rebooting</emphasis> of client host computer with an
131
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
132
150
      linkend="overview"/> for details.
133
151
    </para>
 
152
    
134
153
  </refsect1>
135
154
  
136
155
  <refsect1 id="options">
137
156
    <title>OPTIONS</title>
 
157
    
138
158
    <variablelist>
139
159
      <varlistentry>
140
160
        <term><option>--help</option></term>
192
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
193
213
        </listitem>
194
214
      </varlistentry>
195
 
      
 
215
 
196
216
      <varlistentry>
197
217
        <term><option>--priority <replaceable>
198
218
        PRIORITY</replaceable></option></term>
200
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
201
221
        </listitem>
202
222
      </varlistentry>
203
 
      
 
223
 
204
224
      <varlistentry>
205
225
        <term><option>--servicename
206
226
        <replaceable>NAME</replaceable></option></term>
209
229
                      xpointer="servicename"/>
210
230
        </listitem>
211
231
      </varlistentry>
212
 
      
 
232
 
213
233
      <varlistentry>
214
234
        <term><option>--configdir
215
235
        <replaceable>DIRECTORY</replaceable></option></term>
224
244
          </para>
225
245
        </listitem>
226
246
      </varlistentry>
227
 
      
 
247
 
228
248
      <varlistentry>
229
249
        <term><option>--version</option></term>
230
250
        <listitem>
233
253
          </para>
234
254
        </listitem>
235
255
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
 
        <term><option>--no-dbus</option></term>
239
 
        <listitem>
240
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
241
 
          <para>
242
 
            See also <xref linkend="dbus_interface"/>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--no-ipv6</option></term>
249
 
        <listitem>
250
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
 
        </listitem>
252
 
      </varlistentry>
253
256
    </variablelist>
254
257
  </refsect1>
255
 
  
 
258
 
256
259
  <refsect1 id="overview">
257
260
    <title>OVERVIEW</title>
258
261
    <xi:include href="overview.xml"/>
259
262
    <para>
260
263
      This program is the server part.  It is a normal server program
261
264
      and will run in a normal system environment, not in an initial
262
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
263
266
    </para>
264
267
  </refsect1>
265
 
  
 
268
 
266
269
  <refsect1 id="protocol">
267
270
    <title>NETWORK PROTOCOL</title>
268
271
    <para>
320
323
      </row>
321
324
    </tbody></tgroup></table>
322
325
  </refsect1>
323
 
  
 
326
 
324
327
  <refsect1 id="checking">
325
328
    <title>CHECKING</title>
326
329
    <para>
327
330
      The server will, by default, continually check that the clients
328
331
      are still up.  If a client has not been confirmed as being up
329
332
      for some time, the client is assumed to be compromised and is no
330
 
      longer eligible to receive the encrypted password.  (Manual
331
 
      intervention is required to re-enable a client.)  The timeout,
 
333
      longer eligible to receive the encrypted password.  The timeout,
332
334
      checker program, and interval between checks can be configured
333
335
      both globally and per client; see <citerefentry>
334
336
      <refentrytitle>mandos-clients.conf</refentrytitle>
335
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
336
 
      receiving its password will also be treated as a successful
337
 
      checker run.
 
337
      <manvolnum>5</manvolnum></citerefentry>.
338
338
    </para>
339
339
  </refsect1>
340
 
  
 
340
 
341
341
  <refsect1 id="logging">
342
342
    <title>LOGGING</title>
343
343
    <para>
347
347
      and also show them on the console.
348
348
    </para>
349
349
  </refsect1>
350
 
  
351
 
  <refsect1 id="dbus_interface">
352
 
    <title>D-BUS INTERFACE</title>
353
 
    <para>
354
 
      The server will by default provide a D-Bus system bus interface.
355
 
      This interface will only be accessible by the root user or a
356
 
      Mandos-specific user, if such a user exists.
357
 
      <!-- XXX -->
358
 
    </para>
359
 
  </refsect1>
360
 
  
 
350
 
361
351
  <refsect1 id="exit_status">
362
352
    <title>EXIT STATUS</title>
363
353
    <para>
365
355
      critical error is encountered.
366
356
    </para>
367
357
  </refsect1>
368
 
  
 
358
 
369
359
  <refsect1 id="environment">
370
360
    <title>ENVIRONMENT</title>
371
361
    <variablelist>
385
375
      </varlistentry>
386
376
    </variablelist>
387
377
  </refsect1>
388
 
  
389
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
390
380
    <title>FILES</title>
391
381
    <para>
392
382
      Use the <option>--configdir</option> option to change where
415
405
        </listitem>
416
406
      </varlistentry>
417
407
      <varlistentry>
418
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
408
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
419
409
        <listitem>
420
410
          <para>
421
411
            The file containing the process id of
456
446
      Currently, if a client is declared <quote>invalid</quote> due to
457
447
      having timed out, the server does not record this fact onto
458
448
      permanent storage.  This has some security implications, see
459
 
      <xref linkend="clients"/>.
 
449
      <xref linkend="CLIENTS"/>.
460
450
    </para>
461
451
    <para>
462
452
      There is currently no way of querying the server of the current
470
460
      Debug mode is conflated with running in the foreground.
471
461
    </para>
472
462
    <para>
473
 
      The console log messages do not show a time stamp.
474
 
    </para>
475
 
    <para>
476
 
      This server does not check the expire time of clients’ OpenPGP
477
 
      keys.
 
463
      The console log messages does not show a timestamp.
478
464
    </para>
479
465
  </refsect1>
480
466
  
515
501
      </para>
516
502
    </informalexample>
517
503
  </refsect1>
518
 
  
 
504
 
519
505
  <refsect1 id="security">
520
506
    <title>SECURITY</title>
521
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
522
508
      <title>SERVER</title>
523
509
      <para>
524
510
        Running this <command>&COMMANDNAME;</command> server program
525
511
        should not in itself present any security risk to the host
526
 
        computer running it.  The program switches to a non-root user
527
 
        soon after startup.
 
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.
528
514
      </para>
529
515
    </refsect2>
530
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
531
517
      <title>CLIENTS</title>
532
518
      <para>
533
519
        The server only gives out its stored data to clients which
540
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
541
527
        <manvolnum>5</manvolnum></citerefentry>)
542
528
        <emphasis>must</emphasis> be made non-readable by anyone
543
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
544
530
      </para>
545
531
      <para>
546
532
        As detailed in <xref linkend="checking"/>, the status of all
557
543
        restarting servers if it is suspected that a client has, in
558
544
        fact, been compromised by parties who may now be running a
559
545
        fake Mandos client with the keys from the non-encrypted
560
 
        initial <acronym>RAM</acronym> image of the client host.  What
561
 
        should be done in that case (if restarting the server program
562
 
        really is necessary) is to stop the server program, edit the
 
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
563
549
        configuration file to omit any suspect clients, and restart
564
550
        the server program.
565
551
      </para>
566
552
      <para>
567
553
        For more details on client-side security, see
568
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
569
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
570
556
      </para>
571
557
    </refsect2>
572
558
  </refsect1>
573
 
  
 
559
 
574
560
  <refsect1 id="see_also">
575
561
    <title>SEE ALSO</title>
576
562
    <para>
579
565
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
566
        <refentrytitle>mandos.conf</refentrytitle>
581
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
582
 
        <refentrytitle>mandos-client</refentrytitle>
 
568
        <refentrytitle>password-request</refentrytitle>
583
569
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
584
570
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
585
571
      </citerefentry>