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