/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

* INSTALL: Changed "Python 2.4" to "Python 2.5".
* mandos.lsm: - '' -

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-09-01">
 
5
<!ENTITY TIMESTAMP "2009-02-13">
 
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
39
    <xi:include href="legalnotice.xml"/>
38
40
  </refentryinfo>
39
 
 
 
41
  
40
42
  <refmeta>
41
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
44
    <manvolnum>8</manvolnum>
48
50
      Gives encrypted passwords to authenticated Mandos clients
49
51
    </refpurpose>
50
52
  </refnamediv>
51
 
 
 
53
  
52
54
  <refsynopsisdiv>
53
55
    <cmdsynopsis>
54
56
      <command>&COMMANDNAME;</command>
83
85
      <replaceable>DIRECTORY</replaceable></option></arg>
84
86
      <sbr/>
85
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
86
92
    </cmdsynopsis>
87
93
    <cmdsynopsis>
88
94
      <command>&COMMANDNAME;</command>
100
106
      <arg choice="plain"><option>--check</option></arg>
101
107
    </cmdsynopsis>
102
108
  </refsynopsisdiv>
103
 
 
 
109
  
104
110
  <refsect1 id="description">
105
111
    <title>DESCRIPTION</title>
106
112
    <para>
115
121
      Any authenticated client is then given the stored pre-encrypted
116
122
      password for that specific client.
117
123
    </para>
118
 
 
119
124
  </refsect1>
120
125
  
121
126
  <refsect1 id="purpose">
122
127
    <title>PURPOSE</title>
123
 
 
124
128
    <para>
125
129
      The purpose of this is to enable <emphasis>remote and unattended
126
130
      rebooting</emphasis> of client host computer with an
127
131
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
132
      linkend="overview"/> for details.
129
133
    </para>
130
 
    
131
134
  </refsect1>
132
135
  
133
136
  <refsect1 id="options">
134
137
    <title>OPTIONS</title>
135
 
    
136
138
    <variablelist>
137
139
      <varlistentry>
138
140
        <term><option>--help</option></term>
190
192
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
193
        </listitem>
192
194
      </varlistentry>
193
 
 
 
195
      
194
196
      <varlistentry>
195
197
        <term><option>--priority <replaceable>
196
198
        PRIORITY</replaceable></option></term>
198
200
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
201
        </listitem>
200
202
      </varlistentry>
201
 
 
 
203
      
202
204
      <varlistentry>
203
205
        <term><option>--servicename
204
206
        <replaceable>NAME</replaceable></option></term>
207
209
                      xpointer="servicename"/>
208
210
        </listitem>
209
211
      </varlistentry>
210
 
 
 
212
      
211
213
      <varlistentry>
212
214
        <term><option>--configdir
213
215
        <replaceable>DIRECTORY</replaceable></option></term>
222
224
          </para>
223
225
        </listitem>
224
226
      </varlistentry>
225
 
 
 
227
      
226
228
      <varlistentry>
227
229
        <term><option>--version</option></term>
228
230
        <listitem>
231
233
          </para>
232
234
        </listitem>
233
235
      </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>
234
253
    </variablelist>
235
254
  </refsect1>
236
 
 
 
255
  
237
256
  <refsect1 id="overview">
238
257
    <title>OVERVIEW</title>
239
258
    <xi:include href="overview.xml"/>
243
262
      <acronym>RAM</acronym> disk environment.
244
263
    </para>
245
264
  </refsect1>
246
 
 
 
265
  
247
266
  <refsect1 id="protocol">
248
267
    <title>NETWORK PROTOCOL</title>
249
268
    <para>
301
320
      </row>
302
321
    </tbody></tgroup></table>
303
322
  </refsect1>
304
 
 
 
323
  
305
324
  <refsect1 id="checking">
306
325
    <title>CHECKING</title>
307
326
    <para>
315
334
      <manvolnum>5</manvolnum></citerefentry>.
