/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-09-02 13:04:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902130442-ytnjsmllaph18e20
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
  (BUGS): Commented out.  There are no bugs.
  (EXAMPLE): Added lots of examples.
  (SECURITY): Added text.
  (SEE ALSO): Added "crypttab(5)" and "execve(2)".

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-09-01">
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
37
    <xi:include href="legalnotice.xml"/>
40
38
  </refentryinfo>
41
 
  
 
39
 
42
40
  <refmeta>
43
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
42
    <manvolnum>8</manvolnum>
50
48
      Gives encrypted passwords to authenticated Mandos clients
51
49
    </refpurpose>
52
50
  </refnamediv>
53
 
  
 
51
 
54
52
  <refsynopsisdiv>
55
53
    <cmdsynopsis>
56
54
      <command>&COMMANDNAME;</command>
85
83
      <replaceable>DIRECTORY</replaceable></option></arg>
86
84
      <sbr/>
87
85
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
86
    </cmdsynopsis>
91
87
    <cmdsynopsis>
92
88
      <command>&COMMANDNAME;</command>
104
100
      <arg choice="plain"><option>--check</option></arg>
105
101
    </cmdsynopsis>
106
102
  </refsynopsisdiv>
107
 
  
 
103
 
108
104
  <refsect1 id="description">
109
105
    <title>DESCRIPTION</title>
110
106
    <para>
119
115
      Any authenticated client is then given the stored pre-encrypted
120
116
      password for that specific client.
121
117
    </para>
 
118
 
122
119
  </refsect1>
123
120
  
124
121
  <refsect1 id="purpose">
125
122
    <title>PURPOSE</title>
 
123
 
126
124
    <para>
127
125
      The purpose of this is to enable <emphasis>remote and unattended
128
126
      rebooting</emphasis> of client host computer with an
129
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
130
128
      linkend="overview"/> for details.
131
129
    </para>
 
130
    
132
131
  </refsect1>
133
132
  
134
133
  <refsect1 id="options">
135
134
    <title>OPTIONS</title>
 
135
    
136
136
    <variablelist>
137
137
      <varlistentry>
138
138
        <term><option>--help</option></term>
190
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
191
        </listitem>
192
192
      </varlistentry>
193
 
      
 
193
 
194
194
      <varlistentry>
195
195
        <term><option>--priority <replaceable>
196
196
        PRIORITY</replaceable></option></term>
198
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
199
        </listitem>
200
200
      </varlistentry>
201
 
      
 
201
 
202
202
      <varlistentry>
203
203
        <term><option>--servicename
204
204
        <replaceable>NAME</replaceable></option></term>
207
207
                      xpointer="servicename"/>
208
208
        </listitem>
209
209
      </varlistentry>
210
 
      
 
210
 
211
211
      <varlistentry>
212
212
        <term><option>--configdir
213
213
        <replaceable>DIRECTORY</replaceable></option></term>
222
222
          </para>
223
223
        </listitem>
224
224
      </varlistentry>
225
 
      
 
225
 
226
226
      <varlistentry>
227
227
        <term><option>--version</option></term>
228
228
        <listitem>
231
231
          </para>
232
232
        </listitem>
233
233
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
 
        <term><option>--no-dbus</option></term>
237
 
        <listitem>
238
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
239
 
          <para>
240
 
            See also <xref linkend="dbus_interface"/>.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
234
    </variablelist>
245
235
  </refsect1>
246
 
  
 
236
 
247
237
  <refsect1 id="overview">
248
238
    <title>OVERVIEW</title>
249
239
    <xi:include href="overview.xml"/>
253
243
      <acronym>RAM</acronym> disk environment.
254
244
    </para>
255
245
  </refsect1>
256
 
  
 
246
 
257
247
  <refsect1 id="protocol">
258
248
    <title>NETWORK PROTOCOL</title>
259
249
    <para>
311
301
      </row>
312
302
    </tbody></tgroup></table>
313
303
  </refsect1>
314
 
  
 
304
 
315
305
  <refsect1 id="checking">
