/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: 2009-01-06 05:10:34 UTC
  • mfrom: (237.2.13 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20090106051034-4uaqvrf6tl1in0c2
Merge from trunk: remove last traces of debconf stuff.

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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </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>
 
39
    <xi:include href="legalnotice.xml"/>
60
40
  </refentryinfo>
61
 
 
 
41
  
62
42
  <refmeta>
63
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
44
    <manvolnum>8</manvolnum>
70
50
      Gives encrypted passwords to authenticated Mandos clients
71
51
    </refpurpose>
72
52
  </refnamediv>
73
 
 
 
53
  
74
54
  <refsynopsisdiv>
75
55
    <cmdsynopsis>
76
56
      <command>&COMMANDNAME;</command>
122
102
      <arg choice="plain"><option>--check</option></arg>
123
103
    </cmdsynopsis>
124
104
  </refsynopsisdiv>
125
 
 
 
105
  
126
106
  <refsect1 id="description">
127
107
    <title>DESCRIPTION</title>
128
108
    <para>
137
117
      Any authenticated client is then given the stored pre-encrypted
138
118
      password for that specific client.
139
119
    </para>
140
 
 
141
120
  </refsect1>
142
121
  
143
122
  <refsect1 id="purpose">
144
123
    <title>PURPOSE</title>
145
 
 
146
124
    <para>
147
125
      The purpose of this is to enable <emphasis>remote and unattended
148
126
      rebooting</emphasis> of client host computer with an
149
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
128
      linkend="overview"/> for details.
151
129
    </para>
152
 
    
153
130
  </refsect1>
154
131
  
155
132
  <refsect1 id="options">
156
133
    <title>OPTIONS</title>
157
 
    
158
134
    <variablelist>
159
135
      <varlistentry>
160
136
        <term><option>--help</option></term>
212
188
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
189
        </listitem>
214
190
      </varlistentry>
215
 
 
 
191
      
216
192
      <varlistentry>
217
193
        <term><option>--priority <replaceable>
218
194
        PRIORITY</replaceable></option></term>
220
196
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
197
        </listitem>
222
198
      </varlistentry>
223
 
 
 
199
      
224
200
      <varlistentry>
225
201
        <term><option>--servicename
226
202
        <replaceable>NAME</replaceable></option></term>
229
205
                      xpointer="servicename"/>
230
206
        </listitem>
231
207
      </varlistentry>
232
 
 
 
208
      
233
209
      <varlistentry>
234
210
        <term><option>--configdir
235
211
        <replaceable>DIRECTORY</replaceable></option></term>
244
220
          </para>
245
221
        </listitem>
246
222
      </varlistentry>
247
 
 
 
223
      
248
224
      <varlistentry>
249
225
        <term><option>--version</option></term>
250
226
        <listitem>
255
231
      </varlistentry>
256
232
    </variablelist>
257
233
  </refsect1>
258
 
 
 
234
  
259
235
  <refsect1 id="overview">
260
236
    <title>OVERVIEW</title>
261
237
    <xi:include href="overview.xml"/>
262
238
    <para>
263
239
      This program is the server part.  It is a normal server program
264
240
      and will run in a normal system environment, not in an initial
265
 
      RAM disk environment.
 
241
      <acronym>RAM</acronym> disk environment.
266
242
    </para>
267
243
  </refsect1>
268
 
 
 
244
  
269
245
  <refsect1 id="protocol">
270
246
    <title>NETWORK PROTOCOL</title>
271
247
    <para>
323
299
      </row>
324
300
    </tbody></tgroup></table>
325
301
  </refsect1>
326
 
 
 
302
  
327
303
  <refsect1 id="checking">
328
304
    <title>CHECKING</title>
329
305
    <para>
337
313
      <manvolnum>5</manvolnum></citerefentry>.
338
314
    </para>
339
315
  </refsect1>
340
 
 
 
316
  
341
317
  <refsect1 id="logging">
342
318
    <title>LOGGING</title>
343
319
    <para>
347
323
      and also show them on the console.
348
324
    </para>
349
325
  </refsect1>
350
 
 
 
326
  
351
327
  <refsect1 id="exit_status">
352
328
    <title>EXIT STATUS</title>
353
329
    <para>
355
331
      critical error is encountered.
356
332
    </para>
357
333
  </refsect1>
358
 
 
 
334
  
359
335
  <refsect1 id="environment">
360
336
    <title>ENVIRONMENT</title>
361
337
    <variablelist>
375
351
      </varlistentry>
376
352
    </variablelist>
377
353
  </refsect1>
378
 
 
379
 
  <refsect1 id="file">
 
354
  
 
355
  <refsect1 id="files">
380
356
    <title>FILES</title>
381
357
    <para>
382
358
      Use the <option>--configdir</option> option to change where
405
381
        </listitem>
406
382
      </varlistentry>
407
383
      <varlistentry>
408
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
384
        <term><filename>/var/run/mandos.pid</filename></term>
409
385
        <listitem>
410
386
          <para>
411
387
            The file containing the process id of
446
422
      Currently, if a client is declared <quote>invalid</quote> due to
447
423
      having timed out, the server does not record this fact onto
448
424
      permanent storage.  This has some security implications, see
449
 
      <xref linkend="CLIENTS"/>.
 
425
      <xref linkend="clients"/>.
450
426
    </para>
451
427
    <para>
452
428
      There is currently no way of querying the server of the current
460
436
      Debug mode is conflated with running in the foreground.
461
437
    </para>
462
438
    <para>
463
 
      The console log messages does not show a timestamp.
 
439
      The console log messages does not show a time stamp.
 
440
    </para>
 
441
    <para>
 
442
      This server does not check the expire time of clients’ OpenPGP
 
443
      keys.
464
444
    </para>
465
445
  </refsect1>
466
446
  
501
481
      </para>
502
482
    </informalexample>
503
483
  </refsect1>
504
 
 
 
484
  
505
485
  <refsect1 id="security">
506
486
    <title>SECURITY</title>
507
 
    <refsect2 id="SERVER">
 
487
    <refsect2 id="server">
508
488
      <title>SERVER</title>
509
489
      <para>
510
490
        Running this <command>&COMMANDNAME;</command> server program
511
491
        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.
 
492
        computer running it.  The program switches to a non-root user
 
493
        soon after startup.
514
494
      </para>
515
495
    </refsect2>
516
 
    <refsect2 id="CLIENTS">
 
496
    <refsect2 id="clients">
517
497
      <title>CLIENTS</title>
518
498
      <para>
519
499
        The server only gives out its stored data to clients which
526
506
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
507
        <manvolnum>5</manvolnum></citerefentry>)
528
508
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user running the server.
 
509
        except the user starting the server (usually root).
530
510
      </para>
531
511
      <para>
532
512
        As detailed in <xref linkend="checking"/>, the status of all
543
523
        restarting servers if it is suspected that a client has, in
544
524
        fact, been compromised by parties who may now be running a
545
525
        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
 
526
        initial <acronym>RAM</acronym> image of the client host.  What
 
527
        should be done in that case (if restarting the server program
 
528
        really is necessary) is to stop the server program, edit the
549
529
        configuration file to omit any suspect clients, and restart
550
530
        the server program.
551
531
      </para>
552
532
      <para>
553
533
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
534
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
535
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
536
      </para>
557
537
    </refsect2>
558
538
  </refsect1>
559
 
 
 
539
  
560
540
  <refsect1 id="see_also">
561
541
    <title>SEE ALSO</title>
562
542
    <para>
565
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
546
        <refentrytitle>mandos.conf</refentrytitle>
567
547
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>password-request</refentrytitle>
 
548
        <refentrytitle>mandos-client</refentrytitle>
569
549
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
550
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
551
      </citerefentry>