316
335
    </para>
317
336
  </refsect1>
318
 
 
 
337
  
319
338
  <refsect1 id="logging">
320
339
    <title>LOGGING</title>
321
340
    <para>
325
344
      and also show them on the console.
326
345
    </para>
327
346
  </refsect1>
328
 
 
 
347
  
 
348
  <refsect1 id="dbus_interface">
 
349
    <title>D-BUS INTERFACE</title>
 
350
    <para>
 
351
      The server will by default provide a D-Bus system bus interface.
 
352
      This interface will only be accessible by the root user or a
 
353
      Mandos-specific user, if such a user exists.
 
354
      <!-- XXX -->
 
355
    </para>
 
356
  </refsect1>
 
357
  
329
358
  <refsect1 id="exit_status">
330
359
    <title>EXIT STATUS</title>
331
360
    <para>
333
362
      critical error is encountered.
334
363
    </para>
335
364
  </refsect1>
336
 
 
 
365
  
337
366
  <refsect1 id="environment">
338
367
    <title>ENVIRONMENT</title>
339
368
    <variablelist>
353
382
      </varlistentry>
354
383
    </variablelist>
355
384
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
385
  
 
386
  <refsect1 id="files">
358
387
    <title>FILES</title>
359
388
    <para>
360
389
      Use the <option>--configdir</option> option to change where
383
412
        </listitem>
384
413
      </varlistentry>
385
414
      <varlistentry>
386
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
415
        <term><filename>/var/run/mandos.pid</filename></term>
387
416
        <listitem>
388
417
          <para>
389
418
            The file containing the process id of
424
453
      Currently, if a client is declared <quote>invalid</quote> due to
425
454
      having timed out, the server does not record this fact onto
426
455
      permanent storage.  This has some security implications, see
427
 
      <xref linkend="CLIENTS"/>.
 
456
      <xref linkend="clients"/>.
428
457
    </para>
429
458
    <para>
430
459
      There is currently no way of querying the server of the current
438
467
      Debug mode is conflated with running in the foreground.
439
468
    </para>
440
469
    <para>
441
 
      The console log messages does not show a timestamp.
 
470
      The console log messages does not show a time stamp.
 
471
    </para>
 
472
    <para>
 
473
      This server does not check the expire time of clients’ OpenPGP
 
474
      keys.
442
475
    </para>
443
476
  </refsect1>
444
477
  
479
512
      </para>
480
513
    </informalexample>
481
514
  </refsect1>
482
 
 
 
515
  
483
516
  <refsect1 id="security">
484
517
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
518
    <refsect2 id="server">
486
519
      <title>SERVER</title>
487
520
      <para>
488
521
        Running this <command>&COMMANDNAME;</command> server program
489
522
        should not in itself present any security risk to the host
490
 
        computer running it.  The program does not need any special
491
 
        privileges to run, and is designed to run as a non-root user.
 
523
        computer running it.  The program switches to a non-root user
 
524
        soon after startup.
492
525
      </para>
493
526
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
527
    <refsect2 id="clients">
495
528
      <title>CLIENTS</title>
496
529
      <para>
497
530
        The server only gives out its stored data to clients which
504
537
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
538
        <manvolnum>5</manvolnum></citerefentry>)
506
539
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
540
        except the user starting the server (usually root).
508
541
      </para>
509
542
      <para>
510
543
        As detailed in <xref linkend="checking"/>, the status of all
529
562
      </para>
530
563
      <para>
531
564
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
565
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
566
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
567
      </para>
535
568
    </refsect2>
536
569
  </refsect1>
537
 
 
 
570
  
538
571
  <refsect1 id="see_also">
539
572
    <title>SEE ALSO</title>
540
573
    <para>
543
576
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
577
        <refentrytitle>mandos.conf</refentrytitle>
545
578
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
 
579
        <refentrytitle>mandos-client</refentrytitle>
547
580
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
581
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
582
      </citerefentry>