/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 09:26:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831092612-atz9uzia38h1ijy5
* mandos.xml (OPTIONS): Moved long options before short.  Use <option>
                        tags instead of <literal>.

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