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