316
306
    <title>CHECKING</title>
317
307
    <para>
325
315
      <manvolnum>5</manvolnum></citerefentry>.
326
316
    </para>
327
317
  </refsect1>
328
 
  
 
318
 
329
319
  <refsect1 id="logging">
330
320
    <title>LOGGING</title>
331
321
    <para>
335
325
      and also show them on the console.
336
326
    </para>
337
327
  </refsect1>
338
 
  
339
 
  <refsect1 id="dbus_interface">
340
 
    <title>D-BUS INTERFACE</title>
341
 
    <para>
342
 
      The server will by default provide a D-Bus system bus interface.
343
 
      This interface will only be accessible by the root user or a
344
 
      Mandos-specific user, if such a user exists.
345
 
      <!-- XXX -->
346
 
    </para>
347
 
  </refsect1>
348
328
 
349
329
  <refsect1 id="exit_status">
350
330
    <title>EXIT STATUS</title>
353
333
      critical error is encountered.
354
334
    </para>
355
335
  </refsect1>
356
 
  
 
336
 
357
337
  <refsect1 id="environment">
358
338
    <title>ENVIRONMENT</title>
359
339
    <variablelist>
373
353
      </varlistentry>
374
354
    </variablelist>
375
355
  </refsect1>
376
 
  
377
 
  <refsect1 id="files">
 
356
 
 
357
  <refsect1 id="file">
378
358
    <title>FILES</title>
379
359
    <para>
380
360
      Use the <option>--configdir</option> option to change where
403
383
        </listitem>
404
384
      </varlistentry>
405
385
      <varlistentry>
406
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
386
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
407
387
        <listitem>
408
388
          <para>
409
389
            The file containing the process id of
444
424
      Currently, if a client is declared <quote>invalid</quote> due to
445
425
      having timed out, the server does not record this fact onto
446
426
      permanent storage.  This has some security implications, see
447
 
      <xref linkend="clients"/>.
 
427
      <xref linkend="CLIENTS"/>.
448
428
    </para>
449
429
    <para>
450
430
      There is currently no way of querying the server of the current
458
438
      Debug mode is conflated with running in the foreground.
459
439
    </para>
460
440
    <para>
461
 
      The console log messages does not show a time stamp.
462
 
    </para>
463
 
    <para>
464
 
      This server does not check the expire time of clients’ OpenPGP
465
 
      keys.
 
441
      The console log messages does not show a timestamp.
466
442
    </para>
467
443
  </refsect1>
468
444
  
503
479
      </para>
504
480
    </informalexample>
505
481
  </refsect1>
506
 
  
 
482
 
507
483
  <refsect1 id="security">
508
484
    <title>SECURITY</title>
509
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
510
486
      <title>SERVER</title>
511
487
      <para>
512
488
        Running this <command>&COMMANDNAME;</command> server program
513
489
        should not in itself present any security risk to the host
514
 
        computer running it.  The program switches to a non-root user
515
 
        soon after startup.
 
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.
516
492
      </para>
517
493
    </refsect2>
518
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
519
495
      <title>CLIENTS</title>
520
496
      <para>
521
497
        The server only gives out its stored data to clients which
528
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
505
        <manvolnum>5</manvolnum></citerefentry>)
530
506
        <emphasis>must</emphasis> be made non-readable by anyone
531
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
532
508
      </para>
533
509
      <para>
534
510
        As detailed in <xref linkend="checking"/>, the status of all
553
529
      </para>
554
530
      <para>
555
531
        For more details on client-side security, see
556
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
557
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
558
534
      </para>
559
535
    </refsect2>
560
536
  </refsect1>
561
 
  
 
537
 
562
538
  <refsect1 id="see_also">
563
539
    <title>SEE ALSO</title>
564
540
    <para>
567
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
544
        <refentrytitle>mandos.conf</refentrytitle>
569
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>mandos-client</refentrytitle>
 
546
        <refentrytitle>password-request</refentrytitle>
571
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
573
549
      </citerefentry>